Compute environments

Compute environments define the execution platform where a pipeline or Studio will run. Compute environments enable users to launch pipelines and studios on a growing number of cloud and on-premises platforms.

Path and query parameters

Name	Type	Location	Req/Opt	Description
status	string	query	Optional	Filter by compute environment status.
workspaceId	integer	query	Optional	Workspace numeric identifier. If omitted, lists compute environments in a user context.
name	string	query	Optional	Compute environment name to validate for uniqueness and format.
computeEnvId	string	path	Required	Compute environment alphanumeric identifier.
attributes	array	query	Optional	Additional attribute values to include in the response. Returns labels: null if omitted.

Request body parameters

Name	Type	Req/Opt	Description
CreateComputeEnv			Create compute environment
computeEnv	object	Required
computeEnv.credentialsId	string	Optional	Credentials identifier for compute environment authentication. Requires existing cloud provider/HPC credentials. See Create credentials.
computeEnv.orgId	integer	Optional	Organization numeric identifier (read-only, set by system).
computeEnv.workspaceId	integer	Optional	Workspace numeric identifier (read-only, set by system).
computeEnv.id	string	Optional	Compute environment alphanumeric identifier (read-only, generated by system).
computeEnv.name	string	Required	Unique name for the compute environment. Must consist of 1-100 alphanumeric, dash, or underscore characters.
computeEnv.description	string	Optional	Description of the compute environment. Maximum length: 2000 characters.
computeEnv.platform	string	Required	Compute platform provider.
computeEnv.config	object	Required
computeEnv.config.workDir	string	Optional	Work directory path for storing intermediate workflow files.
computeEnv.config.preRunScript	string	Optional	Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
computeEnv.config.postRunScript	string	Optional	Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
computeEnv.config.environment	array	Optional	Environment variables to set in the compute environment.
computeEnv.config.environment[].name	string	Required	Environment variable name.
computeEnv.config.environment[].value	string	Required	Environment variable value.
computeEnv.config.environment[].head	boolean	Optional	Apply this variable to the Nextflow head job.
computeEnv.config.environment[].compute	boolean	Optional	Apply this variable to the Nextflow compute jobs.
computeEnv.config.nextflowConfig	string	Optional	Additional Nextflow configuration to apply. See Nextflow config file.
computeEnv.config.discriminator	string	Optional	Platform type discriminator (read-only, set based on platform selection).
computeEnv.dateCreated	string	Optional	Creation timestamp (read-only, set by system).
computeEnv.lastUpdated	string	Optional	Last update timestamp (read-only, updated by system).
computeEnv.lastUsed	string	Optional	Last usage timestamp (read-only, updated by system).
computeEnv.deleted	boolean	Optional	Deletion status flag (read-only, updated by system).
computeEnv.status	string	Optional	Current status of the compute environment (read-only).
computeEnv.message	string	Optional
computeEnv.primary	boolean	Optional
labelIds	array	Optional	Array of label IDs to assign to the compute environment.
UpdateComputeEnv			Update compute environment
name	string	Optional	New name for the compute environment. Must be unique within workspace.
credentialsId	string	Optional	Updated credentials identifier. Changing credentials may affect running workflows.
UpdateComputeEnvPrimary			Define primary compute environment