Skip to content

REST API#

This documentation applies to Piler enterprise edition 2.1.0+

Revision #2

Publication date: 2026-OCT-28

Piler enterprise support a comprehensive OpenAPI 3.0 with interactive Swagger UI.

The full OpenAPI 3.0 spec, and the interactive docs is available at /api/docs, see the demo site as an example.

You may use curl to get an access token:

ACCESS_TOKEN="$( curl -s -X POST \
    -H "Content-Type: application/json" \
    -d "{\"username\":\"<your username>\", \"password\":\"<your password>\"}" \
    "https://archive.example.com/auth/login" | jq -r '.access_token' )"

Billing API#

From 2.3.0, billing scripts use a read-only API token instead of a login: /api/v1/billing/quota and /api/v1/billing/quota/monthly/<tenant id>, with Authorization: Bearer plr_.... The token is created on the master in Admin > Tenant > API tokens and works on these two endpoints only. See Hosting: usage reports for billing for the curl examples.