Describe pipeline launch

GET 
/pipelines/:pipelineId/launch

Retrieves the launch details of the pipeline identified by the given pipelineId.

Request

Path Parameters

pipelineId int64required

Pipeline numeric identifier

Query Parameters

workspaceId int64

Workspace numeric identifier

sourceWorkspaceId int64

Source Optional workspace numeric identifier

Responses

200

OK

application/json

Schema

Schema

launch object
idstring
Possible values: <= 22 characters
computeEnv objectnullable
credentialsIdstring
orgIdint64
workspaceIdint64
idstring
Possible values: <= 22 characters
namestringrequired
Possible values: <= 100 characters
descriptionstring
Possible values: <= 2000 characters
platformstringrequired
Possible values: <= 25 characters, [aws-batch, aws-cloud, google-lifesciences, google-batch, azure-batch, k8s-platform, eks-platform, gke-platform, uge-platform, slurm-platform, lsf-platform, altair-platform, moab-platform, local-platform, seqeracompute-platform]
config objectrequired
discriminator string
Possible values: [moab-platform, aws-batch, gke-platform, google-batch, aws-cloud, slurm-platform, k8s-platform, altair-platform, lsf-platform, azure-batch, seqeracompute-platform, eks-platform, google-lifesciences, uge-platform]
moab-platform
workDirstring
Compute environment working directory
preRunScriptstring
Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
postRunScriptstring
Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
nextflowConfigstring
launchDirstring
userNamestring
hostNamestring
portint32
headQueuestring
computeQueuestring
maxQueueSizeint32
headJobOptionsstring
propagateHeadJobOptionsboolean
discriminatorstring
property to select the compute config platform
environment object[]
Array [
namestring
valuestring
headboolean
computeboolean
]
aws-batch
storageTypestringdeprecated
lustreIdstringdeprecated
volumesstring[]
regionstring
computeQueuestring
dragenQueuestring
dragenInstanceTypestring
computeJobRolestring
executionRolestring
headQueuestring
headJobRolestring
cliPathstring
workDirstring
preRunScriptstring
Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
postRunScriptstring
Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
headJobCpusint32
headJobMemoryMbint32
environment object[]
Array [
namestring
valuestring
headboolean
computeboolean
]
waveEnabledboolean
fusion2Enabledboolean
nvnmeStorageEnabledboolean
logGroupstring
nextflowConfigstring
fusionSnapshotsboolean
forge object
typestring
Possible values: [SPOT, EC2]
minCpusint32
maxCpusint32
gpuEnabledboolean
ebsAutoScaleboolean
instanceTypesstring[]
allocStrategystring
Possible values: [BEST_FIT, BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, SPOT_PRICE_CAPACITY_OPTIMIZED]
imageIdstring
vpcIdstring
subnetsstring[]
securityGroupsstring[]
fsxMountstring
fsxNamestring
fsxSizeint32
disposeOnDeletionboolean
ec2KeyPairstring
allowBucketsstring[]
ebsBlockSizeint32
fusionEnabledboolean
bidPercentageint32
efsCreateboolean
efsIdstring
efsMountstring
dragenEnabledboolean
dragenAmiIdstring
ebsBootSizeint32
ecsConfigstring
fargateHeadEnabledboolean
arm64Enabledboolean
dragenInstanceTypestring
forgedResourcesobject[]
gke-platform
discriminatorstring
property to select the compute config platform
workDirstring
preRunScriptstring
Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
postRunScriptstring
Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
serverstring
sslCertstring
namespacestring
computeServiceAccountstring
headServiceAccountstring
storageClaimNamestring
storageMountPathstring
podCleanupPodCleanupPolicy (string)
Possible values: [on_success, always, never]
headPodSpecstring
servicePodSpecstring
environment object[]
Array [
namestring
valuestring
headboolean
computeboolean
]
headJobCpusint32
headJobMemoryMbint32
nextflowConfigstring
regionstring
The GKE cluster region - or - zone
clusterNamestring
The GKE cluster name
fusion2Enabledboolean
waveEnabledboolean
google-batch
locationstring
workDirstring
spotboolean
bootDiskSizeGbint32
cpuPlatformstring
machineTypestring
projectIdstring
sshDaemonboolean
sshImagestring
debugModeint32
copyImagestring
usePrivateAddressboolean
labels object
property name*string
preRunScriptstring
Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
postRunScriptstring
Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
headJobCpusint32
headJobMemoryMbint32
nextflowConfigstring
nfsTargetstring
nfsMountstring
environment object[]
Array [
namestring
valuestring
headboolean
computeboolean
]
waveEnabledboolean
fusion2Enabledboolean
serviceAccountstring
networkstring
subnetworkstring
headJobInstanceTemplatestring
computeJobsInstanceTemplatestring
aws-cloud
allowBucketsstring[]
regionstring
instanceTypestring
imageIdstring
workDirstring
preRunScriptstring
postRunScriptstring
nextflowConfigstring
environment object[]
Array [
namestring
valuestring
headboolean
computeboolean
]
waveEnabledboolean
fusion2Enabledboolean
logGroupstring
arm64Enabledboolean
gpuEnabledboolean
ec2KeyPairstring
ebsBootSizeint32
instanceProfileArnstring
subnetIdstring
securityGroupsstring[]
forgedResourcesobject[]
slurm-platform
workDirstring
Compute environment working directory
preRunScriptstring
Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
postRunScriptstring
Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
nextflowConfigstring
launchDirstring
userNamestring
hostNamestring
portint32
headQueuestring
computeQueuestring
maxQueueSizeint32
headJobOptionsstring
propagateHeadJobOptionsboolean
discriminatorstring
property to select the compute config platform
environment object[]
Array [
namestring
valuestring
headboolean
computeboolean
]
k8s-platform
workDirstring
preRunScriptstring
Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
postRunScriptstring
Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
serverstring
sslCertstring
namespacestring
computeServiceAccountstring
headServiceAccountstring
storageClaimNamestring
storageMountPathstring
podCleanupPodCleanupPolicy (string)
Possible values: [on_success, always, never]
headPodSpecstring
servicePodSpecstring
environment object[]
Array [
namestring
valuestring
headboolean
computeboolean
]
headJobCpusint32
headJobMemoryMbint32
nextflowConfigstring
altair-platform
workDirstring
Compute environment working directory
preRunScriptstring
Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
postRunScriptstring
Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
nextflowConfigstring
launchDirstring
userNamestring
hostNamestring
portint32
headQueuestring
computeQueuestring
maxQueueSizeint32
headJobOptionsstring
propagateHeadJobOptionsboolean
discriminatorstring
property to select the compute config platform
environment object[]
Array [
namestring
valuestring
headboolean
computeboolean
]
lsf-platform
workDirstring
Compute environment working directory
preRunScriptstring
Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
postRunScriptstring
Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
nextflowConfigstring
launchDirstring
userNamestring
hostNamestring
portint32
headQueuestring
computeQueuestring
maxQueueSizeint32
headJobOptionsstring
propagateHeadJobOptionsboolean
discriminatorstring
property to select the compute config platform
unitForLimitsstring
perJobMemLimitboolean
perTaskReserveboolean
environment object[]
Array [
namestring
valuestring
headboolean
computeboolean
]
azure-batch
workDirstring
preRunScriptstring
Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
postRunScriptstring
Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
regionstring
headPoolstring
autoPoolModebooleandeprecated
forge object
vmTypestring
vmCountint32
autoScaleboolean
disposeOnDeletionboolean
containerRegIdsstring[]
tokenDurationstring
deleteJobsOnCompletionJobCleanupPolicy (string)
Possible values: [on_success, always, never]
deletePoolsOnCompletionboolean
environment object[]
Array [
namestring
valuestring
headboolean
computeboolean
]
waveEnabledboolean
fusion2Enabledboolean
nextflowConfigstring
managedIdentityClientIdstringnullable
seqeracompute-platform
storageTypestringdeprecated
lustreIdstringdeprecated
volumesstring[]
discriminatorstring
property to select the compute config platform
regionstring
computeQueuestring
dragenQueuestring
dragenInstanceTypestring
computeJobRolestring
executionRolestring
headQueuestring
headJobRolestring
cliPathstring
workDirstring
preRunScriptstring
Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
postRunScriptstring
Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
headJobCpusint32
headJobMemoryMbint32
environment object[]
Array [
namestring
valuestring
headboolean
computeboolean
]
waveEnabledboolean
fusion2Enabledboolean
nvnmeStorageEnabledboolean
logGroupstring
nextflowConfigstring
fusionSnapshotsboolean
forge object
typestring
Possible values: [SPOT, EC2]
minCpusint32
maxCpusint32
gpuEnabledboolean
ebsAutoScaleboolean
instanceTypesstring[]
allocStrategystring
Possible values: [BEST_FIT, BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, SPOT_PRICE_CAPACITY_OPTIMIZED]
imageIdstring
vpcIdstring
subnetsstring[]
securityGroupsstring[]
fsxMountstring
fsxNamestring
fsxSizeint32
disposeOnDeletionboolean
ec2KeyPairstring
allowBucketsstring[]
ebsBlockSizeint32
fusionEnabledboolean
bidPercentageint32
efsCreateboolean
efsIdstring
efsMountstring
dragenEnabledboolean
dragenAmiIdstring
ebsBootSizeint32
ecsConfigstring
fargateHeadEnabledboolean
arm64Enabledboolean
dragenInstanceTypestring
forgedResourcesobject[]
eks-platform
discriminatorstring
property to select the compute config platform
workDirstring
preRunScriptstring
Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
postRunScriptstring
Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
serverstring
sslCertstring
namespacestring
computeServiceAccountstring
headServiceAccountstring
storageClaimNamestring
storageMountPathstring
podCleanupPodCleanupPolicy (string)
Possible values: [on_success, always, never]
headPodSpecstring
servicePodSpecstring
environment object[]
Array [
namestring
valuestring
headboolean
computeboolean
]
headJobCpusint32
headJobMemoryMbint32
nextflowConfigstring
regionstring
AWS region
clusterNamestring
The AWS EKS cluster name
waveEnabledboolean
fusion2Enabledboolean
google-lifesciences
regionstring
zonesstring[]
locationstring
workDirstring
preemptibleboolean
bootDiskSizeGbint32
projectIdstring
sshDaemonboolean
sshImagestring
debugModeint32
copyImagestring
usePrivateAddressboolean
labels object
property name*string
preRunScriptstring
Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
postRunScriptstring
Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
headJobCpusint32
headJobMemoryMbint32
nextflowConfigstring
nfsTargetstring
nfsMountstring
environment object[]
Array [
namestring
valuestring
headboolean
computeboolean
]
uge-platform
workDirstring
Compute environment working directory
preRunScriptstring
Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
postRunScriptstring
Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
nextflowConfigstring
launchDirstring
userNamestring
hostNamestring
portint32
headQueuestring
computeQueuestring
maxQueueSizeint32
headJobOptionsstring
propagateHeadJobOptionsboolean
discriminatorstring
property to select the compute config platform
environment object[]
Array [
namestring
valuestring
headboolean
computeboolean
]
workDirstring
preRunScriptstring
Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
postRunScriptstring
Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
environment object[]
Array [
namestring
valuestring
headboolean
computeboolean
]
nextflowConfigstring
dateCreateddate-time
lastUpdateddate-time
lastUseddate-time
deletedboolean
statusComputeEnv.Status (string)
Possible values: [CREATING, AVAILABLE, ERRORED, INVALID]
messagestring
Possible values: <= 4096 characters
primaryboolean
pipelinestringrequired
Possible values: <= 200 characters
workDirstring
revisionstring
Possible values: <= 100 characters
configTextstring
towerConfigstring
paramsTextstring
preRunScriptstring
Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
postRunScriptstring
Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
mainScriptstring
Possible values: <= 200 characters
entryNamestring
Possible values: <= 80 characters
schemaNamestring
Possible values: <= 100 characters, Value must match regular expression [\p{Graph}&&[^/]]\p{Graph}+
resumeboolean
resumeLaunchIdstring
Possible values: <= 22 characters
pullLatestboolean
stubRunboolean
sessionIdstring
Possible values: <= 36 characters
runNamestring
Possible values: <= 80 characters
configProfilesstring[]
userSecretsstring[]
workspaceSecretsstring[]
optimizationIdstring
Possible values: <= 32 characters
optimizationTargetsstring
headJobCpusint32
headJobMemoryMbint32
launchContainerstring
dateCreateddate-timerequired
lastUpdateddate-time

