Assessment Profiles
Operations for managing assessment profiles
An assessment profile uses a standard to run scans on an asset group to check whether the assets adhere to the standard.
Retrieve compliance assessment profiles 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 assessment profiles
Bad request - invalid input parameters
Authentication required
Access denied - insufficient permissions
Internal server error
POST /public_api/v1/compliance/get_assessment_profiles 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: 210
{
"request_data": {
"search_from": 0,
"search_to": 50,
"sort": {
"field": "report_type",
"keyword": "desc"
},
"filters": [
{
"field": "creation_time",
"operator": "gte",
"value": 0
},
{
"field": "name",
"operator": "eq",
"value": "John"
}
]
}
}{
"reply": {
"total_count": 925,
"result_count": 1,
"assessment_profiles": [
{
"ID": "472141782aff4a2f999c5e3c35745b3a",
"NAME": "Assessment example",
"STANDARD_ID": "2nnd684-4z14-5cs82-c1a0-7c322b671844",
"STANDARD_NAME": "CIS Amazon Linux 2 Benchmark v1.0.0",
"ASSET_GROUP_ID": 1,
"ASSET_GROUP_NAME": "asset group name",
"DESCRIPTION": "assessment description",
"REPORT_FREQUENCY": null,
"REPORT_TARGETS": [],
"REPORT_TYPE": "NONE",
"ENABLED": true,
"INSERT_TS": 1748259453615,
"MODIFY_TS": 1748259453615,
"CREATED_BY": "Generic Name",
"MODIFIED_BY": "Generic Name"
}
]
}
}An assessment profile uses a standard to run scans on an asset group to check whether the assets adhere to the standard.
Get details of the assessment profile 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 assessment profile
Assessment profile ID
Assessment profile name
Description of the assessment profile
Whether the assessment profile is enabled
Standard ID
Standard name
Asset Group ID
Asset Group name
Report type
Assessment profile creation time
Assessment profile modification time
Assessment profile creator
Assessment profile modified by
Bad request - invalid input parameters
Authentication required
Access denied - insufficient permissions
Resource not found
Internal server error
POST /public_api/v1/compliance/get_assessment_profile 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": "eee175cb00ef4da4a0e3091b1ee77368"
}
}{
"id": "text",
"name": "text",
"description": "text",
"enabled": true,
"standard_id": "text",
"standard_name": "text",
"asset_group_id": 1,
"asset_group_name": "text",
"report_type": "text",
"report_targets": [
"name@gmail.com"
],
"evaluation_frequency": "text",
"creation_time": "2026-01-01T00:00:00.000Z",
"modification_time": "2026-01-01T00:00:00.000Z",
"created_by": "text",
"modified_by": "text"
}Create a custom compliance assessment profile that is tailored to your own business needs and organizational policies.
Required license: Cortex Cloud Runtime Security or Cortex Cloud Posture Management.
API Key ID for authentication
API Key for authentication
Successfully created assessment profile
Whether the assessment profile creation succeeded
Bad request - invalid input parameters
Authentication required
Access denied - insufficient permissions
Conflict - duplicate resource
Internal server error
POST /public_api/v1/compliance/add_assessment_profile 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: 264
{
"request_data": {
"profile_name": "profile example",
"description": "profile description example",
"evaluation_frequency": "0 12 * * *",
"asset_group_id": "3",
"report_type": "ALL",
"standard_id": "532ac684-451c-5c789-b1a8-7c325b678843",
"report_targets": [
"user@company.com"
]
}
}{
"success": true
}Edit an existing compliance custom assessment profile.
Required license: Cortex Cloud Runtime Security or Cortex Cloud Posture Management.
API Key ID for authentication
API Key for authentication
Successfully updated assessment profile
Bad request - invalid input parameters
Authentication required
Access denied - insufficient permissions
Resource not found
Conflict - duplicate resource
Internal server error
POST /public_api/v1/compliance/edit_assessment_profile 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: 85
{
"request_data": {
"id": "48e2f6a9fdc049479e9c6a8eda0bd163",
"control_name": "Control 1"
}
}{
"success": true
}Delete an assessment profile 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 deleted assessment profile
Whether the assessment profile deletion succeeded
Bad request - invalid input parameters
Authentication required
Access denied - insufficient permissions
Resource not found
Internal server error
POST /public_api/v1/compliance/delete_assessment_profile 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": "f9f764717b284e9483f9c1210ed3149d"
}
}{
"success": true
}Last updated
Was this helpful?