Create App Version and Start (v1)

curl --request POST \
  --url https://api.example.com/api/apps/v1/apps/{appId}/versions/createAndStart \
  --header 'Content-Type: application/json' \
  --header 'X-Domino-Api-Key: <api-key>' \
  --data '
{
  "bundleId": "<string>",
  "dataPlaneId": "<string>",
  "description": "<string>",
  "dfsCommitId": "<string>",
  "entryScript": "<string>",
  "environmentId": "<string>",
  "environmentRevisionId": "<string>",
  "extendedIdentityPropagationToAppsEnabled": false,
  "externalVolumeMountIds": [
    "<string>"
  ],
  "hardwareTierId": "<string>",
  "mountDatasets": true,
  "netAppVolumeIds": [
    "<string>"
  ],
  "resolvedDfsCommitId": "<string>",
  "resolvedGitCommitId": "<string>",
  "resolvedImportedGitRepos": [
    {
      "ref": "<string>",
      "repoId": "<string>",
      "repoName": "<string>"
    }
  ],
  "resolvedImportedProjects": [
    {
      "commitId": "<string>",
      "directoryName": "<string>",
      "ownerId": "<string>",
      "projectId": "<string>",
      "projectName": "<string>",
      "release": "<string>"
    }
  ],
  "startOverrides": {
    "deployment": {
      "hardwareTierId": "<string>",
      "renderIFrame": true,
      "vanityUrl": "<string>"
    }
  },
  "tags": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}
'

{
  "version": {
    "createdAt": 123,
    "id": "<string>",
    "tags": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "updatedAt": 123,
    "bundle": {
      "id": "<string>",
      "name": "<string>"
    },
    "content": {
      "mountDatasets": true,
      "dataPlaneId": "<string>",
      "dfsCommitId": "<string>",
      "entryScript": "<string>",
      "environmentId": "<string>",
      "environmentRevisionId": "<string>",
      "extendedIdentityPropagationToAppsEnabled": true,
      "externalVolumeMountIds": [
        "<string>"
      ],
      "gitRef": {
        "value": "<string>"
      },
      "netAppVolumeIds": [
        "<string>"
      ],
      "resolvedCommits": {
        "dfsCommitId": "<string>",
        "gitCommitId": "<string>",
        "importedGitRepos": [
          {
            "ref": "<string>",
            "repoId": "<string>",
            "repoName": "<string>"
          }
        ],
        "importedProjects": [
          {
            "commitId": "<string>",
            "directoryName": "<string>",
            "ownerId": "<string>",
            "projectId": "<string>",
            "projectName": "<string>",
            "release": "<string>"
          }
        ]
      }
    },
    "currentInstance": {
      "createdAt": 123,
      "id": "<string>",
      "status": "<string>",
      "describeUrl": "<string>",
      "dfsCommitId": "<string>",
      "gitCommitId": "<string>",
      "publisher": {
        "id": "<string>",
        "name": "<string>"
      }
    },
    "deployment": {
      "autoscalingSpecification": {
        "enabled": true,
        "maxReplicas": 15,
        "minReplicas": 15,
        "scaleDownStabilizationWindowSeconds": 1800,
        "scaleUpStabilizationWindowSeconds": 1800,
        "targetCpuAvgUtilizationPct": 50,
        "targetMemoryAvgUtilizationPct": 50,
        "useSessionAffinity": true
      },
      "hardwareTierId": "<string>",
      "vanityUrl": "<string>"
    },
    "description": "<string>",
    "versionNumber": 123
  },
  "instance": {
    "createdAt": 123,
    "id": "<string>",
    "status": "<string>",
    "describeUrl": "<string>",
    "dfsCommitId": "<string>",
    "gitCommitId": "<string>",
    "publisher": {
      "id": "<string>",
      "name": "<string>"
    }
  },
  "warnings": [
    "<string>"
  ]
}

AppVersions

Create App Version and Start (v1)

Compound endpoint that creates a new version and initiates a run of it in a single request. The version is always persisted; if the start initiation fails the response still returns the persisted version with a warnings array describing the failure and the caller can retry via the regular start endpoint. Stop-previous: if a different version of the same App is already running, it is stopped before the new version starts (uniform one-running-instance-per-App invariant; not draft-specific). Draft-specific defaulting: when the parent App is a draft AND a previous running version exists on it, omitted content reference fields (dfsCommitId, gitRef, entryScript, environmentId, environmentRevisionId, hardwareTierId, externalVolumeMountIds, netAppVolumeIds) default to the previous running version’s values. On the very first call (no previous running version) all required content fields must be supplied. Governance only starts when a draft is published.

POST

api

apps

{appId}

versions

createAndStart

Create App Version and Start (v1)

curl --request POST \
  --url https://api.example.com/api/apps/v1/apps/{appId}/versions/createAndStart \
  --header 'Content-Type: application/json' \
  --header 'X-Domino-Api-Key: <api-key>' \
  --data '
{
  "bundleId": "<string>",
  "dataPlaneId": "<string>",
  "description": "<string>",
  "dfsCommitId": "<string>",
  "entryScript": "<string>",
  "environmentId": "<string>",
  "environmentRevisionId": "<string>",
  "extendedIdentityPropagationToAppsEnabled": false,
  "externalVolumeMountIds": [
    "<string>"
  ],
  "hardwareTierId": "<string>",
  "mountDatasets": true,
  "netAppVolumeIds": [
    "<string>"
  ],
  "resolvedDfsCommitId": "<string>",
  "resolvedGitCommitId": "<string>",
  "resolvedImportedGitRepos": [
    {
      "ref": "<string>",
      "repoId": "<string>",
      "repoName": "<string>"
    }
  ],
  "resolvedImportedProjects": [
    {
      "commitId": "<string>",
      "directoryName": "<string>",
      "ownerId": "<string>",
      "projectId": "<string>",
      "projectName": "<string>",
      "release": "<string>"
    }
  ],
  "startOverrides": {
    "deployment": {
      "hardwareTierId": "<string>",
      "renderIFrame": true,
      "vanityUrl": "<string>"
    }
  },
  "tags": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}
