Set engagement state

PUT /v1/engagement/state

Pauses or starts an engagement.

Parameters

engagementId: ID of engagement to be modified
state: Desired state for engagement (START or PAUSE)
envs: If changing the state to START, list of environments to start the engagement on, defaults to [PRODUCTION]

application/json

Body Required

Engagement State Change Request

engagementId string Required

ID of engagement to modify
state string Required

New state for given engagement

Values are START or PAUSE.
envs array[string]

Collection of environments on which to change the state. Defaults to [PRODUCTION]

Values are PRODUCTION, INTEGRATION, QA, or STAGE.

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- body object
- statusCode string
  
  Values are 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, or 511.
- statusCodeValue integer(int32)
400

Bad request
401

Unauthorized or bad API Key
404

Account not found
429

Rate limit exceeded

PUT /v1/engagement/state

curl \
 --request PUT 'https://api.aptrinsic.com/v1/engagement/state' \
 --header "Content-Type: application/json" \
 --data '{"engagementId":"string","state":"START","envs":["PRODUCTION"]}'

Request examples

{
  "engagementId": "string",
  "state": "START",
  "envs": [
    "PRODUCTION"
  ]
}

Response examples (200)

{
  "body": {},
  "statusCode": "100",
  "statusCodeValue": 42
}