Dell Technologies Developer

Get all audit log resources

Retrieves all audit log resources. Passing query parameters that are not documented on this page will result in a 400 error when strict REST API validation is enabled. Additional information can be found in the Getting started - Strict REST API validation documentation.

This endpoint supports execution by the following roles: Administrator, User, Security Administrator

This endpoint supports pagination with types: random,serial

Security

Key, Type & Details

BearerAuth

http

For accessing the API, a valid JWT token must be passed in all the queries in the 'Authorization' header with the 'Bearer' HTTP authorization schema: 'Authorization: Bearer <JWT_token>'

Requests

Query Parameters

page

integer

default: 1

range: ≥ 1 ≤ 10000

The page number to be returned. Must not be less than 1. Under Tasks, see Page the result.

pageSize

integer

default: 100

range: ≥ 1 ≤ 10000

The number of resources to be returned. Must not be less than 1. Under Tasks, see Page the result.

filter

string

The filter string that is expressed using PowerProtect Data Manager filter syntax. Under Tasks, see Filter the result.

orderby

string

The attributes and fields to sort by. This parameter can combine with sort direction “ASC” or “DESC”. Default direction is ASC. Under Tasks, see Sort the result.

queryState

string

Token string to retrieve the next page of a result. The initial search request with queryState must be queryState=BEGIN and a pageSize. After a search begins, subsequent responses include a token string to pass as a parameter for the next page retrieval. When the query state in the response that is returned from the previous search is END, no further results can be retrieved from this query. For more details, under Tasks, see Page the result.

Responses

200 : OK

Successfully returned available audit logs.

Response Body

Get Audit Logs.

content

array[object]

after

string

New field values represented as a string. Varies based on the audit type.

auditType

string

The predefined set of audit types.

allowed values: APP_HOST_CONFIGURATION COMPLIANCE PROTECTION PROTECTION_COPY PROTECTION_INFRASTRUCTURE PROTECTION_POLICY PROTECTION_SOURCE PUSH_UPDATE RESTORE_PLAN SECURITY SERVER_DR STORAGE SYSTEM

before

string

Old field values that are represented as a string. Varies based on the audit type.

changeDescription

string

The description of the change. This parameter is a system generated field to get the context of the change.

changedBy

object

The user who made the configuration modification.

string

The user ID.

username

string

The user name.

changedObject

object

The resource changed by the user.

string

The ID of the changed object.

resourceName

string

The name of the changed object (resource value). Possible values are protection policy name, compliance name, asset source name, user name, and so on (security related resource names).

resourceType

string

The resource name of the object (resource path). This path value should be a full resource name corresponding to the audit type. It can be one of the audit type path URL values.

changedTime

string<date-time>

The time when the configurations are modified or deleted.

createdAt

string<date-time>

The time when the audit log was created. Follows ISO 8601.

externalId

string

The ID of the audit log in the external system, The value is null if the audit log originated in PowerProtect Data Manager.

string

The ID of the audit log entry.

messageArgs

array[string]

The message arguments are the values for any substitution variables that are defined as part of the message. Review the message for more information: Message Resources, APIs, and Audit Message.

messageID

string

The message identifier MessageID is an alphanumeric string value that is a maximum of 8 characters long.

source

object

The source system where the audit log was originated.

description

string

The origin system description

string

The origin system id

type

string Required

Indicates the source system type

allowed values: DATA_MANAGER OPERATING_ENVIRONMENT PROTECTION_STORAGE

userNote

object

The user notes on a message.

note

string

The custom text note on the message.

updatedTime

string<date-time>

The time that note is updated. Follows ISO 8601.

username

string

The name of the user who added or updated the notes.

page

object

The page information that is usually used to describe the content of an API response, including page number, page size, total elements count, and total page count.

maxPageableElements

integer

The max number of pageable elements.

number

integer

The page number.

queryState

string

The query token. Only used for serial query. Under Tasks, see Page the result.

