Skip to main content

API reference

This page is the canonical place for documenting CheesePad API surfaces. If an endpoint is not listed here, consider it unsupported.

Base URL​

TBD

Authentication​

See the Authentication page for supported methods.

Conventions​

Versioning​

  • Document API versions explicitly (e.g. /v1).

Pagination​

  • Document default page size, maximum page size, and cursors/offsets.

Errors​

  • Use consistent error codes and a predictable response schema.

Endpoints​

Pools​

  • List pools
  • Get pool details

Locks​

  • List locks
  • Get lock details

Projects​

  • List projects
  • Get project details