v1

latestOpenAPI 3.0.0Apache 2.02026-07-17392074.2 KB
monitoring

Gets the status of an environment

get/monitoring/{owner}/environments/{environment}/status

Path parameters

ownerstring required

The username of the user whose resources that you wish to access

environmentstring required

The environment that you wish to access

Query parameters

eventLimitinteger

Number of events to limit to per DispatchInfo

refreshboolean

Whether to actively refresh information prior to returning it

Response

The status of the environment

launchingUserstring
dispatchIdstring
state'UNKNOWN' | 'PENDING' | 'RUNNING' | 'TERMINATING' | 'MISSING' | 'TERMINATED' | 'COMPLETED' | 'FAILED'
lastUpdatedstring
payloadStatesobject
additionalPropertiesobject

Example response

{
  "lastUpdated": "lastUpdated",
  "payloadStates": {},
  "launchedCapsuleReference": {
    "owner": "owner",
    "name": "name",
    "version": "version"
  },
  "launchingUser": "launchingUser",
  "additionalProperties": "{}",
  "events": [
    {
      "level": "TRACE",
      "reporter": "reporter",
      "additionalProperties": "{}",
      "message": "message",
      "timestamp": "timestamp",
      "extraInfo": {
        "key": "extraInfo"
      }
    },
    {
      "level": "TRACE",
      "reporter": "reporter",
      "additionalProperties": "{}",
      "message": "message",
      "timestamp": "timestamp",
      "extraInfo": {
        "key": "extraInfo"
      }
    }
  ],
  "dispatchId": "dispatchId"
}