List floating IPs

curl --request GET \
  --url https://api.gcore.com/cloud/v1/floatingips/{project_id}/{region_id} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.gcore.com/cloud/v1/floatingips/{project_id}/{region_id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/cloud/v1/floatingips/{project_id}/{region_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/cloud/v1/floatingips/{project_id}/{region_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/cloud/v1/floatingips/{project_id}/{region_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/cloud/v1/floatingips/{project_id}/{region_id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v1/floatingips/{project_id}/{region_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "count": 1,
  "results": [
    {
      "created_at": "2019-06-13T13:58:12+0000",
      "creator_task_id": "d1e1500b-e2be-40aa-9a4b-cc493fa1af30",
      "fixed_ip_address": "192.168.10.15",
      "floating_ip_address": "172.24.4.34",
      "id": "c64e5db1-5f1f-43ec-a8d9-5090df85b82d",
      "instance": {
        "addresses": {},
        "created_at": "2023-11-29T10:56:49Z",
        "creator_task_id": "d1e1500b-e2be-40aa-9a4b-cc493fa1af30",
        "flavor": {
          "flavor_id": "g2-standard-32-64",
          "flavor_name": "g2-standard-32-64",
          "ram": 2048,
          "vcpus": 1
        },
        "id": "6c6aa80f-7836-4dc2-a2ae-125e248be476",
        "instance_description": "Instance description",
        "name": "my-instance-1",
        "project_id": 111,
        "region": "Luxembourg",
        "region_id": 4,
        "security_groups": [
          {
            "name": "some_name"
          }
        ],
        "ssh_key_name": "my-ssh-key",
        "tags": [
          {
            "key": "my-tag",
            "read_only": false,
            "value": "my-tag-value"
          }
        ],
        "task_id": null,
        "task_state": null,
        "volumes": [
          {
            "delete_on_termination": true,
            "id": "<string>"
          }
        ]
      },
      "loadbalancer": {
        "admin_state_up": true,
        "created_at": "2019-06-18T11:56:16+0000",
        "id": "e8ab1be4-1521-4266-be69-28dad4148a30",
        "name": "lbaas_test_lb",
        "project_id": 1337,
        "region": "Luxembourg 1",
        "region_id": 7,
        "tags_v2": [
          {
            "key": "my-tag",
            "read_only": false,
            "value": "my-tag-value"
          }
        ],
        "additional_vips": [
          {
            "ip_address": "127.0.0.1",
            "subnet_id": "00000000-0000-4000-8000-000000000000"
          }
        ],
        "creator_task_id": "9f3ec11e-bcd4-4fe6-924a-a4439a56ad22",
        "ddos_profile": {
          "fields": [
            {
              "base_field": 10,
              "default": null,
              "description": "ARK server ports. Valid port values are in range 1000-65535",
              "field_type": null,
              "field_value": [
                45046,
                45047
              ],
              "id": 11,
              "name": "ARK Ports",
              "required": true,
              "validation_schema": {
                "items": {
                  "maximum": 65535,
                  "minimum": 1000,
                  "type": "integer"
                },
                "minItems": 1,
                "type": "array"
              },
              "value": null
            }
          ],
          "id": 0,
          "options": {
            "active": true,
            "bgp": true
          },
          "profile_template": {
            "description": "test client profile template",
            "fields": [
              {
                "default": null,
                "description": "ARK server ports. Valid port values are in range 1000-65535",
                "field_type": null,
                "id": 11,
                "name": "ARK Ports",
                "required": true,
                "validation_schema": {
                  "items": {
                    "maximum": 65535,
                    "minimum": 1000,
                    "type": "integer"
                  },
                  "minItems": 1,
                  "type": "array"
                }
              }
            ],
            "id": 0,
            "name": "test_client_profile_template"
          },
          "profile_template_description": "ARK server ports. Valid port values are in range 1000-65535",
          "protocols": [
            {
              "additionalProp1": "string",
              "additionalProp2": "string",
              "additionalProp3": "string"
            }
          ],
          "site": "ED",
          "status": {
            "error_description": "",
            "status": "Updated"
          }
        },
        "flavor": {
          "flavor_id": "1d276f53-2834-4855-9859-aa922f073055",
          "flavor_name": "lb1-1-2",
          "ram": 2048,
          "vcpus": 1
        },
        "floating_ips": [
          {
            "created_at": "2019-06-13T13:58:12+0000",
            "creator_task_id": "d1e1500b-e2be-40aa-9a4b-cc493fa1af30",
            "fixed_ip_address": "192.168.10.15",
            "floating_ip_address": "172.24.4.34",
            "id": "c64e5db1-5f1f-43ec-a8d9-5090df85b82d",
            "port_id": "ee2402d0-f0cd-4503-9b75-69be1d11c5f1",
            "project_id": 1337,
            "region": "Luxembourg 1",
            "region_id": 7,
            "router_id": "11005a33-c5ac-4c96-ab6f-8f2827cc7da6",
            "status": "ACTIVE",
            "tags": [
              {
                "key": "my-tag",
                "read_only": false,
                "value": "my-tag-value"
              }
            ],
            "task_id": "a4eb4b29-048e-42f6-a5e1-2c18bc001c45",
            "updated_at": "2019-06-13T13:58:12+0000"
          }
        ],
        "listeners": [
          {
            "id": "43658ea9-54bd-4807-90b1-925921c9a0d1"
          }
        ],
        "logging": {
          "destination_region_id": 1,
          "enabled": true,
          "retention_policy": {
            "period": 45
          },
          "topic_name": "my-log-name"
        },
        "preferred_connectivity": "L2",
        "stats": {
          "active_connections": 0,
          "bytes_in": 34942398609,
          "bytes_out": 304777113641,
          "request_errors": 4,
          "total_connections": 21095970
        },
        "task_id": "<string>",
        "updated_at": "2019-06-18T11:57:00+0000",
        "vip_address": "5.5.5.5",
        "vip_fqdn": "550e8400-e29b-41d4-a716-446655440000.lb.cloud.example.com",
        "vip_ip_family": "ipv4",
        "vip_port_id": "4177d1ef-f1c2-4e45-a531-3e05dfa6d848",
        "vrrp_ips": [
          {
            "ip_address": "127.0.0.1",
            "subnet_id": "00000000-0000-4000-8000-000000000000"
          }
        ]
      },
      "port_id": "ee2402d0-f0cd-4503-9b75-69be1d11c5f1",
      "project_id": 1337,
      "region": "Luxembourg 1",
      "region_id": 7,
      "router_id": "11005a33-c5ac-4c96-ab6f-8f2827cc7da6",
      "status": "ACTIVE",
      "tags": [
        {
          "key": "my-tag",
          "read_only": false,
          "value": "my-tag-value"
        }
      ],
      "task_id": "a4eb4b29-048e-42f6-a5e1-2c18bc001c45",
      "updated_at": "2019-06-13T13:58:12+0000"
    }
  ]
}

