v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Audit Trail Information

Get Audit log based on the audit id.

Retrieves the audit log entry for a given audit ID.

get/network-services/v1/audits/{id}

Path parameters

idstring uuid required

Audit Id log required

Response

Successful operation

idstring uuid required

Unique identifier of the resource.

typestring required

Resource type.

generationinteger required

Monotonically increasing update counter.

createdAtstring date-time required

RFC 3339 UTC timestamp when the resource was created.

updatedAtstring date-time required

RFC 3339 UTC timestamp when the resource was last updated.

auditIdstring required

The audit id of audit.

categorystring required

Category of the executed action.

occurredOnstring required

RFC 3339 UTC timestamp of when the operation executed.

descriptionstring required

Description of the executed action

ipAddressstring required

Source IP Address of the user executed the operation.

actionstring required

Brief text specifying the executed operation.

sourcestring required

Email ID of the user executed the operation.

subCategorystring required

Sub-category of the executed action.

destinationNamestring required

The serial number or Host Name of the audit.

destinationstring required

Name of the entity/component on which action has been performed.

Example response

{
  "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"
}