Skip to main content

Start Here

Authentication

The current docs use a simple API key model. Obtain a key in the personal account and send it on every request to the shared API base URL.

Current contract

  • The API key is issued in the personal account.

  • Every request should include the X-API-Key header.

  • The exact header name is currently a documentation placeholder and can be changed later in one place through the shared docs runtime config.

First authenticated request

Use a non-destructive endpoint first. Listing projects is usually the clearest signal that the base URL, header, and key format are accepted by the server.

curl --request GET \
  --url 'https://client-api.dc.dev.k8s.zenno.services/projects' \
  --header 'X-API-Key: <api-key>' \
  --header 'Accept: application/json'

Operational notes

  • Keep the API key outside source control and inject it at runtime.
  • Reuse the same base URL across every environment-specific request builder.
  • Regenerate code or examples after backend confirms the final header contract.

Common issues

A missing or malformed auth header usually looks identical to a wrong base URL during early integration. Validate both together before debugging payload shape.

GET/projects

Safe first request to validate API key usage.