ReferenceREST API
Audit
Audit log inspection
Query audit logs (org-scoped)
Authorization
bearer Query Parameters
eventType?string
Value in
"AUTH_FAILURE" | "HMAC_INVALID" | "REPLAY_DETECTED" | "PLANT_SUSPENDED" | "PLANT_REACTIVATED" | "PLANT_REVOKED" | "PLANT_PROVISIONED" | "CERT_EXPIRING" | "UNSIGNED_REJECTED" | "PENDING_PLANT_GRACE_EXPIRED" | "PLANT_AUTO_SUSPENDED" | "SECRET_ROTATED" | "DEV_CIPHERTEXT_IN_PROD" | "AUDIT_LOG_CROSS_ORG_ACCESS" | "CREDENTIAL_REWRAP_STARTED" | "CREDENTIAL_REWRAP_COMPLETED" | "CREDENTIAL_REWRAP_FAILED" | "TOKEN_ISSUED" | "TOKEN_AUTH_FAILURE" | "TRADING_CONFIG_CHANGED" | "TRADING_CONFIG_FAILED" | "TRADING_PLANT_SYNCED" | "TRADING_COMMAND_RELAYED" | "TRADING_COMMAND_FAILED" | "API_KEY_CREATED" | "API_KEY_REVOKED" | "TRADING_PARTNER_ENABLED" | "TRADING_PARTNER_DISABLED" | "TRADING_PARTNER_CONFIG_UPDATED" | "TRADING_AMQP_AUTH_SUCCESS" | "TRADING_AMQP_AUTH_FAILURE" | "SUPER_ADMIN_ORG_UNSET" | "SUPER_ADMIN_ORG_SWITCH" | "INVITATION_VERIFIED" | "CSP_VIOLATION" | "EMAIL_CHANGED" | "PLANT_ORG_REASSIGNED" | "DEVICE_TEMPLATE_CREATED" | "DEVICE_TEMPLATE_UPDATED" | "DEVICE_TEMPLATE_DELETED" | "VOKE_ESM_PLANT_CREATED" | "VOKE_ESM_PLANT_UPDATED" | "VOKE_ESM_PLANT_DELETED" | "VOKE_ESM_ENABLED" | "VOKE_ESM_DISABLED"severity?string
Value in
"INFO" | "WARNING" | "CRITICAL"plantId?string
Filter by plant ID
Format
uuidfrom?string
Start date (ISO 8601)
to?string
End date (ISO 8601)
page?number
Default
1Range
1 <= valuelimit?number
Default
20Range
1 <= value <= 100Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://loading/api/v1/audit"{
"data": [
{
"details": {},
"eventType": "AUTH_FAILURE",
"id": "string",
"plantId": "string",
"severity": "INFO",
"timestamp": "2019-08-24T14:15:22Z",
"userId": "string"
}
],
"meta": {
"limit": 0,
"page": 0,
"total": 0,
"totalPages": 0
}
}{
"code": "VALIDATION_ERROR",
"details": {},
"error": "Bad Request",
"message": "Validation error",
"statusCode": 400
}{
"code": "UNAUTHORIZED",
"details": {},
"error": "Unauthorized",
"message": "Unauthorized",
"statusCode": 400
}{
"code": "FORBIDDEN",
"details": {},
"error": "Forbidden",
"message": "Forbidden",
"statusCode": 400
}{
"code": "INTERNAL_SERVER_ERROR",
"details": {},
"error": "Internal Server Error",
"message": "Internal server error",
"statusCode": 400
}