List Audit Records¶

List audit records

URI Template

GET /api/audit/records/{instance}

{instance}

Yamcs instance name

Query Parameters

limit

The maximum number of returned records per page. Choose this value too high and you risk hitting the maximum response size limit enforced by the server. Default: 100

next

Continuation token returned by a previous page response.

start

Filter the lower bound of the record's time. Specify a date string in ISO 8601 format. This bound is inclusive.

stop

Filter the upper bound of the record's time. Specify a date string in ISO 8601 format. This bound is exclusive.

q

Text to search for in the summary.

service

Include only records matching the specified service.

Response Type

interface ListAuditRecordsResponse {

  // Page with matching records
  records: AuditRecord[];

  // Token indicating the response is only partial. More results can then
  // be obtained by performing the same request (including all original
  // query parameters) and setting the ``next`` parameter to this token.
  continuationToken: string;
}

Related Types

interface AuditRecord {
  time: string;  // RFC 3339 timestamp
  service: string;
  method: string;
  user: string;
  summary: string;
  request: {[key: string]: any};
}