---
title: "Suspend scan"
source_url: https://dev.digicert.com/certcentral-apis/discovery-api/scan-lifecycle/suspend-scan.html
api_method: POST
api_endpoint: "/apicontroller/v1/scan/suspend"
api_url: "https://daas.digicert.com/apicontroller/v1/scan/suspend"
---

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

Use this endpoint to suspend the scan job.

## Example requests and responses

## cURL

```bash
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"}'
```

## 200 OK

```json
[
    {
        "error": null,
        "data": {
            "id": "290718",
            "message": "Scan Suspended Successfully"
        }
    }
]
```

## Request parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Req/Opt</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>accountId</td>
<td>required</td>
<td>string</td>
<td>Account ID.</td>
</tr>
<tr>
<td>divisionIds</td>
<td>required</td>
<td>array</td>
<td>Division IDs.</td>
</tr>
<tr>
<td>scanDefIds</td>
<td>required</td>
<td>array</td>
<td>List of unique IDs for scan templates to suspend.</td>
</tr>
<tr>
<td>reason</td>
<td>optional</td>
<td>string</td>
<td>Reason for suspending the scan.</td>
</tr>
</tbody>
</table>

## Response parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>error</td>
<td>object</td>
<td>Includes the error code if any.</td>
</tr>
<tr>
<td>data</td>
<td>object</td>
<td>Object container for response.</td>
</tr>
<tr>
<td>.. id</td>
<td>string</td>
<td>ID associated with the scan, also known as the  <code>surveyDefId</code>.</td>
</tr>
<tr>
<td>.. message</td>
<td>string</td>
<td>Message with additional information about the request.</td>
</tr>
</tbody>
</table>