The API is currently in beta. We are looking for feedback on both the API design itself and the documentation.

Apps

An app is a collection of Modules that work together. When deployed, all modules in an app are deployed to the same namespace.

Apps are the root of the configuration tree holding environments, deployments, shared values, and secrets.

App object

{
  "id": "my-app",
  "name": "My App",
  "envs": [
    {
      "id": "my-env",
      "name": "My Environment"
    }
  ],
  "created_at": "2020-05-22T14:53:27Z",
  "created_by": "[email protected]"
}
Parameter Description
id ID of the app; is unique within an organization.
name Human-friendly name of the app.
env A list of environment objects describing the environments in an app.
created_at A timestamp of when the app was created.
created_by The username of the user who created the app.

List all apps in an organization.

GET /orgs/{orgId}/apps

Lists all of the apps that exist in the specified organization.

Parameters

Parameter Description
orgId ID of the organization

Responses

Status Code Description
200 Possibly empty list of apps.

Adds a new app to an organization.

POST /orgs/{orgId}/apps

Creates a new application and adds it to the specified organization.

Parameters

Parameter Description
orgId ID of the organization

Request Body

ApplicationBase

Responses

Status Code Description
201 The application just created.
409 The application name already exists.

Get a specific app

GET /orgs/{orgId}/apps/{appId}

Gets a specific app in the specified organization by ID.

Parameters

Parameter Description
orgId ID of the organization
appId ID of the app

Responses

Status Code Description
200 Possibly empty list of apps.
404 App not found in the organization.

Delete an app from an organization.

DELETE /orgs/{orgId}/apps/{appId}

Permenantly deleted an application from the specified organization. This operation cannot be undone.

Parameters

Parameter Description
orgId ID of the organization
appId ID of the app

Responses

Status Code Description
204 App successfully deleted.
404 App not found in the organization.