# List native messaging hosts

Retrieves all configured native messaging hosts.

## Endpoint

`GET /bsp/api/v1/bmp/nativehost`

## Request URL

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

## 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/nativehost \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP Code 200

#### Response Body: `application/json`

`JSON Object`

- **native-hosts** (`JSON Array`): Native messaging hosts configured for browser communication, showing their ID and hostname

### HTTP Code 400

#### Response Body: `application/json`

`JSON Object`

- **error_description** (`string`): Message indicating the requested range limit is out of the allowed range
- **error_code** (`string`): Error code identifying the type of bad request

### 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
- `400` — HTTP code
- `401` — HTTP code
- `403` — HTTP code
- `429` — HTTP code
- `500` — HTTP code

## Sample Response: HTTP 200

### All hosts

```json
{
  "native-hosts": [
    {
      "name": "com.example.nativehost",
      "id": "1"
    },
    {
      "name": "com.google.chrome.remote",
      "id": "2"
    }
  ]
}
```

### Paginated result with next page link

```json
{
  "native-hosts": [
    {
      "name": "com.example.nativehost",
      "id": "1"
    }
  ],
  "paging": {
    "next": "<server-url>/api/v1/bmp/nativehost?skip-token=eyJ0eXBlIjoic2tpcCJ9"
  }
}
```

### Search filter

```json
{
  "native-hosts": [
    {
      "name": "com.google.chrome.remote",
      "id": "2"
    }
  ]
}
```

## Sample Response: HTTP 400

### Limit out of range

```json
{
  "error_description": "Range limit exceeded. Maximum allowed: 1000",
  "error_code": "ARRAY_SIZE_OUT_OF_RANGE"
}
```

## Sample Response: HTTP 401

### Unauthorized

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

## Sample Response: HTTP 403

### Forbidden

```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"
}
```

![ ](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.