Outlaw Panel documentation

API Reference

The versioned API supports authenticated customer, commercial, hosting, recovery, administration, and owner workflows.

Purpose

Integrate without bypassing application authorization or data ownership.

Step-by-step

  1. Use the `/api/v1` base path.
  2. Create a scoped API key.
  3. Send Bearer authentication.
  4. Validate status codes and error bodies.
  5. Rotate or revoke unused keys.

Example

`GET /api/v1/health` is public; protected resources require Bearer authentication.

Best practices

  • Use least-privilege scopes.
  • Never put keys in client source or URLs.

Troubleshooting

  • Verify base URL, token expiry, role, scope, and JSON field names.
  • Respect validation errors instead of retrying invalid payloads.

Related documentation