Skip to main content

List security group rules

GET 

/security_groups/security_group/rules

Returns a list of all rules for a given security group

Scopes

  • security_groups
  • security_groups:read

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Query Parameters

    security_group[id] string

    The security group to return all load rules for.

    All 'security_group[]' params are mutually exclusive, only one can be provided.

    page integer

    Possible values: >= 1

    Default value: 1

    The page number to request. If not provided, the first page will be returned.

    per_page integer

    Possible values: >= 1

    Default value: 30

    The number of items to return per page. If not provided, the default value will be used.

Responses

Returns a list of all rules for a given security group

Schema

    pagination

    object

    required

    current_page integer

    The current page

    total_pages integernullable

    The total number of pages

    total integernullable

    The total number of items across all pages

    per_page integer

    The number of items per page

    large_set boolean

    Is this a large set and therefore the total number of records cannot be returned?

    security_group_rules

    object[]

    required

    The security group rules for this security group

  • Array [

  • id string
    direction SecurityGroupRuleDirectionEnum (string)

    Possible values: [inbound, outbound]

    protocol SecurityGroupRuleProtocolEnum (string)

    Possible values: [TCP, UDP, ICMP]

    action SecurityGroupRuleActionEnum (string)

    Possible values: [allow, deny]

    ports stringnullable
    targets string[]
    notes stringnullable
  • ]

Loading...