Documentation | Reserved IPs › List Reserved Fixed IPs

Reserved IPs

reserved_ips

Methods

Create Reserved Fixed IP -> { tasks }

post/v1/reserved_fixed_ips/{project_id}/{region_id}

Create reserved fixed IP

Delete Reserved Fixed IP -> { tasks }

delete/v1/reserved_fixed_ips/{project_id}/{region_id}/{port_id}

Delete reserved fixed ip

List Reserved Fixed IPs -> OffsetPage<

ReservedFixedIP

get/v1/reserved_fixed_ips/{project_id}/{region_id}

List reserved fixed IPs

Parameters

project_id: number

region_id: number

available_only: boolean

Optional

Set to true if the response should only list IP addresses that are not attached to any instance

device_id: string

Optional

Filter IPs by device ID it is attached to

external_only: boolean

Optional

Set to true if the response should only list public IP addresses

internal_only: boolean

Optional

Set to true if the response should only list private IP addresses

ip_address: string

Optional

An IPv4 address to filter results by. Regular expression allowed

limit: number

Optional

Limit the number of returned IPs

offset: number

Optional

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

order_by: string

Optional

Ordering reserved fixed IP list result by name, status, updated_at, created_at or fixed_ip_address fields of the reserved fixed IP and directions (status.asc), default is "fixed_ip_address.asc"

vip_only: boolean

Optional

Set to true if the response should only list VIPs

Response fields

count: number

(minimum: 0)

Number of objects

results: Array<

ReservedFixedIP

Objects

Request example

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

200Example

{
  "count": 1,
  "results": [
    {
      "allowed_address_pairs": [
        {
          "ip_address": "192.168.123.20",
          "mac_address": "00:16:3e:f2:87:16"
        },
        {
          "ip_address": "192.168.0.2",
          "mac_address": "00:16:3e:f2:87:89"
        }
      ],
      "attachments": [
        {
          "resource_id": "e3c6ee77-48cb-416b-b204-11b492cc776e3",
          "resource_type": "instance"
        },
        {
          "resource_id": "e73a4dbd-da04-4b6e-8ef9-07e8742001b7",
          "resource_type": "ai_cluster"
        }
      ],
      "created_at": "2019-06-18T11:56:16+0000",
      "is_external": false,
      "is_vip": false,
      "name": "Reserved fixed ip 10.100.179.44",
      "network": {
        "id": "eed97610-708d-43a5-a9a5-caebd2b7b4ee",
        "created_at": "2019-06-18T11:56:16+0000",
        "external": true,
        "name": "public",
        "port_security_enabled": true,
        "region": "Luxembourg 1",
        "region_id": 7,
        "shared": false,
        "subnets": [
          "f00624ab-41bc-4d54-a723-1673ce32d997",
          "41e0f698-4d39-483b-b77a-18eb070e4c09"
        ],
        "type": "vlan",
        "updated_at": "2019-06-18T11:57:00+0000",
        "creator_task_id": "fd50fdd1-0482-4c9b-b847-fc9924665af6",
        "default": true,
        "metadata": [
          {
            "key": "key1",
            "read_only": false,
            "value": "value1"
          }
        ],
        "mtu": 1500,
        "project_id": 1337,
        "segmentation_id": 9,
        "task_id": "task_id"
      },
      "network_id": "eed97610-708d-43a5-a9a5-caebd2b7b4ee",
      "port_id": "817c8a3d-bb67-4b88-a0d1-aec980318ff1",
      "region": "Luxembourg 1",
      "region_id": 7,
      "reservation": {
        "resource_id": "83ed4ea6-bcae-4100-9e4d-36e541ff919b",
        "resource_type": "instance",
        "status": "attached"
      },
      "status": "DOWN",
      "updated_at": "2019-06-18T11:57:00+0000",
      "creator_task_id": "30378aea-9343-4ff6-be38-9756094e05da",
      "fixed_ip_address": "10.100.179.44",
      "fixed_ipv6_address": "fixed_ipv6_address",
      "project_id": 1337,
      "subnet_id": "747db04a-2aac-4fda-9492-d9b85a798c09",
      "subnet_v6_id": "subnet_v6_id",
      "task_id": "task_id"
    }
  ]
}