Deployments

Deploy and inspect project deployments.

deploy

Deploy a merged project definition to Swirls Cloud. Creates a new deployment row and new deployment-scoped resources (forms, webhooks, schedules, workflows, nodes, edges, triggers) with the IDs embedded in the definition payload. Returns the deployment row alongside any vendor keys the deployment needs that are missing from the project vault; executions for affected nodes are held until those keys are set.

POST

Usage:

const result = await swirls.client.deployments.deploy({
  projectId: '...',
  name: '...',
  definition: {},
})

Input:

Output:

getDeployment

Get a deployment by ID

GET

Usage:

const result = await swirls.client.deployments.getDeployment({
  id: '...',
})

Input:

Output:

getDeploymentSourceManifest

Get stored .swirls source metadata for a deployment. Returns null for older deployments without source files.

GET

Usage:

const result = await swirls.client.deployments.getDeploymentSourceManifest({
  deploymentId: '...',
})

Input:

getDeploymentSourceFile

Get one stored .swirls source file for a deployment. Returns null when the deployment has no source archive or path is missing.

GET

Usage:

const result = await swirls.client.deployments.getDeploymentSourceFile({
  deploymentId: '...',
  path: '...',
})

Input:

getMissingVendorKeys

Vendor keys the deployment needs that are absent from the project vault. Empty for Enterprise orgs (Autumn platform_keys) and for deployments that need no vendor keys. Cloud UI surfaces these on the deployment detail page and on partner cards.

GET

Usage:

const result = await swirls.client.deployments.getMissingVendorKeys({
  deploymentId: '...',
})

Input:

Output:

listDeployments

List all deployments in a project

GET

Usage:

const result = await swirls.client.deployments.listDeployments({
  projectId: '...',
})

Input:

Output:

listExecutions

List executions for a deployment

GET

Usage:

const result = await swirls.client.deployments.listExecutions({
  deploymentId: '...',
})

Input:

Output: