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
The security group to return all load rules for.
All 'security_group[]' params are mutually exclusive, only one can be provided.
Possible values: >= 1
Default value: 1
The page number to request. If not provided, the first page will be returned.
Possible values: >= 1
Default value: 30
The number of items to return per page. If not provided, the default value will be used.
Responses
- 200
- 400
- 403
- 404
- 429
- 503
Returns a list of all rules for a given security group
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
pagination
object
required
The current page
The total number of pages
The total number of items across all pages
The number of items per page
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
Possible values: [inbound
, outbound
]
Possible values: [TCP
, UDP
, ICMP
]
Possible values: [allow
, deny
]
{
"pagination": {
"current_page": 0,
"total_pages": 0,
"total": 0,
"per_page": 0,
"large_set": true
},
"security_group_rules": [
{
"id": "string",
"direction": "inbound",
"protocol": "TCP",
"action": "allow",
"ports": "string",
"targets": [
"string"
],
"notes": "string"
}
]
}
No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [missing_api_token
]
{
"code": "missing_api_token",
"description": "string",
"detail": {}
}
403 error response
- application/json
- Schema
- Example (from schema)
Schema
- UnauthorizedNetworkForAPITokenSchema
- InvalidAPITokenSchema
- InvalidCapabilitiesTokenSchema
- ScopeNotGrantedErrorSchema
- PermissionDeniedSchema
oneOf
Network is not allowed to access the API with this API token
Possible values: [unauthorized_network_for_api_token
]
detail
object
The IP address the request was received from
The API token provided was not valid (it may not exist or have expired)
Possible values: [invalid_api_token
]
detail
object
The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)
Possible values: [invalid_capabilities_token
]
The scope required for this endpoint has not been granted to the authenticating identity
Possible values: [scope_not_granted
]
detail
ScopeNotGrantedError
The authenticated identity is not permitted to perform this action
Possible values: [permission_denied
]
detail
object
Additional information regarding the reason why permission was denied
{}
No security group was found matching any of the criteria provided in the arguments
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [security_group_not_found
]
{
"code": "security_group_not_found",
"description": "string",
"detail": {}
}
You have reached the rate limit for this type of request
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [rate_limit_reached
]
detail
object
The total number of requests per minute that are permitted
{
"code": "rate_limit_reached",
"description": "string",
"detail": {
"total_permitted": 0
}
}
The service is currently unavailable, please try again later
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [service_unavailable
]
{
"code": "service_unavailable",
"description": "string",
"detail": {}
}