Skip to content

Get route

GET
/v1/routes/{routeID}

Fetch information about a particular route.

Token scope required: routes:read

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
routeID
required
string
Example
route-X47KHSCOSQJP5IOKNNKRRGHVAI

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful operation

object
data
required
object
id
required
string
name
required
string
description
required
string
createdAt
required
string format: date-time
modifiedAt
required
string format: date-time
routerHostID
required
string | null
routableCIDRs
required

Keys of object should be IPv4 CIDR ranges, values are an object with an ‘install’ boolean.

object
key
additional properties
object
install
required
boolean
firewallRules
required
Array
object
localCIDR

CIDR range within the routableCIDRs this rule will apply to. Use “0.0.0.0/0” for all IP addresses.

string format: ipv4/cidr
protocol
required

One of ANY, TCP, UDP or ICMP when creating or updating a rule. Responses may include protocols added later, so clients should accept values not listed here.

string
description
string
<= 255 characters
allowedRoleID

Role ID to allow with this firewall rule. If not specified, all roles are included.

string | null
allowedTags

Tags to allow with this firewall rule. An empty list allows all tags; responses return null instead of an empty list. key is max 20 characters, value is max 50 characters, no whitespace around either allowed

array | null
portRange

Range of ports for this firewall rule. If not provided or set to null, all ports are allowed.

object
from
required

First port number included in range.

integer
>= 1 <= 65535
to
required

Last port number included in range. Must be greater than from port.

integer
>= 1 <= 65535
Example
{
  "data": {
    "id": "route-X47KHSCOSQJP5IOKNNKRRGHVAI",
    "name": "My new route",
    "description": "",
    "routerHostID": "host-24NVITKMNU3CYCEDNFWKAOBX7I",
    "routableCIDRs": {
      "192.168.14.0/26": {
        "install": true
      }
    },
    "createdAt": "2024-03-15T13:59:09Z",
    "modifiedAt": "2024-03-15T13:59:09Z",
    "firewallRules": [
      {
        "protocol": "TCP",
        "localCIDR": "192.168.14.56/32",
        "description": "allow SSH access",
        "allowedRoleID": "role-G3TWUQ4FASQEF44MGMTSRBTYKM",
        "allowedTags": null,
        "portRange": {
          "from": 22,
          "to": 22
        }
      }
    ]
  }
}

401

Section titled “401 ”

The API key is missing, invalid or expired.

object
errors
required
Array<object>
object
code
required

A static name for the error type

string
message
required

A short human readable description of the error

string
path

Describes the variable missing or malformed

string
param

The query parameter the error relates to, such as filter.targetType

string
extra

Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.

object
limit

The maximum number of resources allowed

integer
limitName

The kind of resource the limit applies to

string
key
additional properties
any
Example
{
  "errors": [
    {
      "code": "ERR_UNAUTHORIZED",
      "message": "unauthorized"
    }
  ]
}

403

Section titled “403 ”

The API key lacks a required scope.

object
errors
required
Array<object>
object
code
required

A static name for the error type

string
message
required

A short human readable description of the error

string
path

Describes the variable missing or malformed

string
param

The query parameter the error relates to, such as filter.targetType

string
extra

Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.

object
limit

The maximum number of resources allowed

integer
limitName

The kind of resource the limit applies to

string
key
additional properties
any
Examples

The API key lacks a required scope.

{
  "errors": [
    {
      "code": "ERR_FORBIDDEN",
      "message": "api key must support the following scopes: hosts:read"
    }
  ]
}

404

Section titled “404 ”

Route not found

object
errors
required
Array<object>
object
code
required

A static name for the error type

string
message
required

A short human readable description of the error

string
path

Describes the variable missing or malformed

string
param

The query parameter the error relates to, such as filter.targetType

string
extra

Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.

object
limit

The maximum number of resources allowed

integer
limitName

The kind of resource the limit applies to

string
key
additional properties
any
Example
{
  "errors": [
    {
      "code": "ERR_NOT_FOUND",
      "message": "resource not found"
    }
  ]
}

429

Section titled “429 ”

The organization has exceeded its API request rate limit. Retry the request after a short delay.

object
errors
required
Array<object>
object
code
required

A static name for the error type

string
message
required

A short human readable description of the error

string
path

Describes the variable missing or malformed

string
param

The query parameter the error relates to, such as filter.targetType

string
extra

Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.

object
limit

The maximum number of resources allowed

integer
limitName

The kind of resource the limit applies to

string
key
additional properties
any
Example
{
  "errors": [
    {
      "code": "ERR_TOO_MANY_REQUESTS",
      "message": "too many requests"
    }
  ]
}