List add-on management profiles

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 add-on management profiles.

Request URL

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

Scope

DesktopCentralCloud.BrowserManager.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

publishedbooleanOptional

Optional. Set to true to return only published profiles

limitintegerOptional

Optional. Maximum number of profiles to return per page. Used for pagination

offsetintegerOptional

Optional. Number of profiles to skip before starting to return results. Used for pagination

skip-tokenstringOptional

Optional. Token for pagination to retrieve the next set of results

trashbooleanOptional

Optional. Set to true to include trashed (deleted) profiles in results

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/bsp/api/v1/bmp/manage_addons \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
manage_addonsJSON Array

Add-on management profile summaries

Show Sub-Attributes
JSON Object
Show Sub-Attributes
manage_addon_namestring

Profile display name

profiletypestring

Profile type identifier

profilestatusstring

Profile status. 110=Published, 1=Draft

manage_addon_idstring

Unique profile identifier

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

Message describing the internal server error

Possible Response Codes

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

Sample Response: HTTP 200

List of profiles (summary only)

Copied!
  {
    "manage_addons": [
      {
        "manage_addon_name": "AddonPolicy 13",
        "profiletype": "64025",
        "profilestatus": "1",
        "manage_addon_id": "609"
      },
      {
        "manage_addon_name": "AddonPolicy 12",
        "profiletype": "64025",
        "profilestatus": "1",
        "manage_addon_id": "611"
      },
      {
        "manage_addon_name": "TestAddon_Renamed",
        "profiletype": "64025",
        "profilestatus": "110",
        "manage_addon_id": "993"
      }
    ]
  }
                
Show full

No profiles exist

Copied!
  {
    "manage_addons": []
  }
                
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

Insufficient permissions

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "User does not have permission to perform this operation"
  }
                
Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "Too many requests. Please try again after 5 minutes"
  }
                
Show full

Sample Response: HTTP 500

Server error

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

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.