Get Idle Sleep Setting

GET

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

const url = 'https://dashboard.quantcdn.io/api/v3/organizations/example/applications/example/environments/example/idle-sleep';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dashboard.quantcdn.io/api/v3/organizations/example/applications/example/environments/example/idle-sleep \
  --header 'Authorization: Bearer <token>'

Retrieves the idle sleep setting and the current sleep state for the environment.

Authorizations

BearerAuth

Parameters

Path Parameters

organisation

required

string

application

required

string

environment

required

string

Responses

200

Idle sleep setting and state.

application/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"
}

403

The caller lacks the required permission or token scope.

404

Organisation, application or environment not found.