logo

Auto-Scale Groups

Endpoints for managing groups of infrastructure that can be used for auto-scaling.

List Auto-Scale Groups

Requires the autoscale-groups-manage capability.

SecuritybearerAuth and hubAuth
Request
query Parameters
object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

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: "integrations" "models" "locations"
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 a list of Auto-Scale Groups.

default

General error response from the platform

get/v1/infrastructure/auto-scale/groups
Response samples
application/json
{
  • "data": [
    ],
  • "includes": {
    }
}

Create Auto-Scale Group

Requires the 'autoscale-groups-manage'

SecuritybearerAuth and hubAuth
Request
Request Body schema: application/json

Parameters for creating an Auto-Scale Group

name
required
string
identifier
required
string
ACL (object) or null
cluster
required
string
required
object (AutoScaleGroupScale)
required
object (AutoScaleGroupInfrastructure)
Responses
201

Returns an Auto-Scale Group.

default

General error response from the platform

post/v1/infrastructure/auto-scale/groups
Request samples
application/json
{
  • "name": "string",
  • "identifier": "string",
  • "acl": {
    },
  • "cluster": "string",
  • "scale": {
    },
  • "infrastructure": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Get Auto-Scale Group

Requires the autoscale-groups-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
groupId
required
string

The ID for the given Auto-Scale Group.

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: "integrations" "models" "locations"
Responses
200

Returns an Auto-Scale Group.

default

General error response from the platform

get/v1/infrastructure/auto-scale/groups/{groupId}
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}

Update Auto-Scale Group

Requires the autoscale-groups-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
groupId
required
string

The ID for the given Auto-Scale Group.

Request Body schema: application/json

Parameters for creating an Auto-Scale Group

name
string or null
identifier
string or null
AutoScaleGroupScale (object) or null
AutoScaleGroupInfrastructure (object) or null
Responses
200

Returns an Auto-Scale Group.

default

General error response from the platform

patch/v1/infrastructure/auto-scale/groups/{groupId}
Request samples
application/json
{
  • "name": "string",
  • "identifier": "string",
  • "scale": {
    },
  • "infrastructure": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Delete Auto-Scale Group

Requires the autoscale-group-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
groupId
required
string

The ID for the given autoscale group.

Responses
202

Returns a task descriptor.

default

General error response from the platform

delete/v1/infrastructure/auto-scale/groups/{groupId}
Response samples
application/json
{
  • "data": {
    }
}

Update Auto-Scale Group Access

Requires the autoscale-groups-manage capability. If an ACL is present, requires the manage privilege.

SecuritybearerAuth and hubAuth
Request
path Parameters
groupId
required
string

The ID for the given Auto-Scale Group.

Request Body schema: application/json

Parameters for creating an Auto-Scale Group

ACL (object) or null
Responses
200

Returns an Auto-Scale Group.

default

General error response from the platform

patch/v1/infrastructure/auto-scale/groups/{groupId}/access
Request samples
application/json
{
  • "acl": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}
➔ Next to Clusters