# Retrieves settings used to configure on-demand (immediate) power operations

Returns the immediate shutdown or restart settings including the timeout duration, message title, shutdown message, and operation mode. Accepts an 'operationType' query parameter (2 or 3) to specify the type of operation (shutdown or restart).

## Endpoints

`GET /dcapi/tools/shutdown/settings`

## Request

### Request URL

`https://{server-hostname}:8383/dcapi/tools/shutdown/settings`

### Scope

`Tools.READ`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Accept** `string` — **Mandatory** — `application/json`

### Sample Request

```curl
curl --request GET \
  --url https://appdomain/dcapi/tools/shutdown/settings \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response

### Response Parameters

#### HTTP code 200

Response Body — `application/json`

- `JSON Object`
  - **operationType** `integer`: Operation type: 1=Shutdown, 2=Restart, 3=Logoff, 4=Lock, 5=Hibernate
  - **shutdownMessage** `string`: Message displayed to end users before the operation executes
  - **shutdownMessageTitle** `string`: Title of the end-user notification dialog
  - **shutdownTimeout** `integer`: Delay in seconds before the operation executes after the notification is shown
  - **shutdownMode** `integer`: Execution mode: 1=Forced, 2=Graceful

### Possible Response Codes

- **200** `HTTP code`

### Sample Response: HTTP 200

```json
{
  "shutdownMessageTitle": "System Shutdown",
  "shutdownTimeout": 300,
  "operationType": 2,
  "shutdownMessage": "System will shutdown for maintenance.",
  "shutdownMode": 1
}
```

## 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.