> 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/models.md).

# Models

## The PapiPaginatedResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"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"}}}}}}
```

## The CloneStandardRequest object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"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."}}}}}}
```

## The CloneStandardControlResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"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."}}}}}}
```

## The CloneStandardSubcategoryResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"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"}}}},"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."}}}}}}
```

## The CloneStandardCategoryResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"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"}}}}}}}
```

## The CloneStandardResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"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"}}}}}}}
```

## The PapiStandardResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"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)"}}}}}}
```

## The PapiStandardCreate object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"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)"}}}}}}
```

## The PapiStandardUpdate object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"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"}}}}}}
```

## The PapiCategoryResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"PapiCategoryResponse":{"type":"object","description":"PAPI response model for a compliance category.","required":["id","standard_id","name","created_at","created_by"],"properties":{"id":{"type":"string","format":"uuid","description":"System-generated UUID v4"},"standard_id":{"type":"string","format":"uuid","description":"UUID of the parent standard"},"parent_category_id":{"type":"string","format":"uuid","nullable":true,"description":"UUID of the parent category (null for top-level categories)"},"name":{"type":"string","minLength":1,"maxLength":256,"description":"Category name"},"description":{"type":"string","maxLength":2048,"nullable":true,"description":"Optional description"},"created_at":{"type":"integer","description":"Creation timestamp (epoch seconds)"},"modified_at":{"type":"integer","nullable":true,"description":"Last modification timestamp (epoch seconds)"},"created_by":{"type":"string","description":"User who created the resource"},"modified_by":{"type":"string","nullable":true,"description":"User who last modified the resource"}}}}}}
```

## The PapiCategoryCreate object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"PapiCategoryCreate":{"type":"object","description":"PAPI request body for creating a category.","required":["standard_id","name"],"properties":{"standard_id":{"type":"string","format":"uuid","description":"UUID of the parent standard"},"name":{"type":"string","minLength":1,"maxLength":256,"description":"Category name"},"description":{"type":"string","maxLength":2048,"nullable":true,"description":"Optional description"},"parent_category_id":{"type":"string","format":"uuid","nullable":true,"description":"Set to a top-level category UUID to create a subcategory.\nSet to `null` or omit to create a top-level category.\n"}}}}}}
```

## The PapiCategoryUpdate object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"PapiCategoryUpdate":{"type":"object","description":"PAPI request body for updating a category. Only `name` and `description`\ncan be updated; `parent_category_id` is immutable.\n","properties":{"name":{"type":"string","minLength":1,"maxLength":256,"description":"Updated category name"},"description":{"type":"string","maxLength":2048,"nullable":true,"description":"Updated description"}}}}}}
```

## The PapiControlResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"PapiControlResponse":{"type":"object","description":"PAPI response model for a compliance control.\nMatches `PapiControlResponse` Pydantic model (snake_case v2 naming).\n","required":["id","standard_id","name","index","description","is_custom","revision","created_by","insert_ts"],"properties":{"id":{"type":"string","description":"Control unique identifier"},"standard_id":{"type":"string","description":"UUID of the parent standard this control belongs to"},"category_id":{"type":"string","nullable":true,"description":"UUID of the category or subcategory this control belongs to (null if uncategorized)"},"name":{"type":"string","description":"Control name"},"index":{"type":"string","description":"Control index/number within the standard"},"description":{"type":"string","description":"Control description"},"mitigation":{"type":"string","nullable":true,"description":"Mitigation guidance"},"impact":{"type":"string","nullable":true,"description":"Impact description"},"automation_status":{"type":"string","nullable":true,"description":"Automation status"},"audit_procedure":{"type":"string","nullable":true,"description":"Audit procedure"},"severity":{"type":"string","nullable":true,"description":"Control severity level"},"is_custom":{"type":"boolean","description":"Whether this is a custom (user-created) control"},"revision":{"type":"integer","format":"int64","description":"Content-addressable revision hash (signed 64-bit integer)"},"created_by":{"type":"string","description":"User who created the control"},"modified_by":{"type":"string","nullable":true,"description":"User who last modified the control"},"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)"},"rule_ids":{"type":"array","items":{"type":"string"},"description":"List of rule IDs associated with this control"}}}}}}
```

## The PapiControlCreate object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"PapiControlCreate":{"type":"object","description":"PAPI request body for creating a single control.\nMatches `PapiCreateControlRequest` Pydantic model.\n","required":["standard_id","name","category_id"],"properties":{"standard_id":{"type":"string","format":"uuid","description":"UUID of the parent standard"},"name":{"type":"string","minLength":1,"maxLength":256,"description":"Control name"},"index":{"type":"string","default":"","description":"Control index/number within the standard (e.g., \"1.1\", \"4.2\")"},"description":{"type":"string","maxLength":2048,"default":"","description":"Control description"},"category_id":{"type":"string","format":"uuid","description":"UUID of the parent category or subcategory (required)"},"mitigation":{"type":"string","nullable":true,"description":"Mitigation guidance"},"impact":{"type":"string","nullable":true,"description":"Impact description"},"automation_status":{"type":"string","nullable":true,"description":"Automation status (e.g., \"automated\", \"manual\")"},"audit_procedure":{"type":"string","nullable":true,"description":"Audit procedure"},"rule_ids":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Optional list of rule IDs to associate with this control"}}}}}}
```

## The PapiControlUpdate object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"PapiControlUpdate":{"type":"object","description":"PAPI request body for updating a single control.\nMatches `PapiUpdateControlRequest` Pydantic model.\nAll fields are optional; only included fields are updated.\n","properties":{"name":{"type":"string","minLength":1,"maxLength":256,"description":"Updated control name"},"description":{"type":"string","maxLength":2048,"description":"Updated description"},"category_id":{"type":"string","format":"uuid","nullable":true,"description":"Updated category or subcategory ID"},"mitigation":{"type":"string","nullable":true,"description":"Updated mitigation guidance"},"impact":{"type":"string","nullable":true,"description":"Updated impact description"},"automation_status":{"type":"string","nullable":true,"description":"Updated automation status"},"audit_procedure":{"type":"string","nullable":true,"description":"Updated audit procedure"},"severity":{"type":"string","nullable":true,"description":"Updated severity level"},"rule_ids":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Optional list of rule IDs to associate with this control (replaces existing associations)"}}}}}}
```

## The PapiBulkDeleteControls object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"PapiBulkDeleteControls":{"type":"object","description":"PAPI request body for bulk deleting controls.","required":["control_ids"],"properties":{"control_ids":{"type":"array","items":{"type":"string"},"description":"Array of control IDs to delete"}}}}}}
```

## The BulkControlResultItem object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"BulkControlResultItem":{"type":"object","description":"Result for a single item in a bulk control operation.","required":["id","success"],"properties":{"id":{"type":"string","description":"Control ID"},"success":{"type":"boolean","description":"Whether the operation succeeded for this control"},"error":{"type":"string","nullable":true,"description":"Error message if the operation failed for this control"}}}}}}
```

## The BulkControlResult object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"BulkControlResult":{"type":"object","description":"Aggregated result of a bulk control operation (create, update, or delete).\nContains two arrays: `succeeded` lists controls that were processed successfully,\nand `failed` lists controls that encountered errors.\n","required":["succeeded","failed"],"properties":{"succeeded":{"type":"array","items":{"$ref":"#/components/schemas/BulkControlResultItem"},"description":"Controls that were successfully processed"},"failed":{"type":"array","items":{"$ref":"#/components/schemas/BulkControlResultItem"},"description":"Controls that failed processing (each includes an `error` message)"}}},"BulkControlResultItem":{"type":"object","description":"Result for a single item in a bulk control operation.","required":["id","success"],"properties":{"id":{"type":"string","description":"Control ID"},"success":{"type":"boolean","description":"Whether the operation succeeded for this control"},"error":{"type":"string","nullable":true,"description":"Error message if the operation failed for this control"}}}}}}
```

