API Reference
The Plugwerk REST API is documented with an OpenAPI 3.1 specification and rendered as an interactive API reference using Scalar.
Open API ReferenceInteractive REST API documentation with request examples, schemas, and try-it-out functionality.
Authentication
Section titled “Authentication”All namespace-scoped endpoints require authentication via one of two methods:
| Method | Header | Permissions |
|---|---|---|
| API Key | X-Api-Key: pwk_... |
Read-only (list, search, download) |
| Bearer | Authorization: Bearer <jwt> |
Full access per user role |
Base Path
Section titled “Base Path”All namespace-scoped endpoints use the base path:
/api/v1/namespaces/{namespace}/...Download the Spec
Section titled “Download the Spec”The OpenAPI specification is available for download:
- YAML:
/api-docs/openapi.yaml