-
items array[object] | null
View model that represents an audit log.
-
paginationParameters object
A model that is used to encapsulate the parameters needed to perform pagination queries.
-
totalPages integer(int32)
The total number of pages available for the specified parameters and page size.
-
totalCount integer(int32)
The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.
-
hasPreviousPage boolean
Indicates if there is a previous page.
-
hasNextPage boolean
Indicates if there is a next page.
-
continuationToken string | null
The token to continue to retrieve the paginated items.
List all audit logs
GET
/v1/AuditLogs
Returns a list of your audit logs. The audit logs are returned sorted by Timestamp, with the most recent audit logs appearing first. Available to the roles: csp, reseller
Headers
-
X-Tenant string Required
This header identifies which tenant to access with this request. This value should be an existent domain for the specified tenant.
-
X-Correlation-Id string(UUID)
This header is optional and by setting it you can correlate the audit logs made by this request.
Query parameters
-
PageNumber integer(int32)
A cursor for pagination across multiple pages of results. The default value is 1.
-
PageSize integer(int32)
The number of objects to be returned at each page. The size can range between 1 and 2000, and the default is 25.
-
StartDate string(date-time)
The start date for the interval to filter the audit logs. The default value is 1 month ago.
-
EndDate string(date-time)
The end date for the interval to filter the audit logs. The default value is current date time.
-
Operations string
A string containing the operations to filter by. This string is a list separated by |. ex: CreateOrder|CreateCustomer
-
Status string
The audit log status to filter by. Possible values: Processing, Succeded, Failed
-
Reseller string
The reseller name to search by. This field searches for a substring so the provided string as a whole must be a present in the desired reseller name.
-
Customer string
The customer name to search by. This field searches for a substring so the provided string as a whole must be a present in the desired customer name.
-
resellerId string(uuid)
The reseller identifier. View the audit logs as the specified resellerId.
GET /v1/AuditLogs
curl \
-X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/AuditLogs \
-H "X-Tenant: string" \
-H "Authorization: Bearer eyJ0eXAiO..." \
-H "X-Correlation-Id: string"
Response examples (200)
{
"items": [
{
"id": "string",
"customer": "string",
"reseller": "string",
"timestamp": "2024-05-04T09:42:00+00:00",
"operation": "string",
"status": {
"name": "string"
},
"user": "string",
"origin": {
"name": "string"
},
"entityType": "string",
"entityId": "string",
"oldValues": {},
"newValues": {},
"message": "string",
"correlationId": "string"
}
],
"paginationParameters": {
"pageNumber": 42,
"pageSize": 42
},
"totalPages": 42,
"totalCount": 42,
"hasPreviousPage": true,
"hasNextPage": true,
"continuationToken": "string"
}
Response examples (200)
{
"items": [
{
"id": "string",
"customer": "string",
"reseller": "string",
"timestamp": "2024-05-04T09:42:00+00:00",
"operation": "string",
"status": {
"name": "string"
},
"user": "string",
"origin": {
"name": "string"
},
"entityType": "string",
"entityId": "string",
"oldValues": {},
"newValues": {},
"message": "string",
"correlationId": "string"
}
],
"paginationParameters": {
"pageNumber": 42,
"pageSize": 42
},
"totalPages": 42,
"totalCount": 42,
"hasPreviousPage": true,
"hasNextPage": true,
"continuationToken": "string"
}
Response examples (400)
{
"statusCode": 42,
"type": "string",
"description": "string",
"correlationId": "string",
"errors": [
{
"propertyName": "string",
"description": [
"string"
]
}
]
}
Response examples (400)
{
"statusCode": 42,
"type": "string",
"description": "string",
"correlationId": "string",
"errors": [
{
"propertyName": "string",
"description": [
"string"
]
}
]
}
Response examples (500)
{
"statusCode": 42,
"type": "string",
"description": "string",
"correlationId": "string",
"errors": [
{
"propertyName": "string",
"description": [
"string"
]
}
]
}
Response examples (500)
{
"statusCode": 42,
"type": "string",
"description": "string",
"correlationId": "string",
"errors": [
{
"propertyName": "string",
"description": [
"string"
]
}
]
}