API Reference

Katapult Core API

Resources & Endpoints

Get security group rule

Returns details about a security group rule.

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

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_rule Required

The security group rule to return the details for

 Security group rule lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

security_group_rule_not_found

No security group rule 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.

{
    security_group_rule: SecurityGroupRule {
        id: String
        security_group: SecurityGroup {
            id: String
            name: String
        }
        direction: SecurityGroupRuleDirectionEnum
        protocol: SecurityGroupRuleProtocolEnum
        ports: String?
        targets: [ String ]
        notes: String?
    }
}