API Reference

Katapult Core API

Resources & Endpoints

Create load balancer

Create a new load balancer for a given organization.

POST
https://api.katapult.io/core/v1/organizations/{organization}/load_balancers

If successful, this endpoint will return a 201 Created 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

organization Required

The organization to create the load balancer for

 Organization Lookup None

properties Required

The properties for the new load balancer

 LoadBalancerArguments None

annotations

Annotations to add to this load balancer.

 KeyValue Array None

Potential Errors

The following errors may occur during this request.

Details HTTP status

data_center_not_found

No data center was found matching any of the criteria provided in the arguments

 404 Not Found

organization_not_activated

An organization was found from the arguments provided but it wasn't activated yet

 403 Forbidden

organization_not_found

No organization was found matching any of the criteria provided in the arguments

 404 Not Found

organization_suspended

An organization was found from the arguments provided but it was suspended

 403 Forbidden

permission_denied

The authenticated identity is not permitted to perform this action

 403 Forbidden

resource_creation_restricted

The organization chosen is not permitted to create resources

 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?
        resource_type: LoadBalancerResourceTypesEnum
        resources: [ LoadBalancerResource ]
        resource_ids: [ String ]
        ip_address: IPAddress {
            id: String
            address: String
        }
        https_redirect: Boolean
        backend_certificate: String
        backend_certificate_key: String
        data_center: DataCenter {
            id: String
            name: String
            permalink: String
        }
        enable_weighting: Boolean
        weights: [ LoadBalancerWeight {
            virtual_machine_id: String
            weight: Integer
        } ]
        standby_vms: [ String ]
    }
    annotations: [ KeyValue {
        key: String
        value: String?
    } ]
}