Query Audit Logs for Tenant (v2.0)
POST/sdwan/v2.0/api/auditlog/query
Query the audit logs for a given tenant as per specified query filters.
Request
- application/json
Body
Query fields
- Array [
- ]
aggregate Aggregate
The aggregate number of queried elements.
data AggregateData[]
The details of the aggregate data.
Value of the aggregate data.
View the aggregate date.
The field value.
The name of the query response.
Possible values: [max
, count
, min
, avg
, sum
]
The operator values.
The aggregate statistics.
The unit.
The destination page.
The number of queried elements deleted for a time frame.
Group the elements state for the query.
List the element by ID.
Return the ID of a specified query in the current session.
The query limit.
The limit.
Retrieve information from a field.
List the fields to query.
The total number of query parameters.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
The actual count.
The deleted number.
The deleted IDs.
Description of the query. Max size = 256.
The ID.
Details of the next query.
Total number.
items AuditLog[]
The audit log MSP tenant ID. Supported characters; = ^[a-z0-9]{1,50}$).
The audit log ID.
The audit log operator ID. Supported characters; = ^[a-z0-9]{1,50}$).
The audit log tenant ID. Supported characters; = ^[a-z0-9]{1,50}$).
The audit log request body.
The request content length.
The audit log request ID.
Request Ts
The audit log request type (GET|POST|PUT|DELETE|PATCH)$).
The audit log request URL.
The audit log request Etag.
The audit log resource ID. Max length = 50.
The audit log resource key. Max length = 128.
The audit log resource version.
The audit log response body.
Response Code
The audit log response content length.
Response Ts
The audit log session key C. Max length = 128.
The audit log source IP address. Max length = 128.
Time Ms
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"total_count": 0,
"items": [
{
"esp_tenant_id": "string",
"id": "string",
"operator_id": "string",
"operator_tenant_id": "string",
"request_body": "string",
"request_content_length": 0,
"request_id": "string",
"request_ts": 0,
"request_type": "string",
"request_uri": "string",
"resource_etag": 0,
"resource_id": "string",
"resource_key": "string",
"resource_version": "string",
"response_body": "string",
"response_code": 0,
"response_content_length": 0,
"response_ts": 0,
"session_key_c": "string",
"source_ip": "string",
"time_ms": 0
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_REQUEST_ERROR_0001"
},
{
"code": "INVALID_REQUEST_DUPLICATE_KEY"
},
{
"code": "AUDITLOG_INVALID_TENANT_ID"
},
{
"code": "AUDITLOG_MESSAGE_ID_EMPTY"
},
{
"code": "AUDITLOG_MESSAGE_ID_INVALID"
}
]
}
}