Skip to main content

Edit role

PUT /v1/roles/:roleID

Token scope required: roles: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
  • roleID string required
    Example: role-LO4SPDSWTZNJC676WFCZKUB3ZQ
Request Body required
  • description string

    Possible values: <= 255 characters

  • firewallRules object[]

    Incoming firewall rules. Will replace existing list of rules.

  • Array [
  • 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
  • firewallRules object[]
  • Array [
  • 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.

  • ]
  • createdAt date-time
  • modifiedAt date-time
  • metadata object
Loading...