Documentation | Subnets › Metadata › List Subnet Metadata

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

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

Parameters

project_id: number

Project ID

region_id: number

Region ID

subnet_id: string

(format: uuid4)

Subnet ID

Response fields

count: number

(minimum: 0)

Number of objects

results: Array<{ key, read_only, value }>

Objects

Request example

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

200Example

{
  "count": 1,
  "results": [
    {
      "key": "cost-center",
      "read_only": false,
      "value": "Luxembourg"
    }
  ]
}

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