# Suspend an active configuration

Suspends an active configuration, temporarily halting deployment to targeted endpoints.

## Endpoint

**POST** `/dcapi/configuration/{collectionId}/suspend`

## Request URL

`https://{server-hostname}:8383/dcapi/configuration/{collectionId}/suspend`

## Scope

`Configurations.UPDATE`

## Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Accept** (`string`, Mandatory): `application/suspendCollnDetails.v1+json`

### Path Parameters

- **collectionId** (`string`, Mandatory): The unique numeric identifier of the active configuration to be suspended. Fetch from [Get Configurations View](https://www.manageengine.com/products/desktop-central/help/api/onpremise/deployment-fw-get-configurations-view.html).

## Sample Request

```curl
curl --request POST \
  --url https://appdomain/dcapi/configuration/{collectionId}/suspend \
  --header 'Accept: application/suspendCollnDetails.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP Code 200

#### Response Body — `application/json`

`JSON object`

- **status** (`string`): Result of the suspend operation — Success or error message
- **collectionId** (`long`): The collection ID that was suspended
- **collectionName** (`string`): Display name of the suspended configuration

### HTTP Code 400

#### Response Body — `application/json`

`JSON object`

- **error_code** (`string`): BAD_REQUEST: the collection is not in a deployable state (already suspended or trashed)
- **error_description** (`string`): Message indicating the collection must be in deployed state to suspend

### HTTP Code 401

#### Response Body — `application/json`

`JSON object`

- **errorCode** (`long`): Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
- **errorMsg** (`string`): Authentication failure reason

## Possible Response Codes

- **200** — HTTP code
- **400** — HTTP code
- **401** — HTTP code

## Sample Response: HTTP 200

Configuration suspended successfully

```json
{
  "collectionId": 12345,
  "status": "Success",
  "collectionName": "Firewall_Policy_Win11"
}
```

## Sample Response: HTTP 400

Collection is not in a deployable state

```json
{
  "error_description": "Configuration is not in a deployable state",
  "error_code": "BAD_REQUEST"
}
```

## Sample Response: HTTP 401

User lacks write role or scope

```json
{
  "error_description": "Access denied - You are not allowed to access the requested resource.",
  "error_code": "UAC_UNAUTHORIZED"
}
```

## API Rate Limit

![](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.