# Suspend an active compliance collection

Suspends an active CIS compliance collection, stopping scheduled scans until resumed.

## Endpoint

**POST** `/dcapi/scap/compliance/map/{collectionId}/suspend`

## Request

### Request URL

`https://{serverurl}/dcapi/scap/compliance/map/{collectionId}/suspend`

[{serverurl}](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)

### Scope

`DesktopCentralCloud.VulnerabilityMgmt.CREATE`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Path Parameters

- **collectionId** `string` **Mandatory**
  - The collection ID of the CIS compliance audit to suspend. Fetch from [Get CG Association Details](https://www.manageengine.com/products/desktop-central/help/api/cloud/get-cg-association-details.html).

### Sample Request

```curl
curl --request POST \
  --url https://appdomains/dcapi/scap/compliance/map/{collectionId}/suspend \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP Code 200

Response Body — `application/json`

`JSON Object`

- **status** `string`
  - Operation result. Success for suspend, Resumed or Expired for resume.
- **collectionName** `string`
  - Name of the compliance collection.

#### Sample Response: HTTP 200

Compliance collection suspended successfully

```json
{
  "STATUS": "Success",
  "collectionName": "Production Servers Compliance"
}
```

### HTTP Code 401

Response Body — `application/json`

`JSON Object`

- **errorCode** `string`
  - Unauthorized error code. Collection is not a compliance or quarantine collection, or user lacks scope access.
- **errorMessage** `string`
  - Message indicating the collection type mismatch or insufficient scope.

#### Sample Response: HTTP 401

The provided collection is not a compliance collection or user lacks scope

```json
{
  "errorMessage": "The given Collection is not a Compliance Collection",
  "errorCode": "UAC_UNAUTHORIZED"
}
```

User does not have scope access to the resource group

```json
{
  "errorMessage": "No access, Provided resource group is not in scope",
  "errorCode": "UAC_UNAUTHORIZED"
}
```

### HTTP Code 429

Response Body — `application/json`

`JSON Object`

- **errorCode** `long`
  - Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes.
- **errorMsg** `string`
  - Rate limit exceeded message with retry guidance.

#### Sample Response: HTTP 429

API call threshold exceeded

```json
{
  "errorMessage": "Rate limit exceeded. Retry after some time",
  "errorCode": "TOO_MANY_REQUESTS"
}
```

## Rate Limits

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**Duration:** 1 minute | **Threshold:** 30 | **Lock period:** 5 minutes

Duration - Time window for the threshold.  
Threshold - Number of API calls allowed within the specified duration.  
Lock Period - Wait time before consecutive API requests.