Blog

API v2, with a published OpenAPI schema

v2 of the ClusterNest API publishes a full OpenAPI schema, so you can generate a client rather than write one. It also brings its own authentication: two-factor, passkeys and app passwords. The console already runs on it.

A schema you can build against

The whole surface is described in the published schema: every path, every request and response shape, every error. Point a generator at it and you have a client in the language you work in. Point Postman or Swagger UI at it and you can explore the API without writing anything.

The schema is generated from the service rather than maintained alongside it, so it cannot describe an endpoint that isn’t there.

Authentication that belongs to the API

  • Two-factor authentication on accounts.
  • Passkeys, so an account can be secured without a password to phish.
  • App passwords, issued per application and revocable one at a time, so a credential that leaks out of a CI runner can be cancelled without touching your login.

App passwords are the ones that matter for automation. A pipeline should never be holding the same credential you sign in with.

The console runs on it

The ClusterNest Console has been moved onto v2 in full. That is deliberate: the API a customer gets is the API we use ourselves, so an endpoint cannot quietly fall behind the interface that is built on it.

The API documentation has the reference. Questions to hello@clusternest.com.