CapsuleProcessStartConfig

An automation action ($type is capsule) that starts a capsule run. version names the capsule and the version of it to start, and is required.

Kind: an object, used in requests and responses. In a request it is called CapsuleProcessStartConfigInput.

In a request

Field	Type	Required	Description
vfsMounts	CapsuleVirtualFileSystemMountInput[]		Virtual file system mounts for the run. A non-empty list replaces the capsule’s own; an empty list keeps them.
secretMounts	CapsuleSecretMountInput[]		Secret mounts for the run. A non-empty list replaces the capsule’s own; an empty list keeps them.
version	VersionReference| null		The app, interaction or capsule to start, and the version of it. Required for those three; left out for codepipeline (named by name) and interaction-message (which names a run).

{
  "vfsMounts": [
    {
      "vfsId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
      "vfsNamespaceId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
      "mountName": "..."
    }
  ],
  "secretMounts": [
    {
      "secretName": "...",
      "mountName": "..."
    }
  ],
  "version": {
    "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
    "version": 0
  }
}

In a response

Every field is present in a response; empty ones are null.

Field	Type	Description
vfsMounts	CapsuleVirtualFileSystemMount[]	Virtual file system mounts for the run. A non-empty list replaces the capsule’s own; an empty list keeps them.
secretMounts	CapsuleSecretMount[]	Secret mounts for the run. A non-empty list replaces the capsule’s own; an empty list keeps them.
version	VersionReference| null	The app, interaction or capsule to start, and the version of it. Required for those three; left out for codepipeline (named by name) and interaction-message (which names a run).

{
  "vfsMounts": [
    {
      "vfsId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
      "vfsNamespaceId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
      "mountName": "..."
    }
  ],
  "secretMounts": [
    {
      "secretName": "...",
      "mountName": "..."
    }
  ],
  "version": {
    "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
    "version": 0
  }
}

Where it’s used

• Inside ProcessStartConfig