'

{
  "version": {
    "createdAt": 123,
    "id": "<string>",
    "tags": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "updatedAt": 123,
    "bundle": {
      "id": "<string>",
      "name": "<string>"
    },
    "content": {
      "mountDatasets": true,
      "dataPlaneId": "<string>",
      "dfsCommitId": "<string>",
      "entryScript": "<string>",
      "environmentId": "<string>",
      "environmentRevisionId": "<string>",
      "extendedIdentityPropagationToAppsEnabled": true,
      "externalVolumeMountIds": [
        "<string>"
      ],
      "gitRef": {
        "value": "<string>"
      },
      "netAppVolumeIds": [
        "<string>"
      ],
      "resolvedCommits": {
        "dfsCommitId": "<string>",
        "gitCommitId": "<string>",
        "importedGitRepos": [
          {
            "ref": "<string>",
            "repoId": "<string>",
            "repoName": "<string>"
          }
        ],
        "importedProjects": [
          {
            "commitId": "<string>",
            "directoryName": "<string>",
            "ownerId": "<string>",
            "projectId": "<string>",
            "projectName": "<string>",
            "release": "<string>"
          }
        ]
      }
    },
    "currentInstance": {
      "createdAt": 123,
      "id": "<string>",
      "status": "<string>",
      "describeUrl": "<string>",
      "dfsCommitId": "<string>",
      "gitCommitId": "<string>",
      "publisher": {
        "id": "<string>",
        "name": "<string>"
      }
    },
    "deployment": {
      "autoscalingSpecification": {
        "enabled": true,
        "maxReplicas": 15,
        "minReplicas": 15,
        "scaleDownStabilizationWindowSeconds": 1800,
        "scaleUpStabilizationWindowSeconds": 1800,
        "targetCpuAvgUtilizationPct": 50,
        "targetMemoryAvgUtilizationPct": 50,
        "useSessionAffinity": true
      },
      "hardwareTierId": "<string>",
      "vanityUrl": "<string>"
    },
    "description": "<string>",
    "versionNumber": 123
  },
  "instance": {
    "createdAt": 123,
    "id": "<string>",
    "status": "<string>",
    "describeUrl": "<string>",
    "dfsCommitId": "<string>",
    "gitCommitId": "<string>",
    "publisher": {
      "id": "<string>",
      "name": "<string>"
    }
  },
  "warnings": [
    "<string>"
  ]
}

Authorizations

X-Domino-Api-Key

string

header

required

Path Parameters

appId

string

required

Body

application/json

Request body for POST /apps/{appId}/versions/createAndStart and the optional initialVersion sub-flow on POST /apps/drafts. Content (reproducibility) fields (commits, refs, environment, mounts) and deployment (execution) fields (hardwareTier, autoscaling) are accepted on the new version. Run-time overrides for the initiated instance (vanityUrl, autoscalingSpecification, etc.) are carried separately under startOverrides. Draft-specific defaulting: when the parent App is a draft AND a previous running version exists, omitted content reference fields default to the previous running version's values (commitId, mainRepoGitRef, entryScript, environmentId, environmentRevisionId, hardwareTierId, externalVolumeMountIds, netAppVolumeIds). Governance only starts when a draft is published.

autoscalingSpecification

object

Show child attributes

bundleId

string

Guardrails bundle ID. Not applicable on drafts.

dataPlaneId

string

description

string

dfsCommitId

string

entryScript

string

Effective entry point for the App version.

environmentId

string

environmentRevisionId

string

extendedIdentityPropagationToAppsEnabled

boolean

default:false

externalVolumeMountIds

string[]

gitRef

object

Show child attributes

hardwareTierId

string

mountDatasets

boolean

Optional. If supplied, overrides the App's default for this version. If omitted, inherits from the parent App.

netAppVolumeIds

string[]

resolvedDfsCommitId

string

resolvedGitCommitId

string

resolvedImportedGitRepos

object[]

Show child attributes

resolvedImportedProjects

object[]

Show child attributes

startOverrides

object

Optional deployment-only run-time overrides for the initiated instance (deployment.hardwareTierId, deployment.autoscalingSpecification, deployment.vanityUrl, deployment.renderIFrame). Content fields are supplied at the top level of the request body for the version snapshot.

Show child attributes

Response

Version persisted and start initiated. If start initiation failed, the response carries the durable version plus a warnings array.

Response body for POST /apps/{appId}/versions/createAndStart. version is always present (the version is durably persisted before start initiation). instance is populated when start initiation succeeds; if it fails the response carries the version with a warnings array describing the failure and the caller can retry via the regular start endpoint.

version

object

required

Show child attributes

instance

object

Present only when start initiation succeeded.

Show child attributes

warnings

string[]

Non-fatal warnings (e.g., start initiation failure).

Create App Version (v1)Get App Version (v1)

⌘I