## The BulkUpdateControlItem object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"BulkUpdateControlItem":{"type":"object","description":"Single item in a bulk update controls request. Must include `control_id` to identify\nthe control to update. All other fields are optional; only included fields are updated.\n","required":["control_id"],"properties":{"control_id":{"type":"string","description":"UUID of the control to update"},"name":{"type":"string","minLength":1,"maxLength":256,"description":"Updated control name"},"description":{"type":"string","maxLength":2048,"description":"Updated description"},"category_id":{"type":"string","format":"uuid","nullable":true,"description":"Updated category or subcategory ID"},"mitigation":{"type":"string","nullable":true,"description":"Updated mitigation guidance"},"impact":{"type":"string","nullable":true,"description":"Updated impact description"},"automation_status":{"type":"string","nullable":true,"description":"Updated automation status"},"audit_procedure":{"type":"string","nullable":true,"description":"Updated audit procedure"},"severity":{"type":"string","nullable":true,"description":"Updated severity level"},"rule_ids":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Optional list of rule IDs to associate with this control (replaces existing associations)"}}}}}}
```

## The WebControlInHierarchy object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"WebControlInHierarchy":{"type":"object","description":"Lightweight control representation for Web API hierarchy requests/responses.","required":["name"],"properties":{"id":{"type":"string","format":"uuid","description":"Control UUID (present in responses, absent in create requests)"},"name":{"type":"string","minLength":1,"maxLength":256},"index":{"type":"string","default":""},"description":{"type":"string","maxLength":2048,"default":""},"severity":{"type":"string","nullable":true,"enum":["critical","high","medium","low","informational"]},"category_id":{"type":"string","format":"uuid","nullable":true},"rule_ids":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Optional list of rule IDs to associate with this control"}}}}}}
```

## The WebSubcategoryInHierarchy object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"WebSubcategoryInHierarchy":{"type":"object","description":"Subcategory with nested controls for Web API hierarchy.","required":["name"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":2048,"nullable":true},"parent_category_id":{"type":"string","format":"uuid","nullable":true},"controls":{"type":"array","items":{"$ref":"#/components/schemas/WebControlInHierarchy"}}}},"WebControlInHierarchy":{"type":"object","description":"Lightweight control representation for Web API hierarchy requests/responses.","required":["name"],"properties":{"id":{"type":"string","format":"uuid","description":"Control UUID (present in responses, absent in create requests)"},"name":{"type":"string","minLength":1,"maxLength":256},"index":{"type":"string","default":""},"description":{"type":"string","maxLength":2048,"default":""},"severity":{"type":"string","nullable":true,"enum":["critical","high","medium","low","informational"]},"category_id":{"type":"string","format":"uuid","nullable":true},"rule_ids":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Optional list of rule IDs to associate with this control"}}}}}}
```

## The WebCategoryInHierarchy object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"WebCategoryInHierarchy":{"type":"object","description":"Category with nested controls and subcategories for Web API hierarchy.","required":["name"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":2048,"nullable":true},"parent_category_id":{"type":"string","format":"uuid","nullable":true},"controls":{"type":"array","items":{"$ref":"#/components/schemas/WebControlInHierarchy"}},"subcategories":{"type":"array","items":{"$ref":"#/components/schemas/WebSubcategoryInHierarchy"}}}},"WebControlInHierarchy":{"type":"object","description":"Lightweight control representation for Web API hierarchy requests/responses.","required":["name"],"properties":{"id":{"type":"string","format":"uuid","description":"Control UUID (present in responses, absent in create requests)"},"name":{"type":"string","minLength":1,"maxLength":256},"index":{"type":"string","default":""},"description":{"type":"string","maxLength":2048,"default":""},"severity":{"type":"string","nullable":true,"enum":["critical","high","medium","low","informational"]},"category_id":{"type":"string","format":"uuid","nullable":true},"rule_ids":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Optional list of rule IDs to associate with this control"}}},"WebSubcategoryInHierarchy":{"type":"object","description":"Subcategory with nested controls for Web API hierarchy.","required":["name"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":2048,"nullable":true},"parent_category_id":{"type":"string","format":"uuid","nullable":true},"controls":{"type":"array","items":{"$ref":"#/components/schemas/WebControlInHierarchy"}}}}}}}
```

## The WebControlMetadataResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"WebControlMetadataResponse":{"type":"object","description":"Lightweight control representation with only essential fields.\nUsed in the compliance metadata endpoint for lightweight hierarchy retrieval.\n","required":["id","name","rule_ids"],"properties":{"id":{"type":"string","format":"uuid","description":"Control unique identifier"},"name":{"type":"string","description":"Control name"},"rule_ids":{"type":"array","items":{"type":"string"},"description":"List of rule IDs associated with this control"}}}}}}
```

## The WebSubcategoryMetadataResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"WebSubcategoryMetadataResponse":{"type":"object","description":"Lightweight subcategory representation with only essential fields.\nUsed in the compliance metadata endpoint for lightweight hierarchy retrieval.\n","required":["id","name","parent_category_id","controls"],"properties":{"id":{"type":"string","format":"uuid","description":"Subcategory unique identifier"},"name":{"type":"string","description":"Subcategory name"},"parent_category_id":{"type":"string","format":"uuid","description":"UUID of the parent category"},"controls":{"type":"array","items":{"$ref":"#/components/schemas/WebControlMetadataResponse"},"description":"Controls within this subcategory"}}},"WebControlMetadataResponse":{"type":"object","description":"Lightweight control representation with only essential fields.\nUsed in the compliance metadata endpoint for lightweight hierarchy retrieval.\n","required":["id","name","rule_ids"],"properties":{"id":{"type":"string","format":"uuid","description":"Control unique identifier"},"name":{"type":"string","description":"Control name"},"rule_ids":{"type":"array","items":{"type":"string"},"description":"List of rule IDs associated with this control"}}}}}}
```

