router

Modify router

Modifies attributes of a specific router. Modifications to static routes of type service will be ignored.

patch/1.3/router/{router}

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/router/{router}
  • Auth: HTTP bearer

Path parameters

routerstring uuid required

Universally unique identifier

Example:0414e0d7-4436-4037-9dd8-6eaf47dce599

The router identifier.

Request body

Example request

{
  "router": {
    "name": "Example router",
    "labels": [
      {
        "key": "service",
        "value": "postgres cluster connectivity"
      }
    ],
    "static_routes": []
  }
}

Response

Router modified successfully.

Example response

{
  "router": {
    "attached_network_gateways": [],
    "attached_networks": {
      "network": [
        {
          "uuid": "03804f7f-828a-4610-867f-9d62cf9fc14f"
        }
      ]
    },
    "name": "Example router",
    "static_routes": [
      {
        "name": "static-route-0",
        "nexthop": "192.168.1.1",
        "route": "0.0.0.0/0",
        "type": "user"
      }
    ],
    "labels": [],
    "type": "normal",
    "uuid": "0414e0d7-4436-4037-9dd8-6eaf47dce599"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.