Pause an assessment - Synack Enterprise API

POST

organizations

{organizationUid}

assessments

{assessmentUid}

pause

Pause an assessment

curl --request POST \
  --url https://client.synack.com/api/assessment/v1/organizations/{organizationUid}/assessments/{assessmentUid}/pause \
  --header 'Authorization: Bearer <token>'

{
  "status": 123,
  "title": "<string>",
  "type": "https://errors.synack.com/assessment/group-not-found",
  "detail": "<string>",
  "instance": "<string>",
  "logId": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationUid

string

required

The unique identifier of the organization.

assessmentUid

string

required

The unique identifier of the assessment.

Response

Assessment paused successfully.

Resume an assessmentResumes testing on a paused assessment. The assessment must be in a paused state to be resumed. Returns 409 if the assessment is not currently paused.

Pause an assessment

curl --request POST \
  --url https://client.synack.com/api/assessment/v1/organizations/{organizationUid}/assessments/{assessmentUid}/pause \
  --header 'Authorization: Bearer <token>'

{
  "status": 123,
  "title": "<string>",
  "type": "https://errors.synack.com/assessment/group-not-found",
  "detail": "<string>",
  "instance": "<string>",
  "logId": "<string>"
}