Get a configuration profile's full details
Retrieves the full details of a configuration profile, including its metadata and payload configurations.
Endpoints
get /bsp/api/v1/bmp/profiles/{profile_id}
Copy full URL
Request URL
https://{server-hostname}:8383/bsp/api/v1/bmp/profiles/{profile_id}
Scope
BrowserManager.READCopied!
Header
Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters
- Request Headers
AcceptstringMandatoryapplication/jsonapplication/jsonCopied!
- Path Parameters
profile_idstringMandatory
Retrieve the configuration profile ID from the profileid key in the response returned by List Configuration Profiles
Sample Request
Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
--url https://appdomain/bsp/api/v1/bmp/profiles/{profile_id} \
--header 'Accept: application/json' \
--header 'Authorization: d92d4xxxxxxxxxxxxx15f52'Response Parameters
- HTTP code 200
Response Body - application/json
JSON Object
Full configuration profile details including metadata, version info, and associated payloads
Hide Sub-Attributes
profile_idstring
Profile ID
profile_namestring
Display name
profile_descriptionstring
Description
profile_typestring
Profile type code. 64100=Browser Customization, 64005=File Activity, 64011=Browser Router, 64050=Web Isolation, 64200=Threat Prevention, 64201=Data Leakage Prevention, 64210=Browser Lockdown, 64500=Compliance, 64510=Default Extension, 64950=URL Filter, 64960=Managed Browser
scopestring
'0'=Device, '1'=User
is_moved_to_trashboolean
In trash
collection_idstring
Collection reference ID
platform_typestring
'1'=Windows, '2'=Mac, '-1'=All platforms (Windows + Mac)
latest_versionstring
Latest version (increments on modify)
latest_published_versionstring
Latest published version, or '--' if never published
payloadsJSON Array
Associated payload configurations
Show Sub-Attributes
JSON Object
Individual payload configuration item returned in profile responses
Show Sub-Attributes
config_namestring
Internal config name (config_label in Add/Modify responses)
payload_typestring
Payload type code. 64200=Threat, 64201=DLP, 64151=Web Isolation, 64210=Browser Lockdown, 64950=URL Filter, 64960=Managed Browser, 64025=Add-on, 64011=Browser Router, 64012=Java Rules, 64800=Content Restriction, 64801=Upload Restriction
payload_idstring
Payload instance ID
- 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 returned when authentication credentials are missing, expired, or invalid (authentication=required)
errorMsgstring
Authentication failure reason
- HTTP code 403
Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong
Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
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 threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes
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
Threat Prevention profile
Copied!
{
"collection_id": "222",
"profile_name": "ThreatPreventionPolicy 19",
"profile_type": "64200",
"platform_type": "1",
"latest_version": "1",
"is_moved_to_trash": false,
"payloads": [
{
"config_name": "THREAT_PREVENTION",
"payload_type": "64200",
"phishing": "-1",
"invalid_signature_activex": "-1",
"payload_id": "622",
"third_party_blocking_enabled": "-1",
"safebrowsing_trusted_sources": "-1",
"zone_elevation": "-1",
"flash_restriction": "-1",
"certificate_revocation": "-1",
"block_bho": "-1",
"allow_ie_scripting": "-1",
"ie_plugin_active_x": "-1",
"abusive_experience_intervention": "-1",
"download_restriction": "-1",
"certificate_ensurance": "0",
"ads_setting_intrusive_sites": "-1"
}
],
"profile_id": "111",
"scope": "0",
"latest_published_version": "--",
"profile_description": ""
}
▼ Show full
File Activity Restriction profile with download and upload payloads
Copied!
{
"collection_id": "222",
"profile_name": "FileActivity Test API",
"profile_type": "64005",
"platform_type": "-1",
"latest_version": "1",
"is_moved_to_trash": false,
"payloads": [
{
"config_name": "CONTENT_RESTRICTION_PAYLOAD",
"payload_type": "64800",
"payload_id": "1021",
"custom_mail_id": "--",
"custom_message": "--",
"exclude_rules_json": {
"sites": [
{
"name": "www.google.com",
"id": "304",
"type": "4"
}
],
"site_groups": []
},
"all_condition_match": true,
"rules_json": {
"rule_2": {
"enable": "1",
"rule_value": {
"file_types": [
{
"file_type": "pdf",
"file_type_id": "1"
}
]
},
"range": "1",
"type": "3",
"greater": "0"
},
"rule_1": {
"enable": "1",
"rule_value": {
"sites": [
{
"id": "7",
"type": "2",
"url": "www.youtube.com"
},
{
"id": "304",
"type": "2",
"url": "www.google.com"
}
]
},
"range": "1",
"type": "2",
"greater": "0"
},
"rule_4": {
"enable": "1",
"rule_value": [
"09:00:00",
"17:00:00"
],
"range": "1",
"type": "1",
"greater": "0"
},
"rule_3": {
"enable": "1",
"rule_value": {
"file_size": "1048576"
},
"range": "1",
"type": "4",
"greater": "1"
},
"rule_execution_order": "(RULE_1 & RULE_2 & RULE_3 & RULE_4)"
},
"message_type": "0",
"whitelisted": "0",
"custom_logo_path": "--"
},
{
"config_name": "UPLOAD_RESTRICTION_PAYLOAD",
"payload_type": "64801",
"payload_id": "1025",
"custom_mail_id": "--",
"custom_message": "--",
"exclude_rules_json": {
"sites": [],
"site_groups": []
},
"all_condition_match": true,
"rules_json": {
"rule_2": {
"enable": "0",
"rule_value": {
"file_types": [
{
"file_type": "pdf",
"file_type_id": "1"
}
]
},
"range": "1",
"type": "3",
"greater": "0"
},
"rule_1": {
"enable": "0",
"rule_value": {
"sites": {
"id": "7",
"type": "2",
"url": "www.youtube.com"
}
},
"range": "1",
"type": "2",
"greater": "0"
},
"rule_4": {
"enable": "1",
"rule_value": [
"09:00:00",
"17:00:00"
],
"range": "1",
"type": "1",
"greater": "0"
},
"rule_3": {
"enable": "0",
"rule_value": {
"file_size": "2097152"
},
"range": "1",
"type": "4",
"greater": "1"
},
"rule_execution_order": "(RULE_1 & RULE_2 & RULE_3 & RULE_4)"
},
"message_type": "0",
"whitelisted": "0",
"custom_logo_path": "--"
}
],
"profile_id": "111",
"scope": "0",
"latest_published_version": "--",
"profile_description": "Test FA via API"
}
▼ Show full
Browser Restriction profile
Copied!
{
"collection_id": "222",
"profile_name": "Browser Restriction Policy",
"profile_type": "64960",
"platform_type": "1",
"latest_version": "1",
"is_moved_to_trash": false,
"payloads": [
{
"config_name": "MANAGED_BROWSER",
"payload_type": "64960",
"payload_id": "1176",
"browser_permission": "1",
"browsers": [
{
"name": "Google Chrome",
"id": "1"
},
{
"name": "Mozilla Firefox",
"id": "2"
},
{
"name": "Microsoft Edge",
"id": "5"
}
]
}
],
"profile_id": "111",
"scope": "0",
"latest_published_version": "1",
"profile_description": "Allow only approved browsers"
}
▼ Show full
Web Isolation profile
Copied!
{
"collection_id": "222",
"profile_name": "Web Isolation Policy",
"profile_type": "64050",
"platform_type": "1",
"latest_version": "1",
"is_moved_to_trash": false,
"payloads": [
{
"config_name": "WEB_ISOLATION",
"payload_type": "64151",
"payload_id": "2309",
"proxy_range": "10.0.0.0/8",
"defender_app_gaurd_id": "312",
"sites": [
{
"name": "www.google.com",
"id": "304",
"type": "webdomain"
},
{
"name": "www.youtube.com",
"id": "7",
"type": "webdomain"
},
{
"name": "www.bing.com",
"id": "308",
"type": "webdomain"
}
],
"allow_session_persistence": "0",
"prevent_non_ent_in_ent": "1"
}
],
"profile_id": "111",
"scope": "0",
"latest_published_version": "--",
"profile_description": "Isolate enterprise sites in Application Guard"
}
▼ Show full
Sample Response: HTTP 400
Invalid profile ID in the request path
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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.