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

200

Ok

application/json

Schema

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.

Example (auto)

{
  "hRef": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "description": "string",
  "tags": {},
  "createdDate": "2024-07-29T15:51:28.071Z",
  "lastModifiedDate": "2024-07-29T15:51:28.071Z",
  "lastRequesterId": "string",
  "provisioningState": "creating",
  "family": "ipv4",
  "publicIpAddress": "string",
  "isUsed": true
}

400

Bad Request

Request is not valid

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

401

Unauthorized

Credentials are missing

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

403

Forbidden

Valid credentials but not enough privileges to perform the operation

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

404

Not Found

Unknown resource or service

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

405

Method Not Allowed

Operation is not valid according to the state of the resource

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

500

Internal Server Error

Unexpected error, please contact support

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

503

Service Unavailable

Service probably in maintenance. Please retry later.

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

• curl
• python
• go
• nodejs
• php
• java

• CURL

curl -L '/v1/projects/:projectId/zones/:zoneName/publicipaddresses/:publicIPId' \
-H 'Accept: application/json'

Request Collapse all

Base URL

/v1

Parameters

projectId — pathrequired

zoneName — pathrequired

publicIPId — pathrequired

X-API-KEY — header

Authorization — header

X-Requester-Id — header