> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/xdr-5-api/compliance-controls/standards.md).

# Standards

Operations for managing standards

## Get compliance standards (v1)

> Retrieve compliance standards 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 standards from the start of the result set\
> \
> \*\*Required license:\*\* Requires the Cortex Cloud Posture Management add-on.

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"tags":[{"name":"Standards","description":"Operations for managing standards"}],"servers":[{"url":"https://{tenant}.xdr.{region}.paloaltonetworks.com","description":"Cortex tenant","variables":{"tenant":{"default":"api","description":"Tenant-specific subdomain"},"region":{"default":"us","description":"Deployment region","enum":["us","eu","uk","sg","jp","ca","au","in","gov"]}}}],"security":[{"XDRAuth":[],"XDRAuthToken":[]}],"components":{"securitySchemes":{"XDRAuth":{"type":"apiKey","in":"header","name":"x-xdr-auth-id","description":"API Key ID for authentication"}},"schemas":{"StandardFilter":{"type":"object","required":["field","operator","value"],"properties":{"field":{"type":"string","enum":["name","id","publisher","is_custom","insertion_time","created_by","labels"],"description":"Identifies the compliance standard field the filter should match. Filters are based on the following keywords:\n- `name`: Compliance standard name\n- `id`: Compliance standard ID\n- `publisher`: Compliance standard publisher\n- `created_by`: User who created the compliance standard\n- `insertion_time`: When the compliance standard was created\n- `is_custom`: Whether the compliance standard is custom\n- `labels`: Compliance standard labels"},"operator":{"enum":["eq","neq","contains","not_contains","gte","lte","range","relative_timestamp","in"],"description":"Identifies the comparison operator you want to use for this filter. Valid keywords are:\n\n`eq` / `neq` / `contains` / `not_contains`: \n- `name`, `id`, `publisher`, `created_by`: String\n\n`gte` / `lte` / `range` / `relative_timestamp`: \n- `insertion_time``: Integer in timestamp epoch milliseconds\n\n`in`:\n- `is_custom`: Enum with possible values of `yes` or `no`\n\n`contains` / `not_contains`:\n- `labels`: Array of strings"},"value":{"oneOf":[{"type":"string","description":"When the `field` value is one of the following, the `value` is type string: `name`, `id`, `publisher`, `created_by`"},{"type":"integer","description":"When the `field` value is one of the following, the `value` is type integer: `insertion_time`"},{"enum":["yes","no"],"description":"When the `field` value is one of the following, the `value` is type enum: `is_custom`"},{"type":"array","description":"When the `field` value is one of the following, the `value` is an array of strings: `labels`","items":{"type":"string"}}],"description":"Value that this filter must match. The contents of this field will differ depending on the assessment profile `field` that you specified for this filter."}}},"Standard":{"type":"object","properties":{"id":{"type":"string","description":"Standard ID"},"name":{"type":"string","description":"Standard name"},"description":{"type":"string","description":"Description of the standard"},"publisher":{"type":"string","description":"Standard publisher/organization"},"labels":{"type":"array","description":"List of labels for categorization","items":{"type":"string"}},"insertion_time":{"type":"integer","format":"int64","description":"Creation timestamp (epoch)"},"created_by":{"type":"string","description":"User who created the standard"},"is_custom":{"type":"boolean","description":"Whether this is a custom standard"},"controls_count":{"type":"integer","description":"Number of associated controls"},"controls_ids":{"type":"array","description":"List of associated control IDs","items":{"type":"string"}}}},"Error":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"integer","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"object","description":"Additional error details"}}}}}},"responses":{"BadRequest":{"description":"Bad request - invalid input parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/public_api/v1/compliance/get_standards":{"post":{"summary":"Get compliance standards (v1)","description":"Retrieve compliance standards with optional filtering, sorting and pagination.\n- The response is concatenated using AND condition (OR is not supported)\n- The maximum result set size is >100\n- Offset is the zero-based number of standards from the start of the result set\n\n**Required license:** Requires the Cortex Cloud Posture Management add-on.","operationId":"getStandards","tags":["Standards"],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"request_data":{"type":"object","properties":{"filters":{"type":"array","description":"Array of filter conditions","items":{"$ref":"#/components/schemas/StandardFilter"}},"sort":{"type":"object","properties":{"field":{"type":"string","enum":["name","creation_time","created_by","id","insertion_time"],"default":"creation_time","description":"Field to sort by"},"keyword":{"type":"string","enum":["asc","desc"],"default":"asc","description":"Sort order"}}},"search_from":{"type":"integer","minimum":0,"default":0,"description":"Zero-based index of the first standard to return. Use with `search_to` to page through results. For example, `search_from: 0` starts at the first standard; `search_from: 50` skips the first 50."},"search_to":{"type":"integer","minimum":1,"default":100,"description":"Zero-based index marking the end of the page (exclusive). The response includes standards from `search_from` up to, but not including, `search_to`. For example, `search_from: 0` and `search_to: 50` returns the first 50 standards."}}}}}}}},"responses":{"200":{"description":"Successfully retrieved standards","content":{"application/json":{"schema":{"type":"object","properties":{"total_count":{"type":"integer","description":"Total number of standards in the system"},"result_count":{"type":"integer","description":"Number of standards matching the filter criteria + paging"},"standards":{"type":"array","items":{"$ref":"#/components/schemas/Standard"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}}
```

## Get single standard by ID (v1)

> Retrieve details of the compliance standard specified by its ID.\
> \
> \*\*Required license:\*\* Requires the Cortex Cloud Posture Management add-on.

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"tags":[{"name":"Standards","description":"Operations for managing standards"}],"servers":[{"url":"https://{tenant}.xdr.{region}.paloaltonetworks.com","description":"Cortex tenant","variables":{"tenant":{"default":"api","description":"Tenant-specific subdomain"},"region":{"default":"us","description":"Deployment region","enum":["us","eu","uk","sg","jp","ca","au","in","gov"]}}}],"security":[{"XDRAuth":[],"XDRAuthToken":[]}],"components":{"securitySchemes":{"XDRAuth":{"type":"apiKey","in":"header","name":"x-xdr-auth-id","description":"API Key ID for authentication"}},"schemas":{"Standard":{"type":"object","properties":{"id":{"type":"string","description":"Standard ID"},"name":{"type":"string","description":"Standard name"},"description":{"type":"string","description":"Description of the standard"},"publisher":{"type":"string","description":"Standard publisher/organization"},"labels":{"type":"array","description":"List of labels for categorization","items":{"type":"string"}},"insertion_time":{"type":"integer","format":"int64","description":"Creation timestamp (epoch)"},"created_by":{"type":"string","description":"User who created the standard"},"is_custom":{"type":"boolean","description":"Whether this is a custom standard"},"controls_count":{"type":"integer","description":"Number of associated controls"},"controls_ids":{"type":"array","description":"List of associated control IDs","items":{"type":"string"}}}},"Error":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"integer","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"object","description":"Additional error details"}}}}}},"responses":{"BadRequest":{"description":"Bad request - invalid input parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/public_api/v1/compliance/get_standard":{"post":{"summary":"Get single standard by ID (v1)","description":"Retrieve details of the compliance standard specified by its ID.\n\n**Required license:** Requires the Cortex Cloud Posture Management add-on.","operationId":"getStandard","tags":["Standards"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"request_data":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Compliance standard ID"}}}}}}}},"responses":{"200":{"description":"Successfully retrieved standard","content":{"application/json":{"schema":{"type":"object","properties":{"standard":{"$ref":"#/components/schemas/Standard"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}}
```

## Add new standard (v1)

> Create a new compliance standard.\
> \
> \*\*Required license:\*\* Requires the Cortex Cloud Posture Management add-on.

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"tags":[{"name":"Standards","description":"Operations for managing standards"}],"servers":[{"url":"https://{tenant}.xdr.{region}.paloaltonetworks.com","description":"Cortex tenant","variables":{"tenant":{"default":"api","description":"Tenant-specific subdomain"},"region":{"default":"us","description":"Deployment region","enum":["us","eu","uk","sg","jp","ca","au","in","gov"]}}}],"security":[{"XDRAuth":[],"XDRAuthToken":[]}],"components":{"securitySchemes":{"XDRAuth":{"type":"apiKey","in":"header","name":"x-xdr-auth-id","description":"API Key ID for authentication"}},"schemas":{"SuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation success status"}}},"Error":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"integer","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"object","description":"Additional error details"}}}}}},"responses":{"BadRequest":{"description":"Bad request - invalid input parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/public_api/v1/compliance/add_standard":{"post":{"summary":"Add new standard (v1)","description":"Create a new compliance standard.\n\n**Required license:** Requires the Cortex Cloud Posture Management add-on.","operationId":"addStandard","tags":["Standards"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"request_data":{"type":"object","required":["standard_name"],"properties":{"standard_name":{"type":"string","description":"Name of the compliance standard"},"description":{"type":"string","description":"Description of the standard"},"labels":{"type":"array","description":"List of labels for categorization","items":{"type":"string"}},"controls_ids":{"type":"array","description":"List of control IDs to associate with this standard. Only custom controls can be included.","items":{"type":"string"}}}}}}}}},"responses":{"200":{"description":"Standard added successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}}
```

## Edit existing standard (v1)

> Edit an existing compliance standard specified by its ID. \
> \
> \*\*Required license:\*\* Requires the Cortex Cloud Posture Management add-on.

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"tags":[{"name":"Standards","description":"Operations for managing standards"}],"servers":[{"url":"https://{tenant}.xdr.{region}.paloaltonetworks.com","description":"Cortex tenant","variables":{"tenant":{"default":"api","description":"Tenant-specific subdomain"},"region":{"default":"us","description":"Deployment region","enum":["us","eu","uk","sg","jp","ca","au","in","gov"]}}}],"security":[{"XDRAuth":[],"XDRAuthToken":[]}],"components":{"securitySchemes":{"XDRAuth":{"type":"apiKey","in":"header","name":"x-xdr-auth-id","description":"API Key ID for authentication"}},"schemas":{"SuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation success status"}}},"Error":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"integer","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"object","description":"Additional error details"}}}}}},"responses":{"BadRequest":{"description":"Bad request - invalid input parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/public_api/v1/compliance/edit_standard":{"post":{"summary":"Edit existing standard (v1)","description":"Edit an existing compliance standard specified by its ID. \n\n**Required license:** Requires the Cortex Cloud Posture Management add-on.","operationId":"editStandard","tags":["Standards"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"request_data":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Compliance standard ID"},"standard_name":{"type":"string","description":"Name of the standard"},"description":{"type":"string","description":"Description of the standard"},"labels":{"type":"array","description":"List of labels for categorization","items":{"type":"string"}},"controls_ids":{"type":"array","description":"List of control IDs to associate with this standard. Only custom controls can be included.","items":{"type":"string"}}}}}}}}},"responses":{"200":{"description":"Standard updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}}
```

