Autoscaling Groups

srn

string · pattern: ^srn://autoscaling\.…

SRN of the Autoscaling Group.

id

string

Unique identifier of the autoscaling group.

project_id

string

Project ID owning this group.

name

string

Name of the autoscaling group.

tags

string[]

Tags associated with the group.

created_at

string | null · date-time

Creation timestamp of the group. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the group. (RFC 3339 format)

status

scaleway.autoscaling.v1alpha2.Group.GroupStatus · enum

Current status of the autoscaling group.

Enum values:

unknown_group_status

active

scaling_out

scaling_in

refreshing

healing

scaling_failure

deleting

Default: unknown_group_status

List of active alerts on the group.

current_size

integer · uint32

Current number of instances in the group.

target_size

integer · uint32

Target number of instances the group is scaling to.

last_scale_out_at

string | null · date-time

Timestamp of the last scale out event. (RFC 3339 format)

last_scale_in_at

string | null · date-time

Timestamp of the last scale in event. (RFC 3339 format)

template_id

string

The Instance template ID used to create instances in this group.

scaleway.autoscaling.v1alpha2.Group.LoadBalancerConfiguration

Scaling policy configuration.

Optional load balancer configuration.

zone

string

Zone of the Autoscaling Group.

POST/autoscaling/v1alpha2/zones/{zone}/groups

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "project_id": "string",
    "template_id": "string"
  }' \
  "https://api.scaleway.com/autoscaling/v1alpha2/zones/{zone}/groups"

Example Request Body

{
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "template_id": "template_id",
  "scaling_policy_spec": {
    "minimum_size": 0,
    "maximum_size": 0,
    "scale_out_cooldown": "2.5s",
    "scale_in_cooldown": "2.5s",
    "scale_in_step": 0,
    "scale_out_step": 0,
    "fixed_size": {
      "size": 0
    },
    "cpu_target": {
      "target_avg_percent": 0
    },
    "memory_target": {
      "target_avg_percent": 0
    }
  },
  "load_balancer_configuration_spec": {
    "load_balancer_id": "load_balancer_id",
    "backends": [
      {
        "backend_id": "backend_id",
        "address_family": "unknown_address_family",
        "private_network_id": "private_network_id"
      }
    ],
    "auto_healing": {
      "enabled": true,
      "grace_period": "2.5s"
    }
  }
}

json

Example Responses

{
  "srn": "srn",
  "id": "id",
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_group_status",
  "open_alerts": [
    {
      "type": "unknown_alert_type",
      "opened_at": "2022-03-22T12:34:56.123456Z",
      "closed_at": "2022-03-22T12:34:56.123456Z",
      "group_id": "group_id",
      "failing_quotas": [
        "string"
      ]
    }
  ],
  "current_size": 0,
  "target_size": 0,
  "last_scale_out_at": "2022-03-22T12:34:56.123456Z",
  "last_scale_in_at": "2022-03-22T12:34:56.123456Z",
  "template_id": "template_id",
  "scaling_policy": {
    "minimum_size": 0,
    "maximum_size": 0,
    "scale_out_cooldown": "2.5s",
    "scale_in_cooldown": "2.5s",
    "scale_in_step": 0,
    "scale_out_step": 0,
    "fixed_size": {
      "size": 0
    },
    "cpu_target": {
      "target_avg_percent": 0
    },
    "memory_target": {
      "target_avg_percent": 0
    }
  },
  "load_balancer_configuration": {
    "load_balancer_id": "load_balancer_id",
    "backends": [
      {
        "backend_id": "backend_id",
        "address_family": "unknown_address_family",
        "private_network_id": "private_network_id"
      }
    ],
    "auto_healing": {
      "enabled": true,
      "grace_period": "2.5s"
    }
  },
  "zone": "zone"
}

json

application/json

Get an autoscaling group

GET

https://api.scaleway.com

/autoscaling/v1alpha2/zones/{zone}/groups/{group_id}

Get details of a specified autoscaling group including its configuration, current size, and status.

