Documentation | Routers › List Routers

Routers

routers

Methods

Attach Subnet To Router ->

Router

post/v1/routers/{project_id}/{region_id}/{router_id}/attach

Attach subnet to router

Create Router -> { tasks }

post/v1/routers/{project_id}/{region_id}

Create router

Delete Router -> { tasks }

delete/v1/routers/{project_id}/{region_id}/{router_id}

Delete router

Detach Subnet From Router ->

Router

post/v1/routers/{project_id}/{region_id}/{router_id}/detach

Detach subnet from router

List Routers -> OffsetPage<

Router

get/v1/routers/{project_id}/{region_id}

List routers

Parameters

project_id: number

region_id: number

limit: number

Optional

Limit the number of returned limit request entities.

offset: number

Optional

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

Response fields

count: number

(minimum: 0)

Number of objects

results: Array<

Router

Objects

Request example

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

200Example

{
  "count": 1,
  "results": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "interfaces": [
        {
          "ip_assignments": [
            {
              "ip_address": "192.168.123.20",
              "subnet_id": "351b0dd7-ca09-431c-be53-935db3785067"
            },
            {
              "ip_address": "192.168.120.16",
              "subnet_id": "0a641ef8-62dc-4146-91e5-6ab4b464df6d"
            }
          ],
          "network_id": "bc688791-f1b0-44eb-97d4-07697294b1e1",
          "port_id": "1f0ca628-a73b-42c0-bdac-7b10d023e097",
          "mac_address": "00:16:3e:f2:87:16"
        }
      ],
      "name": "name",
      "project_id": 1337,
      "region": "Luxembourg 1",
      "region_id": 7,
      "routes": [
        {
          "destination": "10.0.3.0/24",
          "nexthop": "10.0.0.13"
        }
      ],
      "status": "status",
      "task_id": "task_id",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "creator_task_id": "creator_task_id",
      "external_gateway_info": {
        "enable_snat": true,
        "external_fixed_ips": [
          {
            "ip_address": "172.24.4.6",
            "subnet_id": "b930d7f6-ceb7-40a0-8b81-a425dd994ccf"
          }
        ],
        "network_id": "ae34051f-aa6c-4c75-abf5-50dc9ac99ef3"
      }
    }
  ]
}

Get Specific Router ->

Router

get/v1/routers/{project_id}/{region_id}/{router_id}

Get specific router

Update Router ->

Router

patch/v1/routers/{project_id}/{region_id}/{router_id}

Update router

Domain types

Router = { id, created_at, interfaces, 10 more... }

SubnetID = { subnet_id }