Read
GET v1/audit_log
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| id | NsObjectID |
| type | NsEventType |
| object_id | NsObjectID |
| object_name | NsObjectName |
| object_type | NsObjectType |
| scope | NsScope |
| time | NsTime |
| status | NsOperationStatus |
| error_code | NsErrorCode |
| user_id | NsObjectID |
| user_name | NsAuditLogUserName |
| user_full_name | NsObjectName |
| source_ip | NsIPAddress |
| ext_user_id | NsExtUserId |
| ext_user_group_id | NsObjectID |
| ext_user_group_name | NsObjectName |
| app_name | NsAppName |
| access_type | NsAuditLogAccessType |
| category | NsAuditCategory |
| activity_type | NsAuditOperationType |
| activity | NsAuditActivity |
GET v1/audit_log/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| fields | NsCommaSeparatedList |
| id | NsObjectID |
| type | NsEventType |
| object_id | NsObjectID |
| object_name | NsObjectName |
| object_type | NsObjectType |
| scope | NsScope |
| time | NsTime |
| status | NsOperationStatus |
| error_code | NsErrorCode |
| user_id | NsObjectID |
| user_name | NsAuditLogUserName |
| user_full_name | NsObjectName |
| source_ip | NsIPAddress |
| ext_user_id | NsExtUserId |
| ext_user_group_id | NsObjectID |
| ext_user_group_name | NsObjectName |
| app_name | NsAppName |
| access_type | NsAuditLogAccessType |
| category | NsAuditCategory |
| activity_type | NsAuditOperationType |
| activity | NsAuditActivity |
Description
List a set of audit log entries or a single audit log record.
Normal Response Codes
200
HTTP Error Codes
400 401 404 500 503
Detail Error Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for the audit log record. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| type | NsEventType | number | Identifier for type of audit log record. Non-negative integer in range [0,2147483647]. | |
| object_id | NsObjectID | string | Identifier of object operated upon. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| object_name | NsObjectName | string | Name of object operated upon. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| object_type | NsObjectType | string enum | Type of the object being operated upon. Possible values: 'active_directory', 'group', 'chapuser', 'initiatorgrp', 'perfpolicy', 'snapshot', 'snapcoll', 'vol', 'volcoll', 'partner', 'array', 'pool', 'initiator', 'protsched', 'volacl', 'throttle', 'sshkey', 'user', 'protpol', 'prottmpl', 'branch', 'route', 'role', 'privilege', 'netconfig', 'events', 'session', 'subnet', 'array_netconfig', 'nic', 'initiatorgrp_subnet', 'fc_initiator_alias', 'fc_port', 'fc_interface_collection', 'fc', 'event_dipatcher', 'fc_target_port_group', 'encrypt_key', 'encrypt_config', 'snapshot_lun', 'syslog', 'async_job', 'application_server', 'audit_log', 'ip address', 'disk', 'shelf', 'protocol_endpoint', 'folder', 'pe_acl', 'vvol', 'vvol_acl'. | |
| scope | NsScope | string | Scope within which object exists, for example, name of the array for a NIC. Possible values: array serial number, or '-'. Example: 'AC-109084'. | |
| time | NsTime | number | Time when this operation was performed. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| status | NsOperationStatus | string enum | Status of the operation -- success or failure. Possible values: 'invalid', 'unknown', 'succeeded', 'failed', 'inprogress'. | |
| error_code | NsErrorCode | string | If the operation has failed, this indicates the error code corresponding to the failure. Non-negative integer in range [0,9000]. | |
| user_id | NsObjectID | string | Identifier of the user who performed the operation. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| user_name | NsAuditLogUserName | string | Username of the user who performed the operation. String of up to 32 alphanumeric characters, beginning with a letter. Or | |
| user_full_name | NsObjectName | string | Full name of the user who performed the operation. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| source_ip | NsIPAddress | string | IP address from where the operation request originated. Four numbers in the range [0,255] separated by periods. Example: '128.0.0.1'. | |
| ext_user_id | NsExtUserId | string | The user id of an external user. String of up to 255 printable ASCII characters. Example: 'S_aba-123'. | |
| ext_user_group_id | NsObjectID | string | The group ID of an external user. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| ext_user_group_name | NsObjectName | string | The group name of an external user. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| app_name | NsAppName | string | Name of application from where the operation request was issued, for example, pam, VSS Agent, etc. String of 0-255 printable ASCII characters. Example: 'GUI'. | |
| access_type | NsAuditLogAccessType | string | Name of access on how the operation request was issued, for example, GUI, CLI or API. Possible values: 'GUI', 'CLI', 'API'. | |
| category | NsAuditCategory | string enum | Category of the audit log record. Possible values: 'data_provisioning', 'data_protection', 'data_access', 'user_access', 'system_configuration', 'software_update'. | |
| activity_type | NsAuditOperationType | string enum | Type of activity performed, for example, create, update or delete. Possible values: 'create', 'read', 'update', 'delete', 'other'. | |
| activity | NsAuditActivity | string | Description of activity performed and recorded in audit log. String of 1-1476 printable characters. Example: 'Created snapshot % of volume %'. |
JSON Response