Audit trails

The audit log records all requests made to the API, excluding the request data, for later use. It is typically used for troubleshooting, to be able to determine what happened when, and for examining actions taken by users or other services.

Examining the log

Retrieving log content

GET /log

Retrieves log entries according to the specified filtering criteria. The path can be seen as having an implicit wildcard in the end, unless it is disabled with the wildcard parameter. For example /item/VX-123 will match /item/VX-123/shape but not /item/VX-124.

Query Parameters:
 
  • path – Optional string, matches path in log lines, default is /.
  • first – Optional integer, number of first row to return, default is 0.
  • rows – Optional integer, number of rows to return, default is 100. Cannot be greater than 1000.
  • starttime – Optional ISO 8601 time, for lower limit of rows to return.
  • endtime – Optional ISO 8601 time, for upper limit of rows to return.
  • wildcard
    • false - Do not treat do truncation at end of path.
    • true - Treat end of path to have a * wildcard.
  • username – Optional string, only return rows that the specified user invoked. Default is all rows.
  • method – Optional string, only return rows with the specified method, e.g. GET. Default is all rows.
  • performCount
    • false (default) - Do not return a total number of rows matching criteria.
    • true - Return a total number of rows matching criteria (except first and count).
  • sort
    • asc - Order by timestamp ascending.
    • desc (default) - Order by timestamp descending.
Produces:
Role:

_administrator

Example

GET /log?path=/item/VX-10&method=GET&username=admin&performCount=true
<AuditLogDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <count>13</count>
  <entry timestamp="2010-11-26T15:46:25.328+01:00">
    <username>admin</username>
    <method>GET</method>
    <path>/item/VX-10/uri</path>
    <queryParameters>methodType=AUTO</queryParameters>
    <matrixParameters/>
  </entry>
  <entry timestamp="2010-11-26T15:46:20.053+01:00">
    <username>admin</username>
    <method>GET</method>
    <path>/item/VX-10/uri</path>
    <queryParameters/>
    <matrixParameters/>
  </entry>
  <entry timestamp="2010-11-26T15:28:03.674+01:00">
    <username>admin</username>
    <method>GET</method>
    <path>/item/VX-10</path>
    <queryParameters>content=shape</queryParameters>
    <matrixParameters/>
  </entry>
  <entry timestamp="2010-11-26T15:26:49.031+01:00">
    <username>admin</username>
    <method>GET</method>
    <path>/item/VX-10</path>
    <queryParameters>content=shape</queryParameters>
    <matrixParameters/>
  </entry>
  <entry timestamp="2010-11-26T15:16:53.508+01:00">
    <username>admin</username>
    <method>GET</method>
    <path>/item/VX-10</path>
    <queryParameters>content=shape</queryParameters>
    <matrixParameters/>
  </entry>
</AuditLogDocument>

Exporting log content

GET /log/export

Is very similar to the method above, but instead of delivering the entire document at once it is streamed. Therefore there is no restriction on the maximum number of rows that can be retrieved.

Query Parameters:
 
  • path – Optional string, matches path in log lines, default is /.
  • first – Optional integer, number of first row to return, default is 0.
  • rows – Optional integer, number of rows to return, default is 100.
  • starttime – Optional ISO 8601 time, for lower limit of rows to return.
  • endtime – Optional ISO 8601 time, for upper limit of rows to return.
  • wildcard
    • false - Do not treat do truncation at end of path.
    • true - Treat end of path to have a * wildcard.
  • username – Optional string, only return rows that the specified user invoked. Default is all rows.
  • method – Optional string, only return rows with the specified method, e.g. GET. Default is all rows.
  • sort
    • asc - Order by timestamp ascending.
    • desc (default) - Order by timestamp descending.
Produces:
Role:

_administrator