Delete security group

Delete a security group.

DELETE
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 destroy

Security group lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

deletion_restricted

Object cannot be deleted

409 Conflict

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

validation_error

A validation error occurred with the object that was being created/updated/deleted

422 Unprocessable Entity

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
    }
}