Skip to main content

Find a public IP by its identifier

GET 

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

Get a public IP address with its id in the path.

Request

Path Parameters

    projectId stringrequired

    Project Identifier

    zoneName stringrequired

    Zone name

    publicIPId stringrequired

    Identifier of the public IP address

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
    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/:publicIPId' \
-H 'Accept: application/json'
Request Collapse all
Base URL
/v1
Parameters
— pathrequired
— pathrequired
— pathrequired
— header
— header
— header