History

History

The history endpoint allows you to query and manage the historical audit log and activity feed data programmatically.

Prune history

Prunes historical audit log and activity feed data older than a given timestamp.

POST /api/v2/history/prune

Arguments:

  • maxCreatedAt - timestamp - Prune records created before the given timestamp.

Response object:

  • An object with the following properties:
    • count - number : The number of records that were pruned.

The history pruning endpoint will delete historical records older than the given timestamp. For performance reasons, the endpoint may only delete a limited number of records.

To fully delete all records older than the given timestamp, the endpoint should be repeatedly invoked until the response count is zero.

Example requests:

Prune historical records:

$ curl \
    -H "Accept: application/vnd.jackdb.v2+json" \
    -u "${JACKDB_API_KEY_ID}@api:${JACKDB_API_KEY_SECRET}" \
    -X POST \
    -d "maxCreatedAt=2023-09-14T19:07:47.540Z" \
    "${JACKDB_API_URL}/history/prune"

Example response:

{
  "count": 987
}