Get an autoscaling group › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

group_id

string · required

ID of the group to get.

Get an autoscaling group › Responses

200

srn

string · pattern: ^srn://autoscaling\.…

SRN of the Autoscaling Group.

id

string

Unique identifier of the autoscaling group.

project_id

string

Project ID owning this group.

name

string

Name of the autoscaling group.

tags

string[]

Tags associated with the group.

created_at

string | null · date-time

Creation timestamp of the group. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the group. (RFC 3339 format)

status

scaleway.autoscaling.v1alpha2.Group.GroupStatus · enum

Current status of the autoscaling group.

Enum values:

unknown_group_status

active

scaling_out

scaling_in

refreshing

healing

scaling_failure

deleting

Default: unknown_group_status

List of active alerts on the group.

current_size

integer · uint32

Current number of instances in the group.

target_size

integer · uint32

Target number of instances the group is scaling to.

last_scale_out_at

string | null · date-time

Timestamp of the last scale out event. (RFC 3339 format)

last_scale_in_at

string | null · date-time

Timestamp of the last scale in event. (RFC 3339 format)

template_id

string

The Instance template ID used to create instances in this group.

scaleway.autoscaling.v1alpha2.Group.LoadBalancerConfiguration

Scaling policy configuration.

Optional load balancer configuration.

zone

string

Zone of the Autoscaling Group.

