API Reference

Katapult Core API

Resources & Endpoints

Delete load balancer

Delete a load balancer.

DELETE
https://api.katapult.io/core/v1/load_balancers/{load_balancer}

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

load_balancer Required

The load balancer to destroy

 Load balancer lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

load_balancer_not_found

No load balancer was found matching any of the criteria provided in the arguments

 404 Not Found

permission_denied

The authenticated identity is not permitted to perform this action

 403 Forbidden

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.

{
    load_balancer: LoadBalancer {
        id: String
        name: String
        api_reference: String?
    }
}