# List browser add-ons

Retrieves all registered add-ons, including extensions and plugins.

## Endpoint

`GET /bsp/api/v1/bmp/addons`

## Request

### Request URL

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

### Scope

`BrowserManager.READ`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Accept** `string` (Mandatory): `application/json`

### Sample Request

```curl
curl --request GET \
  --url https://appdomain/bsp/api/v1/bmp/addons \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP 200

Response Body — `application/json`

- `JSON Object`
  - **paging** `JSON Object`: Pagination metadata containing navigation URLs for next and previous pages
  - **addons** `JSON Array`: Addon records (extensions and/or plugins) for the current page

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

### HTTP 200

#### Paginated extension list

```json
{
  "addons": [
    {
      "browser_type": "1",
      "name": "uBlock Origin",
      "binary_id": "100",
      "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm"
    },
    {
      "browser_type": "5",
      "name": "MoveTab",
      "binary_id": "48",
      "id": "ebldafnijcbblaaabcehdamipojmicmg"
    },
    {
      "browser_type": "1024",
      "name": "Dark Reader",
      "binary_id": "103",
      "id": "eimadpbcbfnmbkopoojfekhnkhdbieeh"
    }
  ],
  "paging": {
    "next": "<server-url>/bsp/api/v1/bmp/addons?skip-token=NTA6LTQ4OjI6MTc3NTQ1NTc5NjY5Ng%3D%3D"
  }
}
```

#### Paginated plugin list

```json
{
  "addons": [
    {
      "name": "Java Plugin",
      "binary_id": "104",
      "id": "{CAFEEFAC-0018-0000-FFFF-ABCDEFFEDCBA}",
      "type": 100
    }
  ]
}
```

#### Empty result

```json
{
  "addons": []
}
```

### HTTP 401

#### Unauthorized

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

### HTTP 403

#### Insufficient permissions

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

### HTTP 429

#### Rate limit exceeded

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

### HTTP 500

#### Server error

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

## Rate Limits

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

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