size

integer

The number of elements on each page.

totalElements

integer

The total number of elements across all pages.

totalPages

integer

The total number of pages.

400 : Bad Request

The request is not valid. Check the request parameters.

Response Body

The error response that describes the failure reason and remediation.

code

integer<int32>

range: ≥ -2147483648 ≤ 2147483647

The error code number.

extendedInfo

string

Additional information about the error.

message

string

The error message.

messageArgs

array[string]

The message arguments are the values for any substitution variables that are defined as part of the message.

messageId

string

The unique message ID.

messageTemplate

string

The message template defines the display sequence of the message arguments array.

path

string

The path that produced the error.

reason

string

The reason that the error occurred.

remediation

string

A recommended solution to resolve the error.

timestamp

integer<int64>

range: ≥ -9223372036854776000 ≤ 9223372036854776000

When the error occurred.

401 : Unauthorized

The requestor is not allowed to perform this operation.

Response Body

The error response that describes the failure reason and remediation.

code

integer<int32>

range: ≥ -2147483648 ≤ 2147483647

The error code number.

extendedInfo

string

Additional information about the error.

message

string

The error message.

messageArgs

array[string]

The message arguments are the values for any substitution variables that are defined as part of the message.

messageId

string

The unique message ID.

messageTemplate

string

The message template defines the display sequence of the message arguments array.

path

string

The path that produced the error.

reason

string

The reason that the error occurred.

remediation

string

A recommended solution to resolve the error.

timestamp

integer<int64>

range: ≥ -9223372036854776000 ≤ 9223372036854776000

When the error occurred.

403 : Forbidden

The requestor is not authorized to perform this operation.

Response Body

The error response that describes the failure reason and remediation.

code

integer<int32>

range: ≥ -2147483648 ≤ 2147483647

The error code number.

extendedInfo

string

Additional information about the error.

message

string

The error message.

messageArgs

array[string]

The message arguments are the values for any substitution variables that are defined as part of the message.

messageId

string

The unique message ID.

messageTemplate

string

The message template defines the display sequence of the message arguments array.

path

string

The path that produced the error.

reason

string

The reason that the error occurred.

remediation

string

A recommended solution to resolve the error.

timestamp

integer<int64>

range: ≥ -9223372036854776000 ≤ 9223372036854776000

When the error occurred.

416

The request is too large to be satisfied.

Response Body

The error response that describes the failure reason and remediation.

code

integer<int32>

range: ≥ -2147483648 ≤ 2147483647

The error code number.

extendedInfo

string

Additional information about the error.

message

string

The error message.

messageArgs

array[string]

The message arguments are the values for any substitution variables that are defined as part of the message.

messageId

string

The unique message ID.

messageTemplate

string

The message template defines the display sequence of the message arguments array.

path

string

The path that produced the error.

reason

string

The reason that the error occurred.

remediation

string

A recommended solution to resolve the error.

timestamp

integer<int64>

range: ≥ -9223372036854776000 ≤ 9223372036854776000

When the error occurred.

500 : Server Error

Any server error that prevented the completion of the request.

Response Body

The error response that describes the failure reason and remediation.

code

integer<int32>

range: ≥ -2147483648 ≤ 2147483647

The error code number.

extendedInfo

string

Additional information about the error.

message

string

The error message.

messageArgs

array[string]

The message arguments are the values for any substitution variables that are defined as part of the message.

messageId

string

The unique message ID.

messageTemplate

string

The message template defines the display sequence of the message arguments array.

path

string

The path that produced the error.

reason

string

The reason that the error occurred.

remediation

string

A recommended solution to resolve the error.

timestamp

integer<int64>

range: ≥ -9223372036854776000 ≤ 9223372036854776000

When the error occurred.

GETTry it
/api/v2/audit-logs
Copy
/api/v2/audit-logs
Copy
https://localhost:8443/api/v2/audit-logs

Response Samples

200

400

401

403