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

200
default

application/json

{"data": {"default_config": {"ipv4": true,
"ipv6": true,
"type": "v1",
"details": {"controllers": [{"identifier": "string",
"port": 0,
"waf": {"rules": [{ }
]
},
"transport": {"disable": true,
"mode": "tcp",
"config": {"performance": null,
"ingress": { },
"timeouts": { },
"verbosity": null,
"extension": { }
},
"routers": [null
]
}
}
],
"controller_template": {"identifier": "string",
"port": 0,
"waf": {"rules": [{"description": null,
"skip": null,
"type": null,
"conditions": [ ]
}
]
},
"transport": {"disable": true,
"mode": "tcp",
"config": {"performance": true,
"ingress": {"tls": { }
},
"timeouts": {"idle": null
},
"verbosity": "low",
"extension": {"type": null,
"details": { }
}
},
"routers": [{"match": { },
"mode": null,
"config": { }
}
]
}
},
"waf": {"rules": [{"description": "string",
"skip": true,
"type": "allow",
"conditions": [{ }
]
}
]
}
},
"bind_host": true
},
"default_type": "haproxy",
"current_type": "haproxy",
"base_configs": {"haproxy": {"default": {"frontend": {"mode": "tcp",
"max_connections": 0,
"timeouts": {"client_secs": 0,
"client_fin_ms": 0,
"http_keep_alive_ms": 0,
"http_request_ms": 0
}
},
"backend": {"balance": "roundrobin",
"timeouts": {"server_secs": 0,
"server_fin_ms": 0,
"connect_ms": 0,
"queue_ms": 0,
"tunnel_secs": 0
}
}
},
"ports": {"property1": {"frontend": {"mode": "tcp",
"max_connections": 0,
"timeouts": {"client_secs": null,
"client_fin_ms": null,
"http_keep_alive_ms": null,
"http_request_ms": null
}
},
"backend": {"balance": "roundrobin",
"timeouts": {"server_secs": null,
"server_fin_ms": null,
"connect_ms": null,
"queue_ms": null,
"tunnel_secs": null
}
}
},
"property2": {"frontend": {"mode": "tcp",
"max_connections": 0,
"timeouts": {"client_secs": null,
"client_fin_ms": null,
"http_keep_alive_ms": null,
"http_request_ms": null
}
},
"backend": {"balance": "roundrobin",
"timeouts": {"server_secs": null,
"server_fin_ms": null,
"connect_ms": null,
"queue_ms": null,
"tunnel_secs": null
}
}
}
}
},
"v1": {"controllers": [{"identifier": "string",
"port": 0,
"waf": {"rules": [{ }
]
},
"transport": {"disable": true,
"mode": "tcp",
"config": {"performance": null,
"ingress": { },
"timeouts": { },
"verbosity": null,
"extension": { }
},
"routers": [null
]
}
}
],
"controller_template": {"identifier": "string",
"port": 0,
"waf": {"rules": [{"description": null,
"skip": null,
"type": null,
"conditions": [ ]
}
]
},
"transport": {"disable": true,
"mode": "tcp",
"config": {"performance": true,
"ingress": {"tls": { }
},
"timeouts": {"idle": null
},
"verbosity": "low",
"extension": {"type": null,
"details": { }
}
},
"routers": [{"match": { },
"mode": null,
"config": { }
}
]
}
},
"waf": {"rules": [{"description": "string",
"skip": true,
"type": "allow",
"conditions": [{ }
]
}
]
}
}
},
"service": {"enable": true,
"container_id": "string",
"high_availability": true,
"auto_update": true,
"config": {"ipv4": true,
"ipv6": true,
"type": "v1",
"details": {"controllers": [{"identifier": "string",
"port": 0,
"waf": {"rules": [ ]
},
"transport": {"disable": null,
"mode": null,
"config": { },
"routers": [ ]
}
}
],
"controller_template": {"identifier": "string",
"port": 0,
"waf": {"rules": [{ }
]
},
"transport": {"disable": true,
"mode": "tcp",
"config": {"performance": null,
"ingress": { },
"timeouts": { },
"verbosity": null,
"extension": { }
},
"routers": [null
]
}
},
"waf": {"rules": [{"description": null,
"skip": null,
"type": null,
"conditions": [ ]
}
]
}
},
"bind_host": true
}
}
}
}

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

Payload

application/json

