Skip to content

Floating IPs

All operations require authentication.

5 operationsv2/publicCloud/project
Agent setup

List floating IPsProduction

GET
/v2/publicCloud/project/{projectId}/publicIp/floating

Returns the floating IPs of the project.

Path parameters

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200FloatingIP[]successful operation
checksum
read-only
string

Computed hash representing the current target specification value

createdAt
read-only
stringdate-time

Creation date of the floating IP

currentState
read-only
FloatingIPCurrentState

Current state of the floating IP

currentTasks
read-only
CurrentTask[]

Ongoing asynchronous tasks related to the floating IP

id
read-only
ip

The floating IP address, used as identifier

resourceStatus
read-only
ResourceStatusEnum

Floating IP readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
FloatingIPTargetSpec

Last target specification of the floating IP

updatedAt
read-only
stringdate-time

Last update date of the floating IP

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/publicIp/floating \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "associatedResource": { "id": "string", "type": "GATEWAY" }, "description": "string", "id": "00000000-0000-0000-0000-000000000000", "ip": "192.0.2.0", "location": { "availabilityZone": "string", "region": "string" }, "network": { "id": "00000000-0000-0000-0000-000000000000" }, "status": "ACTIVE" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "192.0.2.0", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "location": { "availabilityZone": "string", "region": "string" } }, "updatedAt": "2024-01-01T12:00:00Z" }]

Get a floating IPProduction

GET
/v2/publicCloud/project/{projectId}/publicIp/floating/{id}

Returns the floating IP, including the resource it's currently associated with.

Path parameters

id
required
ip

Id

projectId
required
string

Project ID

Response

200FloatingIPsuccessful operation
checksum
read-only
string

Computed hash representing the current target specification value

createdAt
read-only
stringdate-time

Creation date of the floating IP

currentState
read-only
FloatingIPCurrentState

Current state of the floating IP

currentTasks
read-only
CurrentTask[]

Ongoing asynchronous tasks related to the floating IP

id
read-only
ip

The floating IP address, used as identifier

resourceStatus
read-only
ResourceStatusEnum

Floating IP readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
FloatingIPTargetSpec

Last target specification of the floating IP

updatedAt
read-only
stringdate-time

Last update date of the floating IP

Example uses id = 192.0.2.0, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/publicIp/floating/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "associatedResource": { "id": "string", "type": "GATEWAY" }, "description": "string", "id": "00000000-0000-0000-0000-000000000000", "ip": "192.0.2.0", "location": { "availabilityZone": "string", "region": "string" }, "network": { "id": "00000000-0000-0000-0000-000000000000" }, "status": "ACTIVE" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "192.0.2.0", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "location": { "availabilityZone": "string", "region": "string" } }, "updatedAt": "2024-01-01T12:00:00Z"}

Create a floating IPProduction

POST
/v2/publicCloud/project/{projectId}/publicIp/floating

Allocates a floating IP in a region.

Path parameters

projectId
required
string

Project ID

Request body (required)

targetSpec
required
FloatingIPTargetSpec

Desired target specification for the floating IP to create

Response

200FloatingIPsuccessful operation
checksum
read-only
string

Computed hash representing the current target specification value

createdAt
read-only
stringdate-time

Creation date of the floating IP

currentState
read-only
FloatingIPCurrentState

Current state of the floating IP

currentTasks
read-only
CurrentTask[]

Ongoing asynchronous tasks related to the floating IP

id
read-only
ip

The floating IP address, used as identifier

resourceStatus
read-only
ResourceStatusEnum

Floating IP readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
FloatingIPTargetSpec

Last target specification of the floating IP

updatedAt
read-only
stringdate-time

Last update date of the floating IP

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/publicIp/floating \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "associatedResource": { "id": "string", "type": "GATEWAY" }, "description": "string", "id": "00000000-0000-0000-0000-000000000000", "ip": "192.0.2.0", "location": { "availabilityZone": "string", "region": "string" }, "network": { "id": "00000000-0000-0000-0000-000000000000" }, "status": "ACTIVE" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "192.0.2.0", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "location": { "availabilityZone": "string", "region": "string" } }, "updatedAt": "2024-01-01T12:00:00Z"}

