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
workspaceId	integer	query	Optional	Workspace numeric identifier
name	string	query	Optional	Compute environment name to validate
computeEnvId	string	path	Required	Compute environment string identifier
attributes	array	query	Optional	Additional attribute values to include in the response (labels). Returns an empty value (labels: null) if omitted.

Request body parameters

Name	Type	Req/Opt	Description
CreateComputeEnv			Create compute environment
computeEnv	object	Optional
computeEnv.credentialsId	string	Optional
computeEnv.orgId	integer	Optional
computeEnv.workspaceId	integer	Optional
computeEnv.id	string	Optional
computeEnv.name	string	Required
computeEnv.description	string	Optional
computeEnv.platform	string	Required
computeEnv.config	object	Required
computeEnv.config.workDir	string	Optional
computeEnv.config.preRunScript	string	Optional
computeEnv.config.postRunScript	string	Optional
computeEnv.config.environment	array	Optional
computeEnv.config.environment[].name	string	Optional
computeEnv.config.environment[].value	string	Optional
computeEnv.config.environment[].head	boolean	Optional
computeEnv.config.environment[].compute	boolean	Optional
computeEnv.config.nextflowConfig	string	Optional
computeEnv.config.discriminator	string	Optional	property to select the compute config platform
computeEnv.dateCreated	string	Optional
computeEnv.lastUpdated	string	Optional
computeEnv.lastUsed	string	Optional
computeEnv.deleted	boolean	Optional
computeEnv.status	object	Optional
computeEnv.message	string	Optional
computeEnv.primary	boolean	Optional
labelIds	array	Optional
UpdateComputeEnv			Update compute environment
name	string	Optional
credentialsId	string	Optional
UpdateComputeEnvPrimary			Define primary compute environment