Load Balancer
All operations require authentication.
List load balancersProduction
Returns the load balancers of the project.
Filters
The optional name, flavor and region query parameters narrow the list. Each one can be repeated (for example ?flavor=SMALL&flavor=MEDIUM): repeated values of the same parameter are combined with OR, and different parameters are combined with AND. An unknown flavor value, or an unavailable region, is rejected with a 400 InvalidParameter. The resourceStatus is computed from the live state of each resource, so it is not a filter: a status query parameter is rejected with a 400 InvalidParameter.
Path parameters
Project ID
Query parameters
Filter by load balancer flavor name. Repeatable.
LARGEMEDIUMSMALLXLFilter by load balancer name (case-insensitive substring match). Repeatable.
Filter by load balancer region. An unavailable region is rejected. Repeatable.
Headers
Pagination cursor
Pagination size
Response
Computed hash representing the current target specification value
Creation date of the load balancer
Current state of the load balancer
Ongoing asynchronous tasks related to the load balancer
Unique identifier of the load balancer
Load balancer readiness in the system
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification of the load balancer
Last update date of the load balancer
Example uses projectId = string
$ curl https:/[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "flavor": { "name": "LARGE" }, "location": { "availabilityZone": "string", "region": "string" }, "name": "string", "network": { "addresses": [ { "ip": "192.0.2.0", "type": "FIXED" } ], "id": "00000000-0000-0000-0000-000000000000", "subnetId": "00000000-0000-0000-0000-000000000000" }, "operatingStatus": "DEGRADED", "provisioningStatus": "ACTIVE" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "flavor": { "name": "LARGE" }, "location": { "availabilityZone": "string", "region": "string" }, "name": "string", "network": { "id": "00000000-0000-0000-0000-000000000000", "ip": "192.0.2.0", "subnetId": "00000000-0000-0000-0000-000000000000" } }, "updatedAt": "2024-01-01T12:00:00Z" }]
Get a load balancerProduction
Returns the load balancer, including its VIP network and operating status.
Path parameters
Loadbalancer ID
Project ID
Response
Computed hash representing the current target specification value
Creation date of the load balancer
Current state of the load balancer
Ongoing asynchronous tasks related to the load balancer
Unique identifier of the load balancer
Load balancer readiness in the system
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification of the load balancer
Last update date of the load balancer
Example uses loadbalancerId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "flavor": { "name": "LARGE" }, "location": { "availabilityZone": "string", "region": "string" }, "name": "string", "network": { "addresses": [ { "ip": "192.0.2.0", "type": "FIXED" } ], "id": "00000000-0000-0000-0000-000000000000", "subnetId": "00000000-0000-0000-0000-000000000000" }, "operatingStatus": "DEGRADED", "provisioningStatus": "ACTIVE" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "flavor": { "name": "LARGE" }, "location": { "availabilityZone": "string", "region": "string" }, "name": "string", "network": { "id": "00000000-0000-0000-0000-000000000000", "ip": "192.0.2.0", "subnetId": "00000000-0000-0000-0000-000000000000" } }, "updatedAt": "2024-01-01T12:00:00Z"}
Create a load balancerProduction
Creates a load balancer with the given Octavia flavor, attaching its virtual IP to a private network and subnet.
Path parameters
Project ID
Request body (required)
Desired target specification for the load balancer to create
Response
Computed hash representing the current target specification value
Creation date of the load balancer
Current state of the load balancer
Ongoing asynchronous tasks related to the load balancer
Unique identifier of the load balancer
Load balancer readiness in the system
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification of the load balancer
Last update date of the load balancer
Example uses projectId = string
$ curl https:/{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "flavor": { "name": "LARGE" }, "location": { "availabilityZone": "string", "region": "string" }, "name": "string", "network": { "addresses": [ { "ip": "192.0.2.0", "type": "FIXED" } ], "id": "00000000-0000-0000-0000-000000000000", "subnetId": "00000000-0000-0000-0000-000000000000" }, "operatingStatus": "DEGRADED", "provisioningStatus": "ACTIVE" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "flavor": { "name": "LARGE" }, "location": { "availabilityZone": "string", "region": "string" }, "name": "string", "network": { "id": "00000000-0000-0000-0000-000000000000", "ip": "192.0.2.0", "subnetId": "00000000-0000-0000-0000-000000000000" } }, "updatedAt": "2024-01-01T12:00:00Z"}
Delete a load balancerProduction
Deletes the load balancer.
Path parameters
Loadbalancer ID
Project ID
Response
Computed hash representing the current target specification value
Creation date of the load balancer
Current state of the load balancer
Ongoing asynchronous tasks related to the load balancer
Unique identifier of the load balancer
Load balancer readiness in the system
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification of the load balancer
Last update date of the load balancer
Example uses loadbalancerId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "flavor": { "name": "LARGE" }, "location": { "availabilityZone": "string", "region": "string" }, "name": "string", "network": { "addresses": [ { "ip": "192.0.2.0", "type": "FIXED" } ], "id": "00000000-0000-0000-0000-000000000000", "subnetId": "00000000-0000-0000-0000-000000000000" }, "operatingStatus": "DEGRADED", "provisioningStatus": "ACTIVE" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "flavor": { "name": "LARGE" }, "location": { "availabilityZone": "string", "region": "string" }, "name": "string", "network": { "id": "00000000-0000-0000-0000-000000000000", "ip": "192.0.2.0", "subnetId": "00000000-0000-0000-0000-000000000000" } }, "updatedAt": "2024-01-01T12:00:00Z"}
Update a load balancerProduction
Updates the load balancer's name, description or flavor. A flavor other than the current one resizes the load balancer in place: it is failed over onto amphorae of the new flavor, which takes several minutes and can briefly interrupt traffic. The VIP network is immutable after creation.
Path parameters
Loadbalancer ID
Project ID
Request body (required)
Optional concurrency-control checksum. When supplied, it must match the resource's current checksum or the request is rejected with a 409 checksum-mismatch conflict. When omitted or empty, the concurrency check is skipped and the write is forced (last-write-wins).
Desired target specification for the load balancer
Response
Computed hash representing the current target specification value
Creation date of the load balancer
Current state of the load balancer
Ongoing asynchronous tasks related to the load balancer
Unique identifier of the load balancer
Load balancer readiness in the system
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification of the load balancer
Last update date of the load balancer
Example uses loadbalancerId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "description": "string", "flavor": { "name": "LARGE" }, "location": { "availabilityZone": "string", "region": "string" }, "name": "string", "network": { "addresses": [ { "ip": "192.0.2.0", "type": "FIXED" } ], "id": "00000000-0000-0000-0000-000000000000", "subnetId": "00000000-0000-0000-0000-000000000000" }, "operatingStatus": "DEGRADED", "provisioningStatus": "ACTIVE" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "flavor": { "name": "LARGE" }, "location": { "availabilityZone": "string", "region": "string" }, "name": "string", "network": { "id": "00000000-0000-0000-0000-000000000000", "ip": "192.0.2.0", "subnetId": "00000000-0000-0000-0000-000000000000" } }, "updatedAt": "2024-01-01T12:00:00Z"}