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

• Secure Audit Log Documentation
• OpenAPI Specification

post/v1beta/config/list

cURL

Code Snippet Language

curl -sSLX POST 'https://audit.aws.us.pangea.cloud/v1beta/config/list' \
-H 'Authorization: Bearer <your_token>' \
-H 'Content-Type: application/json' \
-d '{}'

Response

Raw Output

200

Code Snippet Language

---

v-1-beta-config-list

POST

https://audit.aws.us.pangea.cloud/v1beta/config/list

filter

object

id

string

Only records where id equals this value.

id

id

id__contains

array<string>

Only records where id includes each substring.

id__contains

id__contains

id__in

array<string>

Only records where id equals one of the provided substrings.

id__in

id__in

created_at

string (date-time)

Only records where created_at equals this value.

created_at

created_at

created_at__gt

string (date-time)

Only records where created_at is greater than this value.

created_at__gt

created_at__gt

created_at__gte

string (date-time)

Only records where created_at is greater than or equal to this value.

created_at__gte

created_at__gte

created_at__lt

string (date-time)

Only records where created_at is less than this value.

created_at__lt

created_at__lt

created_at__lte

string (date-time)

Only records where created_at is less than or equal to this value.

created_at__lte

created_at__lte

updated_at

string (date-time)

Only records where updated_at equals this value.

updated_at

updated_at

updated_at__gt

string (date-time)

Only records where updated_at is greater than this value.

updated_at__gt

updated_at__gt

updated_at__gte

string (date-time)

Only records where updated_at is greater than or equal to this value.

updated_at__gte

updated_at__gte

updated_at__lt

string (date-time)

Only records where updated_at is less than this value.

updated_at__lt

updated_at__lt

updated_at__lte

string (date-time)

Only records where updated_at is less than or equal to this value.

updated_at__lte

updated_at__lte

last

string

Reflected value from a previous response to obtain the next page of results.

last

last

order

string

Order results asc(ending) or desc(ending).

order

​

order

order_by

string

Which field to order results by.

order_by

​

order_by

size

integer

Maximum results to include in the response.

• minimum: 1

size

size

Response Schema

object

Pangea standard response schema

result

object

count

integer

The total number of service configs matched by the list request.

last

string

Used to fetch the next page of the current listing when provided in a repeated request's last parameter.

items

Configuration options available for audit service

id

string

The config ID

version

integer

created_at

string (date-time)

The DB timestamp when this config was created. Ignored when submitted.

updated_at

string (date-time)

The DB timestamp when this config was last updated at

name

string

configuration name

retention

Retention window to store audit logs.

cold_query_result_retention

string

(default: "2d")

Retention window for cold query result / state information.

hot_storage(default: "14d")

Retention window to keep audit logs in hot storage.

query_result_retention

string

(default: "2d")

Length of time to preserve server-side query result caching.

redact_service_config_id

string, null

A redact service config that will be used to redact PII from logs.

redaction_fields

array<string>

Fields to perform redaction against.

vault_service_config_id

string, null

A vault service config that will be used to sign logs.

vault_key_id

string

ID of the Vault key used for signing. If missing, use a default Audit key

vault_sign

boolean

(default: false)

Enable/disable event signing

request_id

string

A unique identifier assigned to each request made to the API. It is used to track and identify a specific request and its associated data. The request_id can be helpful for troubleshooting, auditing, and tracing the flow of requests within the system. It allows users to reference and retrieve information related to a particular request, such as the response, parameters, and raw data associated with that specific request.

"request_id":"prq_x6fdiizbon6j3bsdvnpmwxsz2aan7fqd"

request_time

string

The timestamp indicates the exact moment when a request is made to the API. It represents the date and time at which the request was initiated by the client. The request_time is useful for tracking and analyzing the timing of requests, measuring response times, and monitoring performance metrics. It allows users to determine the duration between the request initiation and the corresponding response, aiding in the assessment of API performance and latency.

"request_time":"2022-09-21T17:24:33.105Z"

response_time

string

Duration it takes for the API to process a request and generate a response. It represents the elapsed time from when the request is received by the API to when the corresponding response is returned to the client.

"response_time":"2022-09-21T17:24:34.007Z"

status

string

It represents the status or outcome of the API request made for IP information. It indicates the current state or condition of the request and provides information on the success or failure of the request.

"status":"success"

summary

string

Provides a concise and brief overview of the purpose or primary objective of the API endpoint. It serves as a high-level summary or description of the functionality or feature offered by the endpoint.