Delete a floating IPProduction

DELETE
/v2/publicCloud/project/{projectId}/publicIp/floating/{id}

Deletes the floating IP. If it's associated with a resource, it is disassociated automatically.

Path parameters

id
required
ip

Id

projectId
required
string

Project ID

Response

200FloatingIPsuccessful operation
checksum
read-only
string

Computed hash representing the current target specification value

createdAt
read-only
stringdate-time

Creation date of the floating IP

currentState
read-only
FloatingIPCurrentState

Current state of the floating IP

currentTasks
read-only
CurrentTask[]

Ongoing asynchronous tasks related to the floating IP

id
read-only
ip

The floating IP address, used as identifier

resourceStatus
read-only
ResourceStatusEnum

Floating IP readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
FloatingIPTargetSpec

Last target specification of the floating IP

updatedAt
read-only
stringdate-time

Last update date of the floating IP

Example uses id = 192.0.2.0, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/publicIp/floating/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "associatedResource": { "id": "string", "type": "GATEWAY" }, "description": "string", "id": "00000000-0000-0000-0000-000000000000", "ip": "192.0.2.0", "location": { "availabilityZone": "string", "region": "string" }, "network": { "id": "00000000-0000-0000-0000-000000000000" }, "status": "ACTIVE" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "192.0.2.0", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "location": { "availabilityZone": "string", "region": "string" } }, "updatedAt": "2024-01-01T12:00:00Z"}

Update a floating IPProduction

PUT
/v2/publicCloud/project/{projectId}/publicIp/floating/{id}

Replaces the floating IP's target specification as a whole. The body carries the complete desired state of every field publicCloud.publicIp.FloatingIPUpdateTargetSpec exposes, which today is description alone. description is optional: restate it to keep it, and leave it out to clear it. This is how a description is removed. There is no separate delete.

The create-only field location cannot be changed once the floating IP exists. It is deliberately absent from the update model, and sending it is rejected with a 400.

The optional checksum guards against a lost update: when supplied it must match the floating IP's current checksum or the request is rejected with a 409 checksum mismatch. Omitting it skips the check and forces the write (last-write-wins).

Path parameters

id
required
ip

Id

projectId
required
string

Project ID

Request body (required)

checksum
string

Optional concurrency-control checksum. When supplied, it must match the resource's current checksum or the request is rejected with a 409 checksum-mismatch conflict. When omitted or empty, the concurrency check is skipped and the write is forced (last-write-wins).

targetSpec
required
FloatingIPUpdateTargetSpec

Desired target specification for the floating IP

Response

200FloatingIPsuccessful operation
checksum
read-only
string

Computed hash representing the current target specification value

createdAt
read-only
stringdate-time

Creation date of the floating IP

currentState
read-only
FloatingIPCurrentState

Current state of the floating IP

currentTasks
read-only
CurrentTask[]

Ongoing asynchronous tasks related to the floating IP

id
read-only
ip

The floating IP address, used as identifier

resourceStatus
read-only
ResourceStatusEnum

Floating IP readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
FloatingIPTargetSpec

Last target specification of the floating IP

updatedAt
read-only
stringdate-time

Last update date of the floating IP

400objectError 400 response
409objectError 409 response

Example uses id = 192.0.2.0, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/publicIp/floating/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "associatedResource": { "id": "string", "type": "GATEWAY" }, "description": "string", "id": "00000000-0000-0000-0000-000000000000", "ip": "192.0.2.0", "location": { "availabilityZone": "string", "region": "string" }, "network": { "id": "00000000-0000-0000-0000-000000000000" }, "status": "ACTIVE" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "192.0.2.0", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "location": { "availabilityZone": "string", "region": "string" } }, "updatedAt": "2024-01-01T12:00:00Z"}