Skip to main content

Edit route

PUT /v1/routes/:routeID

Token scope required: routes:update

caution

Any properties not provided in the request will be reset to their default values. If only changing one firewall rule, be sure to include the others as well, otherwise they will be removed.

Request​

Path Parameters
  • routeID string required
    Example: route-X47KHSCOSQJP5IOKNNKRRGHVAI
Request Body required
  • name string required

    Possible values: <= 50 characters

  • description string

    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[]

    Incoming firewall rules. Will replace existing list of 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 string required

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

  • description string

    Possible values: <= 255 characters

  • allowedRoleID string nullable

    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 integer required

    Possible values: >= 1 and <= 65535

    First port number included in range.

  • to integer required

    Possible values: >= 1 and <= 65535

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

  • ]
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 string required

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

  • description string

    Possible values: <= 255 characters

  • allowedRoleID string nullable

    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 integer required

    Possible values: >= 1 and <= 65535

    First port number included in range.

  • to integer required

    Possible values: >= 1 and <= 65535

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

  • ]
  • metadata object
Loading...