REST endpoints: Audit, logs, and version
REST
These endpoints:endpoints Audit,mirror logs,the CLI commands described in the matching CLI chapters. Each endpoint runs the CLI command named under its heading, so the behavior, defaults, and restrictions are the same; this page lists how to call it over REST.
Conventions that apply to every endpoint (request format, the async and outputType parameters, and the response envelope) are in Requests and responses. In the tables below, Required is Yes when the parameter must always be supplied, No when it is optional, and Depends when it is required only in some combinations (for example, either an application and volume, or a consistency group ID); the CLI chapter for the same command explains the combinations.
GET /audit/list
List user events.
CLI command: audit list
Query parameters
system
string
Yes
The system to query.
username
string
No
Filter by username.
eventTypes
array of string
No
Filter by event type.
fromTime
date-time
No
Only show events on or after this date.
toTime
date-time
No
Only show events on or before this date.
search
string
No
A string to search for. Hint: you can search customer, system (cloud), node and module names.
top
integer
No
Limit the number of returned events.
descendingOrder
boolean
No
Sort the results in descending order (most recent first).
Response: a list of EventElement objects in Result.EventElement.
GET /logs/view
View logs.
CLI command: logs view
Query parameters
node
string
Yes
The node to download and view logs from.
dateTime
string
No
The log's timestamp, in the format YYYY/MM/DD hh:mm:ss.
pattern
string
No
A regex pattern to filter the returned log lines. Enclose the pattern in double quotes.
Response: the command output, in the format selected by outputType.
GET /version
View S1 component versions.
CLI command: version
This endpoint takes no parameters.
Response: an object of type S1Version in Result, with: Component (string), Version (string), BuildNumber (string), Versions (array of ComponentVersion).
See also: Requests and responses - Authentication - Examples