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	Compute environment status filter.
workspaceId	integer	query	Optional	Workspace identifier. If omitted, lists compute environments in a user context.
attributes	array	query	Optional	Additional attribute values to include in the response. One of labels or resources. Returns null for omitted attributes.
name	string	query	Optional	Compute environment name to validate for uniqueness and format.
computeEnvId	string	path	Required	Compute environment identifier.
force	boolean	query	Optional	If true, force-delete a stuck compute environment bypassing active-job checks. Only valid for environments in ERRORED, INVALID, or DELETING status.

Request body parameters

Name	Type	Req/Opt	Description
CreateComputeEnv			Create compute environment
computeEnv	object	Required	Compute environment record, including its platform-specific configuration.
computeEnv.credentialsId	string	Optional	Credentials identifier for compute environment authentication. Requires existing cloud provider/HPC credentials. See Create credentials.
computeEnv.orgId	integer	Optional	Organization identifier (read-only, set by system).
computeEnv.workspaceId	integer	Optional	Workspace identifier (read-only, set by system).
computeEnv.id	string	Optional	Compute environment 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	Platform-specific compute environment configuration. The discriminator property selects the configuration type.
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	Timestamp when the compute environment record was created.
computeEnv.lastUpdated	string	Optional	Timestamp when the compute environment record was last updated.
computeEnv.lastUsed	string	Optional	Timestamp when the compute environment was last used to launch a workflow.
computeEnv.deleted	boolean	Optional	If true, the compute environment record has been soft-deleted.
computeEnv.status	object	Optional	Current status of the compute environment (read-only).
computeEnv.message	string	Optional	Optional status or error message associated with the compute environment. Can be null when no message is available.
computeEnv.primary	boolean	Optional	If true, this compute environment is the primary compute environment for its scope.
computeEnv.fusionMetricsCollectionEnabled	boolean	Optional	If true, Platform collects the Fusion metrics files of this compute environment when jobs complete. Can be enabled only when Fusion file system is enabled. Does not change the Nextflow configuration or stop Fusion from generating metrics.
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.
description	string	Optional	Updated description of the compute environment. Maximum 2000 characters.
fusionMetricsCollectionEnabled	boolean	Optional	If true, Platform collects the Fusion metrics files at job completion for workflows run on this compute environment. Can only be enabled when Fusion is enabled on the compute environment and Fusion metrics collection is available for the workspace. When omitted, the current value is left unchanged.
DisableComputeEnv			Disable compute environment
EnableComputeEnv			Enable compute environment
UpdateComputeEnvPrimary			Define primary compute environment
ValidateComputeEnv			Validate compute environment