## The WebCategoryMetadataResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"WebCategoryMetadataResponse":{"type":"object","description":"Lightweight category representation with only essential fields.\nUsed in the compliance metadata endpoint for lightweight hierarchy retrieval.\n","required":["id","name","parent_category_id","controls","subcategories"],"properties":{"id":{"type":"string","format":"uuid","description":"Category unique identifier"},"name":{"type":"string","description":"Category name"},"parent_category_id":{"type":"string","format":"uuid","nullable":true,"description":"Always null for top-level categories"},"controls":{"type":"array","items":{"$ref":"#/components/schemas/WebControlMetadataResponse"},"description":"Controls directly under this category"},"subcategories":{"type":"array","items":{"$ref":"#/components/schemas/WebSubcategoryMetadataResponse"},"description":"Subcategories within this category"}}},"WebControlMetadataResponse":{"type":"object","description":"Lightweight control representation with only essential fields.\nUsed in the compliance metadata endpoint for lightweight hierarchy retrieval.\n","required":["id","name","rule_ids"],"properties":{"id":{"type":"string","format":"uuid","description":"Control unique identifier"},"name":{"type":"string","description":"Control name"},"rule_ids":{"type":"array","items":{"type":"string"},"description":"List of rule IDs associated with this control"}}},"WebSubcategoryMetadataResponse":{"type":"object","description":"Lightweight subcategory representation with only essential fields.\nUsed in the compliance metadata endpoint for lightweight hierarchy retrieval.\n","required":["id","name","parent_category_id","controls"],"properties":{"id":{"type":"string","format":"uuid","description":"Subcategory unique identifier"},"name":{"type":"string","description":"Subcategory name"},"parent_category_id":{"type":"string","format":"uuid","description":"UUID of the parent category"},"controls":{"type":"array","items":{"$ref":"#/components/schemas/WebControlMetadataResponse"},"description":"Controls within this subcategory"}}}}}}
```

## The ErrorResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"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"]}}}}}}
```

## The ImportJobResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"ImportJobResponse":{"type":"object","required":["job_id","status","created_at"],"properties":{"job_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["pending"]},"created_at":{"type":"string","format":"date-time"}}}}}}
```

## The ImportStandardResult object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"ImportStandardResult":{"type":"object","required":["folder","standard_name","status"],"properties":{"folder":{"type":"string"},"standard_name":{"type":"string"},"status":{"type":"string","enum":["success","failed"]},"standard_id":{"type":"string","format":"uuid"},"categories_created":{"type":"integer"},"controls_created":{"type":"integer"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}}}}
```

## The ImportStatusResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"ImportStatusResponse":{"type":"object","required":["job_id","status","created_at"],"properties":{"job_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["pending","processing","completed","failed"]},"created_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time","nullable":true},"total_standards":{"type":"integer"},"processed_standards":{"type":"integer"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ImportStandardResult"}}}},"ImportStandardResult":{"type":"object","required":["folder","standard_name","status"],"properties":{"folder":{"type":"string"},"standard_name":{"type":"string"},"status":{"type":"string","enum":["success","failed"]},"standard_id":{"type":"string","format":"uuid"},"categories_created":{"type":"integer"},"controls_created":{"type":"integer"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}}}}
```

## The ExportRequest object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"ExportRequest":{"type":"object","properties":{"standard_ids":{"type":"array","items":{"type":"string","format":"uuid"}}}}}}}
```

## The ExportJobResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"ExportJobResponse":{"type":"object","required":["job_id","status","created_at"],"properties":{"job_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["pending"]},"created_at":{"type":"string","format":"date-time"}}}}}}
```

## The ExportStatusResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"ExportStatusResponse":{"type":"object","required":["job_id","status","created_at"],"properties":{"job_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["pending","processing","completed","failed"]},"created_at":{"type":"string","format":"date-time"},"completed_at":{"type":"string","format":"date-time","nullable":true},"total_standards":{"type":"integer"},"processed_standards":{"type":"integer"},"download_url":{"type":"string","nullable":true}}}}}}
```

## The FilterParams object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"FilterParams":{"type":"object","properties":{"WILDCARD_FILTERABLE":{"type":"boolean","default":false},"HIGHLIGHT_TYPEAHEAD":{"type":"boolean","default":false},"EXPAND_TREE_ON_SEARCH":{"type":"boolean","default":false},"IS_COUNTABLE":{"type":"boolean","default":false},"ENUM_VALUES":{"type":"array","nullable":true,"items":{"type":"object","properties":{"NAME":{"type":"string"},"PRETTY_NAME":{"type":"string"}}}}}}}}}
```

## The ColumnDefinition object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"ColumnDefinition":{"type":"object","properties":{"FIELD_NAME":{"type":"string","description":"Lowercase field name matching the key in get_data DATA rows"},"FIELD_PRETTY_NAME":{"type":"string","description":"Human-readable column header"},"DATA_TYPE":{"type":"string","enum":["TEXT","TIMESTAMP","ENUM","ARRAY","JSON"]},"COLUMN_TYPE":{"type":"string","enum":["DEFAULT"],"default":"DEFAULT"},"IS_HIDDEN":{"type":"boolean","default":false},"SORTABLE":{"type":"boolean","default":false},"FILTERABLE":{"type":"boolean","default":false},"FILTER_PARAMS":{"$ref":"#/components/schemas/FilterParams"},"ORDER_POSITION":{"type":"integer","default":0}}},"FilterParams":{"type":"object","properties":{"WILDCARD_FILTERABLE":{"type":"boolean","default":false},"HIGHLIGHT_TYPEAHEAD":{"type":"boolean","default":false},"EXPAND_TREE_ON_SEARCH":{"type":"boolean","default":false},"IS_COUNTABLE":{"type":"boolean","default":false},"ENUM_VALUES":{"type":"array","nullable":true,"items":{"type":"object","properties":{"NAME":{"type":"string"},"PRETTY_NAME":{"type":"string"}}}}}}}}}
```

## The PredefinedFilter object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"PredefinedFilter":{"type":"object","properties":{"filter":{"nullable":true},"sort":{"type":"array","nullable":true,"items":{}}}}}}}
```

## The SortObject object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"SortObject":{"type":"object","required":["FIELD","ORDER"],"properties":{"FIELD":{"type":"string","description":"Field name to sort by (matches FIELD_NAME in ColumnDefinition)"},"ORDER":{"type":"string","enum":["ASC","DESC"]}}}}}}
```

## The Paging object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"Paging":{"type":"object","required":["from","to"],"properties":{"from":{"type":"integer","minimum":0,"description":"Zero-based start index"},"to":{"type":"integer","minimum":0,"description":"Exclusive end index (to - from = page size)"}}}}}}
```

## The FilterData object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"FilterData":{"type":"object","properties":{"sort":{"type":"array","items":{"$ref":"#/components/schemas/SortObject"},"default":[]},"filter":{"nullable":true,"description":"Predicate filter object (AND/OR tree of Filter conditions)"},"free_text":{"type":"string","default":""},"visible_columns":{"type":"array","nullable":true,"items":{"type":"string"}},"locked":{"type":"object","nullable":true,"description":"Locked (non-user-removable) filter predicates. Optional.\n\nFor `COMPLIANCE_CONTROLS`, a legacy way to scope to a standard is an\n`AND` array with a `SEARCH_FIELD: \"STANDARDS\"` predicate\n(`SEARCH_TYPE: \"ARRAY_CONTAINS\"`) whose `SEARCH_VALUE` is the standard\nname. This is **not required** — the preferred approach is a\n`standard_name` predicate in `filter_data.filter`. If neither is\nsupplied, all controls are returned.\n"},"paging":{"$ref":"#/components/schemas/Paging"}}},"SortObject":{"type":"object","required":["FIELD","ORDER"],"properties":{"FIELD":{"type":"string","description":"Field name to sort by (matches FIELD_NAME in ColumnDefinition)"},"ORDER":{"type":"string","enum":["ASC","DESC"]}}},"Paging":{"type":"object","required":["from","to"],"properties":{"from":{"type":"integer","minimum":0,"description":"Zero-based start index"},"to":{"type":"integer","minimum":0,"description":"Exclusive end index (to - from = page size)"}}}}}}
```

## The ViewDataReply object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"ViewDataReply":{"type":"object","required":["TOTAL_COUNT","FILTER_COUNT","DATA"],"properties":{"TOTAL_COUNT":{"type":"integer","description":"Total number of records in the table (unfiltered)"},"FILTER_COUNT":{"type":"integer","description":"Number of records matching the current filter/page"},"DATA":{"type":"array","description":"List of row objects. Field names are lowercase and match the\n`FIELD_NAME` values returned by `GET /get_view_def`.\n","items":{"type":"object","additionalProperties":true}}}}}}}
```

