Aller au contenu principal

Cette page est disponible uniquement en anglais (This page is only available in English).

Find key pairs by searching criteria

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

Return key pairs that match all searching criteria. Criteria are project identifier and key pairs name.

Request​

Path Parameters

    projectId stringrequired

    Project Identifier

    zoneName stringrequired

    Zone name

Query Parameters

    provisioningState BasicStateEnum

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

    State of the searched key pair.

    offset int32

    Requested pagination of response. The parameter offset is the index of the first element to retrieve. Zero is the first element of the collection.

    Default value: 0
    limit int32

    Possible values: >= 1

    Requested pagination of response. The parameter limit is the maximum number of elements to retrieve (it can be greater than the actual available number of items).

    Default value: 100
    sort string

    Possible values: <= 100 characters, Value must match regular expression -?[A-Za-z0-9]+(?:,[A-Za-z0-9]+)*

    The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order.

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

Response Headers
    X-Total-Count

    Returns Pagination of response. The total number of items in the collection, after application of filters if any.

    X-Result-Count

    The actual number of items contained in the response body. Note that it can be less than the requested "limit".

Schema
  • Array [
    • namestringrequired

    Unique resource name. This attribute can not be updated.

    Possible values: Value must match regular expression [A-Za-z0-9-]

    descriptionstring

    Resource description

    tags object

    Tags associated with the resource

    property name*string
    iduuidrequired

    Resource identifier.

    hRefurirequired

    Hypertext reference of the resource.

    createdDatedate-timerequired

    Creation date of the resource.

    lastModifiedDatedate-timerequired

    Date of the last modification of the resource.

    lastRequesterIdstringrequired

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

    provisioningStateBasicStateEnum (string)required

    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

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

    publicKeystring

    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.

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

  • ]

Request Collapse all
Base URL
/v1
Parameters
— pathrequired
— pathrequired
— query
— query
— query
— query
— header
— header
— header