v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Audit Trail Information

Get audit logs belonging to the tenant.

This API retrieves all the audit logs based on the tenants.

get/network-services/v1/audits

Query parameters

start-atstring date-time required

Date-time in RFC 3339 format (ISO 8601) in UTC timezone with milliseconds.

Example:2025-08-06T12:34:56.124Z

Data is required starting from this timestamp, provided in RFC 3339 (and ISO 8601) format in the UTC timezone with milliseconds. The difference between end-at and start-at should be less than 90 days.

end-atstring date-time required

Date-time in RFC 3339 format (ISO 8601) in UTC timezone with milliseconds.

Example:2025-08-06T12:34:56.124Z

Data is required up to this timestamp, provided in RFC 3339 (and ISO 8601) format in the UTC timezone with milliseconds. The timestamp must be earlier than the current time and later than the start-at.

filterstring

Example:action eq 'Scope mapped' and category eq 'Alert Management' and destination eq 'Global'

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.

Field	Operators
action	eq and in
description	eq and in
destination	eq and in
category	eq and in
subCategory	eq and in
destinationName	eq and in
ipAddress	eq and in
source	eq and in

The operators are implemented as follows:

eq: Only values exactly matching the given value are returned.
in: Only values present in the given list are returned.

sortstring

Example:occurredOn desc

Comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).

The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.

Supported fields are port, speed, neighbour, neighbourFamily, nativeVlan, neighbourRole, alias, connector, lag, vlanMode, poeClass, ipv4 and mtu. Default sort by name.

limitinteger

Example:200

Specifies the maximum number of Audits returned in the response list.

offsetinteger

Example:1

Number of items to skip before returning results.

Response

Successful operation

countinteger required

Number of objects returned in the list. Maximum will be page size.

totalinteger

The total number of objects contained in the datastore.

offsetinteger required

Number of items skipped before the returned results.

Example response

{
  "items": [
    {
      "id": "1a7a4e3d-6ab8-4d34-93cf-7443e0f32bbe",
      "type": "audit",
      "generation": 1,
      "createdAt": "2019-10-12T07:20:50Z",
      "updatedAt": "2019-10-12T07:20:50Z",
      "auditId": "1a7a4e3d-6ab8-4d34-93cf-7443e0f32bbe",
      "ipAddress": "127.0.0.1",
      "occurredOn": "2019-10-12T07:20:50Z",
      "destinationName": "CX0001066",
      "description": "Audit log description",
      "source": "System",
      "subCategory": "Configuration",
      "category": "Alert Management",
      "action": "Scope unmapped",
      "destination": "Global"
    }
  ],
  "total": 200
}