API quickstart

Make a read-only request to list recent checks in an existing project.

1. 1

   Create a least-privilege API key

   In the RestoreTrust console, open the project, create an API key, and grant v1.checks:read.

   Copy the secret now

   The plaintext key is returned once. Store it in a secret manager and create a replacement if it is lost. Never commit it to source control or place it in a URL.

2. 2

   Set local variables

   Use the API origin supplied for your deployment and your project ID. These values are fake:

   bashCopy

   export RESTORETRUST_API_ORIGIN="https://api.restoretrust.example"export RESTORETRUST_API_KEY="rtk_REPLACE_WITH_YOUR_KEY"export RESTORETRUST_PROJECT_ID="65f0c7a9a7d6b4e2c1234567"

3. 3

   List recent checks

   List endpoints use POST so pagination and filters can be sent as JSON.

   bashCopy

   curl --fail-with-body \  --request POST \  --url "$RESTORETRUST_API_ORIGIN/v1/checks/list" \  --header "Content-Type: application/json" \  --header "X-API-Key: $RESTORETRUST_API_KEY" \  --data '{    "project_id": "'"$RESTORETRUST_PROJECT_ID"'",    "sort": "created-desc",    "pagination": { "limit": 10 },    "filters": {}  }'

4. 4

   Read the response

   A successful list response includes rows and cursor metadata:

   jsonCopy

   {  "status": "success",  "sort": "created-desc",  "filters": {},  "pagination": {    "limit": 10,    "has_more": false  },  "data": {    "checks": []  }}

Next request

Use a returned check ID with Get check details. Do not add project_id to an item request; the API derives and authorizes the owning project from the check.