Skip to main content

Find a public IP by its identifier

GET 
/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

    hRef stringrequired

    hRef to the Public IP Address.

    id uuidrequired

    Public IP Address id.

    description string

    Description of the Public IP Address.

    tags

    object

    Tags

    property name* string
    createdDate date-timerequired

    creation date of the Public IP Address.

    lastModifiedDate date-timerequired

    date of the last modification.

    lastRequester stringrequired

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

    Possible values: [ipv4, ipv6]

    Default value: ipv4

    IP Family Enum (ipv6 not available yet).

    publicIpAddress string

    Allocated public IP address.

    isUsed boolean

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

Loading...