API Reference

Katapult Core API

Resources & Endpoints

List security group rules

Returns a list of all rules for a given security group.

GET
https://api.katapult.io/core/v1/security_groups/{security_group}/rules

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

security_group Required

The security group to return all load rules for

 Security group lookup None

page

Integer 1

per_page

Integer 30

Potential Errors

The following errors may occur during this request.

Details HTTP status

permission_denied

The authenticated identity is not permitted to perform this action

 403 Forbidden

security_group_not_found

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

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    pagination: Pagination Details {
        current_page: Integer
        total_pages: Integer?
        total: Integer?
        per_page: Integer
        large_set: Boolean
    }
    security_group_rules: [ SecurityGroupRule {
        id: String
        direction: SecurityGroupRuleDirectionEnum
        protocol: SecurityGroupRuleProtocolEnum
        action: SecurityGroupRuleActionEnum
        ports: String?
        targets: [ String ]
        notes: String?
    } ]
}