Get ZTR Audit Package Events

get

https://jf.example.com/xray/api/v1/ztr/audit/packages

Returns every evaluated Zero-Touch Remediation package event in the requested time window, including events that were not patched and events that did not need a patch.

The default window is the last seven days. created_at_start and created_at_end are inclusive RFC3339 timestamps. created_at_end must not be earlier than created_at_start.

format=json returns one object per audit event. format=csv returns a ZIP archive. CSV pagination still counts audit events. Each evaluated version becomes its own CSV row, and the event fields are repeated on every row for that event. Group rows by id or event_id.

include_total=true adds meta.total_count to the JSON response. Sending include_total with format=csv is rejected, including include_total=false.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

order_by

string

enum

Defaults to created_at

Sort field. Defaults to created_at.

Allowed:

direction

string

enum

Defaults to desc

Sort direction. Defaults to desc.

Allowed:

num_of_rows

integer

≥ 1

Defaults to 100

Number of audit events to return. Defaults to 100. Minimum is 1. JSON allows at most 2000. CSV allows at most 500000.

offset

integer

≥ 0

Defaults to 0

Zero-based event offset. Defaults to 0.

created_at_start

date-time

Inclusive RFC3339 start time. Defaults to seven days before the request is received.

created_at_end

date-time

Inclusive RFC3339 end time. Defaults to the request time.

include_total

boolean

Defaults to false

When true, the JSON response includes meta.total_count. Defaults to false. Not accepted when format is csv.

format

string

enum

Defaults to json

Response format. json returns the event list. csv returns a ZIP archive. Defaults to json.

Allowed:

status

string

Audit status. Accepts one value or a comma-separated list.

package_name

string

Case-insensitive substring of the package name. %, _, and \ are matched literally.

ecosystem

string

Package ecosystem. Accepts one value or a comma-separated list of maven and npm.

repo_key

string

Exact repository key. Accepts one value or a comma-separated list.

requested_by

string

Request source. Accepts one value or a comma-separated list of artifactory and jfrog_cli.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/zip

400A query parameter is unknown, repeated, empty, or has a value this API does not accept. num_of_rows above 2000 is rejected for JSON, and above 500000 is rejected for CSV.

401Authentication is required or the credentials are invalid.

403The caller is not authorized to invoke the endpoint.

404The Self-Healing feature is disabled.

500The audit list could not be read, or the CSV export could not be written. JSON failures use failed fetching self-heal audit. CSV failures use failed exporting self-heal audit.