Skip to content

REST API#

This documentation applies to Piler enterprise edition 2.1.0+

Revision #1

Publication date: 2026-JAN-01

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' )"