Public API #

The Kuzzle PaaS backend is a Kuzzle application. It exposes custom Kuzzle controllers to manage organizations, projects, environments, applications, releases and deployments.

Every action is called as controller:action, with any Kuzzle SDK:

await kuzzle.query({
  controller: 'org-environment',
  action: 'list',
  organizationId: 'paas-org-my-company',
  projectId: 'my-project'
});

or with Kourou, passing each argument with -a and the request body with --body:

kourou org-environment:list -a organizationId=paas-org-my-company -a projectId=my-project

This is how the Kuzzle PaaS console itself calls the API, and the supported way to integrate with it.

Authentication #

Most actions require an authenticated Kuzzle user. Authenticate with the SDK (see Authentication); the SDK then sends the JWT with every request.

Main resources #

• Organizations
• Projects
• Environments
• Applications
• Releases
• Deployments
• Monitoring and alerts
• Data models
• Browser logs
• Legacy deploy bridge (deprecated)

Resource hierarchy #

Organization
+-- Project
    +-- Environment
    |   +-- Application
    +-- Release
    +-- Deployment (a release applied to one environment)

An organization is the top-level tenant. A project belongs to one organization. An environment belongs to one project. An application belongs to one environment. Releases and deployments belong to a project; a deployment targets one environment of that project.

Common conventions #

• organizationId is the organization tenant index, for example paas-org-my-company.
• projectId is the project (soft tenant) identifier inside the organization, for example my-project.
• environmentId is the environment name, for example staging or production.
• applicationId is the application _id, for example api or webapp.
• releaseId and deploymentId are the document ids returned when the release or deployment is created.
• Scalar parameters (names, ids, flags) are top-level request arguments. Structured payloads (an application definition, an image to deploy, a webhook) are passed in the request body.
• Boolean flags such as initKeycloakRealm or existingRepo are read as the string 'true'; any other value means false.
• Long-running operations may return an acknowledgement (for example "deleted") or a document in an intermediate status before the platform has finished provisioning, building or rolling out.

Public controller summary #