Floating IPs

Floating IPs of the project

GET /floating_ips

Parameters

Name	In	Type	Required	Description
page	query	integer	No	(minimum 1, default 1)
per_page	query	integer	No	(minimum 1, maximum 100, default 25)
name	query	string	No	Exact name (maximum length 64)
label_selector	query	string	No	key, !key, key==v, key=v, key!=v, key in (a,b), key notin (a,b); comma-separated (and) (maximum length 1024)
sort	query	string	No	<field>:asc|desc; fields id, name, created; default created:desc (pattern ^(id|name|created):(asc|desc)$)
q	query	string	No	Every word must match, in any case: part of the name or address, or label:key, label:key=value (minimum length 2, maximum length 100)

Responses

Status	Description
200	Floating IPs
401	No valid API key
403	The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded)
422	A field is missing or malformed (invalid_input, details.fields) or an Idempotency-Key was reused with a different request (idempotency_key_mismatch)
429	The key's allowance is used up

Response body

Field	Type	Required	Description
floating_ips	array of FloatingIp	Yes
meta	Meta	Yes

Create a floating IP

POST /floating_ips

Counts against the floating_ips quota. Either location or server is given.

Parameters

Name	In	Type	Required	Description
Idempotency-Key	header	string	No	16-128 visible ASCII characters; the first response is replayed for 24 hours (pattern ^[\x21-\x7e]{16,128}$)

Request body

Field	Type	Required	Description
type	ipv4, ipv6	Yes
location	Reference	No
server	Reference	No
name	string	No	1-64 printable characters without @ (minimum length 1, maximum length 64)
description	string	No	(maximum length 200)
labels	map of string	No	At most 32 keys; keys and values of 1-63 (values may be empty) letters, digits, ., _, -, starting and ending with a letter or digit

Responses

Status	Description
201	The floating IP and its action
401	No valid API key
403	The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded)
409	The request conflicts with the resource's state (conflict) or an Idempotency-Key is still being processed (idempotency_in_progress)
422	A field is missing or malformed (invalid_input, details.fields) or an Idempotency-Key was reused with a different request (idempotency_key_mismatch)
429	The key's allowance is used up

Response body

Field	Type	Required	Description
floating_ip	FloatingIp	Yes
action	Action	Yes

One floating IP

GET /floating_ips/{id}

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes

Responses

Status	Description
200	The floating IP
401	No valid API key
404	No such resource in this project
429	The key's allowance is used up

Response body

Field	Type	Required	Description
floating_ip	FloatingIp	Yes

Rename, describe or relabel a floating IP

PUT /floating_ips/{id}

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes

Request body

Field	Type	Required	Description
name	string	No	1-64 printable characters without @ (minimum length 1, maximum length 64)
description	string	No	(maximum length 200)
labels	map of string	No	At most 32 keys; keys and values of 1-63 (values may be empty) letters, digits, ., _, -, starting and ending with a letter or digit

Responses

Status	Description
200	The floating IP
401	No valid API key
403	The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded)
404	No such resource in this project
409	The request conflicts with the resource's state (conflict) or an Idempotency-Key is still being processed (idempotency_in_progress)
422	A field is missing or malformed (invalid_input, details.fields) or an Idempotency-Key was reused with a different request (idempotency_key_mismatch)
423	The resource has a running action
429	The key's allowance is used up

Response body

Field	Type	Required	Description
floating_ip	FloatingIp	Yes

Release a floating IP

DELETE /floating_ips/{id}

Refused while assigned or while protection.delete is on (409).

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes

Responses

Status	Description
204	Released
401	No valid API key
403	The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded)
404	No such resource in this project
409	The request conflicts with the resource's state (conflict) or an Idempotency-Key is still being processed (idempotency_in_progress)
423	The resource has a running action
429	The key's allowance is used up

Actions of a floating IP

GET /floating_ips/{id}/actions

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes
page	query	integer	No	(minimum 1, default 1)
per_page	query	integer	No	(minimum 1, maximum 100, default 25)
status	query	running, success, error	No
sort	query	string	No	<field>:asc|desc; fields id, command, status, started, finished; default started:desc (pattern ^(id|command|status|started|finished):(asc|desc)$)