## The S2SRuleItem object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"S2SRuleItem":{"type":"object","description":"A single rule to associate with a control.\nAccepts BOTH be3 rule-payload spellings (CRTX-265311):\n  * canonical: `rule_id` / `rule_type` (single-control public-API path,\n    migration/content-sync models, and the persisted contract).\n  * controls-catalog rule-management / bulk path: `_logic_id` (aliased to\n    `rule_id`) and `type` (aliased to `rule_type`). That path forwards raw\n    rule objects that also carry display fields (`name`, `description`,\n    `severity`, `_scannable_assets`, `_generate_*`); those extra fields are\n    IGNORED, not rejected.\n\nThe persisted contract is UNCHANGED — the compliance_control_rules PK is `(control_id, control_revision, rule_id, rule_type)`; only the accepted INPUT keys are widened.\n","required":["rule_id"],"additionalProperties":true,"properties":{"rule_id":{"type":"string","description":"Identifier of the rule to associate. Accepts either `rule_id` or the be3 `_logic_id` alias.\n"},"_logic_id":{"type":"string","description":"be3 rule-management alias for `rule_id`. Either `rule_id` or `_logic_id` must be present.\n"},"rule_type":{"type":"string","description":"Type of the rule (e.g. 'custom', 'ootb'). Accepts either `rule_type` or the be3 `type` alias. Defaults to 'custom'.\n","default":"custom"},"type":{"type":"string","description":"be3 rule-management alias for `rule_type`."}}}}}}
```

## The RuleWithType object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"RuleWithType":{"type":"object","description":"A single rule entry with its type, name, and severity.","required":["rule_id","rule_name","rule_type","rule_severity"],"properties":{"rule_id":{"type":"string","description":"Identifier of the rule."},"rule_name":{"type":"string","description":"Display name of the rule (empty until enriched from rule service)."},"rule_type":{"type":"string","description":"Type of the rule (e.g. 'config', 'custom', 'ootb')."},"rule_severity":{"type":"string","description":"Severity of the rule (empty until enriched from rule service)."}}}}}}
```

## The S2SSearchCondition object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"S2SSearchCondition":{"type":"object","description":"A single filter condition for the standards search endpoint.","required":["field","value"],"properties":{"field":{"type":"string","description":"Field name to filter on (e.g. 'name', 'is_custom', 'labels')."},"operator":{"type":"string","description":"Comparison operator (e.g. 'eq', 'contains', 'in').","default":"eq"},"value":{"description":"Value to compare against."}}}}}}
```

## The S2SSearchSort object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"S2SSearchSort":{"type":"object","description":"Sort specification for the standards search endpoint.","required":["field"],"properties":{"field":{"type":"string","description":"Field name to sort by."},"order":{"type":"string","description":"Sort direction: 'asc' or 'desc'.","default":"desc","enum":["asc","desc"]}}}}}}
```

## The S2SSearchPaging object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"S2SSearchPaging":{"type":"object","description":"Pagination specification for the standards search endpoint.","properties":{"offset":{"type":"integer","description":"Number of results to skip.","default":0,"minimum":0},"limit":{"type":"integer","description":"Maximum number of results to return.","default":50,"minimum":1,"maximum":200}}}}}}
```

## The S2SSearchFilterData object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"S2SSearchFilterData":{"type":"object","description":"Filter data envelope for the standards search endpoint.","properties":{"conditions":{"type":"array","items":{"$ref":"#/components/schemas/S2SSearchCondition"},"default":[]},"sort":{"type":"array","items":{"$ref":"#/components/schemas/S2SSearchSort"},"default":[]},"paging":{"$ref":"#/components/schemas/S2SSearchPaging"}}},"S2SSearchCondition":{"type":"object","description":"A single filter condition for the standards search endpoint.","required":["field","value"],"properties":{"field":{"type":"string","description":"Field name to filter on (e.g. 'name', 'is_custom', 'labels')."},"operator":{"type":"string","description":"Comparison operator (e.g. 'eq', 'contains', 'in').","default":"eq"},"value":{"description":"Value to compare against."}}},"S2SSearchSort":{"type":"object","description":"Sort specification for the standards search endpoint.","required":["field"],"properties":{"field":{"type":"string","description":"Field name to sort by."},"order":{"type":"string","description":"Sort direction: 'asc' or 'desc'.","default":"desc","enum":["asc","desc"]}}},"S2SSearchPaging":{"type":"object","description":"Pagination specification for the standards search endpoint.","properties":{"offset":{"type":"integer","description":"Number of results to skip.","default":0,"minimum":0},"limit":{"type":"integer","description":"Maximum number of results to return.","default":50,"minimum":1,"maximum":200}}}}}}
```

## The S2SStandardsMetadataFilterData object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"S2SStandardsMetadataFilterData":{"type":"object","description":"Filter data envelope for the S2S compliance metadata endpoint.\n\nMirrors the be3 `filter_data` shape used by sibling search endpoints\nbut scoped to the small set of metadata filters: `standard_ids`,\n`control_ids`, `rule_ids`, `is_custom`.\n\nFilter conditions are expressed via the `conditions` array of\n`S2SSearchCondition` (field/operator/value triplets). Multiple\nconditions are combined with AND semantics; multiple conditions on\nthe same field are intersected.\n","properties":{"conditions":{"type":"array","description":"List of filter conditions. Supported `field` values:\n- `standard_ids` / `control_ids` / `rule_ids` (operator `in`/`eq`, value: list of strings)\n- `is_custom` (operator `eq`, value: bool)\n","items":{"$ref":"#/components/schemas/S2SSearchCondition"}},"sort":{"type":"array","description":"Sort specifications (currently informational; result order is service-defined).","items":{"$ref":"#/components/schemas/S2SSearchSort"}},"paging":{"$ref":"#/components/schemas/S2SSearchPaging"}}},"S2SSearchCondition":{"type":"object","description":"A single filter condition for the standards search endpoint.","required":["field","value"],"properties":{"field":{"type":"string","description":"Field name to filter on (e.g. 'name', 'is_custom', 'labels')."},"operator":{"type":"string","description":"Comparison operator (e.g. 'eq', 'contains', 'in').","default":"eq"},"value":{"description":"Value to compare against."}}},"S2SSearchSort":{"type":"object","description":"Sort specification for the standards search endpoint.","required":["field"],"properties":{"field":{"type":"string","description":"Field name to sort by."},"order":{"type":"string","description":"Sort direction: 'asc' or 'desc'.","default":"desc","enum":["asc","desc"]}}},"S2SSearchPaging":{"type":"object","description":"Pagination specification for the standards search endpoint.","properties":{"offset":{"type":"integer","description":"Number of results to skip.","default":0,"minimum":0},"limit":{"type":"integer","description":"Maximum number of results to return.","default":50,"minimum":1,"maximum":200}}}}}}
```

## The ContentSyncStandard object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"ContentSyncStandard":{"type":"object","description":"A single standard in the content sync payload.","required":["id","name","version","release_date","revision"],"properties":{"id":{"type":"string","description":"UUID of the standard."},"name":{"type":"string","description":"Name of the standard."},"version":{"type":"string","description":"Version string."},"description":{"type":"string","description":"Description of the standard.","default":""},"publisher":{"type":"string","nullable":true,"description":"Publisher of the standard."},"release_date":{"type":"string","description":"Release date of the standard."},"labels":{"type":"array","items":{"type":"string"},"description":"Labels for the standard.","default":[]},"status":{"type":"string","description":"Status: ACTIVE or INACTIVE.","default":"ACTIVE"},"revision":{"type":"integer","format":"int64","description":"Content-addressable revision hash."},"is_custom":{"type":"boolean","description":"Whether this is a custom standard.","default":false},"control_ids":{"type":"array","items":{"type":"string"},"description":"List of control UUIDs belonging to this standard.","default":[]}}}}}}
```

