Skip to main content
PATCH
/
cloud
/
v1
/
floatingips
/
{project_id}
/
{region_id}
/
{floating_ip_id}
Python
import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
floating_ip = client.cloud.floating_ips.update(
    floating_ip_id="c64e5db1-5f1f-43ec-a8d9-5090df85b82d",
    project_id=1,
    region_id=1,
)
print(floating_ip.id)
{
  "created_at": "2023-11-07T05:31:56Z",
  "creator_task_id": "d1e1500b-e2be-40aa-9a4b-cc493fa1af30",
  "fixed_ip_address": "192.168.10.15",
  "floating_ip_address": "172.24.4.34",
  "id": "<string>",
  "port_id": "ee2402d0-f0cd-4503-9b75-69be1d11c5f1",
  "project_id": 123,
  "region": "<string>",
  "region_id": 123,
  "router_id": "11005a33-c5ac-4c96-ab6f-8f2827cc7da6",
  "status": "ACTIVE",
  "tags": [
    {
      "key": "<string>",
      "read_only": true,
      "value": "<string>"
    }
  ],
  "task_id": "a4eb4b29-048e-42f6-a5e1-2c18bc001c45",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
project_id
integer
required

Project ID

​
region_id
integer
required

Region ID

​
floating_ip_id
string<uuid4>
required

Floating IP ID

Body

application/json
​
tags
UpdateTagsSerializer · object

Update key-value tags using JSON Merge Patch semantics (RFC 7386). Provide key-value pairs to add or update tags. Set tag values to null to remove tags. Unspecified tags remain unchanged. Read-only tags are always preserved and cannot be modified.

Examples:

  • Add/update tags: {'tags': {'environment': 'production', 'team': 'backend'}} adds new tags or updates existing ones.

  • Delete tags: {'tags': {'old_tag': null}} removes specific tags.

  • Remove all tags: {'tags': null} removes all user-managed tags (read-only tags are preserved).

  • Partial update: {'tags': {'environment': 'staging'}} only updates specified tags.

  • Mixed operations: {'tags': {'environment': 'production', 'cost_center': 'engineering', 'deprecated_tag': null}} adds/updates 'environment' and 'cost_center' while removing 'deprecated_tag', preserving other existing tags.

  • Replace all: first delete existing tags with null values, then add new ones in the same request.

Example:
{
  "my-tag": "my-tag-value",
  "my-tag-to-remove": null
}

Response

200 - application/json

OK

​
created_at
string<date-time>
required

Datetime when the floating IP was created

​
creator_task_id
string<uuid4> | null
required

Task that created this entity

Example:

"d1e1500b-e2be-40aa-9a4b-cc493fa1af30"

​
fixed_ip_address
string<ipvanyaddress> | null
required

IP address of the port the floating IP is attached to

Example:

"192.168.10.15"

​
floating_ip_address
string<ipvanyaddress> | null
required

IP Address of the floating IP

Example:

"172.24.4.34"

​
id
string<uuid4>
required

Floating IP ID

​
port_id
string<uuid4> | null
required

Port ID the floating IP is attached to. The fixed_ip_address is the IP address of the port.

Example:

"ee2402d0-f0cd-4503-9b75-69be1d11c5f1"

​
project_id
integer
required

Project ID

​
region
string
required

Region name

​
region_id
integer
required

Region ID

​
router_id
string<uuid4> | null
required

Router ID

Example:

"11005a33-c5ac-4c96-ab6f-8f2827cc7da6"

​
status
enum<string> | null
required

Floating IP status. DOWN - unassigned (available). ACTIVE - attached to a port (in use). ERROR - error state.

Available options:
ACTIVE,
DOWN,
ERROR
Example:

"ACTIVE"

​
tags
TagSerializer · object[]
required

List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.

​
task_id
string<uuid4> | null
required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

Example:

"a4eb4b29-048e-42f6-a5e1-2c18bc001c45"

​
updated_at
string<date-time>
required

Datetime when the floating IP was last updated