API Reference

Katapult Core API

Resources & Endpoints

Get security group

Returns details about a security group.

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

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 the details for

 Security group lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

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.

{
    security_group: SecurityGroup {
        id: String
        name: String
        allow_all_inbound: Boolean
        allow_all_outbound: Boolean
        associations: [ String ]
    }
    annotations: [ KeyValue {
        key: String
        value: String?
    } ]
}