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

To create Mac Firmware password policy

## Endpoints

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

## Request URL

```
https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/macfirmwarepassword
```

## Scope

```
MDMOnDemand.MDMDeviceMgmt.CREATE
```

## Header

```
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
```

## Request Parameters

### Path Parameters

- **profile_id** (string) — **Mandatory**  
  Unique identifier of the profile. Obtain from the [Create Profile](https://www.manageengine.com/mobile-device-management/help/api/cloud/profiles-create-profile.html) or [Get Profiles](https://www.manageengine.com/mobile-device-management/help/api/cloud/profiles-get-profile.html) response

### Query Parameters

- **t** (long) — Optional
- **ignoreHeader** (boolean) — Optional
- **qlt** (long) — Optional
- **previousTab** (string) — Optional
- **service** (string) — Optional
- **search** (string) — Optional  
  Free-text search string applied to the default searchable fields of the resource
- **all** (boolean) — Optional
- **dc_customerid** (long) — Optional
- **mdm_instance** (string) — Optional
- **signupsrc** (string) — Optional
- **zaaid** (string) — Optional
- **command** (string) — Optional
- **orderby** (string) — Optional
- **sortorder** (string) — Optional
- **select_all** (boolean) — Optional  
  When true, applies the operation to every record matching the current filter rather than to specific IDs. Default: false
- **zoho-internal** (boolean) — Optional
- **dc_instance** (string) — Optional
- **SUBREQUEST** (string) — Optional
- **source** (string) — Optional
- **nocache** (long) — Optional  
  param to avoid being served from cache
- **wms_csrparam** (string) — Optional  
  CSRF Token

### Request Body

**Content-Type:** `application/json`

- **firmware_password_type** (integer) — **Mandatory**  
  Firmware password mode. Allowed values:  
  `1` = Set static password  
  `2` = Set dynamic password  
  `3` = Turn Off Firmware password
- **firmware_new_password** (string) — Optional  
  Firmware New Password
- **firmware_old_password** (string) — Optional  
  Firmware Old Password

## Sample Request

### Curl

```bash
curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macfirmwarepassword \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"firmware_password_type":1}'
```

### Java

```java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macfirmwarepassword"))
        .header("content-type", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"firmware_password_type\":1}"))
        .build();
    HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());

  }
}
```

### Python

```python
import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"firmware_password_type\":1}"

headers = {
    'content-type': "application/json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/macfirmwarepassword", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

### Deluge

```javascript
headersMap = Map();
headersMap.put("Content-Type", "application/json");
headersMap.put("Accept", "application/json");

data=Map();
data.put("firmware_password_type","1");

response = invokeUrl
[
    url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/macfirmwarepassword"
    type: POST
    headers: headersMap
    body: data
    connection: connection_name
]

info response;
```

### PowerShell

```powershell
$headers=@{}
$headers.Add("content-type", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/macfirmwarepassword' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"firmware_password_type":1}'
```

## Sample Request Body

Add Firmware Password payload to the profile

```json
{
  "firmware_old_password": "********",
  "firmware_password_type": 1,
  "firmware_new_password": "********"
}
```

## Response Parameters

### HTTP 200

**Response Body:** `application/json`

- **payload_id** (long)  
  Unique identifier for the created payload item
- **firmware_password_type** (integer)  
  Firmware password mode. Allowed values:  
  `1` = Set static password  
  `2` = Set dynamic password  
  `3` = Turn Off Firmware password
- **firmware_new_password** (string)  
  Firmware New Password
- **firmware_old_password** (string)  
  Firmware Old Password

## Sample Response: HTTP 200

Firmware Password payload successfully added

```json
{
  "payload_id": 9007199254741000,
  "firmware_old_password": "********",
  "firmware_password_type": 1,
  "firmware_new_password": "********"
}
```

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