> 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/xpanse-api/xpanse-public-api/audit-log.md).
# Audit Log
APIs for audit logs
## Get Audit Management Log
> Get audit management logs. \
- Response is concatenated using AND condition (OR is not supported). \
- Maximum result set size is 100. \
- Offset is the zero-based number of incidents from the start of the result set.
```json
{"openapi":"3.0.2","info":{"title":"Cortex Xpanse REST API","version":"2.12.0"},"tags":[{"name":"Audit Log","description":"APIs for audit logs"}],"servers":[{"url":"https://api-{{fqdn}}"}],"paths":{"/public_api/v1/audits/management_logs/":{"post":{"parameters":[{"in":"header","name":"authorization","description":"api-key","schema":{"type":"string"},"required":true},{"in":"header","name":"x-xdr-auth-id","description":"api-key-id","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManagementLogsResponseApi"}}}},"400":{"description":"Bad Request. Got an invalid JSON.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"401":{"description":"Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"402":{"description":"Unauthorized access. User does not have the required license type to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"403":{"description":"Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}},"422":{"$ref":"#/components/responses/UNPROCESSABLE_ENTITY"},"500":{"description":"Internal server error. A unified status for API communication type errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultApiErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManagementLogsRequestApi"}}},"description":"Note: You can send a request to retrieve either **all** or **filtered** results."},"summary":"Get Audit Management Log","tags":["Audit Log"],"description":"Get audit management logs.
- Response is concatenated using AND condition (OR is not supported).
- Maximum result set size is 100.
- Offset is the zero-based number of incidents from the start of the result set.\n"}}},"components":{"schemas":{"GetManagementLogsResponseApi":{"type":"object","properties":{"reply":{"$ref":"#/components/schemas/ManagementLogsPageApi"}},"required":["reply"],"additionalProperties":true},"ManagementLogsPageApi":{"type":"object","properties":{"total_count":{"type":"integer","minimum":0},"result_count":{"type":"integer","minimum":0},"data":{"type":"array","items":{"$ref":"#/components/schemas/ManagementLogApi"}}},"required":["data","result_count","total_count"],"additionalProperties":true},"ManagementLogApi":{"type":"object","properties":{"AUDIT_ID":{"type":"integer"},"AUDIT_OWNER_NAME":{"type":"string"},"AUDIT_OWNER_EMAIL":{"type":"string"},"AUDIT_ASSET_JSON":{"type":"object","nullable":true},"AUDIT_ASSET_NAMES":{"type":"string","nullable":true},"AUDIT_HOSTNAME":{"type":"string","nullable":true},"AUDIT_RESULT":{"type":"string"},"AUDIT_REASON":{"type":"string","nullable":true},"AUDIT_DESCRIPTION":{"type":"string","nullable":true},"AUDIT_ENTITY":{"type":"string","enum":["LIVE_TERMINAL","RULES","RULES_EXCEPTIONS","AUTH","RESPONSE","INCIDENT_MANAGEMENT","ALERT_MANAGEMENT","INCIDENT_TIMELINE_EVENT","ENDPOINT_MANAGEMENT","ENDPOINT_GROUPS","ALERT_WHITELIST","PUBLIC_API","DISTRIBUTIONS","STARRED_INCIDENTS","POLICY_PROFILES","DEVICE_CONTROL_PROFILES","DEVICE_CONTROL_POLICY","PROTECTION_PROFILES","DEVICE_CONTROL_PROFILE","HOST_FIREWALL_PROFILE","HOST_DISK_ENCRYPTION_PROFILE","POLICY_RULES","PROTECTION_POLICY","DEVICE_CONTROL_TEMP_EXCEPTIONS","DEVICE_CONTROL_GLOBAL_EXCEPTIONS","DEVICE_CONTROL_CUSTOM_DEVICE","GLOBAL_EXCEPTIONS","MSSP","REPORTING","DASHBOARD","BROKER_API","BROKER_VM","MTH","MDR","ALERT_NOTIFICATIONS","INTEGRATIONS","QUERY","SCRIPT_EXECUTION","ALERT_RULES","COLLECTION","API_KEY","EDL","VA_RESCAN_ENDPOINT","HI_RESCAN_ENDPOINT","REMEDIATION","INGEST_DATA","LICENSING","AGENT_CONFIGURATION","PERMISSIONS","SCORING_RULES","LAYOUT_RULES","PLAYBOOK_TRIGGERS","FEATURED_ALERT_FIELDS","SYSTEM","TENANT_TAKEOVER","SCOUTER_POLICY","SCOUTER_PROFILE","SCOUTER_GROUPS","ALLOWED_DOMAINS","QUERY_LIBRARY","TENANT_CONFIGURATION","SCOUTER_CONFIGURATION","HOST_FIREWALL","XIF","XDM","ACTION_CENTER","XCLOUD_INTEGRATION","DATASETS","XSOAR","SECURITY_SETTINGS","ALERT_EXCLUSION","INDICATOR_RULES","EVENT_FORWARDING","ASSET_INVENTORY","SERVER_SETTINGS","ASSET_ROLES","CUSTOM_FIELDS","AUTOMATION_RULES","AGENT_EXCEPTION_RULES","REMEDIATION_PATH_RULES"]},"AUDIT_ENTITY_SUBTYPE":{"type":"string"},"AUDIT_SESSION_ID":{"type":"string","nullable":true},"AUDIT_CASE_ID":{"type":"string","nullable":true},"AUDIT_INSERT_TIME":{"type":"integer"},"AUDIT_SEVERITY":{"type":"string"},"AUDIT_LINK":{"type":"string","nullable":true},"AUDIT_SOURCE_IP":{"type":"string"},"AUDIT_USER_AGENT":{"type":"string"},"AUDIT_USER_ROLES":{"type":"array","items":{"type":"string"}}},"additionalProperties":true},"DefaultApiErrorResponse":{"type":"object","properties":{"reply":{"description":"The query results upon error.","allOf":[{"$ref":"#/components/schemas/GenericReply"}]}},"required":["reply"],"additionalProperties":true},"GenericReply":{"type":"object","properties":{"err_code":{"type":"string","description":"HTTP response code."},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","description":"Additional information describing the error."}},"additionalProperties":true},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors"}}},"GetManagementLogsRequestApi":{"type":"object","properties":{"request_data":{"$ref":"#/components/schemas/GetManagementLogsRequestDataApi"}},"required":["request_data"],"additionalProperties":true},"GetManagementLogsRequestDataApi":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/ManagementLogsFilterApi"}},"search_from":{"type":"integer","default":0,"minimum":0},"search_to":{"type":"integer","default":100,"minimum":0},"sort":{"$ref":"#/components/schemas/GetManagementLogsSortApi"}}},"ManagementLogsFilterApi":{"type":"object","properties":{"field":{"type":"string","enum":["email","type","sub_type","result","timestamp","audit_id"]},"operator":{"type":"string","enum":["in","neq","eq","lte","gte"]},"value":{"type":"integer"}},"additionalProperties":true},"GetManagementLogsSortApi":{"type":"object","properties":{"field":{"type":"string","default":"timestamp","enum":["sub_type","result","timestamp","audit_id","type"]},"keyword":{"type":"string","default":"desc","enum":["ASC","asc","DESC","desc"]}},"additionalProperties":true}},"responses":{"UNPROCESSABLE_ENTITY":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```
---
# 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/xpanse-api/xpanse-public-api/audit-log.md?ask=&goal=
```
`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.