Example (auto)

{
  "launch": {
    "id": "string",
    "computeEnv": {
      "credentialsId": "string",
      "orgId": 0,
      "workspaceId": 0,
      "id": "string",
      "name": "string",
      "description": "string",
      "platform": "aws-batch",
      "config": {
        "volumes": [
          "string"
        ],
        "discriminator": "string",
        "region": "string",
        "computeQueue": "string",
        "dragenQueue": "string",
        "dragenInstanceType": "string",
        "computeJobRole": "string",
        "executionRole": "string",
        "headQueue": "string",
        "headJobRole": "string",
        "cliPath": "string",
        "workDir": "string",
        "preRunScript": "string",
        "postRunScript": "string",
        "headJobCpus": 0,
        "headJobMemoryMb": 0,
        "environment": [
          {
            "name": "string",
            "value": "string",
            "head": true,
            "compute": true
          }
        ],
        "waveEnabled": true,
        "fusion2Enabled": true,
        "nvnmeStorageEnabled": true,
        "logGroup": "string",
        "nextflowConfig": "string",
        "fusionSnapshots": true,
        "forge": {
          "type": "SPOT",
          "minCpus": 0,
          "maxCpus": 0,
          "gpuEnabled": true,
          "ebsAutoScale": true,
          "instanceTypes": [
            "string"
          ],
          "allocStrategy": "BEST_FIT",
          "imageId": "string",
          "vpcId": "string",
          "subnets": [
            "string"
          ],
          "securityGroups": [
            "string"
          ],
          "fsxMount": "string",
          "fsxName": "string",
          "fsxSize": 0,
          "disposeOnDeletion": true,
          "ec2KeyPair": "string",
          "allowBuckets": [
            "string"
          ],
          "ebsBlockSize": 0,
          "fusionEnabled": true,
          "bidPercentage": 0,
          "efsCreate": true,
          "efsId": "string",
          "efsMount": "string",
          "dragenEnabled": true,
          "dragenAmiId": "string",
          "ebsBootSize": 0,
          "ecsConfig": "string",
          "fargateHeadEnabled": true,
          "arm64Enabled": true,
          "dragenInstanceType": "string"
        },
        "forgedResources": [
          {}
        ]
      },
      "dateCreated": "2024-07-29T15:51:28.071Z",
      "lastUpdated": "2024-07-29T15:51:28.071Z",
      "lastUsed": "2024-07-29T15:51:28.071Z",
      "deleted": true,
      "status": "CREATING",
      "message": "string",
      "primary": true
    },
    "pipeline": "string",
    "workDir": "string",
    "revision": "string",
    "configText": "string",
    "towerConfig": "string",
    "paramsText": "string",
    "preRunScript": "string",
    "postRunScript": "string",
    "mainScript": "string",
    "entryName": "string",
    "schemaName": "string",
    "resume": true,
    "resumeLaunchId": "string",
    "pullLatest": true,
    "stubRun": true,
    "sessionId": "string",
    "runName": "string",
    "configProfiles": [
      "string"
    ],
    "userSecrets": [
      "string"
    ],
    "workspaceSecrets": [
      "string"
    ],
    "optimizationId": "string",
    "optimizationTargets": "string",
    "headJobCpus": 0,
    "headJobMemoryMb": 0,
    "launchContainer": "string",
    "dateCreated": "2024-07-29T15:51:28.071Z",
    "lastUpdated": "2024-07-29T15:51:28.071Z"
  }
}

400

Bad request

application/json

Schema

Schema

messagestringrequired

Example (auto)

{
  "message": "string"
}

403

Operation not allowed

Authorization: http

name: BearerAuthtype: httpscheme: bearerbearerFormat: jwt

• python
• curl
• java
• r
• javascript
• go
• powershell

• HTTP.CLIENT
• REQUESTS

import http.client

conn = http.client.HTTPSConnection("docs.seqera.io")
payload = ''
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer <token>'
}
conn.request("GET", "/pipelines/:pipelineId/launch", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Auth

Bearer Token

Parameters

pipelineId — pathrequired

workspaceId — query

sourceWorkspaceId — query