{"action": "reconfigure",
"contents": {"high_availability": true,
"auto_update": true,
"config": {"ipv4": true,
"ipv6": true,
"type": "v1",
"details": {"controllers": [{"identifier": "string",
"port": 0,
"waf": {"rules": [{ }
]
},
"transport": {"disable": true,
"mode": "tcp",
"config": {"performance": null,
"ingress": { },
"timeouts": { },
"verbosity": null,
"extension": { }
},
"routers": [null
]
}
}
],
"controller_template": {"identifier": "string",
"port": 0,
"waf": {"rules": [{"description": null,
"skip": null,
"type": null,
"conditions": [ ]
}
]
},
"transport": {"disable": true,
"mode": "tcp",
"config": {"performance": true,
"ingress": {"tls": { }
},
"timeouts": {"idle": null
},
"verbosity": "low",
"extension": {"type": null,
"details": { }
}
},
"routers": [{"match": { },
"mode": null,
"config": { }
}
]
}
},
"waf": {"rules": [{"description": "string",
"skip": true,
"type": "allow",
"conditions": [{ }
]
}
]
}
},
"bind_host": true
}
}
}

Response samples

202
default

application/json

{"data": {"action": "string",
"job": {"id": "string",
"accepted": true,
"queue": "string",
"schedule": "2021-01-30T08:30:00Z",
"parallel": {"sub_queue": "string",
"tasks": true
},
"tasks": [{"caption": "string",
"header": "string",
"steps": [{"caption": "string",
"description": "string",
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
],
"input": {"property1": null,
"property2": null
}
}
]
}
}
}

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

200
default

application/json

{"data": {"created": "2021-01-30T08:30:00Z",
"range": {"start": "2021-01-30T08:30:00Z",
"end": "2021-01-30T08:30:00Z"
},
"snapshots": [{"time": "2021-01-30T08:30:00Z",
"controller": "string",
"metrics": {"disconnects": {"no_error": 0,
"request_invalid": 0,
"timeout_idle": 0,
"router_none": 0,
"router_nomatch": 0,
"destination_unavailable": 0,
"unknown_error": 0
},
"connections": 0,
"requests": 0,
"bytes_transmitted": 0,
"bytes_received": 0
}
}
]
}
}

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

200
default

application/json

{"data": {"created": "2021-01-30T08:30:00Z",
"controllers": [{"time": "2021-01-30T08:30:00Z",
"controller": "string",
"instances": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"environment_id": "651586fca6078e98982dbd90",
"container_id": "651586fca6078e98982dbd90",
"instance_id": "651586fca6078e98982dbd90",
"server_id": "651586fca6078e98982dbd90",
"cluster": "string",
"time": "2021-01-30T08:30:00Z",
"controller": "string",
"latest": {"time": "2021-01-30T08:30:00Z",
"started": "2021-01-30T08:30:00Z",
"version": "string",
"dataset_id": 0,
"current": {"router": null,
"urls": null,
"metrics": null
},
"cumulative": {"router": null,
"urls": null,
"metrics": null
}
},
"snapshots": [{"time": null,
"started": null,
"version": null,
"dataset_id": null,
"current": { },
"cumulative": { }
}
]
}
]
}
]
}
}

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

200
default

application/json

