Skip to main content
PATCH
Update 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

router_id
string<uuid4>
required

Router ID

Example:

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

Body

application/json
external_gateway_info
RouterExternalManualGwSerializer · object | null

New external gateway configuration. Only type 'manual' is accepted on update, so you must provide the network_id of the external network. Set to null to remove the external gateway.

Example:
name
string

New name of router

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

"my_renamed_router"

routes
RouteInSerializer · object[]

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: