# Create a new add-on entry

Creates a new add-on in the inventory and returns its details.

## Endpoint

**POST** `/bsp/api/v1/bmp/addons`

## Request

### Request URL

```text
https://{server-hostname}:8383/bsp/api/v1/bmp/addons
```

### Scope

```text
BrowserManager.CREATE
```

### Header

```text
Authorization: d92d4xxxxxxxxxxxxx15f52
```

### Request Parameters

#### Request Headers

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

#### Request Body

JSON body with addon identifier and browser type. For extensions, provide the webstore ID. For plugins, provide the CLSID/GUID.

`application/json`

- `JSON Object`
  - **id** `string` — Optional
    - Addon identifier. For extensions: the webstore ID. For plugins: the CLSID/GUID in curly braces
  - **browser_type** `string` — Optional
    - Browser type code. 1=Chrome, 2=Firefox, 3=Internet Explorer, 5=Chromium Edge, 31=Ulaa, 1024=Other Chromium

### Sample Request

```curl
curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/addons \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"browser_type":1,"id":"cjpalhdlnbpafiamejdnhcphjbkeiagm"}'
```

### Sample Request Body

#### Chrome extension (browser_type=1)

```json
{
  "browser_type": 1,
  "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm"
}
```

#### Firefox extension (browser_type=2)

```json
{
  "browser_type": 2,
  "id": "uBlock0@raymondhill.net"
}
```

#### Chromium Edge extension (browser_type=5)

```json
{
  "browser_type": 5,
  "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm"
}
```

#### Ulaa extension (browser_type=31)

```json
{
  "browser_type": 31,
  "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm"
}
```

#### Other Chromium extension (browser_type=1024)

```json
{
  "browser_type": 1024,
  "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm"
}
```

#### IE plugin by CLSID (browser_type=3)

```json
{
  "browser_type": 3,
  "id": "{CAFEEFAC-0018-0000-FFFF-ABCDEFFEDCBA}"
}
```

## Response Parameters

### HTTP Code 200

Response Body — `application/json`

- `JSON Object`
  - **extension_group_id** `string`
    - Unique identifier for the extension group
  - **browser_type** `string`
    - Browser type code. 1=Chrome, 2=Firefox, 3=Internet Explorer, 5=Chromium Edge, 31=Ulaa, 1024=Other Chromium
  - **binary_id** `string`
    - Unique binary ID used as the universal addon reference
  - **id** `string`
    - Addon webstore identifier (e.g., Chrome extension ID)
  - **customer_id** `string`
    - Customer identifier
  - **binary_type** `string`
    - Type of the binary. Only present on first creation

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

### HTTP Code 403

Response Body — `application/json`

- `JSON Object`
  - **errorCode** `long`
    - Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
  - **errorMsg** `string`
    - Message indicating insufficient privileges to access this resource

### HTTP Code 429

Response Body — `application/json`

- `JSON Object`
  - **errorCode** `long`
    - Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes
  - **errorMsg** `string`
    - Rate limit exceeded message with retry guidance

### HTTP Code 500

Response Body — `application/json`

- `JSON Object`
  - **error_description** `string`
    - Message describing the internal server error
  - **error_code** `string`
    - Error code identifying the type of server error

### Possible Response Codes

- **200** — HTTP code
- **401** — HTTP code
- **403** — HTTP code
- **429** — HTTP code
- **500** — HTTP code

### Sample Response: HTTP 200

#### Created Chrome extension

```json
{
  "extension_group_id": "100",
  "browser_type": "1",
  "binary_id": "100",
  "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm",
  "customer_id": "2",
  "binary_type": "7"
}
```

#### Created Firefox extension

```json
{
  "extension_group_id": "101",
  "browser_type": "2",
  "binary_id": "101",
  "id": "uBlock0@raymondhill.net",
  "customer_id": "2",
  "binary_type": "7"
}
```

#### Created Chromium Edge extension

```json
{
  "extension_group_id": "102",
  "browser_type": "5",
  "binary_id": "102",
  "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm",
  "customer_id": "2",
  "binary_type": "7"
}
```

#### Created Ulaa extension

```json
{
  "extension_group_id": "338",
  "browser_type": "31",
  "binary_id": "338",
  "id": "oeopbcgkkoapgobdbedcemjljbihmemj",
  "customer_id": "1",
  "binary_type": "7"
}
```

#### Created Other Chromium extension

```json
{
  "extension_group_id": "103",
  "browser_type": "1024",
  "binary_id": "103",
  "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm",
  "customer_id": "2",
  "binary_type": "7"
}
```

### Sample Response: HTTP 401

#### Unauthorized

```json
{
  "errorCode": "UNAUTHORIZED",
  "errorMsg": "You are not authorized to perform this action"
}
```

### Sample Response: HTTP 403

#### Insufficient permissions

```json
{
  "errorCode": "FORBIDDEN",
  "errorMsg": "You do not have permission to access this resource"
}
```

### Sample Response: HTTP 429

#### Rate limit exceeded

```json
{
  "errorCode": "RATE_LIMIT_EXCEEDED",
  "errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
}
```

### Sample Response: HTTP 500

#### Server error

```json
{
  "error_description": "Internal Server error, Please try again in a moment.",
  "error_code": "COM0004"
}
```

## Rate Limiting

![Help](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**Duration:** 1 minute | **Threshold:** 60 | **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.