Skip to main content

Suspend scan

POST https://daas.digicert.com/apicontroller/v1/scan/suspend

Use this endpoint to suspend the scan job.

Example requests and responses

Example 1. cURL
curl --location --request POST 'https://daas.digicert.com/apicontroller/v1/scan/suspend' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{"accountId":5153184,"divisionIds":[677793],"scanDefIds":[290718],"reason":"Duplicate scan"}'

Request parameters

Name

Req/Opt

Type

Description

accountId

required

string

Account ID.

divisionIds

required

array

Division IDs.

scanDefIds

required

array

List of unique IDs for scan templates to suspend.

reason

optional

string

Reason for suspending the scan.

Response parameters

Name

Type

Description

error

object

Includes the error code if any.

data

object

Object container for response.

.. id

string

ID associated with the scan, also known as the  surveyDefId.

.. message

string

Message with additional information about the request.

In this section: