Skip to main content
GET
/
cloud
/
v1
/
routers
/
{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.routers.list(
    project_id=0,
    region_id=0,
)
page = page.results[0]
print(page.id)
{
  "count": 1,
  "results": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "distributed": true,
      "id": "<string>",
      "interfaces": [
        {
          "ip_assignments": [
            {
              "ip_address": "<string>",
              "subnet_id": "<string>"
            }
          ],
          "network_id": "<string>",
          "port_id": "<string>",
          "mac_address": "00:16:3e:f2:87:16"
        }
      ],
      "name": "<string>",
      "project_id": 123,
      "region": "<string>",
      "region_id": 123,
      "routes": [
        {
          "destination": "<string>",
          "nexthop": "<string>"
        }
      ],
      "status": "<string>",
      "task_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "creator_task_id": "<string>",
      "external_gateway_info": {
        "enable_snat": true,
        "external_fixed_ips": [
          {
            "ip_address": "<string>",
            "subnet_id": "<string>"
          }
        ],
        "network_id": "<string>"
      }
    }
  ]
}

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

Limit the number of returned limit request entities.

​
offset
integer

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

Response

200 - application/json

list of routers.

​
count
integer
required

Number of objects

Required range: x >= 0
Example:

1

​
results
RouterSerializer · object[]
required

Objects