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=1,
    region_id=1,
)
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": "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": "<string>",
      "project_id": 1337,
      "region": "Luxembourg 1",
      "region_id": 7,
      "routes": [
        {
          "destination": "10.0.3.0/24",
          "nexthop": "10.0.0.13"
        }
      ],
      "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": "172.24.4.6",
            "subnet_id": "b930d7f6-ceb7-40a0-8b81-a425dd994ccf"
          }
        ],
        "network_id": "ae34051f-aa6c-4c75-abf5-50dc9ac99ef3"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://gcore-doc-1046.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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

Example:

1

​
region_id
integer
required

Region ID

Example:

1

Query Parameters

​
limit
integer
default:1000

Limit of items on a single page

Required range: x <= 1000
Example:

10

​
name
string

Optional. Filter routers by name

Example:

"router-name"

​
offset
integer
default:0

Offset in results list

Required range: x >= 0
Example:

0

Response

200 - application/json

OK

​
count
integer
required

Number of objects

Required range: x >= 0
Example:

1

​
results
RouterSerializer · object[]
required

Objects