Modify an existing CIS compliance policy group

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

Modifies an existing custom CIS compliance policy group, updating its name and replacing the associated benchmark profiles

Request URL

https://{serverurl}/dcapi/scap/compliance/policygroups/{policyGrpId}

Scope

DesktopCentralCloud.VulnerabilityMgmt.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/editPolicyGrp.v1+jsonapplication/editPolicyGrp.v1+jsonCopied!
AcceptstringMandatory
application/editPolicyGrp.v1+jsonapplication/editPolicyGrp.v1+jsonCopied!

- Path Parameters

policyGrpIdstringMandatory

The ID of the policy group to delete. Fetch from List Policy Groups

- Request Body

application/json
JSON Object
Hide Sub-Attributes
profilesJSON ArrayOptional

List of CIS benchmark profile objects to associate with the policy group. Fetch available profiles from Get Profiles List for Platform

Show Sub-Attributes
JSON Object
Show Sub-Attributes
idlongOptional

Profile ID. Fetch from Get Profiles List for Platform

typelongOptional

Profile type. 1 = XCCDF. Fetch from Get Profiles List for Platform

groupNamestringOptional

Name of the policy group

platformstringOptional

Platform identifier. 1 = Windows, 3 = Linux

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/scap/compliance/policygroups/{policyGrpId} \
  --header 'Accept: application/editPolicyGrp.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/editPolicyGrp.v1+json' \
  --data '{}'

Sample Request Body

Modify an existing policy group name and replace its profiles

Copied!
  {
    "groupName": "Updated Policy Group Name",
    "profiles": [
      {
        "id": "50001",
        "type": 1
      },
      {
        "id": "50003",
        "type": 1
      }
    ]
  }
                
Show full

Response Parameters

- HTTP code 200

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

true if the policy group was modified successfully, false otherwise

statusMsgstring

Error message when the policy group ID is not found

- HTTP code 400

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

HTTP status code (400)

errorCodestring

API-specific error code identifying the validation failure

messagestring

Error 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 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
400HTTP code
401HTTP code
429HTTP code

Sample Response: HTTP 200

Policy group modified successfully

Copied!
  {
    "status": true
  }
                
Show full

Policy group ID not found

Copied!
  {
    "statusMsg": "policy grp id not present",
    "status": false
  }
                
Show full

Sample Response: HTTP 400

A request body parameter has an invalid format or type

Copied!
  {
    "errorCode": "IAM0025",
    "url": "/dcapi/scap/compliance/policygroups/{policyGrpId}",
    "errorMsg": "id is an invalid parameter format."
  }
                
Show full

Sample Response: HTTP 401

User is action-restricted for this policy group

Copied!
  {
    "errorMessage": "User Not Authorized",
    "errorCode": "UAC_UNAUTHORIZED"
  }
                
Show full

Sample Response: HTTP 429

API call threshold exceeded

Copied!
  {
    "errorMessage": "Rate limit exceeded. Retry after some time",
    "errorCode": "TOO_MANY_REQUESTS"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | 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.