## The ContentSyncControl object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"ContentSyncControl":{"type":"object","description":"A single control in the content sync payload.","required":["id","name","index","revision"],"properties":{"id":{"type":"string","description":"UUID of the control."},"name":{"type":"string","description":"Name of the control."},"index":{"type":"string","description":"Index of the control within its standard."},"description":{"type":"string","description":"Description of the control.","default":""},"severity":{"type":"string","nullable":true,"description":"Severity level."},"category":{"type":"string","nullable":true,"description":"Category name string (mapped to category entity in Postgres)."},"sub_category":{"type":"string","nullable":true,"description":"Sub-category name string (mapped to child category entity)."},"is_custom":{"type":"boolean","description":"Whether this is a custom control.","default":false},"status":{"type":"string","description":"Status: ACTIVE or INACTIVE.","default":"ACTIVE"},"revision":{"type":"integer","format":"int64","description":"Content-addressable revision hash."},"mitigation":{"type":"string","nullable":true},"impact":{"type":"string","nullable":true},"automation_status":{"type":"string","nullable":true},"audit_procedure":{"type":"string","nullable":true}}}}}}
```

## The ContentSyncStandardToControlRelation object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"ContentSyncStandardToControlRelation":{"type":"object","description":"A standard-to-control relation.","required":["standard_id","control_id","revision"],"properties":{"standard_id":{"type":"string","description":"UUID of the standard."},"control_id":{"type":"string","description":"UUID of the control."},"revision":{"type":"integer","format":"int64","description":"Revision hash for this relation."}}}}}}
```

## The ContentSyncControlToRuleRelation object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"ContentSyncControlToRuleRelation":{"type":"object","description":"A control-to-rule relation.","required":["control_id","rule_id"],"properties":{"control_id":{"type":"string","description":"UUID of the control."},"rule_id":{"type":"string","description":"ID of the rule."},"asset_type_id":{"type":"string","nullable":true,"description":"Asset type ID for the rule."},"logic_id":{"type":"string","nullable":true,"description":"Logic ID for the rule."}}}}}}
```

## The CatalogDataRow object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"CatalogDataRow":{"type":"object","description":"A single row of catalog data for the assessment calc job.","required":["standard_id","standard_name","standard_revision","control_id","control_name","control_index","control_revision"],"properties":{"standard_id":{"type":"string","description":"UUID of the standard."},"standard_name":{"type":"string","description":"Name of the standard."},"standard_revision":{"type":"integer","format":"int64","description":"Revision of the standard."},"standard_labels":{"type":"array","items":{"type":"string"},"default":[]},"control_id":{"type":"string","description":"UUID of the control."},"control_name":{"type":"string","description":"Name of the control."},"control_index":{"type":"string","description":"Index of the control."},"control_revision":{"type":"integer","format":"int64","description":"Revision of the control."},"control_severity":{"type":"string","nullable":true},"control_category":{"type":"string","nullable":true},"control_sub_category":{"type":"string","nullable":true},"control_is_custom":{"type":"boolean","default":false}}}}}}
```

## The GetAssessmentProfilesRequest object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"GetAssessmentProfilesRequest":{"type":"object","required":["request_data"],"properties":{"request_data":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentProfileFilter"}},"sort":{"$ref":"#/components/schemas/AssessmentProfileSortObject"},"search_from":{"type":"integer","minimum":0,"default":0,"description":"Zero-based index of the first assessment profile to return. Use with `search_to` to page through results. For example, `search_from: 0` starts at the first assessment profile; `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 assessment profiles from `search_from` up to, but not including, `search_to`. For example, `search_from: 0` and `search_to: 50` returns the first 50 assessment profiles."}}}}},"AssessmentProfileFilter":{"type":"object","properties":{"field":{"type":"string","description":"Identifies the assessment profile field the filter should match. Filters are based on the following keywords:\n- `name`: Assessment profile name\n- `standard_name` : Standard name\n- `description`: Assessment profile description\n- `asset_group_name`: Asset Group name\n- `created_by`: Creator of the assessment profile\n- `modified_by`: Modifier of the assessment profile\n- `id`: Assessment profile ID\n- `report_type`: Report type\n- `standard_id`: Standard ID\n- `creation_time`: Assessment profile's creation time\n- `modification_time`: Assessment profile's modification time\n- `enabled`: Whether the assessment profile is enabled\n- `asset_group_id`: Asset Group ID"},"operator":{"type":"string","description":"Identifies the comparison operator you want to use for this filter. Valid keywords are:\n\n`eq` / `neq` / `contains` / `not_contains`\n\n- `name`, `standard_name`, `description`, `asset_group_name`, `created_by`, `modified_by`, `id`, `report_type`, `standard_id`: String\n\n`gte`, `lte`, `range`, `relative_timestamp`\n- `creation_time`, `modification_time`: Integer in timestamp epoch milliseconds\n\n`in`\n- `enabled`: valid values are `yes` or `no`\n\n`eq` / `neq`\n- `asset_group_id`: String"},"value":{"oneOf":[{"type":"string","description":"When the `field` value is one of the following, the `value` is type string: `name`, `standard_name`, `description`, `asset_group_name`, `created_by`, `modified_by`, `id`, `report_type`, `standard_id`, `asset_group_id`"},{"type":"integer","description":"When the `field` value is one of the following, the `value` is type integer: `creation_time`, `modification_time`"},{"enum":["yes","no"],"description":"When the `field` value is one of the following, the `value` is type enum: `enabled`"}],"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"}}},"AssessmentProfileSortObject":{"type":"object","properties":{"field":{"type":"string","enum":["name","category","subcategory","creation_time","created_by","modified_by","modified_ts","id","description","standard_name","standard_id","enabled","asset_group_name","modification_time","report_type"],"default":"creation_time","description":"Sort according to this field"},"keyword":{"type":"string","enum":["asc","desc"],"default":"asc","description":"Sort in ascending (`asc`) or descending (`desc`) order"}}}}}}
```

## The EditAssessmentProfileRequest object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"EditAssessmentProfileRequest":{"type":"object","required":["request_data"],"properties":{"request_data":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Assessment profile ID"},"enabled":{"oneOf":[{"type":"string","enum":["yes","no"],"description":"Whether the assessment profile is enabled. Valid values are:\n- `yes`\n- `no`"},{"type":"boolean","description":"Whether the assessment profile is enabled"}],"description":"Enable or disable the assessment profile"},"profile_name":{"type":"string","description":"Name of the assessment profile"},"description":{"type":"string","description":"Description of the assessment profile"},"report_targets":{"type":"array","description":"List of email addresses for reports","items":{"type":"string","format":"email"}},"report_type":{"type":"string","enum":["ALL","PDF","CSV","NONE"],"description":"Type of reporting. Valid values include:\n- `ALL`\n- `PDF`\n- `CSV`\n- `NONE`"},"evaluation_frequency":{"type":"string","description":"Cron expression for assessment report evaluation frequency","format":"cron"},"asset_group_id":{"type":"integer","description":"Asset group ID"},"standard_id":{"type":"string","description":"Compliance standard ID"}}}}}}}}
```

