Floating IPs
All operations require authentication.
List floating IPsProduction
Returns the floating IPs of the project.
Path parameters
Project ID
Headers
Pagination cursor
Pagination size
Response
Computed hash representing the current target specification value
Creation date of the floating IP
Current state of the floating IP
Ongoing asynchronous tasks related to the floating IP
The floating IP address, used as identifier
Floating IP readiness in the system
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification of the floating IP
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"[ { "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
Returns the floating IP, including the resource it's currently associated with.
Path parameters
Id
Project ID
Response
Computed hash representing the current target specification value
Creation date of the floating IP
Current state of the floating IP
Ongoing asynchronous tasks related to the floating IP
The floating IP address, used as identifier
Floating IP readiness in the system
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification of the floating IP
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"{ "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
Allocates a floating IP in a region.
Path parameters
Project ID
Request body (required)
Desired target specification for the floating IP to create
Response
Computed hash representing the current target specification value
Creation date of the floating IP
Current state of the floating IP
Ongoing asynchronous tasks related to the floating IP
The floating IP address, used as identifier
Floating IP readiness in the system
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification of the floating IP
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"{ "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
Deletes the floating IP. If it's associated with a resource, it is disassociated automatically.
Path parameters
Id
Project ID
Response
Computed hash representing the current target specification value
Creation date of the floating IP
Current state of the floating IP
Ongoing asynchronous tasks related to the floating IP
The floating IP address, used as identifier
Floating IP readiness in the system
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification of the floating IP
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"{ "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
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
Project ID
Request body (required)
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).
Desired target specification for the floating IP
Response
Computed hash representing the current target specification value
Creation date of the floating IP
Current state of the floating IP
Ongoing asynchronous tasks related to the floating IP
The floating IP address, used as identifier
Floating IP readiness in the system
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification of the floating IP
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"{ "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"}