{"data": {"created": "2021-01-30T08:30:00Z",
"controllers": [{"time": "2021-01-30T08:30:00Z",
"controller": "string",
"instances": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"environment_id": "651586fca6078e98982dbd90",
"container_id": "651586fca6078e98982dbd90",
"instance_id": "651586fca6078e98982dbd90",
"server_id": "651586fca6078e98982dbd90",
"cluster": "string",
"time": "2021-01-30T08:30:00Z",
"controller": "string",
"latest": {"time": "2021-01-30T08:30:00Z",
"started": "2021-01-30T08:30:00Z",
"version": "string",
"dataset_id": 0,
"current": {"router": null,
"urls": null,
"metrics": null
},
"cumulative": {"router": null,
"urls": null,
"metrics": null
}
},
"snapshots": [{"time": null,
"started": null,
"version": null,
"dataset_id": null,
"current": { },
"cumulative": { }
}
]
}
]
}
]
},
"includes": {"creators": {"accounts": {"property1": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
},
"property2": {"name": {"first": "string",
"last": "string"
},
"email": {"address": "string"
},
"id": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
}
},
"employees": null,
"visitors": null,
"environments": null,
"api_keys": null
},
"stack_builds": {"property1": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"stack_id": "string",
"spec": {"version": "1.0",
"about": {"version": "string",
"description": "string"
},
"scoped_variables": [{"identifier": "string",
"scope": {"containers": { }
},
"access": {"env_variable": { },
"internal_api": { },
"file": { }
},
"source": { }
}
],
"containers": {"property1": {"name": "string",
"image": {"name": null,
"origin": null,
"build": { },
"builder": { }
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": null,
"deploy": null,
"scaling": null,
"runtime": null,
"resources": null,
"integrations": null
},
"role": "conductor",
"volumes": [null
],
"deprecate": true,
"lock": true
},
"property2": {"name": "string",
"image": {"name": null,
"origin": null,
"build": { },
"builder": { }
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": null,
"deploy": null,
"scaling": null,
"runtime": null,
"resources": null,
"integrations": null
},
"role": "conductor",
"volumes": [null
],
"deprecate": true,
"lock": true
}
},
"services": {"discovery": { },
"loadbalancer": { },
"scheduler": { },
"vpn": { }
},
"annotations": {"property1": null,
"property2": null
}
},
"about": {"version": "string",
"description": "string",
"git_commit": {"hash": "string",
"message": "string",
"time": "2021-01-30T08:30:00Z",
"author": {"name": "string",
"email": "string"
}
}
},
"instructions": {"git": {"type": "hash",
"value": "string"
},
"variables": {"property1": "string",
"property2": "string"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"stack_id": "string",
"spec": {"version": "1.0",
"about": {"version": "string",
"description": "string"
},
"scoped_variables": [{"identifier": "string",
"scope": {"containers": { }
},
"access": {"env_variable": { },
"internal_api": { },
"file": { }
},
"source": { }
}
],
"containers": {"property1": {"name": "string",
"image": {"name": null,
"origin": null,
"build": { },
"builder": { }
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": null,
"deploy": null,
"scaling": null,
"runtime": null,
"resources": null,
"integrations": null
},
"role": "conductor",
"volumes": [null
],
"deprecate": true,
"lock": true
},
"property2": {"name": "string",
"image": {"name": null,
"origin": null,
"build": { },
"builder": { }
},
"annotations": {"property1": null,
"property2": null
},
"stateful": true,
"config": {"network": null,
"deploy": null,
"scaling": null,
"runtime": null,
"resources": null,
"integrations": null
},
"role": "conductor",
"volumes": [null
],
"deprecate": true,
"lock": true
}
},
"services": {"discovery": { },
"loadbalancer": { },
"scheduler": { },
"vpn": { }
},
"annotations": {"property1": null,
"property2": null
}
},
"about": {"version": "string",
"description": "string",
"git_commit": {"hash": "string",
"message": "string",
"time": "2021-01-30T08:30:00Z",
"author": {"name": "string",
"email": "string"
}
}
},
"instructions": {"git": {"type": "hash",
"value": "string"
},
"variables": {"property1": "string",
"property2": "string"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}
},
"stacks": {"property1": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"type": "account",
"id": "651586fca6078e98982dbd90"
},
"source": {"type": "git-repo",
"details": {"stack_file": "string",
"url": "string",
"branch": "string",
"auth": {"type": "http",
"credentials": {"username": null,
"password": null
}
},
"ref": {"type": "string",
"value": "string"
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"variables": {"property1": "string",
"property2": "string"
},
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"last_build": "2021-01-30T08:30:00Z"
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"builds_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"name": "string",
"hub_id": "651586fca6078e98982dbd90",
"creator": {"type": "account",
"id": "651586fca6078e98982dbd90"
},
"source": {"type": "git-repo",
"details": {"stack_file": "string",
"url": "string",
"branch": "string",
"auth": {"type": "http",
"credentials": {"username": null,
"password": null
}
},
"ref": {"type": "string",
"value": "string"
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"variables": {"property1": "string",
"property2": "string"
},
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"last_build": "2021-01-30T08:30:00Z"
},
"meta": {"containers_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
},
"builds_count": {"state": {"new": 0,
"starting": 0,
"running": 5,
"stopping": 0,
"deleting": 0,
"deleted": 0
},
"total": 5,
"available": 5
}
}
}
},
"sources": {"property1": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"type": "stack-build",
"hub_id": "651586fca6078e98982dbd90",
"name": "string",
"about": {"description": "string"
},
"origin": {"type": "docker-hub",
"details": {"existing": {"source_id": "651586fca6078e98982dbd90"
},
"target": "string",
"username": "string",
"token": "string"
}
},
"builder": {"integration_id": "my-image-source"
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"meta": {"images_count": {"total": 0,
"state": {"new": 0,
"downloading": 0,
"building": 0,
"verifying": 0,
"saving": 0,
"live": 0,
"deleting": 0
}
}
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"identifier": "string",
"type": "stack-build",
"hub_id": "651586fca6078e98982dbd90",
"name": "string",
"about": {"description": "string"
},
"origin": {"type": "docker-hub",
"details": {"existing": {"source_id": "651586fca6078e98982dbd90"
},
"target": "string",
"username": "string",
"token": "string"
}
},
"builder": {"integration_id": "my-image-source"
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"acl": {"roles": {"property1": {"view": true,
"modify": true,
"manage": true
},
"property2": {"view": true,
"modify": true,
"manage": true
}
}
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"meta": {"images_count": {"total": 0,
"state": {"new": 0,
"downloading": 0,
"building": 0,
"verifying": 0,
"saving": 0,
"live": 0,
"deleting": 0
}
}
}
}
}
}
}

➔ Next to Services/Scheduler