List subnets

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.networks.subnets.list(
    project_id=1,
    region_id=1,
)
page = page.results[0]
print(page.cidr)

{
  "count": 1,
  "results": [
    {
      "cidr": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "enable_dhcp": true,
      "ip_version": 4,
      "name": "<string>",
      "network_id": "<string>",
      "project_id": 123,
      "region": "<string>",
      "region_id": 123,
      "tags": [
        {
          "key": "<string>",
          "read_only": true,
          "value": "<string>"
        }
      ],
      "updated_at": "2023-11-07T05:31:56Z",
      "available_ips": 250,
      "creator_task_id": "5cc890da-d031-4a23-ac31-625edfa22812",
      "dns_nameservers": [
        "8.8.8.8",
        "8.8.4.4"
      ],
      "gateway_ip": "192.168.13.1",
      "has_router": false,
      "host_routes": [],
      "id": "b39792c3-3160-4356-912e-ba396c95cdcf",
      "task_id": null,
      "total_ips": 253
    }
  ]
}

GET

cloud

subnets

{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.networks.subnets.list(
    project_id=1,
    region_id=1,
)
page = page.results[0]
print(page.cidr)

{
  "count": 1,
  "results": [
    {
      "cidr": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "enable_dhcp": true,
      "ip_version": 4,
      "name": "<string>",
      "network_id": "<string>",
      "project_id": 123,
      "region": "<string>",
      "region_id": 123,
      "tags": [
        {
          "key": "<string>",
          "read_only": true,
          "value": "<string>"
        }
      ],
      "updated_at": "2023-11-07T05:31:56Z",
      "available_ips": 250,
      "creator_task_id": "5cc890da-d031-4a23-ac31-625edfa22812",
      "dns_nameservers": [
        "8.8.8.8",
        "8.8.4.4"
      ],
      "gateway_ip": "192.168.13.1",
      "has_router": false,
      "host_routes": [],
      "id": "b39792c3-3160-4356-912e-ba396c95cdcf",
      "task_id": null,
      "total_ips": 253
    }
  ]
}

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

limit

integer

default:1000

Optional. Limit the number of returned items

Required range: x <= 1000

network_id

string<uuid4>

Only list subnets of this network

offset

integer

default:0

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

Required range: x >= 0

order_by

enum<string>

default:cidr.asc

Ordering subnets list result by name, created_at, updated_at, available_ips, total_ips, and cidr (default) fields of the subnet and directions (name.asc).

Available options:

available_ips.asc,

available_ips.desc,

cidr.asc,

cidr.desc,

created_at.asc,

created_at.desc,

name.asc,

name.desc,

total_ips.asc,

total_ips.desc,

updated_at.asc,

updated_at.desc

tag_key

string[]

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

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

Required string length: 1 - 255

tag_key_value

string

Optional. Filter by tag key-value pairs.

Response

200 - application/json

count

integer

required

Number of objects

Required range: x >= 0

results

SubnetSerializer · object[]

required

Objects

Show child attributes

results.cidr

string<ipvanynetwork>

required

CIDR

results.created_at

string<date-time>

required

Datetime when the subnet was created

results.enable_dhcp

boolean

required

True if DHCP should be enabled

results.ip_version

enum<integer>

required

IP version

Available options:

4,

6

results.name

string

required

Subnet name

results.network_id

string<uuid4>

required

Network ID

results.project_id

integer

required

Project ID

results.region

string

required

Region name

results.region_id

integer

required

Region ID

results.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.tags.key

string

required

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

results.tags.read_only

boolean

required

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

results.tags.value

string

required

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

results.updated_at

string<date-time>

required

Datetime when the subnet was last updated

results.available_ips

integer | null

Number of available ips in subnet

Example:

250

results.creator_task_id

string<uuid4> | null

Task that created this entity

Example:

"5cc890da-d031-4a23-ac31-625edfa22812"

results.dns_nameservers

string<ipvanyaddress>[] | null

List IP addresses of a DNS resolver reachable from the network

Example:

["8.8.8.8", "8.8.4.4"]

results.gateway_ip

string<ipvanyaddress> | null

Default GW IPv4 address, advertised in DHCP routes of this subnet. If null, no gateway is advertised by this subnet.

Example:

"192.168.13.1"

results.has_router

boolean

default:false

deprecated

Deprecated. Always returns false.

results.host_routes

RouteOutSerializer · object[] | null

List of custom static routes to advertise via DHCP.

Show child attributes

results.host_routes.destination

string<ipvanynetwork>

required

CIDR of destination IPv4 subnet.

results.host_routes.nexthop

string<ipvanyaddress>

required

IPv4 address to forward traffic to if it's destination IP matches 'destination' CIDR.

Example:

[]

results.id

string<uuid4> | null

Subnet id.

Example:

"b39792c3-3160-4356-912e-ba396c95cdcf"

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

results.total_ips

integer | null

Total number of ips in subnet

Example:

253

List instance ports by network Create subnet

⌘I

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

Authorizations

Path Parameters

Query Parameters

Response