GET/autoscaling/v1alpha2/zones/{zone}/groups/{group_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/autoscaling/v1alpha2/zones/{zone}/groups/{group_id}"

Example Responses

{
  "srn": "srn",
  "id": "id",
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_group_status",
  "open_alerts": [
    {
      "type": "unknown_alert_type",
      "opened_at": "2022-03-22T12:34:56.123456Z",
      "closed_at": "2022-03-22T12:34:56.123456Z",
      "group_id": "group_id",
      "failing_quotas": [
        "string"
      ]
    }
  ],
  "current_size": 0,
  "target_size": 0,
  "last_scale_out_at": "2022-03-22T12:34:56.123456Z",
  "last_scale_in_at": "2022-03-22T12:34:56.123456Z",
  "template_id": "template_id",
  "scaling_policy": {
    "minimum_size": 0,
    "maximum_size": 0,
    "scale_out_cooldown": "2.5s",
    "scale_in_cooldown": "2.5s",
    "scale_in_step": 0,
    "scale_out_step": 0,
    "fixed_size": {
      "size": 0
    },
    "cpu_target": {
      "target_avg_percent": 0
    },
    "memory_target": {
      "target_avg_percent": 0
    }
  },
  "load_balancer_configuration": {
    "load_balancer_id": "load_balancer_id",
    "backends": [
      {
        "backend_id": "backend_id",
        "address_family": "unknown_address_family",
        "private_network_id": "private_network_id"
      }
    ],
    "auto_healing": {
      "enabled": true,
      "grace_period": "2.5s"
    }
  },
  "zone": "zone"
}

json

application/json

Update an autoscaling group

PATCH

https://api.scaleway.com

/autoscaling/v1alpha2/zones/{zone}/groups/{group_id}

Update the configuration of a specified autoscaling group including name, tags, template, scaling policy, and load balancer settings.

Update an autoscaling group › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

group_id

string · required

ID of the group to update.

Update an autoscaling group › Request Body

name

string | null

New name for the group.

tags

array | null

New tags for the group.

template_id

string | null

New template ID for instances.

scaleway.autoscaling.v1alpha2.ScalingPolicySpec

New scaling policy configuration.

scaleway.autoscaling.v1alpha2.LoadBalancerConfigurationSpec

New load balancer configuration.

Update an autoscaling group › Responses

200

srn

string · pattern: ^srn://autoscaling\.…

SRN of the Autoscaling Group.

id

string

Unique identifier of the autoscaling group.

project_id

string

Project ID owning this group.

name

string

Name of the autoscaling group.

tags

string[]

Tags associated with the group.

created_at

string | null · date-time

Creation timestamp of the group. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the group. (RFC 3339 format)

status

scaleway.autoscaling.v1alpha2.Group.GroupStatus · enum

Current status of the autoscaling group.

Enum values:

unknown_group_status

active

scaling_out

scaling_in

refreshing

healing

scaling_failure

deleting

Default: unknown_group_status

List of active alerts on the group.

current_size

integer · uint32

Current number of instances in the group.

target_size

integer · uint32

Target number of instances the group is scaling to.

last_scale_out_at

string | null · date-time

Timestamp of the last scale out event. (RFC 3339 format)

last_scale_in_at

string | null · date-time

Timestamp of the last scale in event. (RFC 3339 format)

template_id

string

The Instance template ID used to create instances in this group.

scaleway.autoscaling.v1alpha2.Group.LoadBalancerConfiguration

Scaling policy configuration.

Optional load balancer configuration.

zone

string

Zone of the Autoscaling Group.

PATCH/autoscaling/v1alpha2/zones/{zone}/groups/{group_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/autoscaling/v1alpha2/zones/{zone}/groups/{group_id}"

Example Request Body

{
  "name": "name",
  "tags": [],
  "template_id": "template_id",
  "scaling_policy_spec": {
    "minimum_size": 0,
    "maximum_size": 0,
    "scale_out_cooldown": "2.5s",
    "scale_in_cooldown": "2.5s",
    "scale_in_step": 0,
    "scale_out_step": 0,
    "fixed_size": {
      "size": 0
    },
    "cpu_target": {
      "target_avg_percent": 0
    },
    "memory_target": {
      "target_avg_percent": 0
    }
  },
  "load_balancer_configuration_spec": {
    "load_balancer_id": "load_balancer_id",
    "backends": [
      {
        "backend_id": "backend_id",
        "address_family": "unknown_address_family",
        "private_network_id": "private_network_id"
      }
    ],
    "auto_healing": {
      "enabled": true,
      "grace_period": "2.5s"
    }
  }
}

json

Example Responses

{
  "srn": "srn",
  "id": "id",
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_group_status",
  "open_alerts": [
    {
      "type": "unknown_alert_type",
      "opened_at": "2022-03-22T12:34:56.123456Z",
      "closed_at": "2022-03-22T12:34:56.123456Z",
      "group_id": "group_id",
      "failing_quotas": [
        "string"
      ]
    }
  ],
  "current_size": 0,
  "target_size": 0,
  "last_scale_out_at": "2022-03-22T12:34:56.123456Z",
  "last_scale_in_at": "2022-03-22T12:34:56.123456Z",
  "template_id": "template_id",
  "scaling_policy": {
    "minimum_size": 0,
    "maximum_size": 0,
    "scale_out_cooldown": "2.5s",
    "scale_in_cooldown": "2.5s",
    "scale_in_step": 0,
    "scale_out_step": 0,
    "fixed_size": {
      "size": 0
    },
    "cpu_target": {
      "target_avg_percent": 0
    },
    "memory_target": {
      "target_avg_percent": 0
    }
  },
  "load_balancer_configuration": {
    "load_balancer_id": "load_balancer_id",
    "backends": [
      {
        "backend_id": "backend_id",
        "address_family": "unknown_address_family",
        "private_network_id": "private_network_id"
      }
    ],
    "auto_healing": {
      "enabled": true,
      "grace_period": "2.5s"
    }
  },
  "zone": "zone"
}

json

application/json

Delete an autoscaling group

DELETE

https://api.scaleway.com

/autoscaling/v1alpha2/zones/{zone}/groups/{group_id}

Delete a specified autoscaling group and all its associated resources.

Delete an autoscaling group › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

group_id

string · required

ID of the group to delete.

Delete an autoscaling group › Responses

200

srn

string · pattern: ^srn://autoscaling\.…

SRN of the Autoscaling Group.

id

string

Unique identifier of the autoscaling group.

project_id

string

Project ID owning this group.

name

string

Name of the autoscaling group.

tags

string[]

Tags associated with the group.

created_at

string | null · date-time

Creation timestamp of the group. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the group. (RFC 3339 format)

status

scaleway.autoscaling.v1alpha2.Group.GroupStatus · enum

Current status of the autoscaling group.

Enum values:

unknown_group_status

active

scaling_out

scaling_in

refreshing

healing

scaling_failure

deleting

Default: unknown_group_status

List of active alerts on the group.

current_size

integer · uint32

Current number of instances in the group.

target_size

integer · uint32

Target number of instances the group is scaling to.

last_scale_out_at

string | null · date-time

Timestamp of the last scale out event. (RFC 3339 format)

last_scale_in_at

string | null · date-time

Timestamp of the last scale in event. (RFC 3339 format)

template_id

string

The Instance template ID used to create instances in this group.

scaleway.autoscaling.v1alpha2.Group.LoadBalancerConfiguration

Scaling policy configuration.

Optional load balancer configuration.

zone

string

Zone of the Autoscaling Group.

DELETE/autoscaling/v1alpha2/zones/{zone}/groups/{group_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/autoscaling/v1alpha2/zones/{zone}/groups/{group_id}"

Example Responses

{
  "srn": "srn",
  "id": "id",
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "status": "unknown_group_status",
  "open_alerts": [
    {
      "type": "unknown_alert_type",
      "opened_at": "2022-03-22T12:34:56.123456Z",
      "closed_at": "2022-03-22T12:34:56.123456Z",
      "group_id": "group_id",
      "failing_quotas": [
        "string"
      ]
    }
  ],
  "current_size": 0,
  "target_size": 0,
  "last_scale_out_at": "2022-03-22T12:34:56.123456Z",
  "last_scale_in_at": "2022-03-22T12:34:56.123456Z",
  "template_id": "template_id",
  "scaling_policy": {
    "minimum_size": 0,
    "maximum_size": 0,
    "scale_out_cooldown": "2.5s",
    "scale_in_cooldown": "2.5s",
    "scale_in_step": 0,
    "scale_out_step": 0,
    "fixed_size": {
      "size": 0
    },
    "cpu_target": {
      "target_avg_percent": 0
    },
    "memory_target": {
      "target_avg_percent": 0
    }
  },
  "load_balancer_configuration": {
    "load_balancer_id": "load_balancer_id",
    "backends": [
      {
        "backend_id": "backend_id",
        "address_family": "unknown_address_family",
        "private_network_id": "private_network_id"
      }
    ],
    "auto_healing": {
      "enabled": true,
      "grace_period": "2.5s"
    }
  },
  "zone": "zone"
}

json

application/json

Refresh an autoscaling group

POST

https://api.scaleway.com

/autoscaling/v1alpha2/zones/{zone}/groups/{group_id}/refresh

This will replace all the instances of the group. Its main use case is applying changes if the instance template has been updated.

Refresh an autoscaling group › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

group_id

string · required

Refresh an autoscaling group › Request Body

Refresh an autoscaling group › Responses

200

srn

string · pattern: ^srn://autoscaling\.…

SRN of the Autoscaling Group.

id

string

Unique identifier of the autoscaling group.

project_id

string

Project ID owning this group.

name

string

Name of the autoscaling group.

tags

string[]

Tags associated with the group.

created_at

string | null · date-time

Creation timestamp of the group. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the group. (RFC 3339 format)

status

scaleway.autoscaling.v1alpha2.Group.GroupStatus · enum

Current status of the autoscaling group.

Enum values:

unknown_group_status

active

scaling_out

scaling_in

refreshing

healing

scaling_failure

deleting

Default: unknown_group_status

List of active alerts on the group.

current_size

integer · uint32

Current number of instances in the group.

target_size

integer · uint32

Target number of instances the group is scaling to.

last_scale_out_at

string | null · date-time

Timestamp of the last scale out event. (RFC 3339 format)

last_scale_in_at

string | null · date-time

Timestamp of the last scale in event. (RFC 3339 format)

template_id

string

The Instance template ID used to create instances in this group.