Documentation | Floating IPs › Metadata › List Floating IP Metadata

Floating IPs

floating_ips

Methods

Assign Floating IP To Instance Or Loadbalancer ->

FloatingIP

post/v1/floatingips/{project_id}/{region_id}/{pk}/assign

Assign floating IP to instance or loadbalancer

Create Floating IP -> { tasks }

post/v1/floatingips/{project_id}/{region_id}

Create floating IP

Delete Floating IP -> { tasks }

delete/v1/floatingips/{project_id}/{region_id}/{pk}

Delete floating IP

Get Available Floating IPs -> { count, results }

get/v1/availablefloatingips/{project_id}/{region_id}

Get available floating IPs

List Floating IPs -> OffsetPage<{ id, created_at, creator_task_id, 16 more... }>

get/v1/floatingips/{project_id}/{region_id}

List floating IPs

Get Floating IP ->

FloatingIP

get/v1/floatingips/{project_id}/{region_id}/{pk}

Get floating IP

Unassign Floating IP From The Instance ->

FloatingIP

post/v1/floatingips/{project_id}/{region_id}/{pk}/unassign

Unassign floating IP from the instance

Domain types

FloatingIP = { created_at, project_id, region, 14 more... }

Floating IPs

Metadata

floating_ips.metadata

Methods

Create Or Update Floating IP Metadata ->

post/v1/floatingips/{project_id}/{region_id}/{pk}/metadata

Create or update one or more metadata items for a floating IP. If an item does not exist, it gets created. If an item already exists, it's value is overwritten

List Floating IP Metadata -> { count, results }

get/v1/floatingips/{project_id}/{region_id}/{pk}/metadata

Lists all metadata for a floating IP

Parameters

project_id: number

region_id: number

pk: string

Response fields

count: number

(minimum: 0)

Number of objects

results: Array<{ key, read_only, value }>

Objects

Request example

curl https://api.gcore.com/cloud/v1/floatingips/$PROJECT_ID/$REGION_ID/$PK/metadata \
    -H "APIKey: $CLOUD_API_API_KEY"

200Example

{
  "count": 1,
  "results": [
    {
      "key": "cost-center",
      "read_only": false,
      "value": "Luxembourg"
    }
  ]
}

Replace Floating IP Metadata ->

put/v1/floatingips/{project_id}/{region_id}/{pk}/metadata

All existing metadata is deleted and replaced with the metadata from the request.

Floating IPs

Metadata Item

floating_ips.metadata_item

Methods

Delete Floating IP Metadata Item By Key ->

delete/v1/floatingips/{project_id}/{region_id}/{pk}/metadata_item

Delete Floating IP metadata item by key

Get Floating IP Metadata Item By Key -> { key, read_only, value }

get/v1/floatingips/{project_id}/{region_id}/{pk}/metadata_item

Get Floating IP metadata item by key