List configuration 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 configuration profiles along with their basic metadata and publish status.

Endpoints

Request URL

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

Scope

DesktopCentralCloud.BrowserManager.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

searchstringOptional

Filter profiles by name (contains match). Example: 'corporate', 'finance', 'security'

publishedbooleanOptional

Filter by published status. Values: true (only published/active profiles), false (only draft profiles)

typestringOptional

Filter by profile type ID. Comma-separated for multiple types. Common values: 64005 (Browser Customization), 64600 (Security), 64700 (Privacy), 64800 (Download Filter), 64900 (Upload Filter), 64950 (URL Filter). Example: '64005' or '64005,64600'

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

platform_typestringOptional

Platform filter. Values: '1' (Windows only), '2' (Mac only), '-1' (all platforms)

trashbooleanOptional

Filter by trash status. Values: true (only trashed/deleted profiles), false (only active profiles, default)

Sample Request

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

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object

List of configuration profiles

Hide Sub-Attributes
profilesJSON Array

Configuration profiles with name, type, status, platform, and browser details

Show Sub-Attributes
JSON Object

Summary of a configuration profile in a list response

Show Sub-Attributes
profileidstring

Profile ID

profilenamestring

Display name

profiletypestring

Profile type code. See profileDetailResponse.profile_type

platform_typestring

'1'=Windows, '2'=Mac, '-1'=All platforms (Windows + Mac)

profilestatusstring

'110'=Published, '1'=Draft

pagingJSON Object

Pagination. Contains 'next' URL with skip-token when more results exist

Show Sub-Attributes

- HTTP code 400

Response Body - application/json
JSON Object

Bad request error for invalid input or constraint violations

Hide Sub-Attributes
errorcodestring

Error code identifying the specific validation failure

errormsgstring

Message describing the validation failure

- 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

Internal server error response for profile operations

Hide Sub-Attributes
error_descriptionstring

Error message describing the server failure

error_codestring

Error code for internal server errors

Possible Response Codes

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

Sample Response: HTTP 200

List of configuration profiles with pagination

Copied!
  {
    "profiles": [
      {
        "platform_type": "1",
        "profiletype": "64960",
        "profilestatus": "1",
        "profileid": "111",
        "profilename": "ManagedbrowserPolicy 15"
      },
      {
        "platform_type": "1",
        "profiletype": "64200",
        "profilestatus": "1",
        "profileid": "111",
        "profilename": "ThreatPreventionPolicy 19"
      }
    ],
    "paging": {
      "next": "<server-url>/api/v1/bmp/profiles?skip-token=NTA6NTE6MToxNzc2MTY1MDg0Nzk3"
    }
  }
                
Show full

No matching profiles found

Copied!
  {
    "profiles": []
  }
                
Show full

Sample Response: HTTP 400

Pagination parameters out of allowed range

Copied!
  {
    "errorcode": "IAM0003",
    "errormsg": "Invalid request."
  }
                
Show full

Sample Response: HTTP 401

API key is missing or invalid

Copied!
  {
    "errorCode": "IAM0001",
    "errorMsg": "Authentication key is invalid. Please regenerate the key and try again."
  }
                
Show full

Sample Response: HTTP 403

Forbidden

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!
  {
    "error_description": "Internal Server error, Please try again in a moment.",
    "error_code": "COM0004"
  }
                
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.