List native messaging hosts

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Retrieves all configured native messaging hosts.

Endpoints

Request URL

https://{serverurl}/bsp/api/v1/bmp/nativehost

Scope

DesktopCentralCloud.BrowserManager.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

search_bspstringOptional

Search string to filter native hosts by URL or hostname (contains match). Example: 'com.company', 'chrome.extension', 'messaging'

limitintegerOptional

Max results per page. Example: 50, 100, 200

offsetintegerOptional

Starting index for results (0-based). Example: 0, 50, 100

skip-tokenstringOptional

Cursor-based pagination token returned from previous response for fetching next page

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
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
Hide Sub-Attributes
native-hostsJSON Array

Native messaging hosts configured for browser communication, showing their ID and hostname

Show Sub-Attributes
JSON Object
Show Sub-Attributes
idstring

Unique identifier for the native messaging host

namestring

Native messaging host identifier string (e.g., com.example.nativehost)

- HTTP code 400

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_descriptionstring

Message indicating the requested range limit is out of the allowed range

error_codestring

Error code identifying the type of bad request

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 403

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Error code indicating insufficient permissions

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 429

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Rate limit error code returned when the API call reached threshold

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

Response Body - application/json
JSON Object
Hide Sub-Attributes
error_descriptionstring

Message describing the internal server error

error_codestring

Error code identifying the type of server error

Possible Response Codes

200HTTP code
400HTTP code
401HTTP code
403HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 200

All hosts

Copied!
  {
    "native-hosts": [
      {
        "name": "com.example.nativehost",
        "id": "1"
      },
      {
        "name": "com.google.chrome.remote",
        "id": "2"
      }
    ]
  }
                
Show full

Paginated result with next page link

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

Search filter

Copied!
  {
    "native-hosts": [
      {
        "name": "com.google.chrome.remote",
        "id": "2"
      }
    ]
  }
                
Show full

Sample Response: HTTP 400

Limit out of range

Copied!
  {
    "error_description": "Range limit exceeded. Maximum allowed: 1000",
    "error_code": "ARRAY_SIZE_OUT_OF_RANGE"
  }
                
Show full

Sample Response: HTTP 401

Unauthorized

Copied!
  {
    "errorCode": "UNAUTHORIZED",
    "errorMsg": "You are not authorized to perform this action"
  }
                
Show full

Sample Response: HTTP 403

Forbidden

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "You do not have permission to access this resource"
  }
                
Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
  }
                
Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "error_description": "Internal Server error, Please try again in a moment.",
    "error_code": "COM0004"
  }
                
Show full

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.