Skip to main content
POST
Create router

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

Body

application/json
name
string
required

name of router

Pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$
Example:

"my_wonderful_router"

external_gateway_info
RouterExternalManualGwSerializer · object

External gateway configuration. Use type 'default' to let the platform automatically select the external network, or type 'manual' to specify a particular external network via network_id. If omitted, the router is created without an external gateway.

Example:
interfaces
CreateRouterInterfaceSubnetSerializer · object[] | null

List of interfaces to attach to router immediately after creation.

Example:
routes
RouteInSerializer · object[] | null

List of custom routes.

Example:

Response

200 - application/json

OK

tasks
string[]
required

List of task IDs representing asynchronous operations. Use these IDs to monitor operation progress:

  • GET /v1/tasks/{task_id} - Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.
Example: