Skip to content
Gradient SDK Docs
  • Auto
  • Light
  • Dark

List History

List history events
get/v2/droplets/autoscale/{autoscale_pool_id}/history

To list all of the scaling history events of an autoscale pool, send a GET request to /v2/droplets/autoscale/$AUTOSCALE_POOL_ID/history.

The response body will be a JSON object with a key of history. This will be set to an array containing objects each representing a history event.

Path Parameters
autoscale_pool_idstring
Query Parameters
pagenumber
optional

Which 'page' of paginated results to return.

minimum1
per_pagenumber
optional

Number of items returned per page

minimum1
maximum200
Returns
metatotalnumberMetaProperties

Information about the response itself.

historyarray of object
optional
Hide ParametersShow Parameters
created_atstring

The creation time of the history event in ISO8601 combined date and time format.

formatdate-time
current_instance_countnumber

The current number of Droplets in the autoscale pool.

desired_instance_countnumber

The target number of Droplets for the autoscale pool after the scaling event.

history_event_idstring

The unique identifier of the history event.

reasonenum
"CONFIGURATION_CHANGE" OR "SCALE_UP" OR "SCALE_DOWN"

The reason for the scaling event.

Hide ParametersShow Parameters
"CONFIGURATION_CHANGE"
"SCALE_UP"
"SCALE_DOWN"
statusenum
"in_progress" OR "success" OR "error"

The status of the scaling event.

Hide ParametersShow Parameters
"in_progress"
"success"
"error"
updated_atstring

The last updated time of the history event in ISO8601 combined date and time format.

formatdate-time
curl https://api.digitalocean.com//v2/droplets/autoscale/$AUTOSCALE_POOL_ID/history \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"
200 Example
{
  "history": [
    {
      "history_event_id": "01936530-4471-7b86-9634-32d8fcfecbc6",
      "current_instance_count": 2,
      "desired_instance_count": 2,
      "reason": "CONFIGURATION_CHANGE",
      "status": "success",
      "created_at": "2020-11-19T20:27:18Z",
      "updated_at": "2020-12-01T00:42:16Z"
    }
  ],
  "links": {
    "pages": null
  },
  "meta": {
    "total": 1
  }
}