# List native messaging hosts

Retrieves all configured native messaging hosts.

## Endpoint

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

## Request

### Request URL

`https://`[*{serverurl}*](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)`/bsp/api/v1/bmp/nativehost`

### Scope

`DesktopCentralCloud.BrowserManager.READ`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

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

#### Query Parameters

- **search_bsp** `string` — Optional
  - Search string to filter native hosts by URL or hostname (contains match). Example: 'com.company', 'chrome.extension', 'messaging'
- **limit** `integer` — Optional
  - Max results per page. Example: 50, 100, 200
- **offset** `integer` — Optional
  - Starting index for results (0-based). Example: 0, 50, 100
- **skip-token** `string` — Optional
  - Cursor-based pagination token returned from previous response for fetching next page

### Sample Request

```curl
curl --request GET \
  --url https://appdomains/bsp/api/v1/bmp/nativehost \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  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

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

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

### Sample Response: HTTP 400

#### Limit out of range

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

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

### Sample Response: HTTP 401

#### Unauthorized

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

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

### Sample Response: HTTP 403

#### Forbidden

```json
{
  "errorCode": "FORBIDDEN",
  "errorMsg": "You do not have permission 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

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

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

### Sample Response: HTTP 500

#### Server error

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

## Rate Limit

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