Skip to main content
POST
Update an origin group in a Load Balancer profile

Authorizations

AccessKey
string
header
required

API Access Key authorization header

Scopes

User
AccessKey
UserApi
AccessKey
SubuserAPIPullZones
AccessKey
SubuserPullZones
AccessKey
SubuserManage
AccessKey
SubuserAPIManage
AccessKey
ScopedApiKey
AccessKey
User
bearer
UserApi
bearer
SubuserAPIPullZones
bearer
SubuserPullZones
bearer
SubuserManage
bearer
SubuserAPIManage
bearer
ScopedApiKey
bearer

Path Parameters

loadBalancerId
integer<int64>
required
id
integer<int64>
required

Body

application/json

The model for updating the origin group

Name
string | null

The name of the origin group

Enabled
boolean | null

Set to true if the origin group is enabled

HealthCheckSettings
object | null

Health check settings for monitoring origins in the group

OriginLoadBalancingMethod
enum<integer> | null

The load balancing method used for selecting origins within the group

0 = Round Robin 1 = Weighted Random 2 = Least Connections 3 = Latency

Available options:
0,
1,
2,
3
Latitude
number<double> | null

The latitude of the origin group location

Longitude
number<double> | null

The longitude of the origin group location

Weight
integer<byte> | null

The weight of the origin group used for weighted load balancing

Priority
integer<byte> | null

The priority of the origin group used for failover load balancing

Response

The updated origin group

Id
integer<int64>

The unique ID of the origin group

Name
string | null

The name of the origin group

Enabled
boolean

Set to true if the origin group is enabled

Latitude
number<double>

The latitude of the origin group location

Longitude
number<double>

The longitude of the origin group location

Weight
integer<byte>

The weight of the origin group used for weighted load balancing

Priority
integer<byte>

The priority of the origin group used for failover load balancing

OriginLoadBalancingMethod
enum<integer>

The load balancing method used for selecting origins within the group

0 = Round Robin 1 = Weighted Random 2 = Least Connections 3 = Latency

Available options:
0,
1,
2,
3
Origins
object[] | null

The list of origins associated with the origin group

HealthCheckSettings
object | null

Health settings for the origin group