Skip to main content

Find public IP by searching criteria

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

Return public IPs that match all searching criteria. Criteria are project identifier, public IP status (used or not) and public IP name.

Request​

Path Parameters

    projectId stringrequired

    Project Identifier

    zoneName stringrequired

    Zone name

Query Parameters

    isUsed boolean

    is used or not searching criteria

    provisioningState BasicStateEnum

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

    State of the searched public IP address.

    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 [
    • hRefstringrequired

    hRef to the Public IP Address.

    iduuidrequired

    Public IP Address id.

    descriptionstring

    Description of the Public IP Address.

    tags object

    Tags

    property name*string
    createdDatedate-timerequired

    creation date of the Public IP Address.

    lastModifiedDatedate-timerequired

    date of the last modification.

    lastRequesterIdstringrequired

    Identifier of the user of the last create/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]

    familystringrequired

    IP Family Enum (ipv6 not available yet).

    Possible values: [ipv4, ipv6]

    Default value: ipv4
    publicIpAddressstring

    Allocated public IP address.

    isUsedboolean

    Flag indicating if the public IP address is already used on an interface of a VM.

  • ]
curl -L '/v1/projects/:projectId/zones/:zoneName/publicipaddresses' \
-H 'Accept: application/json'
Request Collapse all
Base URL
/v1
Parameters
— pathrequired
— pathrequired
— query
— query
— query
— query
— query
— header
— header
— header