Set Idle Sleep Setting

PUT

/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/idle-sleep

curl --request PUT \
  --url https://dashboard.quantcdn.io/api/v3/organizations/example/applications/example/environments/example/idle-sleep \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true, "idleMinutes": 30 }'

• QuantCDN Public Cloud
• QuantGov Cloud

Enable or disable idle sleep. Only Fargate compute sleeps. Disabling a sleeping environment wakes it first; a 202 means it is still waking.

Authorizations

• BearerAuth

Parameters

Path Parameters

organisation

required

string

application

required

string

environment

required

string

Request Body^required

Media typeapplication/json

object

enabled

required

Whether the environment sleeps when idle.

boolean

idleMinutes

Minutes with no requests before compute sleeps.

integer

default: 30 >= 10 <= 1440

Responses

200

Applied.

Media typeapplication/json

object

enabled

required

boolean

idleMinutes

required

integer

nullable

state

required

string

Allowed values: awake sleeping waking

stateChangedAt

required

string format: date-time

nullable

Example

{
  "state": "awake"
}

202

Applied; environment still waking.

Media typeapplication/json

object

enabled

required

boolean

idleMinutes

required

integer

nullable

state

required

string

Allowed values: awake sleeping waking

stateChangedAt

required

string format: date-time

nullable

Example

{
  "state": "awake"
}

400

The environment cannot use idle sleep. It runs on EC2 rather than Fargate, it has no web service, or its hostname is too long to route while asleep.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

403

The caller lacks the required permission or token scope.

404

Organisation, application or environment not found.

422

Validation failed. idleMinutes must be an integer from 10 to 1440.

Media typeapplication/json

object

message

string

errors

object

Example^generated

{
  "message": "example",
  "errors": {}
}