Documentation | Subnets › List Subnets

Subnets

subnets

Methods

Create Subnet -> { tasks }

post/v1/subnets/{project_id}/{region_id}

Create subnet

Delete Subnet ->

delete/v1/subnets/{project_id}/{region_id}/{subnet_id}

Delete subnet

List Subnets -> OffsetPage<

Subnet

get/v1/subnets/{project_id}/{region_id}

List subnets

Parameters

project_id: number

Project ID

region_id: number

Region ID

limit: number

Optional

(exclusiveMinimum: 0, maximum: 1000)

Optional. Limit the number of returned items

metadata_k: Array<string>

Optional

Optional. Filter by metadata keys. ?metadata_k=key1&metadata_k=key2

metadata_kv: string

Optional

Optional. Filter by metadata key-value pairs. curl -G --data-urlencode "metadata_kv={"key": "value"}" --url "https://example.com/cloud/v1/subnets/1/1"

network_id: string

Optional

(format: uuid4)

Optional. Only list subnets of this network

offset: number

Optional

(minimum: 0)

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

order_by: Array<

Optional

Optional. 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_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"

Response fields

count: number

(minimum: 0)

Number of objects

results: Array<

Subnet

Objects

Request example

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

200Example

{
  "count": 1,
  "results": [
    {
      "cidr": "192.168.13.0/24",
      "created_at": "2019-06-13T13:58:12+0000",
      "enable_dhcp": true,
      "ip_version": 4,
      "name": "subnet_3",
      "network_id": "b30d0de7-bca2-4c83-9c57-9e645bd2cc92",
      "project_id": 1337,
      "region": "Luxembourg 1",
      "region_id": 7,
      "updated_at": "2019-06-13T13:58:12+0000",
      "id": "b39792c3-3160-4356-912e-ba396c95cdcf",
      "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": [
        {
          "destination": "10.0.3.0/24",
          "nexthop": "10.0.0.13"
        }
      ],
      "metadata": [
        {
          "key": "hosting",
          "read_only": false,
          "value": "some value"
        },
        {
          "key": "euro-net",
          "read_only": false,
          "value": "net1"
        }
      ],
      "task_id": "task_id",
      "total_ips": 253
    }
  ]
}

Get Subnet ->

Subnet

get/v1/subnets/{project_id}/{region_id}/{subnet_id}

Get subnet

Change Subnet Properties ->

Subnet

patch/v1/subnets/{project_id}/{region_id}/{subnet_id}

Change subnet properties

Domain types

Subnet = { cidr, created_at, enable_dhcp, 17 more... }

Subnets

Metadata

subnets.metadata

Methods

Create Or Update Subnet Metadata ->

post/v1/subnets/{project_id}/{region_id}/{subnet_id}/metadata

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

List Subnet Metadata -> { count, results }

get/v1/subnets/{project_id}/{region_id}/{subnet_id}/metadata

Lists all metadata for a subnet

Replace Subnet Metadata ->

put/v1/subnets/{project_id}/{region_id}/{subnet_id}/metadata

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

Domain types

UpdateTags = Record<string, string>

Used to process user input, accepting all fields except read-only or internal keys (issued by a regular user). Users can specify key-value tags here.

Subnets

Metadata Item

subnets.metadata_item

Methods

Delete Subnet Metadata Item By Key ->

delete/v1/subnets/{project_id}/{region_id}/{subnet_id}/metadata_item

Delete subnet metadata item by key

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

get/v1/subnets/{project_id}/{region_id}/{subnet_id}/metadata_item

Get subnet metadata item by key