# Configure a new Windows Lockdown (Kiosk) Policy

Store Windows Kiosk payload's Meta Data

## Endpoint

**POST** `/api/mdm/profiles/lockdown`

## Request

### Request URL

```text
https://{server-hostname}:8383/api/mdm/profiles/lockdown
```

### Scope

```text
MDMDeviceMgmt.CREATE
```

### Header

```text
Authorization: d92d4xxxxxxxxxxxxx15f52
```

### Request Parameters

#### Request Headers

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

#### Request Body

`application/json`

- `JSON Object`
  - **policy_name** `string` — **Mandatory**
    - Name of the lockdown policy
  - **policy_desc** `string` — Optional
    - Description for the lockdown policy
  - **allowed_apps** `JSON Array` — Optional
    - List of apps allowed in Kiosk mode
  - **configuration** `JSON Object` — Optional
    - Configuration settings for the lockdown policy

## Sample Request

### Curl

```curl
curl --request POST \
  --url https://appdomain/api/mdm/profiles/lockdown \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"policy_desc":"test desc","configuration":{"show_taskbar":true,"auto_distribute_apps":true,"auto_logon_app":"Microsoft.WindowsCamera_8wekyb3d8bbwe!App","kiosk_type":"1","create_user":true,"associated_user":"Kiosk","explorer_restriction":"5"},"allowed_apps":[{"app_type":"1","app_identifier":"Microsoft.WindowsCamera_8wekyb3d8bbwe!App","is_background_app":false},{"app_type":"2","app_identifier":"%windir%\\system32\\calc.exe","is_background_app":false},{"app_type":"2","app_identifier":"%windir%\\system32\\cmd.exe","is_background_app":true}],"policy_name":"test lockdown policy"}'
```

## Sample Request Body

### Create a Windows Lockdown (Multi App Kiosk) Policy

```json
{
  "policy_desc": "test desc",
  "configuration": {
    "show_taskbar": true,
    "auto_distribute_apps": true,
    "auto_logon_app": "Microsoft.WindowsCamera_8wekyb3d8bbwe!App",
    "kiosk_type": "1",
    "create_user": true,
    "associated_user": "Kiosk",
    "explorer_restriction": "5"
  },
  "allowed_apps": [
    {
      "app_type": "1",
      "app_identifier": "Microsoft.WindowsCamera_8wekyb3d8bbwe!App",
      "is_background_app": false
    },
    {
      "app_type": "2",
      "app_identifier": "%windir%\\system32\\calc.exe",
      "is_background_app": false
    },
    {
      "app_type": "2",
      "app_identifier": "%windir%\\system32\\cmd.exe",
      "is_background_app": true
    }
  ],
  "policy_name": "test lockdown policy"
}
```

### Create a Single App Profile

```json
{
  "policy_desc": "test desc",
  "configuration": {
    "kiosk_type": "2",
    "create_user": true,
    "associated_user": "Kiosk"
  },
  "allowed_apps": [
    {
      "app_type": "1",
      "app_identifier": "Microsoft.WindowsCalculator_8wekyb3d8bbwe!App",
      "is_background_app": false
    }
  ],
  "policy_name": "test lockdown policy"
}
```

### Create a Single App Edge Kiosk Profile

```json
{
  "policy_desc": "test desc",
  "configuration": {
    "kiosk_type": "3",
    "create_user": true,
    "associated_user": "Kiosk",
    "edge_configuration": {
      "edge_kiosk_type": "1",
      "home_page_urls": [
        {
          "home_page_url_id": "1"
        }
      ],
      "edge_idle_timeout": 0
    }
  },
  "allowed_apps": [
    {
      "app_type": "2",
      "app_identifier": "%ProgramFiles(x86)%\\Microsoft\\Edge\\Application\\msedge.exe",
      "is_background_app": false
    }
  ],
  "policy_name": "test lockdown policy"
}
```

## Response Parameters

### HTTP Code 200

Response Body — `application/json`

- `JSON Object`
  - **policy_id** `string`
    - Unique ID of the newly created lockdown policy
  - **policy_name** `string`
    - Name of the created lockdown policy

## Possible Response Codes

- **200** — HTTP code

## Sample Response: HTTP 200

### Lockdown policy successfully created

```json
{
  "policy_id": "9007199254741005",
  "policy_name": "test lockdown policy"
}
```

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