Get Audit Management Log

Retrieve management logs.

Synopsis

URI	/public_api/v1/audits/management_logs/
HTTP Method	POST
Required License	Cortex XDR Prevent, Cortex XDR Pro per Endpoint, or Cortex XDR Pro per TB

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.

Request Fields

The body of this request contains a JSON object with the following fields:

You can send a request to retrieve either all
or filtered
results.

Field	Description
request_data	(`Required`) A dictionary containing the API request fields. An empty dictionary returns all results.
filters	Provides an array of filtered fields. Each JSON object can contain the following keywords: field String that identifies a list. Filters are based on the following keywords: email —User’s email address. type —Type of audit log. sub_type —Subtype of audit log result —Result type timestamp —Log timestamp operator String that identifies the comparison operator you want to use for this filter. Valid keywords and values are: in email , type , sub_type , result —List of strings gte and lte timestamp —Integer in timestamp epoch milliseconds value Value that this filter must match. timestamp - Integer representing the number of milliseconds after the Unix epoch, UTC timezone. All other fields require a string value. In the case of in operator, the value is a list of possible values enclosed in square brackets.
search_from	An integer representing the starting offset within the query result set from which you want management logs returned. Management logs are returned as a zero-based list. Any log indexed less than this value is not returned in the final result set and defaults to zero.
search_to	An integer representing the end offset within the result set after which you do not want management logs returned. Logs in the management log list that are indexed higher than this value are not returned in the final results set. Defaults to 100, which returns all logs to the end of the list.
sort	Identifies the sort order for the result set. By default the sort is defined as creation-time and desc . field —String, either type , sub_type , result . keyword —String, either acs (ascending order) or desc (descending order).

Request Example

Request all results:

curl -X POST https://api-{fqdn}/public_api/v1/audits/management_logs/ \
-H "x-xdr-auth-id:{API_KEY_ID}" \
-H "Authorization:{API_KEY}" \
-H "Content-Type:application/json" \
-d '{ 
   "request_data":{}
   }'

Request filtered results:


curl -X POST https://api-{fqdn}/public_api/v1/audits/management_logs/ \    
-H "x-xdr-auth-id:{API_KEY_ID}" \    
-H "Authorization:{API_KEY}" \    
-H "Content-Type:application/json" \    
-d '{ 
   "request_data":{ 
      "filters":[ 
         { 
            "field":"timestamp",
            "operator":"gte",
            "value":0
         }
      ],
      "sort":{ 
         "field":"timestamp",
         "keyword":"asc"
      }'

Success Response

Upon success, the HTTP response code is 200. In addition, this API returns a JSON object containing the query status, as well as an array of JSON objects, each of which represents a single management log.

Field	Description
reply	JSON object containing the query result.
total_count	Number of total results of this filter without paging.
result_count	Number of returned items (integer).
endpoints	List of audit items: AUDIT_ID integer AUDIT_OWNER_NAME string AUDIT_OWNER_EMAIL string AUDIT_ASSET_JSON string AUDIT_ASSET_NAMES list of strings representing asset names AUDIT_HOSTNAME string AUDIT_RESULT string AUDIT_REASON string AUDIT_DESCRIPTION string AUDIT_ENTITY string AUDIT_ENTITY_SUBTYPE string AUDIT_SESSION_ID integer AUDIT_CASE_ID integer AUDIT_INSERT_TIME integer, epoch time in epoch milliseconds, UTC timezone

Success Response Example

 
{ 
   "reply":{
   	  "total_count":1,	 
      "result_count":1,
      "data":[ 
         { 
            "AUDIT_ID":1,
            "AUDIT_OWNER_NAME":"User Name",
            "AUDIT_OWNER_EMAIL":"username@paloaltonetworks.com",
            "AUDIT_ASSET_JSON":"{}",
            "AUDIT_ASSET_NAMES":"",
            "AUDIT_HOSTNAME":null,
            "AUDIT_RESULT":"SUCCESS",
            "AUDIT_REASON":null,
            "AUDIT_DESCRIPTION":null,
            "AUDIT_ENTITY":"AUTH",
            "AUDIT_ENTITY_SUBTYPE":"Login",
            "AUDIT_SESSION_ID":null,
            "AUDIT_CASE_ID":null,
            "AUDIT_INSERT_TIME":1565074114053
         }
      ]
   }
}

Error Response

Upon error, the reply includes an HTTP response code, an error message, and additional information describing the error. The HTTP response code is one of the following:

Field	Description
400	Bad Request. Got an invalid JSON.
401	Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.
402	Unauthorized access. User does not have the required license type to run this API.
403	Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.
500	Internal server error. A unified status for API communication type errors.

Error Response Format

{"reply": {"err_code": STATUS_CODE, "err_msg": GENERAL_MESSAGE, "err_extra": EXTRA_DATA}}

Document:Cortex XDR™ API Reference

Get Audit Management Log

Get Audit Management Log

Synopsis

Description

Request Fields

Success Response

Error Response

Recommended For You

Document:Cortex XDR™ API Reference

Get Audit Management Log

Get Audit Management Log

Synopsis

Description

Request Fields

Success Response

Error Response

Recommended For You

Recommended Videos