## The AssessmentProfileFilter object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"AssessmentProfileFilter":{"type":"object","properties":{"field":{"type":"string","description":"Identifies the assessment profile field the filter should match. Filters are based on the following keywords:\n- `name`: Assessment profile name\n- `standard_name` : Standard name\n- `description`: Assessment profile description\n- `asset_group_name`: Asset Group name\n- `created_by`: Creator of the assessment profile\n- `modified_by`: Modifier of the assessment profile\n- `id`: Assessment profile ID\n- `report_type`: Report type\n- `standard_id`: Standard ID\n- `creation_time`: Assessment profile's creation time\n- `modification_time`: Assessment profile's modification time\n- `enabled`: Whether the assessment profile is enabled\n- `asset_group_id`: Asset Group ID"},"operator":{"type":"string","description":"Identifies the comparison operator you want to use for this filter. Valid keywords are:\n\n`eq` / `neq` / `contains` / `not_contains`\n\n- `name`, `standard_name`, `description`, `asset_group_name`, `created_by`, `modified_by`, `id`, `report_type`, `standard_id`: String\n\n`gte`, `lte`, `range`, `relative_timestamp`\n- `creation_time`, `modification_time`: Integer in timestamp epoch milliseconds\n\n`in`\n- `enabled`: valid values are `yes` or `no`\n\n`eq` / `neq`\n- `asset_group_id`: String"},"value":{"oneOf":[{"type":"string","description":"When the `field` value is one of the following, the `value` is type string: `name`, `standard_name`, `description`, `asset_group_name`, `created_by`, `modified_by`, `id`, `report_type`, `standard_id`, `asset_group_id`"},{"type":"integer","description":"When the `field` value is one of the following, the `value` is type integer: `creation_time`, `modification_time`"},{"enum":["yes","no"],"description":"When the `field` value is one of the following, the `value` is type enum: `enabled`"}],"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"}}}}}}
```

## The AssessmentProfileSortObject object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"AssessmentProfileSortObject":{"type":"object","properties":{"field":{"type":"string","enum":["name","category","subcategory","creation_time","created_by","modified_by","modified_ts","id","description","standard_name","standard_id","enabled","asset_group_name","modification_time","report_type"],"default":"creation_time","description":"Sort according to this field"},"keyword":{"type":"string","enum":["asc","desc"],"default":"asc","description":"Sort in ascending (`asc`) or descending (`desc`) order"}}}}}}
```

## The AssetSortObject object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"AssetSortObject":{"type":"object","properties":{"field":{"type":"string","enum":["asset_name","asset_type","status","rule_name","control","severity"],"description":"Field to sort by","default":"asset_name"},"keyword":{"type":"string","enum":["asc","desc"],"default":"asc","description":"Sort direction"}}}}}}
```

## The AssessmentProfile object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"AssessmentProfile":{"type":"object","properties":{"id":{"type":"string","description":"Assessment profile ID"},"name":{"type":"string","description":"Assessment profile name"},"description":{"type":"string","description":"Description of the assessment profile"},"enabled":{"type":"boolean","description":"Whether the assessment profile is enabled"},"standard_id":{"type":"string","description":"Standard ID"},"standard_name":{"type":"string","description":"Standard name"},"asset_group_id":{"type":"integer","description":"Asset Group ID"},"asset_group_name":{"type":"string","description":"Asset Group name"},"report_type":{"type":"string","description":"Report type"},"report_targets":{"type":"array","items":{"type":"string","format":"email"}},"evaluation_frequency":{"type":"string"},"creation_time":{"type":"string","format":"date-time","description":"Assessment profile creation time"},"modification_time":{"type":"string","format":"date-time","description":"Assessment profile modification time"},"created_by":{"type":"string","description":"Assessment profile creator"},"modified_by":{"type":"string","description":"Assesment profile modified by"}}}}}}
```

## The AssessmentProfilesResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"AssessmentProfilesResponse":{"type":"object","properties":{"reply":{"type":"object","properties":{"total_count":{"type":"integer","description":"Total number of records"},"result_count":{"type":"integer","description":"Number of records matching the filter + paging"},"assessment_profiles":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentProfile"}}}}}},"AssessmentProfile":{"type":"object","properties":{"id":{"type":"string","description":"Assessment profile ID"},"name":{"type":"string","description":"Assessment profile name"},"description":{"type":"string","description":"Description of the assessment profile"},"enabled":{"type":"boolean","description":"Whether the assessment profile is enabled"},"standard_id":{"type":"string","description":"Standard ID"},"standard_name":{"type":"string","description":"Standard name"},"asset_group_id":{"type":"integer","description":"Asset Group ID"},"asset_group_name":{"type":"string","description":"Asset Group name"},"report_type":{"type":"string","description":"Report type"},"report_targets":{"type":"array","items":{"type":"string","format":"email"}},"evaluation_frequency":{"type":"string"},"creation_time":{"type":"string","format":"date-time","description":"Assessment profile creation time"},"modification_time":{"type":"string","format":"date-time","description":"Assessment profile modification time"},"created_by":{"type":"string","description":"Assessment profile creator"},"modified_by":{"type":"string","description":"Assesment profile modified by"}}}}}}
```

## The AssessmentProfileResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"AssessmentProfileResponse":{"$ref":"#/components/schemas/AssessmentProfile"},"AssessmentProfile":{"type":"object","properties":{"id":{"type":"string","description":"Assessment profile ID"},"name":{"type":"string","description":"Assessment profile name"},"description":{"type":"string","description":"Description of the assessment profile"},"enabled":{"type":"boolean","description":"Whether the assessment profile is enabled"},"standard_id":{"type":"string","description":"Standard ID"},"standard_name":{"type":"string","description":"Standard name"},"asset_group_id":{"type":"integer","description":"Asset Group ID"},"asset_group_name":{"type":"string","description":"Asset Group name"},"report_type":{"type":"string","description":"Report type"},"report_targets":{"type":"array","items":{"type":"string","format":"email"}},"evaluation_frequency":{"type":"string"},"creation_time":{"type":"string","format":"date-time","description":"Assessment profile creation time"},"modification_time":{"type":"string","format":"date-time","description":"Assessment profile modification time"},"created_by":{"type":"string","description":"Assessment profile creator"},"modified_by":{"type":"string","description":"Assesment profile modified by"}}}}}}
```

