API Reference

Most Epinio commands communicate with the Epinio server over an API. The API is secured with Basic Auth; make requests with the credentials from your Epinio settings.

• Get your credentials with epinio settings show.
• Make a request with curl:

curl -u <username>:<password> https://epinio.<your-system-domain>/api/v1/info

Responses are JSON objects, except for some errors that occur before the request reaches the Epinio server (for example, a misconfigured cluster).

Browse the API

The full endpoint reference is rendered from the OpenAPI specification:

• API reference — browse every endpoint, parameter, and schema.
• Download the raw OpenAPI spec.