Responses

Status	Description
200	Actions
401	No valid API key
404	No such resource in this project
422	A field is missing or malformed (invalid_input, details.fields) or an Idempotency-Key was reused with a different request (idempotency_key_mismatch)
429	The key's allowance is used up

Response body

Field	Type	Required	Description
actions	array of Action	Yes
meta	Meta	Yes

One action of a floating IP

GET /floating_ips/{id}/actions/{action_id}

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes
action_id	path	string (uuid)	Yes

Responses

Status	Description
200	The action
401	No valid API key
404	No such resource in this project
429	The key's allowance is used up

Response body

Field	Type	Required	Description
action	Action	Yes

Assign a floating IP to a server

POST /floating_ips/{id}/actions/assign

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes
Idempotency-Key	header	string	No	16-128 visible ASCII characters; the first response is replayed for 24 hours (pattern ^[\x21-\x7e]{16,128}$)

Request body

Field	Type	Required	Description
server	Reference	Yes

Responses

Status	Description
201	The action
401	No valid API key
403	The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded)
404	No such resource in this project
409	The request conflicts with the resource's state (conflict) or an Idempotency-Key is still being processed (idempotency_in_progress)
422	A field is missing or malformed (invalid_input, details.fields) or an Idempotency-Key was reused with a different request (idempotency_key_mismatch)
423	The resource has a running action
429	The key's allowance is used up

Response body

Field	Type	Required	Description
action	Action	Yes

Unassign a floating IP

POST /floating_ips/{id}/actions/unassign

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes
Idempotency-Key	header	string	No	16-128 visible ASCII characters; the first response is replayed for 24 hours (pattern ^[\x21-\x7e]{16,128}$)

Responses

Status	Description
201	The action
401	No valid API key
403	The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded)
404	No such resource in this project
409	The request conflicts with the resource's state (conflict) or an Idempotency-Key is still being processed (idempotency_in_progress)
422	A field is missing or malformed (invalid_input, details.fields) or an Idempotency-Key was reused with a different request (idempotency_key_mismatch)
423	The resource has a running action
429	The key's allowance is used up

Response body

Field	Type	Required	Description
action	Action	Yes

Set or clear the reverse DNS name

POST /floating_ips/{id}/actions/change_dns_ptr

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes
Idempotency-Key	header	string	No	16-128 visible ASCII characters; the first response is replayed for 24 hours (pattern ^[\x21-\x7e]{16,128}$)

Request body

Field	Type	Required	Description
ip	string	Yes	(maximum length 45)
dns_ptr	string or null	Yes	A hostname, or null to clear (maximum length 253)

Responses

Status	Description
201	The action
401	No valid API key
403	The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded)
404	No such resource in this project
409	The request conflicts with the resource's state (conflict) or an Idempotency-Key is still being processed (idempotency_in_progress)
422	A field is missing or malformed (invalid_input, details.fields) or an Idempotency-Key was reused with a different request (idempotency_key_mismatch)
423	The resource has a running action
429	The key's allowance is used up

Response body

Field	Type	Required	Description
action	Action	Yes

Protect a floating IP from deletion

POST /floating_ips/{id}/actions/change_protection

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes
Idempotency-Key	header	string	No	16-128 visible ASCII characters; the first response is replayed for 24 hours (pattern ^[\x21-\x7e]{16,128}$)

Request body

Field	Type	Required	Description
delete	boolean	Yes

Responses

Status	Description
201	The action
401	No valid API key
403	The key's scope or the organization's subscription does not allow the request (forbidden), or a quota is exhausted (resource_limit_exceeded)
404	No such resource in this project
409	The request conflicts with the resource's state (conflict) or an Idempotency-Key is still being processed (idempotency_in_progress)
422	A field is missing or malformed (invalid_input, details.fields) or an Idempotency-Key was reused with a different request (idempotency_key_mismatch)
423	The resource has a running action
429	The key's allowance is used up

Response body

Field	Type	Required	Description
action	Action	Yes