List reserved fixed IPs

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
)
page = client.cloud.reserved_fixed_ips.list(
    project_id=0,
    region_id=0,
)
page = page.results[0]
print(page.network_id)

{
  "count": 1,
  "results": [
    {
      "allowed_address_pairs": [
        {
          "ip_address": "<string>",
          "mac_address": "<string>"
        }
      ],
      "attachments": [
        {
          "resource_id": "83ed4ea6-bcae-4100-9e4d-36e541ff919b",
          "resource_type": "instance"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "is_external": true,
      "is_vip": true,
      "name": "<string>",
      "network": {
        "created_at": "2023-11-07T05:31:56Z",
        "creator_task_id": "fd50fdd1-0482-4c9b-b847-fc9924665af6",
        "default": true,
        "external": true,
        "id": "<string>",
        "mtu": 123,
        "name": "<string>",
        "port_security_enabled": true,
        "project_id": 1337,
        "region": "<string>",
        "region_id": 123,
        "segmentation_id": 9,
        "shared": true,
        "subnets": [
          "<string>"
        ],
        "tags": [
          {
            "key": "<string>",
            "read_only": true,
            "value": "<string>"
          }
        ],
        "task_id": null,
        "type": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "network_id": "<string>",
      "port_id": "<string>",
      "region": "<string>",
      "region_id": 123,
      "reservation": {
        "resource_id": "83ed4ea6-bcae-4100-9e4d-36e541ff919b",
        "resource_type": "instance",
        "status": "attached"
      },
      "status": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "creator_task_id": "30378aea-9343-4ff6-be38-9756094e05da",
      "fixed_ip_address": "10.100.179.44",
      "fixed_ipv6_address": null,
      "project_id": 1337,
      "subnet_id": "747db04a-2aac-4fda-9492-d9b85a798c09",
      "subnet_v6_id": null,
      "task_id": null
    }
  ]
}

GET

cloud

reserved_fixed_ips

{project_id}

{region_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
)
page = client.cloud.reserved_fixed_ips.list(
    project_id=0,
    region_id=0,
)
page = page.results[0]
print(page.network_id)

{
  "count": 1,
  "results": [
    {
      "allowed_address_pairs": [
        {
          "ip_address": "<string>",
          "mac_address": "<string>"
        }
      ],
      "attachments": [
        {
          "resource_id": "83ed4ea6-bcae-4100-9e4d-36e541ff919b",
          "resource_type": "instance"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "is_external": true,
      "is_vip": true,
      "name": "<string>",
      "network": {
        "created_at": "2023-11-07T05:31:56Z",
        "creator_task_id": "fd50fdd1-0482-4c9b-b847-fc9924665af6",
        "default": true,
        "external": true,
        "id": "<string>",
        "mtu": 123,
        "name": "<string>",
        "port_security_enabled": true,
        "project_id": 1337,
        "region": "<string>",
        "region_id": 123,
        "segmentation_id": 9,
        "shared": true,
        "subnets": [
          "<string>"
        ],
        "tags": [
          {
            "key": "<string>",
            "read_only": true,
            "value": "<string>"
          }
        ],
        "task_id": null,
        "type": "<string>",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "network_id": "<string>",
      "port_id": "<string>",
      "region": "<string>",
      "region_id": 123,
      "reservation": {
        "resource_id": "83ed4ea6-bcae-4100-9e4d-36e541ff919b",
        "resource_type": "instance",
        "status": "attached"
      },
      "status": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "creator_task_id": "30378aea-9343-4ff6-be38-9756094e05da",
      "fixed_ip_address": "10.100.179.44",
      "fixed_ipv6_address": null,
      "project_id": 1337,
      "subnet_id": "747db04a-2aac-4fda-9492-d9b85a798c09",
      "subnet_v6_id": null,
      "task_id": null
    }
  ]
}

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

Query Parameters

available_only

boolean

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

device_id

string

Filter IPs by device ID it is attached to

external_only

boolean

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

internal_only

boolean

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

ip_address

string

An IPv4 address to filter results by. Regular expression allowed

limit

integer

Limit the number of returned IPs

offset

integer

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

order_by

string

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

vip_only

boolean

Set to true if the response should only list VIPs

Response

200 - application/json

List of reserved fixed IPs

count

integer

required

Number of objects

Required range: x >= 0

results

ReservedFixedIPSerializer · object[]

required

Objects

Show child attributes

results.allowed_address_pairs

AllowedAddressPairsSerializer · object[]

required

Group of subnet masks and/or IP addresses that share the current IP as VIP

Show child attributes

results.allowed_address_pairs.ip_address

required

Subnet mask or IP address of the port specified in allowed_address_pairs

results.allowed_address_pairs.mac_address

string | null

MAC address of the port specified in allowed_address_pairs

results.attachments

AttachmentSerializer · object[]

required

Reserved fixed IP attachment entities

Show child attributes

results.attachments.resource_id

string | null

Resource ID

Example:

"83ed4ea6-bcae-4100-9e4d-36e541ff919b"

results.attachments.resource_type

string | null

Resource type

Example:

"instance"

results.created_at

string<date-time>

required

Datetime when the reserved fixed IP was created

results.is_external

boolean

required

If reserved fixed IP belongs to a public network

results.is_vip

boolean

required

If reserved fixed IP is a VIP

results.name

string

required

Reserved fixed IP name

results.network

NetworkSerializer · object

required

Network details

Show child attributes

results.network.created_at

string<date-time>

required

Datetime when the network was created

results.network.creator_task_id

string<uuid4> | null

required

Task that created this entity

Example:

"fd50fdd1-0482-4c9b-b847-fc9924665af6"

results.network.default

boolean | null

required

True if network has is_default attribute

Example:

true

results.network.external

boolean

required

True if the network router:external attribute

results.network.id

string<uuid4>

required

Network ID

results.network.mtu

integer

required

MTU (maximum transmission unit). Default value is 1450

results.network.name

string

required

Network name

results.network.port_security_enabled

boolean

required

Indicates port_security_enabled status of all newly created in the network ports.

results.network.project_id

integer | null

required

Project ID

Example:

1337

results.network.region

string

required

Region name

results.network.region_id

integer

required

Region ID

results.network.segmentation_id

integer | null

required

Id of network segment

Example:

9

results.network.shared

boolean

required

True when the network is shared with your project by external owner

results.network.subnets

string<uuid4>[]

required

List of subnetworks

results.network.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.

Show child attributes

results.network.tags.key

string

required

Tag key. The maximum size for a key is 255 characters.

results.network.tags.read_only

boolean

required

If true, the tag is read-only and cannot be modified by the user

results.network.tags.value

string

required

Tag value. The maximum size for a value is 255 characters.

results.network.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:

null

results.network.type

string

required

Network type (vlan, vxlan)

results.network.updated_at

string<date-time>

required

Datetime when the network was last updated

results.network_id

string<uuid4>

required

ID of the network the port is attached to

results.port_id

string<uuid4>

required

ID of the port underlying the reserved fixed IP

results.region

string

required

Region name

results.region_id

integer

required

Region ID

results.reservation

ReservationSerializer · object

required

Reserved fixed IP status with resource type and ID it is attached to

Show child attributes

results.reservation.resource_id

string<uuid4> | null

ID of the instance or load balancer the IP is attached to

Example:

"83ed4ea6-bcae-4100-9e4d-36e541ff919b"

results.reservation.resource_type

string | null

Resource type of the resource the IP is attached to

Example:

"instance"

results.reservation.status

string | null

IP reservation status

Example:

"attached"

results.status

string

required

Underlying port status

results.updated_at

string<date-time>

required

Datetime when the reserved fixed IP was last updated

results.creator_task_id

string<uuid4> | null

Task that created this entity

Example:

"30378aea-9343-4ff6-be38-9756094e05da"

results.fixed_ip_address

string<ipv4> | null

IPv4 address of the reserved fixed IP

Example:

"10.100.179.44"

results.fixed_ipv6_address

string<ipv6> | null

IPv6 address of the reserved fixed IP

Example:

null

results.project_id

integer | null

Project ID

Example:

1337

results.subnet_id

string<uuid4> | null

ID of the subnet that owns the IP address

Example:

"747db04a-2aac-4fda-9492-d9b85a798c09"

results.subnet_v6_id

string<uuid4> | null

ID of the subnet that owns the IPv6 address

Example:

null

results.task_id

string<uuid4> | null

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:

null

Preview reserved fixed IP price Create reserved fixed IP

⌘I

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

List reserved fixed IPs

Authorizations

Path Parameters

Query Parameters

Response