GET

cloud

floatingips

{project_id}

{region_id}

List floating IPs

curl --request GET \
  --url https://api.gcore.com/cloud/v1/floatingips/{project_id}/{region_id} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.gcore.com/cloud/v1/floatingips/{project_id}/{region_id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/cloud/v1/floatingips/{project_id}/{region_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/cloud/v1/floatingips/{project_id}/{region_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/cloud/v1/floatingips/{project_id}/{region_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/cloud/v1/floatingips/{project_id}/{region_id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v1/floatingips/{project_id}/{region_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "count": 1,
  "results": [
    {
      "created_at": "2019-06-13T13:58:12+0000",
      "creator_task_id": "d1e1500b-e2be-40aa-9a4b-cc493fa1af30",
      "fixed_ip_address": "192.168.10.15",
      "floating_ip_address": "172.24.4.34",
      "id": "c64e5db1-5f1f-43ec-a8d9-5090df85b82d",
      "instance": {
        "addresses": {},
        "created_at": "2023-11-29T10:56:49Z",
        "creator_task_id": "d1e1500b-e2be-40aa-9a4b-cc493fa1af30",
        "flavor": {
          "flavor_id": "g2-standard-32-64",
          "flavor_name": "g2-standard-32-64",
          "ram": 2048,
          "vcpus": 1
        },
        "id": "6c6aa80f-7836-4dc2-a2ae-125e248be476",
        "instance_description": "Instance description",
        "name": "my-instance-1",
        "project_id": 111,
        "region": "Luxembourg",
        "region_id": 4,
        "security_groups": [
          {
            "name": "some_name"
          }
        ],
        "ssh_key_name": "my-ssh-key",
        "tags": [
          {
            "key": "my-tag",
            "read_only": false,
            "value": "my-tag-value"
          }
        ],
        "task_id": null,
        "task_state": null,
        "volumes": [
          {
            "delete_on_termination": true,
            "id": "<string>"
          }
        ]
      },
      "loadbalancer": {
        "admin_state_up": true,
        "created_at": "2019-06-18T11:56:16+0000",
        "id": "e8ab1be4-1521-4266-be69-28dad4148a30",
        "name": "lbaas_test_lb",
        "project_id": 1337,
        "region": "Luxembourg 1",
        "region_id": 7,
        "tags_v2": [
          {
            "key": "my-tag",
            "read_only": false,
            "value": "my-tag-value"
          }
        ],
        "additional_vips": [
          {
            "ip_address": "127.0.0.1",
            "subnet_id": "00000000-0000-4000-8000-000000000000"
          }
        ],
        "creator_task_id": "9f3ec11e-bcd4-4fe6-924a-a4439a56ad22",
        "ddos_profile": {
          "fields": [
            {
              "base_field": 10,
              "default": null,
              "description": "ARK server ports. Valid port values are in range 1000-65535",
              "field_type": null,
              "field_value": [
                45046,
                45047
              ],
              "id": 11,
              "name": "ARK Ports",
              "required": true,
              "validation_schema": {
                "items": {
                  "maximum": 65535,
                  "minimum": 1000,
                  "type": "integer"
                },
                "minItems": 1,
                "type": "array"
              },
              "value": null
            }
          ],
          "id": 0,
          "options": {
            "active": true,
            "bgp": true
          },
          "profile_template": {
            "description": "test client profile template",
            "fields": [
              {
                "default": null,
                "description": "ARK server ports. Valid port values are in range 1000-65535",
                "field_type": null,
                "id": 11,
                "name": "ARK Ports",
                "required": true,
                "validation_schema": {
                  "items": {
                    "maximum": 65535,
                    "minimum": 1000,
                    "type": "integer"
                  },
                  "minItems": 1,
                  "type": "array"
                }
              }
            ],
            "id": 0,
            "name": "test_client_profile_template"
          },
          "profile_template_description": "ARK server ports. Valid port values are in range 1000-65535",
          "protocols": [
            {
              "additionalProp1": "string",
              "additionalProp2": "string",
              "additionalProp3": "string"
            }
          ],
          "site": "ED",
          "status": {
            "error_description": "",
            "status": "Updated"
          }
        },
        "flavor": {
          "flavor_id": "1d276f53-2834-4855-9859-aa922f073055",
          "flavor_name": "lb1-1-2",
          "ram": 2048,
          "vcpus": 1
        },
        "floating_ips": [
          {
            "created_at": "2019-06-13T13:58:12+0000",
            "creator_task_id": "d1e1500b-e2be-40aa-9a4b-cc493fa1af30",
            "fixed_ip_address": "192.168.10.15",
            "floating_ip_address": "172.24.4.34",
            "id": "c64e5db1-5f1f-43ec-a8d9-5090df85b82d",
            "port_id": "ee2402d0-f0cd-4503-9b75-69be1d11c5f1",
            "project_id": 1337,
            "region": "Luxembourg 1",
            "region_id": 7,
            "router_id": "11005a33-c5ac-4c96-ab6f-8f2827cc7da6",
            "status": "ACTIVE",
            "tags": [
              {
                "key": "my-tag",
                "read_only": false,
                "value": "my-tag-value"
              }
            ],
            "task_id": "a4eb4b29-048e-42f6-a5e1-2c18bc001c45",
            "updated_at": "2019-06-13T13:58:12+0000"
          }
        ],
        "listeners": [
          {
            "id": "43658ea9-54bd-4807-90b1-925921c9a0d1"
          }
        ],
        "logging": {
          "destination_region_id": 1,
          "enabled": true,
          "retention_policy": {
            "period": 45
          },
          "topic_name": "my-log-name"
        },
        "preferred_connectivity": "L2",
        "stats": {
          "active_connections": 0,
          "bytes_in": 34942398609,
          "bytes_out": 304777113641,
          "request_errors": 4,
          "total_connections": 21095970
        },
        "task_id": "<string>",
        "updated_at": "2019-06-18T11:57:00+0000",
        "vip_address": "5.5.5.5",
        "vip_fqdn": "550e8400-e29b-41d4-a716-446655440000.lb.cloud.example.com",
        "vip_ip_family": "ipv4",
        "vip_port_id": "4177d1ef-f1c2-4e45-a531-3e05dfa6d848",
        "vrrp_ips": [
          {
            "ip_address": "127.0.0.1",
            "subnet_id": "00000000-0000-4000-8000-000000000000"
          }
        ]
      },
      "port_id": "ee2402d0-f0cd-4503-9b75-69be1d11c5f1",
      "project_id": 1337,
      "region": "Luxembourg 1",
      "region_id": 7,
      "router_id": "11005a33-c5ac-4c96-ab6f-8f2827cc7da6",
      "status": "ACTIVE",
      "tags": [
        {
          "key": "my-tag",
          "read_only": false,
          "value": "my-tag-value"
        }
      ],
      "task_id": "a4eb4b29-048e-42f6-a5e1-2c18bc001c45",
      "updated_at": "2019-06-13T13:58:12+0000"
    }
  ]
}

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

Example:

1

region_id

integer

required

Region ID

Example:

1

Query Parameters

limit

integer

default:1000

Optional. Limit the number of returned items

Required range: x <= 1000

Example:

1000

offset

integer

default:0

Optional. Offset value is used to exclude the first set of records from the result

Required range: x >= 0

Example:

0

port_ids

string<uuid4>[]

Optional. Filter by the port ID the floating IP is attached to. Repeat the parameter to filter by multiple ports (?port_ids=id1&port_ids=id2).

Example:

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

status

enum<string>

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

Available options:

ACTIVE,

DOWN,

ERROR

Example:

"DOWN"

tag_key

string[]

Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character. Trailing or leading whitespaces will be stripped.

Required string length: 1 - 255

Pattern: ^[^\s=]+$

Example:

["key1", "key2"]

tag_key_value

string

Optional. Filter by tag key-value pairs.

Example:

{ "key": "value" }

Response

200 - application/json

count

integer

required

Number of objects

Required range: x >= 0

Example:

1

results

FloatingIPDetailedSerializer · object[]

required

Objects

Show child attributes

Delete file share tag Create floating IP

⌘I