## The GetAssessmentResultsRequest object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"GetAssessmentResultsRequest":{"type":"object","properties":{"request_data":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentResultFilterObject"},"description":"Array of filter objects"}}}},"required":["request_data"]},"AssessmentResultFilterObject":{"type":"object","description":"Filter object for querying assessment results","required":["field","operator","value"],"properties":{"field":{"type":"string","enum":["labels"],"description":"Field to filter on (only 'labels' is supported)"},"operator":{"type":"string","enum":["contains","not_contains"],"description":"Filter operator to apply. Valid values include:\n- `contains`\n- `not_contains`"},"value":{"type":"string","description":"Value to filter by"}}}}}}
```

## The AssessmentResultsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"AssessmentResultsResponse":{"type":"object","properties":{"reply":{"type":"object","properties":{"total_count":{"type":"integer","description":"Total number of assessment results available"},"result_count":{"type":"integer","description":"Number of assessment results matching the applied filters"},"standard_filter_count":{"type":"integer","description":"Count from standard filter processing"},"standard_total_count":{"type":"integer","description":"Total count from standard processing"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AssessmentResult"},"description":"Array of assessment profile results"}}}}},"AssessmentResult":{"type":"object","description":"Individual assessment profile result data"}}}}
```

## The AssessmentResult object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"AssessmentResult":{"type":"object","description":"Individual assessment profile result data"}}}}
```

## The GetAssetsRequest object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"GetAssetsRequest":{"type":"object","required":["request_data"],"properties":{"request_data":{"type":"object","required":["assessment_profile_revision","last_evaluation_time"],"properties":{"assessment_profile_revision":{"type":"string","description":"Assessment profile revision identifier"},"last_evaluation_time":{"type":"integer","format":"int64","description":"Last evaluation timestamp in epoch format"},"filters":{"type":"array","description":"Array of filter objects for filtering assets","items":{"$ref":"#/components/schemas/AssetFilterObject"}},"sort":{"$ref":"#/components/schemas/AssetSortObject"},"search_from":{"type":"integer","minimum":0,"default":0,"description":"Starting index for pagination"},"search_to":{"type":"integer","minimum":1,"default":100,"description":"Ending index for pagination"}}}}},"AssetFilterObject":{"type":"object","description":"Filter object for querying compliance assets","required":["field","operator","value"],"properties":{"field":{"type":"string","enum":["asset_name","asset_type","status","rule_name","control","severity","rule_type","SEVERITY","ASSET_NAME","ASSET_TYPE","STATUS","RULE_NAME","CONTROL","RULE_TYPE"],"description":"Field to filter on"},"operator":{"type":"string","description":"Filter operator to apply"},"value":{"type":"string","description":"Value to filter by"}},"allOf":[{"if":{"properties":{"field":{"enum":["asset_name","rule_name","control","ASSET_NAME","RULE_NAME","CONTROL"]}}},"then":{"properties":{"operator":{"enum":["eq","neq","contains","not_contains"]}}}},{"if":{"properties":{"field":{"enum":["asset_type","status","severity","rule_type","ASSET_TYPE","STATUS","SEVERITY","RULE_TYPE"]}}},"then":{"properties":{"operator":{"enum":["eq","neq"]}}}},{"if":{"properties":{"field":{"enum":["status","STATUS"]}}},"then":{"properties":{"value":{"enum":["FAILED","PASSED","NOT_ASSESSED"]}}}},{"if":{"properties":{"field":{"enum":["severity","SEVERITY"]}}},"then":{"properties":{"value":{"enum":["low","medium","high","critical"]}}}}]},"AssetSortObject":{"type":"object","properties":{"field":{"type":"string","enum":["asset_name","asset_type","status","rule_name","control","severity"],"description":"Field to sort by","default":"asset_name"},"keyword":{"type":"string","enum":["asc","desc"],"default":"asc","description":"Sort direction"}}}}}}
```

## The AssetsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"AssetsResponse":{"type":"object","properties":{"reply":{"type":"object","properties":{"total_count":{"type":"integer","description":"Total number of assets available"},"result_count":{"type":"integer","description":"Number of assets matching the applied filters + paging"},"filter_count":{"type":"integer","description":"Number of assets matching the applied filters"},"assets":{"type":"array","description":"Array of compliance assets","items":{"$ref":"#/components/schemas/ComplianceAsset"}}}}}},"ComplianceAsset":{"type":"object","description":"Compliance asset information","properties":{"ASSET_ID":{"type":"string","description":"Identifier for the asset"},"ASSET_NAME":{"type":"string","description":"Name of the asset"},"ASSET_TYPE":{"type":"string","description":"Type of the asset"},"STATUS":{"type":"string","enum":["FAILED","PASSED","NOT_ASSESSED"],"description":"Compliance status of the asset"},"RULE_NAME":{"type":"string","description":"Name of the compliance rule"},"CONTROL":{"type":"string","description":"Associated compliance control"},"RULE_REVISION_ID":{"type":"string","description":"Identifier for the compliance rule"},"CONTROL_REVISION_ID":{"type":"integer","format":"int64","description":"Identifier for the associated compliance control"},"SOURCE":{"type":"string","description":"Asset source"},"SEVERITY":{"type":"string","enum":["low","medium","high","critical"],"description":"Severity level of the compliance issue"},"RULE_TYPE":{"type":"string","description":"Type of the compliance rule"},"PROVIDER":{"type":"string","description":"Cloud provider"},"REGION":{"type":"string","description":"Geographic region"},"REALM":{"type":"string","description":"Realm identifier"},"TAGS":{"type":"object","additionalProperties":{"type":"string"},"description":"Asset tags"},"ORGANIZATION":{"type":"string","nullable":true,"description":"Organization identifier"},"ASSET_STRONG_ID":{"type":"string","description":"Strong identifier for the asset"}}}}}}
```

## The ComplianceAsset object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"ComplianceAsset":{"type":"object","description":"Compliance asset information","properties":{"ASSET_ID":{"type":"string","description":"Identifier for the asset"},"ASSET_NAME":{"type":"string","description":"Name of the asset"},"ASSET_TYPE":{"type":"string","description":"Type of the asset"},"STATUS":{"type":"string","enum":["FAILED","PASSED","NOT_ASSESSED"],"description":"Compliance status of the asset"},"RULE_NAME":{"type":"string","description":"Name of the compliance rule"},"CONTROL":{"type":"string","description":"Associated compliance control"},"RULE_REVISION_ID":{"type":"string","description":"Identifier for the compliance rule"},"CONTROL_REVISION_ID":{"type":"integer","format":"int64","description":"Identifier for the associated compliance control"},"SOURCE":{"type":"string","description":"Asset source"},"SEVERITY":{"type":"string","enum":["low","medium","high","critical"],"description":"Severity level of the compliance issue"},"RULE_TYPE":{"type":"string","description":"Type of the compliance rule"},"PROVIDER":{"type":"string","description":"Cloud provider"},"REGION":{"type":"string","description":"Geographic region"},"REALM":{"type":"string","description":"Realm identifier"},"TAGS":{"type":"object","additionalProperties":{"type":"string"},"description":"Asset tags"},"ORGANIZATION":{"type":"string","nullable":true,"description":"Organization identifier"},"ASSET_STRONG_ID":{"type":"string","description":"Strong identifier for the asset"}}}}}}
```

