Skip to main content
POST
/
cloud
/
v1
/
routers
/
{project_id}
/
{region_id}
/
{router_id}
/
attach
Python
from gcore import Gcore

client = Gcore(
    api_key="My API Key",
)
router = client.cloud.networks.routers.attach_subnet(
    router_id="ccd5b925-e35c-4611-a511-67ab503104c8",
    project_id=1,
    region_id=1,
    subnet_id="subnet_id",
)
print(router.id)
{
  "created_at": "2023-11-07T05:31:56Z",
  "creator_task_id": "<string>",
  "distributed": true,
  "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"
  },
  "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"
        }
      ],
      "mac_address": "00:16:3e:f2:87:16",
      "network_id": "bc688791-f1b0-44eb-97d4-07697294b1e1",
      "port_id": "1f0ca628-a73b-42c0-bdac-7b10d023e097"
    }
  ],
  "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"
}

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

Examples:

1

​
region_id
integer
required

Region ID

Examples:

1

​
router_id
string<uuid4>
required

Router ID

Examples:

"ccd5b925-e35c-4611-a511-67ab503104c8"

Body

application/json
​
subnet_id
string<uuid4>
required

Subnet ID on which router interface will be created

​
ip_address
string<ipvanyaddress>

IP address to assign for router's interface, if not specified, address will be selected automatically

Response

200 - application/json

OK

​
created_at
string<date-time>
required

Datetime when the router was created

​
distributed
boolean
required

Whether the router is distributed or centralized.

Examples:

true

false

​
id
string<uuid4>
required

Router ID

​
interfaces
PortSerializer · object[]
required

List of router interfaces.

​
name
string
required

Router name

​
project_id
integer
required

Project ID

Examples:

1337

​
region
string
required

Region name

Examples:

"Luxembourg 1"

​
region_id
integer
required

Region ID

Examples:

7

​
routes
RouteOutSerializer · object[]
required

List of custom routes.

​
status
string
required

Status of the router.

​
task_id
string<uuid4> | null
required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

​
updated_at
string<date-time>
required

Datetime when the router was last updated

​
creator_task_id
string<uuid4> | null

Task that created this entity

​
external_gateway_info
object | null

State of this router's external gateway.

⌘I