Documentation | Networks › List Networks With Subnets Details

Networks

networks

Methods

Create Network -> { tasks }

post/v1/networks/{project_id}/{region_id}

Create network

Delete Network -> { tasks }

delete/v1/networks/{project_id}/{region_id}/{network_id}

Delete network

List Networks -> OffsetPage<

Network

get/v1/networks/{project_id}/{region_id}

List networks

Parameters

project_id: number

region_id: number

limit: number

Optional

Limit the number of returned limit request entities.

metadata_k: string

Optional

Filter by metadata keys. Must be a valid JSON string. curl -G --data-urlencode "metadata_k=["value", "sense"]" --url "http://localhost:1111/v1/networks/1/1"

metadata_kv: string

Optional

Filter by metadata key-value pairs. Must be a valid JSON string. curl -G --data-urlencode "metadata_kv={"key": "value"}" --url "http://localhost:1111/v1/networks/1/1"

offset: number

Optional

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

order_by: string

Optional

Order networks by fields and directions (name.asc). Default is created_at.asc.

Response fields

count: number

(minimum: 0)

Number of objects

results: Array<

Network

Objects

Request example

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

200Example

{
  "count": 1,
  "results": [
    {
      "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"
    }
  ]
}

List Networks With Subnets Details -> OffsetPage<{ id, created_at, external, 15 more... }>

get/v1/availablenetworks/{project_id}/{region_id}

Retrieve the list of directly-attachable networks with subnet details. Returned entities may or may not be owned by the project

Parameters

project_id: number

region_id: number

limit: number

Optional

Limit the number of returned limit request entities.

metadata_k: string

Optional

Filter by metadata keys. Must be a valid JSON string. curl -G --data-urlencode "metadata_k=["value", "sense"]" --url "http://localhost:1111/v1/availablenetworks/1/1"

metadata_kv: string

Optional

Filter by metadata key-value pairs. Must be a valid JSON string. curl -G --data-urlencode "metadata_kv={"key": "value"}" --url "http://localhost:1111/v1/availablenetworks/1/1"

network_id: string

Optional

Can be used to only show subnets of the specific network

network_type: string

Optional

Filter network by network type (vlan or vxlan)

offset: number

Optional

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

order_by: string

Optional

Order networks by transmitted fields and directions (name.asc).

shared: boolean

Optional

Can be used to only show networks with shared state"

Response fields

count: number

(minimum: 0)

Number of objects

results: Array<{ id, created_at, external, 15 more... }>

Objects

Request example

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

200Example

{
  "count": 1,
  "results": [
    {
      "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,
      "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,
      "subnets": [
        {
          "cidr": "10.0.0.0/16",
          "created_at": "2019-07-18T12:07:00+0000",
          "enable_dhcp": true,
          "ip_version": 4,
          "name": "test 2",
          "network_id": "162091db-33cc-45d5-a375-964509af4813",
          "project_id": 1,
          "region": "Luxembourg 1",
          "region_id": 1,
          "updated_at": "2019-07-22T10:55:45+0000",
          "id": "80bfcb8e-1709-4bb2-99d4-3fa1332571de",
          "available_ips": 65432,
          "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": "key1",
              "read_only": false,
              "value": "value1"
            }
          ],
          "task_id": "task_id",
          "total_ips": 65536
        },
        {
          "cidr": "192.168.192.0/24",
          "created_at": "2019-07-22T15:15:05+0000",
          "enable_dhcp": true,
          "ip_version": 4,
          "name": "string",
          "network_id": "162091db-33cc-45d5-a375-964509af4813",
          "project_id": 1,
          "region": "Luxembourg 1",
          "region_id": 1,
          "updated_at": "2019-07-22T15:15:05+0000",
          "id": "94196a6a-c2ce-4f0d-8dc7-d9e0e722aea0",
          "available_ips": 232,
          "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": "key1",
              "read_only": false,
              "value": "value1"
            }
          ],
          "task_id": "task_id",
          "total_ips": 256
        }
      ],
      "task_id": "task_id"
    }
  ]
}

List Of Instance Ports By Network ID -> Array<{ id, instance_id, instance_name }>

get/v1/networks/{project_id}/{region_id}/{network_id}/ports

List of instance ports by network_id

Get Network ->

Network

get/v1/networks/{project_id}/{region_id}/{network_id}

Get network

Change Network Name ->

Network

patch/v1/networks/{project_id}/{region_id}/{network_id}

Change network name

Domain types

Network = { id, created_at, external, 15 more... }

Networks

Metadata

networks.metadata

Methods

Create Or Update Network Metadata ->

post/v1/networks/{project_id}/{region_id}/{network_id}/metadata

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

List Network Metadata -> { count, results }

get/v1/networks/{project_id}/{region_id}/{network_id}/metadata

Lists all metadata for a network

Replace Network Metadata ->

put/v1/networks/{project_id}/{region_id}/{network_id}/metadata

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

Networks

Metadata Item

networks.metadata_item

Methods

Delete Network Metadata Item By Key ->

delete/v1/networks/{project_id}/{region_id}/{network_id}/metadata_item

Delete network metadata item by key

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

get/v1/networks/{project_id}/{region_id}/{network_id}/metadata_item

Get network metadata item by key