---
title: "Describe Launch record"
method: GET
path: "/launch/{launchId}"
tags: ["launch"]
---

# Describe Launch record

`GET /launch/{launchId}`

Retrieves the details of the launch identified by the given `launchId`.

## Path parameters

- `launchId` string, required

## Query parameters

- `workspaceId` integer

## Response `200`

OK

- DescribeLaunchResponse
  - `launch` Launch
    - `id` string
    - `workspaceId` integer
    - `computeEnv` ComputeEnvComputeConfig
      - `credentialsId` string
      - `orgId` integer
      - `workspaceId` integer
      - `id` string
      - `name` string, required
      - `description` string
      - `platform` 'aws-batch' | 'aws-cloud' | 'google-lifesciences' | 'google-batch' | 'google-cloud' | 'azure-batch' | 'azure-cloud' | 'k8s-platform' | 'eks-platform' | 'gke-platform' | 'uge-platform' | 'slurm-platform' | 'lsf-platform' | 'altair-platform' | 'moab-platform' | 'local-platform' | 'seqeracompute-platform', required
      - `config` union, required
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `storageType` string
          - `lustreId` string
          - `volumes` string[]
          - `region` string
          - `computeQueue` string
          - `dragenQueue` string
          - `dragenInstanceType` string
          - `computeJobRole` string
          - `executionRole` string
          - `headQueue` string
          - `headJobRole` string
          - `cliPath` string
          - `headJobCpus` integer
          - `headJobMemoryMb` integer
          - `waveEnabled` boolean
          - `fusion2Enabled` boolean
          - `nvnmeStorageEnabled` boolean
          - `logGroup` string
          - `fusionSnapshots` boolean
          - `forge` ForgeConfig
            - `type` 'SPOT' | 'EC2'
            - `minCpus` integer
            - `maxCpus` integer
            - `gpuEnabled` boolean
            - `ebsAutoScale` boolean
            - `instanceTypes` string[]
            - `allocStrategy` 'BEST_FIT' | 'BEST_FIT_PROGRESSIVE' | 'SPOT_CAPACITY_OPTIMIZED' | 'SPOT_PRICE_CAPACITY_OPTIMIZED'
            - `imageId` string
            - `vpcId` string
            - `subnets` string[]
            - `securityGroups` string[]
            - `fsxMount` string
            - `fsxName` string
            - `fsxSize` integer
            - `disposeOnDeletion` boolean
            - `ec2KeyPair` string
            - `allowBuckets` string[]
            - `ebsBlockSize` integer
            - `fusionEnabled` boolean
            - `bidPercentage` integer
            - `efsCreate` boolean
            - `efsId` string
            - `efsMount` string
            - `dragenEnabled` boolean
            - `dragenAmiId` string
            - `ebsBootSize` integer
            - `ecsConfig` string
            - `fargateHeadEnabled` boolean
            - `arm64Enabled` boolean
            - `dragenInstanceType` string
          - `forgedResources` object[]
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `allowBuckets` string[]
          - `region` string
          - `instanceType` string
          - `imageId` string
          - `waveEnabled` boolean
          - `fusion2Enabled` boolean
          - `logGroup` string
          - `arm64Enabled` boolean
          - `gpuEnabled` boolean
          - `ec2KeyPair` string
          - `ebsBootSize` integer
          - `instanceProfileArn` string
          - `subnetId` string
          - `securityGroups` string[]
          - `forgedResources` object[]
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `region` string
          - `defaultDataRetentionPolicy` boolean
          - `instanceTypeSize` 'SMALL' | 'MEDIUM' | 'LARGE'
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `region` string
          - `zones` string[]
          - `location` string
          - `preemptible` boolean
          - `bootDiskSizeGb` integer
          - `projectId` string
          - `sshDaemon` boolean
          - `sshImage` string
          - `debugMode` integer
          - `copyImage` string
          - `usePrivateAddress` boolean
          - `labels` object
          - `headJobCpus` integer
          - `headJobMemoryMb` integer
          - `nfsTarget` string
          - `nfsMount` string
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `location` string
          - `spot` boolean
          - `bootDiskSizeGb` integer
          - `cpuPlatform` string
          - `machineType` string
          - `projectId` string
          - `sshDaemon` boolean
          - `sshImage` string
          - `debugMode` integer
          - `copyImage` string
          - `usePrivateAddress` boolean
          - `labels` object
          - `headJobCpus` integer
          - `headJobMemoryMb` integer
          - `nfsTarget` string
          - `nfsMount` string
          - `waveEnabled` boolean
          - `fusion2Enabled` boolean
          - `serviceAccount` string
          - `network` string
          - `subnetwork` string
          - `headJobInstanceTemplate` string
          - `computeJobsInstanceTemplate` string
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `waveEnabled` boolean
          - `fusion2Enabled` boolean
          - `projectId` string
          - `region` string
          - `zone` string
          - `serviceAccountEmail` string
          - `instanceType` string
          - `imageId` string
          - `arm64Enabled` boolean
          - `gpuEnabled` boolean
          - `bootDiskSizeGb` integer
          - `forgedResources` object[]
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `region` string
          - `headPool` string
          - `autoPoolMode` boolean
          - `forge` AzBatchForgeConfig
            - `vmType` string
            - `vmCount` integer
            - `autoScale` boolean
            - `disposeOnDeletion` boolean
            - `containerRegIds` string[]
          - `tokenDuration` string
          - `deleteJobsOnCompletion` 'on_success' | 'always' | 'never'
          - `deletePoolsOnCompletion` boolean
          - `waveEnabled` boolean
          - `fusion2Enabled` boolean
          - `managedIdentityClientId` string, nullable
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `waveEnabled` boolean
          - `fusion2Enabled` boolean
          - `instanceType` string
          - `region` string
          - `resourceGroup` string
          - `networkId` string
          - `subscriptionId` string
          - `managedIdentityId` string
          - `managedIdentityClientId` string
          - `logWorkspaceId` string
          - `logTableName` string
          - `dataCollectionEndpoint` string
          - `dataCollectionRuleId` string
          - `forgedResources` MapEntryStringString[]
            - `key` string
            - `value` string
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `launchDir` string
          - `userName` string
          - `hostName` string
          - `port` integer
          - `headQueue` string
          - `computeQueue` string
          - `maxQueueSize` integer
          - `headJobOptions` string
          - `propagateHeadJobOptions` boolean
          - `unitForLimits` string
          - `perJobMemLimit` boolean
          - `perTaskReserve` boolean
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `launchDir` string
          - `userName` string
          - `hostName` string
          - `port` integer
          - `headQueue` string
          - `computeQueue` string
          - `maxQueueSize` integer
          - `headJobOptions` string
          - `propagateHeadJobOptions` boolean
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `server` string
          - `sslCert` string
          - `namespace` string
          - `computeServiceAccount` string
          - `headServiceAccount` string
          - `storageClaimName` string
          - `storageMountPath` string
          - `podCleanup` 'on_success' | 'always' | 'never'
          - `headPodSpec` string
          - `servicePodSpec` string
          - `headJobCpus` integer
          - `headJobMemoryMb` integer
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `server` string
          - `sslCert` string
          - `namespace` string
          - `computeServiceAccount` string
          - `headServiceAccount` string
          - `storageClaimName` string
          - `storageMountPath` string
          - `podCleanup` 'on_success' | 'always' | 'never'
          - `headPodSpec` string
          - `servicePodSpec` string
          - `headJobCpus` integer
          - `headJobMemoryMb` integer
          - `region` string — AWS region
          - `clusterName` string — The AWS EKS cluster name
          - `waveEnabled` boolean
          - `fusion2Enabled` boolean
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `server` string
          - `sslCert` string
          - `namespace` string
          - `computeServiceAccount` string
          - `headServiceAccount` string
          - `storageClaimName` string
          - `storageMountPath` string
          - `podCleanup` 'on_success' | 'always' | 'never'
          - `headPodSpec` string
          - `servicePodSpec` string
          - `headJobCpus` integer
          - `headJobMemoryMb` integer
          - `region` string — The GKE cluster region - or - zone
          - `clusterName` string — The GKE cluster name
          - `fusion2Enabled` boolean
          - `waveEnabled` boolean
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `launchDir` string
          - `userName` string
          - `hostName` string
          - `port` integer
          - `headQueue` string
          - `computeQueue` string
          - `maxQueueSize` integer
          - `headJobOptions` string
          - `propagateHeadJobOptions` boolean
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `launchDir` string
          - `userName` string
          - `hostName` string
          - `port` integer
          - `headQueue` string
          - `computeQueue` string
          - `maxQueueSize` integer
          - `headJobOptions` string
          - `propagateHeadJobOptions` boolean
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `launchDir` string
          - `userName` string
          - `hostName` string
          - `port` integer
          - `headQueue` string
          - `computeQueue` string
          - `maxQueueSize` integer
          - `headJobOptions` string
          - `propagateHeadJobOptions` boolean
        - object
          - `workDir` string — Compute environment working directory
          - `preRunScript` string — Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `postRunScript` string — Add a script that executes after all Nextflow processes have completed. See [Pre and post-run scripts](https://docs.seqera.io/platform-cloud/launch/advanced#pre-and-post-run-scripts).
          - `environment` ConfigEnvVariable[]
            - `name` string
            - `value` string
            - `head` boolean
            - `compute` boolean
          - `nextflowConfig` string
          - `discriminator` string — property to select the compute config platform
          - `waveEnabled` boolean
          - `fusion2Enabled` boolean
      - `dateCreated` string, date-time
      - `lastUpdated` string, date-time
      - `lastUsed` string, date-time
      - `deleted` boolean
      - `status` 'CREATING' | 'AVAILABLE' | 'DELETING' | 'ERRORED' | 'INVALID' | 'DISABLED'
      - `message` string
      - `primary` boolean
    - `pipeline` string, required
    - `workDir` string
    - `revision` string
    - `commitId` string
    - `configText` string
    - `towerConfig` string
    - `paramsText` string
    - `preRunScript` string
    - `postRunScript` string
    - `mainScript` string
    - `entryName` string
    - `schemaName` string
    - `resume` boolean
    - `resumeLaunchId` string
    - `pullLatest` boolean
    - `stubRun` boolean
    - `sessionId` string
    - `runName` string
    - `configProfiles` string[]
    - `userSecrets` string[]
    - `workspaceSecrets` string[]
    - `optimizationId` string
    - `optimizationTargets` string
    - `headJobCpus` integer
    - `headJobMemoryMb` integer
    - `launchContainer` string
    - `dateCreated` string, date-time, required
    - `lastUpdated` string, date-time

## Other responses

- `400` — Bad request
- `403` — Operation not allowed

## Changes

> 3 revisions in range; 1 not diffed.

- **2026-01-20** `98d6b538c88e` — 2 breaking, 2 warning, 144 info
  - added `#/components/schemas/GoogleCloudConfig, #/components/schemas/AzCloudConfig, #/components/schemas/LocalComputeConfig` to the `launch/computeEnv/allOf[#/components/schemas/ComputeEnv_ComputeConfig_]/config` response property `oneOf` list for the response status `200`
  - the `launch/computeEnv/allOf[#/components/schemas/ComputeEnv_ComputeConfig_]/status` response's property type/format changed from ``/`` to `string`/`` for status `200`
  - added the new `DELETING` enum value to the `launch/computeEnv/allOf[#/components/schemas/ComputeEnv_ComputeConfig_]/status/allOf[#/components/schemas/ComputeEnv.Status]/` response property for the response status `200`
  - added the new `DISABLED` enum value to the `launch/computeEnv/allOf[#/components/schemas/ComputeEnv_ComputeConfig_]/status/allOf[#/components/schemas/ComputeEnv.Status]/` response property for the response status `200`
  - …144 more

[Change history](https://skmtc.dev/seqeralabs/apis/seqera-api/changes/launch/:launchId/get.md)

---

[API](https://skmtc.dev/seqeralabs/apis/seqera-api.md) · [All operations](https://skmtc.dev/seqeralabs/apis/seqera-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/seqeralabs/seqera-api/revisions/98d6b538c88e/schema)
