Skip to main content

Create route

POST 

/v1/routes

Create a new route.

Token scope required: routes:create

Request

Body

required

    name stringrequired

    Name of the new route

    Possible values: non-empty and <= 50 characters

    Example: My new route
    description string

    Optional description

    Possible values: <= 255 characters

    routerHostID string

    routableCIDRs

    object

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

    property name*

    object

    install boolean

    firewallRules

    object[]

    Route firewall rules

  • Array [

  • localCIDR ipv4/cidr

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

    protocol stringrequired

    Possible values: [ANY, TCP, UDP, ICMP]

    description string

    Possible values: <= 255 characters

    allowedRoleID stringnullable

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

    allowedTags key:value[]

    Tags to allow with this firewall rule. An empty list allows all tags. key is max 20 characters, value is max 50 characters, no whitespace around either allowed

    portRange

    object

    nullable

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

    from integerrequired

    First port number included in range.

    Possible values: >= 1 and <= 65535

    to integerrequired

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

    Possible values: >= 1 and <= 65535

  • ]

Responses

Successful operation

Schema

    data

    object

    id string
    name string
    description string
    createdAt date-time
    modifiedAt date-time
    routerHostID string

    routableCIDRs

    object

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

    property name*

    object

    install boolean

    firewallRules

    object[]

  • Array [

  • localCIDR ipv4/cidr

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

    protocol stringrequired

    Possible values: [ANY, TCP, UDP, ICMP]

    description string

    Possible values: <= 255 characters

    allowedRoleID stringnullable

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

    allowedTags key:value[]

    Tags to allow with this firewall rule. An empty list allows all tags. key is max 20 characters, value is max 50 characters, no whitespace around either allowed

    portRange

    object

    nullable

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

    from integerrequired

    First port number included in range.

    Possible values: >= 1 and <= 65535

    to integerrequired

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

    Possible values: >= 1 and <= 65535

  • ]

  • metadata object
Loading...