/api/v1/logs

Request a set of logs.

The logs are line-delimited JSON compressed using gzip.

HTTP authorization scheme:

bearer

Method

POST

Query parameters

type

required

string

Type of logs to retrieve.
Example: type=query

Request body

Inputs bounding the logs you want to get.

database

string

Path of the database you want to get logs for, including the region group. Omit this field if you want to export logs for your region group.

regionGroup

string

Enum: classic us-std eu-std
Region group you want to get the logs for. Include this field only if you want to export logs for your region group. This field is ignored if you are requesting logs for a database. The bearer token must have access to this region group.

time_start

required

string <date-time>

Date-time to start receiving logs, inclusive.

time_end

required

string <date-time>

Date-time to stop receiving logs, exclusive.

idempotency_token

string <uuid>

Optional idempotence token for requesting logs. Multiple requests issued with the same idempotency_token in 24 hours resolve to the same request.

Example:

Content-Type:

application/json

 
{
  "database": "classic/parent-db/child-db",
  "region_group": "classic",
  "time_start": "2022-09-19T20:42:16.828Z",
  "time_end": "2022-09-19T20:42:16.828Z",
  "idempotency_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response

200 Success

request_id

string

A unique identifier for your request. Pass to GET /api/v1/logs/${requestId} to poll for results.

database

string

Path of the database you want to get logs for, including the region group. This field is omitted when exporting logs for your region group.

region_group

string

Region group you want to get the logs for. Present only if you want to export logs for your region group.

time_start

required

string <date-time>

Date-time to start receiving logs, inclusive.

time_end

required

string <date-time>

Date-time to stop receiving logs, exclusive.

state

required

string (LogState)

Log state:

  • Complete Successful log receipt.

  • CreatingNewUrl Successful log receipt and creating URL for log retrieval.

  • DoesNotExist No logs exist for the request.

  • Failed Extraction failed.

  • Pending Successful request.

  • Requested Logs are submitted for extraction.

  • TimedOut Timed out before log received.

presigned_url

string <uri>

URL that can get the requested logs. The field is present only if the state is Complete.

presigned_url_expiration_time

string <date-time>

Date-time the URL expires.

Example:

Content-Type:

application/json

 
{
  "request_id": "123456",
  "database": "classic/parent-db/child-db",
  "region_group": "classic",
  "time_start": "2022-09-19T20:42:16.828Z",
  "time_end": "2022-09-19T20:42:16.828Z",
  "state": "Complete",
  "presigned_url": "https://link.to.your.logs.com",
  "presigned_url_expiration_time": "2022-09-19T21:42:16.828Z"
}

HTTP error response

message

required

string

Example:

Content-Type:

application/json

 
{
  "message": "string"
}

Is this article helpful? 

Tell Fauna how the article can be improved:
 Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!