## Delete standard (v1)

> Delete a the compliance standard specified by its ID.\
> \
> \*\*Required license:\*\* Requires the Cortex Cloud Posture Management add-on.

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"tags":[{"name":"Standards","description":"Operations for managing standards"}],"servers":[{"url":"https://{tenant}.xdr.{region}.paloaltonetworks.com","description":"Cortex tenant","variables":{"tenant":{"default":"api","description":"Tenant-specific subdomain"},"region":{"default":"us","description":"Deployment region","enum":["us","eu","uk","sg","jp","ca","au","in","gov"]}}}],"security":[{"XDRAuth":[],"XDRAuthToken":[]}],"components":{"securitySchemes":{"XDRAuth":{"type":"apiKey","in":"header","name":"x-xdr-auth-id","description":"API Key ID for authentication"}},"schemas":{"SuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation success status"}}},"Error":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"integer","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"object","description":"Additional error details"}}}}}},"responses":{"BadRequest":{"description":"Bad request - invalid input parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/public_api/v1/compliance/delete_standard":{"post":{"summary":"Delete standard (v1)","description":"Delete a the compliance standard specified by its ID.\n\n**Required license:** Requires the Cortex Cloud Posture Management add-on.","operationId":"deleteStandard","tags":["Standards"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"request_data":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Compliance standard ID"}}}}}}}},"responses":{"200":{"description":"Standard deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}}
```

## List standards (v2)

> Returns a paginated list of compliance standards for the tenant.\
> Requires \`platform\_compliance\_view\` permission.\
> \
> \
> \*\*Required license:\*\* Requires the Cortex Cloud Posture Management add-on.

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"tags":[{"name":"Standards","description":"Operations for managing standards"}],"servers":[{"url":"https://{tenant}.xdr.{region}.paloaltonetworks.com","description":"Cortex tenant","variables":{"tenant":{"default":"api","description":"Tenant-specific subdomain"},"region":{"default":"us","description":"Deployment region","enum":["us","eu","uk","sg","jp","ca","au","in","gov"]}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{},"parameters":{"OffsetParam":{"name":"offset","in":"query","required":false,"description":"Pagination offset (0-based)","schema":{"type":"integer","minimum":0,"default":0}},"LimitParam":{"name":"limit","in":"query","required":false,"description":"Maximum number of results to return (PAPI). Default 50, max 200.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}}},"schemas":{"PapiPaginatedResponse":{"type":"object","description":"PAPI pagination envelope","required":["total_count","results"],"properties":{"total_count":{"type":"integer","description":"Total number of items matching the query"},"results":{"type":"array","items":{"type":"object"},"description":"Array of result items for the current page"},"next_offset":{"type":"integer","nullable":true,"description":"Offset for the next page, or null if no more results"}}},"Error":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"integer","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"object","description":"Additional error details"}}}}}},"responses":{"BadRequest":{"description":"Bad request - invalid input parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/public_api/v2/compliance/standards":{"get":{"operationId":"papiListStandards","summary":"List standards (v2)","description":"Returns a paginated list of compliance standards for the tenant.\nRequires `platform_compliance_view` permission.\n\n\n**Required license:** Requires the Cortex Cloud Posture Management add-on.","tags":["Standards"],"parameters":[{"$ref":"#/components/parameters/OffsetParam"},{"$ref":"#/components/parameters/LimitParam"}],"responses":{"200":{"description":"Paginated list of standards","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PapiPaginatedResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}}}}
```

## Create a standard (v2)

> Creates a new compliance standard (metadata only).\
> Requires \`platform\_compliance\_edit\` permission.\
> \
> \
> \*\*Required license:\*\* Requires the Cortex Cloud Posture Management add-on.

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"tags":[{"name":"Standards","description":"Operations for managing standards"}],"servers":[{"url":"https://{tenant}.xdr.{region}.paloaltonetworks.com","description":"Cortex tenant","variables":{"tenant":{"default":"api","description":"Tenant-specific subdomain"},"region":{"default":"us","description":"Deployment region","enum":["us","eu","uk","sg","jp","ca","au","in","gov"]}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{},"schemas":{"PapiStandardCreate":{"type":"object","description":"PAPI request body for creating a standard.","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":256,"description":"Standard name (unique per tenant)"},"version":{"type":"string","default":"1.0","description":"Standard version string"},"description":{"type":"string","maxLength":2048,"default":"","description":"Standard description"},"publisher":{"type":"string","nullable":true,"description":"Standard publisher/organization"},"release_date":{"type":"string","default":"","description":"Release date string"},"labels":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"maxItems":20,"description":"Optional labels (max 20 items, each max 64 chars)"}}},"PapiStandardResponse":{"type":"object","description":"PAPI response model for a compliance standard.\nFields match be3 PAPI v1 `Standard` schema (snake_case naming).\n","required":["id","name","is_custom","created_by","insert_ts","revision"],"properties":{"id":{"type":"string","description":"Standard unique identifier"},"name":{"type":"string","description":"Standard name"},"description":{"type":"string","description":"Standard description"},"version":{"type":"string","description":"Standard version string"},"publisher":{"type":"string","nullable":true,"description":"Standard publisher/organization"},"release_date":{"type":"string","description":"Release date"},"created_by":{"type":"string","description":"User who created the standard"},"insert_ts":{"type":"integer","format":"int64","description":"Creation timestamp (epoch milliseconds)"},"modify_ts":{"type":"integer","format":"int64","nullable":true,"description":"Last modification timestamp (epoch milliseconds)"},"is_custom":{"type":"boolean","description":"Whether this is a custom standard"},"labels":{"type":"array","items":{"type":"string"},"description":"List of labels for categorization"},"revision":{"type":"integer","format":"int64","description":"Content-addressable revision hash (signed 64-bit integer)"}}},"Error":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"integer","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"object","description":"Additional error details"}}}}},"ErrorResponse":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"integer","description":"Error code"},"err_msg":{"type":"string","description":"Error message describing what went wrong"},"err_extra":{"type":"object","description":"Additional error details"}},"required":["err_code","err_msg"]}}}},"responses":{"BadRequest":{"description":"Bad request - invalid input parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Conflict":{"description":"Conflict - duplicate resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/public_api/v2/compliance/standards":{"post":{"operationId":"papiCreateStandard","summary":"Create a standard (v2)","description":"Creates a new compliance standard (metadata only).\nRequires `platform_compliance_edit` permission.\n\n\n**Required license:** Requires the Cortex Cloud Posture Management add-on.","tags":["Standards"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PapiStandardCreate"}}},"description":"Payload for create a standard"},"responses":{"201":{"description":"Standard created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PapiStandardResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"409":{"$ref":"#/components/responses/Conflict"}}}}}}
```

## Get a single standard (v2)

> Returns a single compliance standard by ID (metadata only).\
> Requires \`platform\_compliance\_view\` permission.\
> \
> \
> \*\*Required license:\*\* Requires the Cortex Cloud Posture Management add-on.

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"tags":[{"name":"Standards","description":"Operations for managing standards"}],"servers":[{"url":"https://{tenant}.xdr.{region}.paloaltonetworks.com","description":"Cortex tenant","variables":{"tenant":{"default":"api","description":"Tenant-specific subdomain"},"region":{"default":"us","description":"Deployment region","enum":["us","eu","uk","sg","jp","ca","au","in","gov"]}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{},"schemas":{"PapiStandardResponse":{"type":"object","description":"PAPI response model for a compliance standard.\nFields match be3 PAPI v1 `Standard` schema (snake_case naming).\n","required":["id","name","is_custom","created_by","insert_ts","revision"],"properties":{"id":{"type":"string","description":"Standard unique identifier"},"name":{"type":"string","description":"Standard name"},"description":{"type":"string","description":"Standard description"},"version":{"type":"string","description":"Standard version string"},"publisher":{"type":"string","nullable":true,"description":"Standard publisher/organization"},"release_date":{"type":"string","description":"Release date"},"created_by":{"type":"string","description":"User who created the standard"},"insert_ts":{"type":"integer","format":"int64","description":"Creation timestamp (epoch milliseconds)"},"modify_ts":{"type":"integer","format":"int64","nullable":true,"description":"Last modification timestamp (epoch milliseconds)"},"is_custom":{"type":"boolean","description":"Whether this is a custom standard"},"labels":{"type":"array","items":{"type":"string"},"description":"List of labels for categorization"},"revision":{"type":"integer","format":"int64","description":"Content-addressable revision hash (signed 64-bit integer)"}}},"Error":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"integer","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"object","description":"Additional error details"}}}}}},"responses":{"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/public_api/v2/compliance/standards/{standard_id}":{"get":{"operationId":"papiGetStandard","summary":"Get a single standard (v2)","description":"Returns a single compliance standard by ID (metadata only).\nRequires `platform_compliance_view` permission.\n\n\n**Required license:** Requires the Cortex Cloud Posture Management add-on.","tags":["Standards"],"responses":{"200":{"description":"Standard details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PapiStandardResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```

## Update a standard (v2)

> Updates an existing compliance standard (metadata only). All fields are optional;\
> only included fields are updated. The \`labels\` field replaces the entire array when provided.\
> Requires \`platform\_compliance\_edit\` permission.\
> \
> Returns \*\*400\*\* if the target standard is official (\`is\_custom: false\`).\
> Out-of-the-box standards are immutable from this API.\
> \
> \
> \*\*Required license:\*\* Requires the Cortex Cloud Posture Management add-on.

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"tags":[{"name":"Standards","description":"Operations for managing standards"}],"servers":[{"url":"https://{tenant}.xdr.{region}.paloaltonetworks.com","description":"Cortex tenant","variables":{"tenant":{"default":"api","description":"Tenant-specific subdomain"},"region":{"default":"us","description":"Deployment region","enum":["us","eu","uk","sg","jp","ca","au","in","gov"]}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{},"schemas":{"PapiStandardUpdate":{"type":"object","description":"PAPI request body for updating a standard. All fields are optional;\nonly included fields are updated.\n","properties":{"name":{"type":"string","minLength":1,"maxLength":256,"description":"Updated name (must remain unique per tenant)"},"version":{"type":"string","description":"Updated version string"},"description":{"type":"string","maxLength":2048,"description":"Updated description"},"publisher":{"type":"string","nullable":true,"description":"Updated publisher/organization"},"labels":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"maxItems":20,"description":"Replaces the entire labels array"}}},"PapiStandardResponse":{"type":"object","description":"PAPI response model for a compliance standard.\nFields match be3 PAPI v1 `Standard` schema (snake_case naming).\n","required":["id","name","is_custom","created_by","insert_ts","revision"],"properties":{"id":{"type":"string","description":"Standard unique identifier"},"name":{"type":"string","description":"Standard name"},"description":{"type":"string","description":"Standard description"},"version":{"type":"string","description":"Standard version string"},"publisher":{"type":"string","nullable":true,"description":"Standard publisher/organization"},"release_date":{"type":"string","description":"Release date"},"created_by":{"type":"string","description":"User who created the standard"},"insert_ts":{"type":"integer","format":"int64","description":"Creation timestamp (epoch milliseconds)"},"modify_ts":{"type":"integer","format":"int64","nullable":true,"description":"Last modification timestamp (epoch milliseconds)"},"is_custom":{"type":"boolean","description":"Whether this is a custom standard"},"labels":{"type":"array","items":{"type":"string"},"description":"List of labels for categorization"},"revision":{"type":"integer","format":"int64","description":"Content-addressable revision hash (signed 64-bit integer)"}}},"ErrorResponse":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"integer","description":"Error code"},"err_msg":{"type":"string","description":"Error message describing what went wrong"},"err_extra":{"type":"object","description":"Additional error details"}},"required":["err_code","err_msg"]}}},"Error":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"integer","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"object","description":"Additional error details"}}}}}},"responses":{"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Conflict":{"description":"Conflict - duplicate resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/public_api/v2/compliance/standards/{standard_id}":{"post":{"operationId":"papiUpdateStandard","summary":"Update a standard (v2)","description":"Updates an existing compliance standard (metadata only). All fields are optional;\nonly included fields are updated. The `labels` field replaces the entire array when provided.\nRequires `platform_compliance_edit` permission.\n\nReturns **400** if the target standard is official (`is_custom: false`).\nOut-of-the-box standards are immutable from this API.\n\n\n**Required license:** Requires the Cortex Cloud Posture Management add-on.","tags":["Standards"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PapiStandardUpdate"}}},"description":"Payload for update a standard"},"responses":{"200":{"description":"Standard updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PapiStandardResponse"}}}},"400":{"description":"Bad request. In addition to standard validation errors, returns 400 when\nthe target standard is official (`is_custom: false`) — see\n`official_standard` example.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}}}}
```

## Delete a standard (v2)

> Deletes a compliance standard and cascades to all its categories, subcategories, and controls.\
> Requires \`platform\_compliance\_edit\` permission.\
> \
> Returns \*\*400\*\* if the target standard is official (\`is\_custom: false\`).\
> Out-of-the-box standards are immutable from this API.\
> \
> \
> \*\*Required license:\*\* Requires the Cortex Cloud Posture Management add-on.

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"tags":[{"name":"Standards","description":"Operations for managing standards"}],"servers":[{"url":"https://{tenant}.xdr.{region}.paloaltonetworks.com","description":"Cortex tenant","variables":{"tenant":{"default":"api","description":"Tenant-specific subdomain"},"region":{"default":"us","description":"Deployment region","enum":["us","eu","uk","sg","jp","ca","au","in","gov"]}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{},"schemas":{"ErrorResponse":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"integer","description":"Error code"},"err_msg":{"type":"string","description":"Error message describing what went wrong"},"err_extra":{"type":"object","description":"Additional error details"}},"required":["err_code","err_msg"]}}},"Error":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"integer","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"object","description":"Additional error details"}}}}}},"responses":{"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/public_api/v2/compliance/standards/{standard_id}":{"delete":{"operationId":"papiDeleteStandard","summary":"Delete a standard (v2)","description":"Deletes a compliance standard and cascades to all its categories, subcategories, and controls.\nRequires `platform_compliance_edit` permission.\n\nReturns **400** if the target standard is official (`is_custom: false`).\nOut-of-the-box standards are immutable from this API.\n\n\n**Required license:** Requires the Cortex Cloud Posture Management add-on.","tags":["Standards"],"responses":{"204":{"description":"Standard deleted (cascades to categories and controls)"},"400":{"description":"Bad request. Returned when the target standard is official\n(`is_custom: false`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```

## Clone a standard (v2)

> Creates a deep copy of the source standard with all its categories,\
> subcategories, controls, and control-to-rule associations.\
> The cloned standard gets a new ID, the provided name and description,\
> null version, and release\_date set to today. Labels are copied from the source.\
> Requires \`platform\_compliance\_edit\` permission.\
> \
> \
> \*\*Required license:\*\* Requires the Cortex Cloud Posture Management add-on.

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"tags":[{"name":"Standards","description":"Operations for managing standards"}],"servers":[{"url":"https://{tenant}.xdr.{region}.paloaltonetworks.com","description":"Cortex tenant","variables":{"tenant":{"default":"api","description":"Tenant-specific subdomain"},"region":{"default":"us","description":"Deployment region","enum":["us","eu","uk","sg","jp","ca","au","in","gov"]}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{},"schemas":{"CloneStandardRequest":{"type":"object","description":"Request body for cloning a compliance standard.","required":["name"],"properties":{"name":{"type":"string","description":"Name for the cloned standard (required)."},"description":{"type":"string","nullable":true,"description":"Description for the cloned standard. If empty or omitted, the cloned standard's description will be empty."}}},"CloneStandardResponse":{"type":"object","description":"Response model for a cloned compliance standard with full hierarchy.\nReturns the newly created standard with all its deep-copied categories,\nsubcategories, controls, and rule associations.\n","required":["id","name","is_custom","created_by","insert_ts","revision"],"properties":{"id":{"type":"string","description":"New standard UUID."},"name":{"type":"string","description":"Name of the cloned standard."},"version":{"type":"string","nullable":true,"description":"Always null for cloned standards."},"description":{"type":"string","description":"Description of the cloned standard."},"publisher":{"type":"string","nullable":true},"release_date":{"type":"string","nullable":true,"description":"Always null for cloned standards."},"labels":{"type":"array","items":{"type":"string"},"description":"Labels copied from the source standard."},"is_custom":{"type":"boolean","description":"Always true for cloned standards."},"revision":{"type":"integer","format":"int64"},"created_by":{"type":"string"},"modified_by":{"type":"string","nullable":true},"insert_ts":{"type":"integer","format":"int64"},"modify_ts":{"type":"integer","format":"int64","nullable":true},"categories":{"type":"array","items":{"$ref":"#/components/schemas/CloneStandardCategoryResponse"},"description":"Full hierarchy of deep-copied categories with subcategories and controls."}}},"CloneStandardCategoryResponse":{"type":"object","description":"Category representation in the clone standard response.","properties":{"id":{"type":"string","description":"New category UUID."},"name":{"type":"string"},"description":{"type":"string","nullable":true},"parent_category_id":{"type":"string","nullable":true},"controls":{"type":"array","items":{"$ref":"#/components/schemas/CloneStandardControlResponse"}},"subcategories":{"type":"array","items":{"$ref":"#/components/schemas/CloneStandardSubcategoryResponse"}}}},"CloneStandardControlResponse":{"type":"object","description":"Control representation in the clone standard response.","properties":{"id":{"type":"string","description":"New control UUID."},"name":{"type":"string"},"index":{"type":"string"},"description":{"type":"string"},"severity":{"type":"string","nullable":true},"category_id":{"type":"string","nullable":true},"rule_ids":{"type":"array","items":{"type":"string"},"description":"Rule IDs associated with this control."}}},"CloneStandardSubcategoryResponse":{"type":"object","description":"Subcategory representation in the clone standard response.","properties":{"id":{"type":"string","description":"New subcategory UUID."},"name":{"type":"string"},"description":{"type":"string","nullable":true},"parent_category_id":{"type":"string","nullable":true},"controls":{"type":"array","items":{"$ref":"#/components/schemas/CloneStandardControlResponse"}}}},"Error":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"integer","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"object","description":"Additional error details"}}}}}},"responses":{"BadRequest":{"description":"Bad request - invalid input parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/public_api/v2/compliance/standards/{standard_id}/clone":{"post":{"operationId":"papiCloneStandard","summary":"Clone a standard (v2)","description":"Creates a deep copy of the source standard with all its categories,\nsubcategories, controls, and control-to-rule associations.\nThe cloned standard gets a new ID, the provided name and description,\nnull version, and release_date set to today. Labels are copied from the source.\nRequires `platform_compliance_edit` permission.\n\n\n**Required license:** Requires the Cortex Cloud Posture Management add-on.","tags":["Standards"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloneStandardRequest"}}},"description":"Payload for clone a standard"},"responses":{"201":{"description":"Standard cloned successfully with full hierarchy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloneStandardResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://cortex-docs.paloaltonetworks.com/xdr-5-api/compliance-controls/standards.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.