# Add a new Firmware Password payload configuration to an existing profile

To create Mac Firmware password policy

## Endpoint

**POST** `/api/v1/mdm/profiles/{profile_id}/payloads/macfirmwarepassword`

## Request

### Request URL

```text
https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/macfirmwarepassword
```

### Scope

```text
MDMDeviceMgmt.CREATE
```

### Header

```text
Authorization: d92d4xxxxxxxxxxxxx15f52
```

### Request Parameters

#### Request Headers

| Parameter | Type | Required | Value |
|---|---|---|---|
| Content-Type | string | Mandatory | application/json |
| Accept | string | Mandatory | application/json |

#### Path Parameters

| Parameter | Type | Required | Description |
|---|---|---|---|
| profile_id | string | Mandatory | Unique identifier of the profile. Obtain from the [Create Profile](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-profiles-create-profile.html) or [Get Profiles](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-profiles-get-profile.html) response |

#### Request Body

`application/json`

| Attribute | Type | Required | Description |
|---|---|---|---|
| firmware_password_type | integer | Mandatory | Firmware password mode. Allowed values: 1=Static Password, 2=Dynamic Password, 3=Turn Off firmware Password |
| firmware_new_password | long | Mandatory | Managed password ID for the new firmware/recovery lock password. Create the password first using the [Add Managed Password](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mac-add-managed-password.html) and use the returned managed_password_id |
| firmware_old_password | long | Optional | Managed password ID for the current firmware/recovery lock password (required when changing an existing password). Create using the [Add Managed Password](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mac-add-managed-password.html) |

### Sample Request

```curl
curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macfirmwarepassword \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"firmware_password_type":1,"firmware_new_password":6967000001030042}'
```

### Sample Request Body

Add Firmware Password payload to the profile

```json
{
  "firmware_password_type": 1,
  "firmware_new_password": 6967000001030042
}
```

## Response

### Response Parameters

#### HTTP Code 200

Response Body: `application/json`

| Attribute | Type | Description |
|---|---|---|
| payload_id | long | Unique identifier for the created payload item |
| firmware_password_type | string | Firmware password mode. Values: 1=Static Password, 2=Dynamic Password, 3=Turn Off firmware Password |
| firmware_new_password | string | Managed password ID of the new firmware/recovery lock password that was set |

### Sample Response: HTTP 200

Firmware Password payload successfully added

```json
{
  "payload_id": 6967000001030044,
  "firmware_password_type": "1",
  "firmware_new_password": "6967000001030042"
}
```

### Possible Response Codes

| Code | Type |
|---|---|
| 200 | HTTP code |

## Rate Limit

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