Get security group rule

GET 
/security_groups/rules/security_group_rule

Returns details about a security group rule

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_rule[id] string

The security group rule to return the details for.

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

Responses

200

Returns details about a security group rule

application/json

Schema

Schema

security_group_rule

object

required

id string

security_group

object

id string

name 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

Example (from schema)

{
  "security_group_rule": {
    "id": "string",
    "security_group": {
      "id": "string",
      "name": "string"
    },
    "direction": "inbound",
    "protocol": "TCP",
    "action": "allow",
    "ports": "string",
    "targets": [
      "string"
    ],
    "notes": "string"
  }
}

400

No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer

application/json

Schema

Schema

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string
detail object

Example (from schema)

{
  "code": "missing_api_token",
  "description": "string",
  "detail": {}
}

403

403 error response

application/json

Schema

Schema

oneOf

UnauthorizedNetworkForAPITokenSchema

Network is not allowed to access the API with this API token

code UnauthorizedNetworkForAPITokenEnum (string)

Possible values: [unauthorized_network_for_api_token]

description string

detail

object

ip_address string

The IP address the request was received from

InvalidAPITokenSchema

The API token provided was not valid (it may not exist or have expired)

code InvalidAPITokenEnum (string)

Possible values: [invalid_api_token]

description string

detail

object

details stringnullable

InvalidCapabilitiesTokenSchema

The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)

code InvalidCapabilitiesTokenEnum (string)

Possible values: [invalid_capabilities_token]

description string

detail object

ScopeNotGrantedErrorSchema

The scope required for this endpoint has not been granted to the authenticating identity

code ScopeNotGrantedErrorEnum (string)

Possible values: [scope_not_granted]

description string

detail

ScopeNotGrantedError

scopes string[]

PermissionDeniedSchema

The authenticated identity is not permitted to perform this action

code PermissionDeniedEnum (string)

Possible values: [permission_denied]

description string

detail

object

details stringnullable

Additional information regarding the reason why permission was denied

Example (from schema)

{}

404

No security group rule was found matching any of the criteria provided in the arguments

application/json

Schema

Schema

code SecurityGroupRuleNotFoundEnum (string)

Possible values: [security_group_rule_not_found]

description string
detail object

Example (from schema)

{
  "code": "security_group_rule_not_found",
  "description": "string",
  "detail": {}
}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

503

The service is currently unavailable, please try again later

application/json

Schema

Schema

code ServiceUnavailableEnum (string)

Possible values: [service_unavailable]

description string
detail object

Example (from schema)

{
  "code": "service_unavailable",
  "description": "string",
  "detail": {}
}

Loading...