## The AssessmentResultFilterObject object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"AssessmentResultFilterObject":{"type":"object","description":"Filter object for querying assessment results","required":["field","operator","value"],"properties":{"field":{"type":"string","enum":["labels"],"description":"Field to filter on (only 'labels' is supported)"},"operator":{"type":"string","enum":["contains","not_contains"],"description":"Filter operator to apply. Valid values include:\n- `contains`\n- `not_contains`"},"value":{"type":"string","description":"Value to filter by"}}}}}}
```

## The AssetFilterObject object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"AssetFilterObject":{"type":"object","description":"Filter object for querying compliance assets","required":["field","operator","value"],"properties":{"field":{"type":"string","enum":["asset_name","asset_type","status","rule_name","control","severity","rule_type","SEVERITY","ASSET_NAME","ASSET_TYPE","STATUS","RULE_NAME","CONTROL","RULE_TYPE"],"description":"Field to filter on"},"operator":{"type":"string","description":"Filter operator to apply"},"value":{"type":"string","description":"Value to filter by"}},"allOf":[{"if":{"properties":{"field":{"enum":["asset_name","rule_name","control","ASSET_NAME","RULE_NAME","CONTROL"]}}},"then":{"properties":{"operator":{"enum":["eq","neq","contains","not_contains"]}}}},{"if":{"properties":{"field":{"enum":["asset_type","status","severity","rule_type","ASSET_TYPE","STATUS","SEVERITY","RULE_TYPE"]}}},"then":{"properties":{"operator":{"enum":["eq","neq"]}}}},{"if":{"properties":{"field":{"enum":["status","STATUS"]}}},"then":{"properties":{"value":{"enum":["FAILED","PASSED","NOT_ASSESSED"]}}}},{"if":{"properties":{"field":{"enum":["severity","SEVERITY"]}}},"then":{"properties":{"value":{"enum":["low","medium","high","critical"]}}}}]}}}}
```

## The Filter object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"Filter":{"type":"object","required":["field","operator","value"],"properties":{"field":{"type":"string","enum":["name","category","subcategory","is_custom","creation_time","created_by","modified_by","modification_time","id","description"],"description":"Identifies the compliance control field the filter should match. Filters are based on the following keywords:\n- `name`: Compliance control name\n- `category` : Compliance control category\n- `subcategory`: Compliance control subcategory\n- `description`: Compliance control description\n- `created_by`: Creator of the compliance control\n- `modified_by`: Modifier of the compliance control\n- `id`: Compliance control ID\n- `creation_time`: Compliance control's creation time\n- `modification_time`: Compliance control's modification time\n- `is_custom`: Whether the compliance control is custom"},"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`, `category`, `subcategory`, `created_by`, `modified_by`, `id`, `description`: String\n\n`gte`, `lte`, `range`, `relative_timestamp`: \n- `creation_time`, `modification_time`: Integer in timestamp epoch milliseconds\n\n`in`:\n- `is_custom`: valid values are `yes` or `no`"},"value":{"oneOf":[{"type":"string","description":"When the `field` value is one of the following, the `value` is type string: `name`, `category`, `subcategory`, `created_by`, `modified_by`, `id`, `description`"},{"type":"integer","description":"When the `field` value is one of the following, the `value` is type integer: `creation_time`, `modification_time`"},{"enum":["yes","no"],"description":"When the `field` value is one of the following, the `value` is type enum: `is_custom`"}],"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."}}}}}}
```

## The Control object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"Control":{"type":"object","properties":{"id":{"type":"string","description":"Compliance control ID"},"name":{"type":"string","description":"Compliance control name"},"description":{"type":"string","description":"Description of the ompliance control"},"category":{"type":"string","description":"Compliance control category"},"subcategory":{"type":"string","description":"Compliance control subcategory"},"creation_time":{"type":"integer","format":"int64","description":"Creation timestamp"},"modification_time":{"type":"integer","format":"int64","description":"Last modification timestamp"},"created_by":{"type":"string","description":"User who created the control"},"modified_by":{"type":"string","description":"User who last modified the control"},"is_custom":{"type":"boolean","description":"Whether this is a custom control"}}}}}}
```

## The ComplianceReport object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"ComplianceReport":{"type":"object","description":"Archived compliance assessment report"}}}}
```

## The ReportFilter object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"ReportFilter":{"type":"object","required":["field","operator","value"],"properties":{"field":{"enum":["standard_name","assessment_profile_name","asset_group_name","score","evaluation_time"],"description":"Identifies the compliance report field the filter should match. Filters are based on the following keywords:\n- `standard_name`: Standard name\n- `assessment_profile_name`: Assessment profile name\n- `asset_group_name`: Asset Group name\n- `score`: Compliance score\n- `evaluation_time`: Evaluation time"},"operator":{"enum":["eq","neq","contains","not_contains","gte","lte","range","relative_timestamp"],"description":"Identifies the comparison operator you want to use for this filter. Valid keywords are:\n\n`eq` / `neq` / `contains` / `not_contains`: \n- `standard_name`, `assessment_profile_name`, `asset_group_name`: String\n\n`gte` / `lte` / `range` / `relative_timestamp`: \n- `evaluation_time``: Integer in timestamp epoch milliseconds\n\n`gte` / `lte` / `eq` / `neq`:\n- `score`: Integer"},"value":{"oneOf":[{"type":"string","description":"When the `field` value is one of the following, the `value` is type string: `standard_name`, `assessment_profile_name`, `asset_group_name`"},{"type":"integer","description":"When the `field` value is one of the following, the `value` is type integer: `evaluation_time`, `score`"}],"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."}}}}}}
```

## The Rule object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"Rule":{"type":"object","required":["name","type","logical_id","scannable_assets","generate_findings","generate_issues","generate_scan_logs"],"properties":{"name":{"type":"string","description":"Rule name"},"description":{"type":"string","description":"Description of the rule"},"type":{"type":"string","description":"Rule type","enum":["Identity"]},"logical_id":{"type":"string","description":"Logical identifier for the rule"},"severity":{"type":"string","description":"Rule severity level","enum":["low","medium","high","critical"],"default":"low"},"scannable_assets":{"type":"array","description":"List of scannable asset types","items":{"type":"string"}},"remediation_steps":{"type":"string","description":"Steps to remediate violations"},"generate_findings":{"type":"boolean","description":"Whether to generate findings for this rule"},"generate_issues":{"type":"boolean","description":"Whether to generate issues for this rule"},"generate_scan_logs":{"type":"boolean","description":"Whether to generate scan logs for this rule"}}}}}}
```

## The Error object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"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"}}}}}}}}
```

## The Findings object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"Findings":{"title":"Findings","type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}}}}}}}
```

## The Issues object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"Issues":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Severity name"},"pretty_name":{"type":"string"},"value":{"type":"integer","description":"The number of issues with this level of severity"},"ids":{"type":"array","description":"List of issue IDs with this level of severity","items":{"type":"string"}}}}}}}}
```

## The SuccessResponse object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"schemas":{"SuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation success status"}}}}}}
```

## The Standard object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"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"}}}}}}}
```

## The StandardFilter object

```json
{"openapi":"3.0.3","info":{"title":"Compliance Controls API","version":"Cortex XDR 5.1"},"components":{"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."}}}}}}
```


---

# 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/models.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.