router

List routers

Returns a list of all available routers associated with the current account.

It is also possible to filter routers with label URL parameters, e.g. ?label=env or ?label=env%3Dprod. URL parameter can be given multiple times to add more filters (e.g. ?label=env%3Dprod&label=v2), where only routers that match all labels are returned. Label keys are matched case insensitively.

get/1.3/router

Request

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

Query parameters

keystring required

Label key used to classify the resource

valuestring required

Value associated with the label key

A label filter. Can be specified multiple times to create an AND condition. Format: label=key:value

{
  "key": "env",
  "value": "production"
}

Response

A list of routers.

Example response

{
  "routers": {
    "router": [
      {
        "attached_network_gateways": [],
        "attached_networks": {
          "network": []
        },
        "labels": [],
        "name": "Example router",
        "static_routes": [],
        "type": "normal",
        "uuid": "04c0df35-2658-4b0c-8ac7-962090f4e92a"
      }
    ]
  }
}

Changes

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