Services/Load Balancer

Endpoints related to managing an environment's load balancer service.

Get Load Balancer Service

Requires the environments-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
environmentId
required
string

The environmentId where the load balancer resides.

Responses
200

Returns a load balancer info resource.

default

General error response from the platform

get/v1/environments/{environmentId}/services/lb
Response samples
application/json
{
  • "data": {
    }
}

Create Load Balancer Service Job

Creates a task that will update the load balancer's configuration.

SecuritybearerAuth and hubAuth
Request
path Parameters
environmentId
required
string

The ID of the environment where this load balancer resides.

Request Body schema: application/json

Parameters for reconfiguring a load balancer.

action
required
string

The name of the action to perform.

Value: "reconfigure"
required
object
Responses
202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/environments/{environmentId}/services/lb/tasks
Request samples
application/json
{
  • "action": "reconfigure",
  • "contents": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Get Load Balancer Telemetry Report

Fetches a telemetry report for Cycle's native load balancer for the specified range.

Permissions

Requires the environments-view capability. Also requires the user to have access specifically to the requested Environment.

SecuritybearerAuth and hubAuth
Request
path Parameters
environmentId
required
string

The environmentId where the load balancer resides.

query Parameters
required
object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

Responses
200

Returns the load balancer telemetry report

default

General error response from the platform

get/v1/environments/{environmentId}/services/lb/telemetry/report
Response samples
application/json
{
  • "data": {
    }
}

Get Latest Load Balancer Telemetry Report.

Fetches the latest telemetry report for Cycle's native load balancer. Provides detailed information on a per-instance basis.

Permissions

Requires the environments-view capability. Also requires the user to have access specifically to the requested Environment.

SecuritybearerAuth and hubAuth
Request
path Parameters
environmentId
required
string

The environmentId where the load balancer resides.

query Parameters
required
object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

Required Filter

On this endpoint, you MUST pass filter[controller].

Responses
200

Returns the latest load balancer telemetry

default

General error response from the platform

get/v1/environments/{environmentId}/services/lb/telemetry/latest
Response samples
application/json
{
  • "data": {
    }
}

Get Latest Load Balancer Controller Telemetry

Gets the controller information for the specified load balancer. Returns a similar struct to the 'latest' load balancer telemetry call, but does NOT return snapshots, just the controller information.

Permissions

Requires the environments-view capability. Also requires the user to have access specifically to the requested Environment.

SecuritybearerAuth and hubAuth
Request
path Parameters
environmentId
required
string

The ID of the environment of the desired load balancer.

query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "instances" "servers" "containers"
Responses
200

Returns information about the latest controllers that produced telemetry.

default

General error response from the platform

get/v1/environments/{environmentId}/services/lb/telemetry/latest-controllers
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}