Controls
Operations for managing compliance controls
Compliance controls are measures related to the standard that ensure compliance and mitigate risks. Controls are built from one or more rules, the specific checks that run on an asset. Controls can be grouped into categories, for example RBAC and Pod security.
Retrieve compliance control details with optional filtering, sorting and pagination.
The response is concatenated using AND condition (OR is not supported)
The maximum result set size is >100
Offset is the zero-based number of assessment profiles from the start of the result set
Required license: Cortex Cloud Runtime Security or Cortex Cloud Posture Management
API Key ID for authentication
API Key for authentication
Successfully retrieved controls
Bad request - invalid input parameters
Internal server error
POST /public_api/v1/compliance/get_controls HTTP/1.1
Host: api.xdr.us.paloaltonetworks.com
x-xdr-auth-id: YOUR_API_KEY
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 98
{
"request_data": {
"filters": [
{
"field": "name",
"operator": "contains",
"value": "Access Enforcement"
}
]
}
}{
"reply": {
"total_count": 1,
"result_count": 1,
"controls": [
{
"id": "text",
"name": "text",
"description": "text",
"category": "text",
"subcategory": "text",
"creation_time": 1,
"modification_time": 1,
"created_by": "text",
"modified_by": "text",
"is_custom": true
}
]
}
}Get details of the compliance control specified by its ID.
Required license: Cortex Cloud Runtime Security or Cortex Cloud Posture Management
API Key ID for authentication
API Key for authentication
Successfully retrieved control
Bad request - invalid input parameters
Resource not found
Internal server error
POST /public_api/v1/compliance/get_control HTTP/1.1
Host: api.xdr.us.paloaltonetworks.com
x-xdr-auth-id: YOUR_API_KEY
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"request_data": {
"id": "ede175cb30ef4dd4a0e3031b1ee77868"
}
}{
"control": {
"CATEGORY": "text",
"CATEGORY_DESCRIPTION": "text",
"SUBCATEGORY": "text",
"SUBCATEGORY_DESCRIPTION": "text",
"CONTROL_ID": "text",
"STANDARDS": [
"text"
],
"CONTROL_NAME": "text",
"SEVERITY": "text",
"SUPPORTED": true,
"INSERTION_TIME": 1,
"MODIFICATION_TIME": 1,
"MODIFIED_BY": null,
"CREATED_BY": "text",
"DESCRIPTION": "text",
"MITIGATION": null,
"ADDITIONAL_DATA": [
{}
],
"COMPLIANCE_RULES": [
{}
],
"RULES": 1,
"REVISION": "text",
"IMPACT": null,
"AUTOMATION_STATUS": "text",
"AUDIT_PROCEDURE": null,
"ENABLED": true,
"IS_CUSTOM": true,
"STATUS": "text"
}
}Create a custom compliance control.
Required license: Cortex Cloud Runtime Security or Cortex Cloud Posture Management
API Key ID for authentication
API Key for authentication
Control added successfully
Whether the compliance control creation was successful
Bad request - invalid input parameters
Internal server error
POST /public_api/v1/compliance/add_control HTTP/1.1
Host: api.xdr.us.paloaltonetworks.com
x-xdr-auth-id: YOUR_API_KEY
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 103
{
"request_data": {
"control_name": "control name",
"category": "Network Configuration",
"subcategory": "4.2"
}
}{
"success": true
}Edit an existing compliance custom compliance control.
Required license: Cortex Cloud Runtime Security or Cortex Cloud Posture Management
API Key ID for authentication
API Key for authentication
Control updated successfully
Whether the custom compliance control was edited successfully
Bad request - invalid input parameters
Resource not found
Internal server error
POST /public_api/v1/compliance/edit_control HTTP/1.1
Host: api.xdr.us.paloaltonetworks.com
x-xdr-auth-id: YOUR_API_KEY
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 90
{
"request_data": {
"id": "48e2f6a9fcc049579e9c6b8eda0bd123",
"control_name": "Great new name"
}
}{
"success": true
}Delete a compliance control specified by its ID.
Required license: Cortex Cloud Runtime Security or Cortex Cloud Posture Management
API Key ID for authentication
API Key for authentication
Control deleted successfully
Whether the compliance control was successfully deleted
Bad request - invalid input parameters
Resource not found
Internal server error
POST /public_api/v1/compliance/delete_control HTTP/1.1
Host: api.xdr.us.paloaltonetworks.com
x-xdr-auth-id: YOUR_API_KEY
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"request_data": {
"id": "f9f744717b284e9383f9c1210ad3143d"
}
}{
"success": true
}Get details of the compliance control specified by its revision ID, including inactive controls.
Required license: Cortex Cloud Runtime Security or Cortex Cloud Posture Management
API Key ID for authentication
API Key for authentication
Successfully retrieved control
Bad request - invalid input parameters
Resource not found
Internal server error
POST /public_api/v1/compliance/get_control_by_revision HTTP/1.1
Host: api.xdr.us.paloaltonetworks.com
x-xdr-auth-id: YOUR_API_KEY
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59
{
"request_data": {
"control_revision": "4983640851729713422"
}
}{
"reply": {
"control": {
"id": "text",
"name": "text",
"description": "text",
"category": "text",
"subcategory": "text",
"creation_time": 1,
"modification_time": 1,
"created_by": "text",
"modified_by": "text",
"is_custom": true
}
}
}Last updated
Was this helpful?