Secure Audit Log Configuration API Reference
The Secure Audit Log API is designed for recording a trail of application-based user activity in a scalable, tamper-proof log.
Base URL
audit.<csp>.<region>.pangea.cloud
curl -sSLX POST 'https://audit.aws.us.pangea.cloud/v1beta/config' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response
Get audit config (Beta)
curl -sSLX POST 'https://audit.aws.us.pangea.cloud/v1beta/config/create' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
This endpoint cannot be called through the documentation site
Create audit config (Beta)
curl -sSLX POST 'https://audit.aws.us.pangea.cloud/v1beta/config/update' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
This endpoint cannot be called through the documentation site
Update audit config (Beta)
curl -sSLX POST 'https://audit.aws.us.pangea.cloud/v1beta/config/delete' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
This endpoint cannot be called through the documentation site
Delete audit config (Beta)
curl -sSLX POST 'https://audit.aws.us.pangea.cloud/v1beta/config/list' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response
List audit configs (Beta)
List audit service configs
curl -sSLX POST 'https://audit.aws.us.pangea.cloud/v1beta/config/partition_overrides' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'
Response
Update retention for a partition value (Beta)
Update the retention settings for a specific partitioned value. This beta endpoint accepts an overrides object whose keys are the partition values (for example, individual tenant_ids) and whose values specify custom warm- and cold-storage retention periods. You must first enable partitioning on your audit configuration schema (typically set on the tenant_id field).
Status Codes
Status | Status Code | Description |
---|---|---|
TreeNotFound | 200 | A tree has not been built for proofs. This is likely due to a lack of audit messages ingested. |
BadOffset | 400 | The offset provided is invalid or out of range. |
ForwardingError | 400 | Forwarder has experienced an error while forwarding messages |
InvalidSchema | 400 | The configured schema is not valid for this endpoint. |
NoForwarderConfigured | 400 | Testing a forwarder requires a forwarder to be configured |
ForbiddenFieldValue | 403 | A field value was supplied that is not allowed by the token's field restrictions. |
Was this article helpful?