Skip to main content

Get a key pair by its identifier

GET 
/projects/:projectId/zones/:zoneName/keypairs/:keyPairId

Get the key pair by its id in the path.

Request​

Path Parameters

    projectId stringrequired

    Project Identifier

    zoneName stringrequired

    Zone name

    keyPairId stringrequired

    Key pair identifier.

Header Parameters

    X-API-Key string

    Your SIU token if you use this API through Orange Developer.

    Authorization string

    Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.

    X-Requester-Id string

    Your SIU Id if you use this API through Orange Developer Inside.

Responses​

Ok

Schema

    name stringrequired

    Possible values: <= 40 characters, Value must match regular expression [A-Za-z0-9-]

    Unique resource name. This attribute can not be updated.

    description string

    Resource description

    tags

    object

    Tags associated with the resource

    property name* string
    id uuidrequired

    Resource identifier.

    hRef urirequired

    Hypertext reference of the resource.

    createdDate date-timerequired

    Creation date of the resource.

    lastModifiedDate date-timerequired

    Date of the last modification of the resource.

    lastRequesterId stringrequired

    Identifier of the user of the last create/update/delete operation requested on the resource.

    provisioningState BasicStateEnum (string)required

    Possible values: [creating, updating, deleting, active, error]

    Provisioning state of the resource. Possible state:

    • creating: resource creation in progress
    • updating: resource update in progress
    • deleting: resource deletion in progress
    • active: resource created/updated successfully
    • error: resource in error because the last creation/update/deletion failed
    publicKey string

    Possible values: >= 512 characters and <= 2000 characters

    SSH Public Key to connect to virtual machines. If a public key is provided, it will be used to create the KeyPair resource. Otherwise, a public key and a private key will be automatically generated and their values will be returned as a result of the KeyPair creation request.

Loading...