Pauses the given harness, scaling its deployment to zero.
Required permission
Project > Harnesses > General > Update
Path parameters
projectId
string requiredID of the projectharnessId
string requiredID of the harness
Query parameters
acknowledgeActiveSessions
boolean
Response body
- {object}Response object.
data
{object} requiredResult data.
API
CLI
JS Client
POST /v1/projects/{projectId}/harnesses/{harnessId}/pause
POST /v1/teams/{teamId}/projects/{projectId}/harnesses/{harnessId}/pause
Example response
200 OK
The operation was performed successfully.
JSON
{
"data": {}
}Example response
409 Conflict
The harness could not be paused as it is already paused.