Getting started

Quickstart Live

Point one request at a running deployment and confirm it answers. Everything here uses the health endpoint that ships with the service.

1 · Check service health

The deployment's base URL is configured as PESAGUARD_API_URL in the infrastructure environment file.

curl -sS "$PESAGUARD_API_URL/health"

A 200 means the API process is up. The public status site probes this same endpoint, so the green strip above the marketing site means exactly this check answered.

2 · Read the OpenAPI contract

curl -sS "$PESAGUARD_API_URL/openapi.json" -o openapi.json
python -c "import json;print(json.load(open('openapi.json'))['info']['version'])"

The service publishes its own OpenAPI 3.0.3 document, versioned independently of this site. A static copy lives at api-reference/openapi.json; the running deployment is authoritative.

3 · Next

• First authenticated request — the bearer-token pattern and scopes.
• Reconciliation — what matching decides.
• Errors — the envelope every failure uses.