Skip to main content
The OpenPMM API uses JSON over HTTP.
The endpoint reference uses the OpenAPI document from the production API. OpenPMM refreshes the reference after a successful production deployment.

​
Conventions

  • Send the API key as a bearer token except during signup and CLI browser authorization.
  • Send and receive JSON unless an upload endpoint gives different instructions.
  • Use IDs without changes.
  • Send Idempotency-Key when the endpoint requires it.
  • Send If-Match when the endpoint requires an ETag.
  • Send confirmed: true for an action that can publish.

​
Versioning

The /v1 prefix identifies this API version. OpenPMM can add response fields without a new version. Ignore response fields that your application does not use.