Skip to main content
POST
/
api
/
apps
/
beta
/
apps
/
{appId}
/
versions
/
{versionId}
/
start
Start App Version
curl --request POST \
  --url https://api.example.com/api/apps/beta/apps/{appId}/versions/{versionId}/start \
  --header 'X-Domino-Api-Key: <api-key>'
{
  "createdAt": 123,
  "environmentId": "<string>",
  "environmentRevisionId": "<string>",
  "extendedIdentityPropagationToAppsEnabled": true,
  "externalVolumeMountIds": [
    "<string>"
  ],
  "hardwareTierId": "<string>",
  "id": "<string>",
  "netAppVolumeIds": [
    "<string>"
  ],
  "tags": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "updatedAt": 123,
  "autoscalingSpecification": {
    "enabled": true,
    "maxReplicas": 15,
    "minReplicas": 15,
    "scaleDownStabilizationWindowSeconds": 1800,
    "scaleUpStabilizationWindowSeconds": 1800,
    "targetCpuAvgUtilizationPct": 50,
    "targetMemoryAvgUtilizationPct": 50,
    "useSessionAffinity": true
  },
  "bundleId": "<string>",
  "bundleName": "<string>",
  "currentInstance": {
    "createdAt": 123,
    "id": "<string>",
    "status": "<string>",
    "describeUrl": "<string>",
    "dfsCommitId": "<string>",
    "gitCommitId": "<string>"
  },
  "description": "<string>",
  "dfsCommitId": "<string>",
  "entryScript": "<string>",
  "gitRef": {
    "value": "<string>"
  },
  "publisher": {
    "id": "<string>",
    "name": "<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>"
      }
    ]
  },
  "vanityUrl": "<string>",
  "versionNumber": 123
}

Authorizations

​
X-Domino-Api-Key
string
header
required

Path Parameters

​
appId
string
required

The id of the app.

​
versionId
string
required

The id of the app version to start.

Response

Success

​
createdAt
number<epoch>
required
​
environmentId
string
required
​
environmentRevisionId
string
required
​
extendedIdentityPropagationToAppsEnabled
boolean
required
​
externalVolumeMountIds
string[]
required
​
hardwareTierId
string
required
​
id
string
required
​
netAppVolumeIds
string[]
required
​
tags
object[]
required
​
updatedAt
number<epoch>
required
​
autoscalingSpecification
object
​
bundleId
string

Guardrails bundle ID. Immutable after creation.

​
bundleName
string
​
currentInstance
object
​
description
string

Optional version description.

​
dfsCommitId
string

The original DFS commit ID specified when the version was created. May be null if not explicitly provided.

​
entryScript
string

Optional inline script to execute instead of the app's entry point. If provided, this script will take precedence over the entry point.

​
gitRef
object

The original git reference (e.g. branch name) specified when the version was created.

​
publisher
object
​
resolvedCommits
object

Commit and import snapshots resolved at version creation time, representing the actual values used for execution.

​
vanityUrl
string
​
versionNumber
integer<int64>