Router

Download schema

Router management

List routers

GET

https://api.upcloud.com

/1.3/router

Retrieves a list of routers.

List routers › query Parameters

routerLabel

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

A key/value pair to label and categorize resources

List routers › Responses

A list of routers.

A list of routers

routers

object · required

Create a new router

POST

https://api.upcloud.com

/1.3/router

Creates a new router.

Create a new router › Request Body

Router describes a virtual router that can route between SDN networks

routerDetails

name

string · required

object

Networks attached to the router.

routerLabels

routerRouteNexthop[]

Static routes that will be added to the routing table of the SDN router

type

routerType · enum

Type of the router.

Enum values:

normal

service

uuid

routerUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Universally unique identifier

Create a new router › Responses

Router created successfully.

Schema for a single router

router

routerDetails · required

Router describes a virtual router that can route between SDN networks

POST/1.3/router

curl https://api.upcloud.com/1.3/router \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "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": "normal",
  "uuid": "0414e0d7-4436-4037-9dd8-6eaf47dce599"
}'

Example Request Body

{
  "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": "normal",
  "uuid": "0414e0d7-4436-4037-9dd8-6eaf47dce599"
}

json

Example Responses

{
  "router": {
    "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": "normal",
    "uuid": "0414e0d7-4436-4037-9dd8-6eaf47dce599"
  }
}

json

application/json

Get router details

GET

https://api.upcloud.com

/1.3/router/{router}

Retrieves details of a specific router.

Get router details › path Parameters

router

routerUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The router identifier.

Universally unique identifier

Get router details › Responses

Router details.

Schema for a single router

router

routerDetails · required

Router describes a virtual router that can route between SDN networks

Delete a router

DELETE

https://api.upcloud.com

/1.3/router/{router}

Deletes a specific router.

Delete a router › path Parameters

router

routerUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The router identifier.

Universally unique identifier

Delete a router › Responses

Router deleted successfully.

No data returned

Modify a router

PATCH

https://api.upcloud.com

/1.3/router/{router}

Modifies attributes of a specific router.

Modify a router › path Parameters

router

routerUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The router identifier.

Universally unique identifier

Modify a router › Request Body

Router describes a virtual router that can route between SDN networks

routerDetails

name

string · required

object

Networks attached to the router.

routerLabels

routerRouteNexthop[]

Static routes that will be added to the routing table of the SDN router

type

routerType · enum

Type of the router.

Enum values:

normal

service

uuid

routerUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Universally unique identifier

Modify a router › Responses

Router modified successfully.

Schema for a single router

router

routerDetails · required

Router describes a virtual router that can route between SDN networks

PATCH/1.3/router/{router}

curl https://api.upcloud.com/1.3/router/:router \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "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": "normal",
  "uuid": "0414e0d7-4436-4037-9dd8-6eaf47dce599"
}'

Example Request Body

{
  "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": "normal",
  "uuid": "0414e0d7-4436-4037-9dd8-6eaf47dce599"
}

json

Example Responses

{
  "router": {
    "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": "normal",
    "uuid": "0414e0d7-4436-4037-9dd8-6eaf47dce599"
  }
}

json

application/json

IP Address Firewall Ruleset

List routers

GET

https://api.upcloud.com

/1.3/router

Retrieves a list of routers.

List routers › query Parameters

routerLabel

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

A key/value pair to label and categorize resources

List routers › Responses

A list of routers.

A list of routers

routers

object · required

Create a new router

POST

https://api.upcloud.com

/1.3/router

Creates a new router.

Create a new router › Request Body

Router describes a virtual router that can route between SDN networks

routerDetails

name

string · required

object

Networks attached to the router.

routerLabels

routerRouteNexthop[]

Static routes that will be added to the routing table of the SDN router

type

routerType · enum

Type of the router.

Enum values:

normal

service

uuid

routerUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Universally unique identifier

Create a new router › Responses

Router created successfully.

Schema for a single router

router

routerDetails · required

Router describes a virtual router that can route between SDN networks

Get router details

GET

https://api.upcloud.com

/1.3/router/{router}

Retrieves details of a specific router.

Get router details › path Parameters

router

routerUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The router identifier.

Universally unique identifier

Get router details › Responses

Router details.

Schema for a single router

router

routerDetails · required

Router describes a virtual router that can route between SDN networks

Delete a router

DELETE

https://api.upcloud.com

/1.3/router/{router}

Deletes a specific router.

Delete a router › path Parameters

router

routerUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The router identifier.

Universally unique identifier

Delete a router › Responses

Router deleted successfully.

No data returned

Modify a router

PATCH

https://api.upcloud.com

/1.3/router/{router}

Modifies attributes of a specific router.

Modify a router › path Parameters

router

routerUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f… · required

The router identifier.

Universally unique identifier

Modify a router › Request Body

Router describes a virtual router that can route between SDN networks

routerDetails

name

string · required

object

Networks attached to the router.

routerLabels

routerRouteNexthop[]

Static routes that will be added to the routing table of the SDN router

type

routerType · enum

Type of the router.

Enum values:

normal

service

uuid

routerUuid · uuid · pattern: ^[0-9a-f]{8}-[0-9a-f…

Universally unique identifier

Modify a router › Responses

Router modified successfully.

Schema for a single router

router

routerDetails · required

Router describes a virtual router that can route between SDN networks