Reserve a public IP with Orange

POST 
/projects/:projectId/zones/:zoneName/publicipaddresses

Create a public IP address.

Request

Path Parameters

projectId stringrequired

Project Identifier

zoneName stringrequired

Zone name

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.

application/json

Body

required

Attributes to create a public IP address.

description string

Public IP Address resource description.

tags

object

Tags associated with the Public IP Address resource.

property name* string
family stringrequired

Possible values: [ipv4, ipv6]

Default value: ipv4

IP Family Enum (ipv6 not available yet).

Responses

201

Created

Response Headers

• X-Job-Href

  string

  Href of the asynchronous job that will process the request, in order to track its status.

• X-Retry-After

  integer

  The number of seconds to wait before checking the status of the job.

application/json

Schema

Schema

id uuidrequired

Resource identifier.

hRef urirequired

Hypertext reference of the resource.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "hRef": "string"
}

OK

{   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",   "hRef": "/projects/{projectId}/zones/{zoneName}/publicipaddresses/{publicIPId}" }

400

Bad Request

Request is not valid

application/json

Schema

Schema

code int32required

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

message stringrequired

A short localized string that describes the error.

description string

(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 (from schema)

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

401

Unauthorized

Credentials are missing

application/json

Schema

Schema

code int32required

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

message stringrequired

A short localized string that describes the error.

description string

(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 (from schema)

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

403

Forbidden

Valid credentials but not enough privileges to perform the operation

application/json

Schema

Schema

code int32required

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

message stringrequired

A short localized string that describes the error.

description string

(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 (from schema)

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

404

Not Found

Unknown resource or service

application/json

Schema

Schema

code int32required

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

message stringrequired

A short localized string that describes the error.

description string

(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 (from schema)

{
  "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

code int32required

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

message stringrequired

A short localized string that describes the error.

description string

(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 (from schema)

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

500

Internal Server Error

Unexpected error, please contact support

application/json

Schema

Schema

code int32required

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

message stringrequired

A short localized string that describes the error.

description string

(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 (from schema)

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

503

Service Unavailable

Service probably in maintenance. Please retry later.

application/json

Schema

Schema

code int32required

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

message stringrequired

A short localized string that describes the error.

description string

(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 (from schema)

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

Loading...