Update a compliance profile

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

Updates an existing compliance profile's name, description, or rules.

Request URL

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

Scope

DesktopCentralCloud.BrowserManager.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

compliance_idstringMandatory

Compliance profile ID from List Compliance Profiles response (profileid field)

- Request Body

application/json
JSON Object
Hide Sub-Attributes
profile_namestringOptional

Name of the compliance profile. Maximum 50 characters.

profile_descriptionstringOptional

Description of the compliance profile. Maximum 100 characters.

rule_idsarrayOptional

Compliance rule IDs from List All Compliance Rules response (rule_id field) to attach to the profile. Accepts 1 to 50 rule IDs.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomains/bsp/api/v1/bmp/compliance/{compliance_id}/profiles \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

Sample Request Body

Modify profile with rule IDs from List All Compliance Rules response (rule_id field)

Copied!
  {
    "profile_name": "Chrome Security Baseline",
    "rule_ids": [
      351,
      357,
      362,
      367,
      377
    ],
    "profile_description": "Baseline compliance for Chrome browsers"
  }
                
Show full

Response Parameters

- HTTP code 200

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

Collection ID associated with this profile version

profile_namestring

Name of the compliance profile

compliance_detailsJSON Object

Compliance details including attached rule IDs and compliance ID

Show Sub-Attributes
rule_idsarray

Compliance rule IDs from List All Compliance Rules response (rule_id field) attached to this profile

compliance_idstring

Internal compliance ID associated with this profile

profile_typestring

Profile type code. 64500=Custom, 64501=STIG, 64502=CIS

latest_versionstring

Latest version number of this profile

is_moved_to_trashboolean

Whether the profile has been moved to trash. false indicates active

profile_idstring

Unique identifier of the compliance profile

scopestring

Scope of the profile. 0 indicates organization-wide

latest_published_versionstring

Latest published version number of this profile

profile_descriptionstring

Description of the compliance profile

- 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

Possible Response Codes

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

Returns 500 with no response body when an invalid compliance_id is provided.

Sample Response: HTTP 200

Profile modified

Copied!
  {
    "collection_id": "222",
    "profile_name": "Chrome Security Baseline",
    "compliance_details": {
      "rule_ids": [
        351,
        357,
        362,
        367,
        377
      ],
      "compliance_id": "303"
    },
    "profile_type": "64500",
    "latest_version": "1",
    "is_moved_to_trash": false,
    "profile_id": "111",
    "scope": "0",
    "latest_published_version": "1",
    "profile_description": "Baseline compliance for Chrome browsers"
  }
                
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

Copied!
500 Returns 500 with no response body when an invalid compliance_id is provided.
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.