Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/seqera-labs-compute-envs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
contact:
email: info@seqera.io
url: https://seqera.io
description: Seqera Platform services API
title: Seqera actions Compute Envs API
version: 1.181.0
servers:
- url: https://api.cloud.seqera.io
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- description: Compute environments
name: compute-envs
paths:
/compute-envs:
get:
description: Lists all available compute environments in a user context. Append `?workspaceId` to list compute environments in a workspace context, and `?status` to filter by compute environment status.
operationId: ListComputeEnvs
parameters:
- description: Compute environment status
in: query
name: status
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
- description: 'Additional attribute values to include in the response (`labels`, `resources`). Returns an empty value (ex. `labels: null`) if omitted.'
explode: false
in: query
name: attributes
schema:
items:
$ref: '#/components/schemas/ComputeEnvQueryAttribute'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListComputeEnvsResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: List compute environments
tags:
- compute-envs
post:
description: Creates a new compute environment. Append `?workspaceId` to create the environment in a workspace context.
operationId: CreateComputeEnv
parameters:
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateComputeEnvRequest'
description: Compute environment create request
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CreateComputeEnvResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Create compute environment
tags:
- compute-envs
/compute-envs/validate:
get:
description: Confirms the validity of the given compute environment name in a user context. Append `?name=<your_ce_name>`.
operationId: ValidateComputeEnvName
parameters:
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
- description: Compute environment name to validate
in: query
name: name
schema:
type: string
responses:
'204':
description: OK - No content
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Duplicate element
security:
- BearerAuth: []
summary: Validate compute environment name
tags:
- compute-envs
/compute-envs/{computeEnvId}:
delete:
description: Deletes the compute environment identified by the given `computeEnvId`. When `force=true`, bypasses active-job checks and SCMS/forge cleanup; only allowed for environments in ERRORED, INVALID, or DELETING status.
operationId: DeleteComputeEnv
parameters:
- description: Compute environment string identifier
in: path
name: computeEnvId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
- description: Force-delete a stuck compute environment, bypassing active-job checks. Only valid for environments in ERRORED, INVALID, or DELETING status.
in: query
name: force
schema:
type: boolean
responses:
'204':
description: OK - No content
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Conflicting deletion
security:
- BearerAuth: []
summary: Delete compute environment
tags:
- compute-envs
get:
description: Retrieves the details of the compute environment identified by the given `computeEnvId`.
operationId: DescribeComputeEnv
parameters:
- description: Compute environment string identifier
in: path
name: computeEnvId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
- description: 'Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted.'
in: query
name: attributes
schema:
items:
$ref: '#/components/schemas/ComputeEnvQueryAttribute'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeComputeEnvResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Describe compute environment
tags:
- compute-envs
put:
description: Updates the details of the compute environment identified by the given `computeEnvId`.
operationId: UpdateComputeEnv
parameters:
- description: Compute environment string identifier
in: path
name: computeEnvId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateComputeEnvRequest'
description: Compute environment update request
required: true
responses:
'204':
description: OK - No content
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Duplicate element
security:
- BearerAuth: []
summary: Update compute environment
tags:
- compute-envs
/compute-envs/{computeEnvId}/disable:
post:
description: Disables the compute environment identified by the given `computeEnvId`. A disabled compute environment cannot be used to launch workflows. If the compute environment is primary, it will be automatically unset as primary.
operationId: DisableComputeEnv
parameters:
- description: Compute environment string identifier
in: path
name: computeEnvId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmptyBodyRequest'
responses:
'204':
description: OK - No content
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Disable compute environment
tags:
- compute-envs
/compute-envs/{computeEnvId}/enable:
post:
description: Enables the compute environment identified by the given `computeEnvId`. An enabled compute environment can be used to launch workflows.
operationId: EnableComputeEnv
parameters:
- description: Compute environment string identifier
in: path
name: computeEnvId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmptyBodyRequest'
responses:
'204':
description: OK - No content
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Enable compute environment
tags:
- compute-envs
/compute-envs/{computeEnvId}/primary:
post:
description: Selects the compute environment identified by the given `computeEnvId` as the primary compute environment in the given workspace context.
operationId: UpdateComputeEnvPrimary
parameters:
- description: Compute environment string identifier
in: path
name: computeEnvId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmptyBodyRequest'
responses:
'204':
description: OK - No content
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Bad request
'403':
description: Operation not allowed
security:
- BearerAuth: []
summary: Define primary compute environment
tags:
- compute-envs
/compute-envs/{computeEnvId}/validate:
post:
description: Re-runs the pre-flight checks (associated-credential validation and work-directory accessibility) for the compute environment identified by the given `computeEnvId` and persists the outcome to the compute environment and its credential. Intended to recover a compute environment marked `INVALID` after the underlying problem has been fixed. Available only while the pre-flight feature is enabled.
operationId: ValidateComputeEnv
parameters:
- description: Compute environment string identifier
in: path
name: computeEnvId
required: true
schema:
type: string
- description: Workspace numeric identifier
in: query
name: workspaceId
schema:
format: int64
type: integer
- description: When true, skip the credential and work-dir checks and force the compute environment (INVALID only, with an AVAILABLE credential) to AVAILABLE. Rejected with 409 otherwise.
in: query
name: force
required: false
schema:
type: boolean
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmptyBodyRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateComputeEnvResponse'
description: Validation outcome - inspect status and the transientError flag on the response body
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Compute environment is in a status that cannot be validated
'403':
description: Operation not allowed
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Compute environment not found
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Pre-flight feature is disabled
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Force override rejected because the compute environment or its associated credential is not in a compatible state
security:
- BearerAuth: []
summary: Validate a compute environment
tags:
- compute-envs
components:
schemas:
AzBatchConfig:
allOf:
- $ref: '#/components/schemas/ComputeConfig'
- properties:
autoPoolMode:
deprecated: true
type: boolean
deleteJobsOnCompletion:
allOf:
- $ref: '#/components/schemas/JobCleanupPolicy'
readOnly: true
deleteJobsOnCompletionEnabled:
type:
- boolean
- 'null'
deletePoolsOnCompletion:
type: boolean
deleteTasksOnCompletion:
type:
- boolean
- 'null'
forge:
$ref: '#/components/schemas/AzBatchForgeConfig'
fusion2Enabled:
type: boolean
headJobCpus:
description: Number of CPU slots reserved on the head pool VM for the Nextflow head job. Defaults to 1 so multiple head jobs can share a head pool VM; increase to dedicate more CPU and memory to each head job.
example: 1
format: int32
type:
- integer
- 'null'
headJobMemoryMb:
description: Memory in MiB reserved for the Nextflow head job container. When omitted, the value is derived from the head pool VM size as the per-slot share (vmMemory / vmCpus) multiplied by the requested slot count.
example: 4096
format: int32
type:
- integer
- 'null'
headPool:
type: string
jobMaxWallClockTime:
description: 'Maximum wall clock time for Azure Batch jobs before automatic termination. Accepts human-readable duration syntax (e.g., ''7d'', ''1d1h1m''). Defaults to 7d when not specified. Maximum: 180 days.'
example: 7d
type:
- string
- 'null'
managedIdentityClientId:
type:
- string
- 'null'
managedIdentityHeadResourceId:
type:
- string
- 'null'
managedIdentityPoolClientId:
type:
- string
- 'null'
managedIdentityPoolResourceId:
type:
- string
- 'null'
region:
type: string
subnetId:
description: Azure VNet subnet resource ID for private network isolation. Requires Entra (service principal) credentials.
example: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet
type:
- string
- 'null'
terminateJobsOnCompletion:
type:
- boolean
- 'null'
tokenDuration:
type: string
waveEnabled:
type: boolean
workerPool:
type: string
type: object
title: Azure Batch configuration
type: object
GoogleLifeSciencesConfig:
allOf:
- $ref: '#/components/schemas/ComputeConfig'
- properties:
bootDiskSizeGb:
format: int32
type: integer
copyImage:
type: string
debugMode:
format: int32
type: integer
headJobCpus:
format: int32
type: integer
headJobMemoryMb:
format: int32
type: integer
labels:
additionalProperties:
type: string
type: object
location:
type: string
nfsMount:
type: string
nfsTarget:
type: string
preemptible:
type: boolean
projectId:
type: string
region:
type: string
sshDaemon:
type: boolean
sshImage:
type: string
usePrivateAddress:
type: boolean
zones:
items:
type: string
type: array
type: object
title: Google Life Sciences configuration (retired)
type: object
DescribeComputeEnvResponse:
properties:
computeEnv:
$ref: '#/components/schemas/ComputeEnvResponseDto'
type: object
ListComputeEnvsResponse:
properties:
computeEnvs:
items:
$ref: '#/components/schemas/ListComputeEnvsResponse.Entry'
type: array
type: object
ComputeEnvQueryAttribute:
enum:
- labels
- resources
type: string
x-enum-varnames:
- labels
- resources
SchedConfig.Pool:
properties:
desiredWarm:
description: Target number of idle VMs to keep warm. Bounds total warm-VM cost across all of this CE's pool clusters.
format: int32
type: integer
enabled:
description: Whether the warm pool is active for this CE. When false, the scheduler will not maintain idle VMs.
type: boolean
scaleToZeroSecs:
description: Seconds of inactivity after which the warm pool scales to zero. Set to 0 to never scale to zero.
format: int32
type: integer
type: object
AltairPbsComputeConfig:
allOf:
- $ref: '#/components/schemas/AbstractGridConfig'
title: Altair PBS configuration
type: object
ForgeConfig:
properties:
allocStrategy:
enum:
- BEST_FIT
- BEST_FIT_PROGRESSIVE
- SPOT_CAPACITY_OPTIMIZED
- SPOT_PRICE_CAPACITY_OPTIMIZED
type: string
allowBuckets:
items:
type: string
type: array
arm64Enabled:
type: boolean
bidPercentage:
format: int32
type: integer
disposeOnDeletion:
type: boolean
dragenAmiId:
type: string
dragenEnabled:
type: boolean
dragenInstanceType:
type: string
ebsAutoScale:
type: boolean
ebsBlockSize:
format: int32
type: integer
ebsBootSize:
format: int32
type: integer
ec2KeyPair:
type: string
ecsConfig:
type: string
efsCreate:
type: boolean
efsId:
type: string
efsMount:
type: string
fargateHeadEnabled:
type: boolean
fsxMount:
type: string
fsxName:
type: string
fsxSize:
format: int32
type: integer
fusionEnabled:
type: boolean
gpuEnabled:
type: boolean
imageId:
type: string
instanceTypes:
items:
type: string
type: array
maxCpus:
format: int32
type: integer
minCpus:
format: int32
type: integer
securityGroups:
items:
type: string
type: array
subnets:
items:
type: string
type: array
type:
enum:
- SPOT
- EC2
type: string
vpcId:
type: string
type: object
ComputeEnv.Status:
enum:
- CREATING
- AVAILABLE
- DISABLED
- DELETING
- ERRORED
- INVALID
- DELETED
type: string
AbstractGridConfig:
allOf:
- $ref: '#/components/schemas/ComputeConfig'
- properties:
computeQueue:
type: string
headJobOptions:
type: string
headQueue:
type: string
hostName:
type: string
launchDir:
type: string
maxQueueSize:
format: int32
type: integer
port:
format: int32
type: integer
propagateHeadJobOptions:
type: boolean
userName:
type: string
type: object
type: object
LabelDbDto:
properties:
dateCreated:
format: date-time
type: string
id:
format: int64
type: integer
isDefault:
type: boolean
isDynamic:
type: boolean
isInterpolated:
type: boolean
name:
type: string
resource:
type: boolean
value:
type: string
type: object
MoabComputeConfig:
allOf:
- $ref: '#/components/schemas/AbstractGridConfig'
title: Moab configuration
type: object
ComputeEnvResponseDto:
properties:
awsAccountId:
type:
- string
- 'null'
config:
$ref: '#/components/schemas/ComputeConfig'
credentialsId:
type: string
dateCreated:
format: date-time
type: string
deleted:
type: boolean
description:
type: string
fusionMetricsCollectionEnabled:
type: boolean
id:
type: string
labels:
items:
$ref: '#/components/schemas/LabelDbDto'
type: array
lastUpdated:
format: date-time
type: string
lastUsed:
format: date-time
type: string
managedIdentityId:
type: string
message:
type: string
name:
type: string
orgId:
format: int64
type: integer
platform:
enum:
- aws-batch
- aws-cloud
- seqeracompute-platform
- 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
- google-lifesciences
type: string
primary:
type: boolean
resources:
allOf:
- $ref: '#/components/schemas/ComputeEnvResources'
status:
$ref: '#/components/schemas/ComputeEnv.Status'
workspaceId:
format: int64
type: integer
type: object
SeqeraComputeConfig:
allOf:
- $ref: '#/components/schemas/ComputeConfig'
- properties:
defaultDataRetentionPolicy:
type: boolean
instanceTypeSize:
allOf:
- $ref: '#/components/schemas/SeqeraComputeCloudInstanceTypeSize'
description: Size of the Data Studios instance (SMALL, MEDIUM, LARGE)
region:
type: string
type: object
title: Seqera Compute configuration
type: object
ComputeEnvResources:
properties:
cpus:
format: int32
type:
- integer
- 'null'
diskSize:
format: int32
type:
- integer
- 'null'
estimatedPrice:
format: float
type:
- number
- 'null'
gpuEnabled:
type:
- boolean
- 'null'
gpus:
format: int32
type:
- integer
- 'null'
instanceType:
type:
- string
- 'null'
memory:
format: int32
type:
- integer
- 'null'
type: object
SeqeraComputeCloudInstanceTypeSize:
enum:
- SMALL
- MEDIUM
- LARGE
type: string
SlurmComputeConfig:
allOf:
- $ref: '#/components/schemas/AbstractGridConfig'
title: Slurm configuration
type: object
AwsBatchConfig:
allOf:
- $ref: '#/components/schemas/ComputeConfig'
- properties:
cliPath:
type: string
computeJobRole:
type: string
computeQueue:
type: string
deletedResources:
items:
additionalProperties:
type: object
type: object
readOnly: true
type: array
dragenInstanceType:
type: string
dragenQueue:
type: string
executionRole:
type: string
forge:
$ref: '#/components/schemas/ForgeConfig'
forgedResources:
items:
additionalProperties:
type: object
type: object
type: array
fusion2Enabled:
type: boolean
fusionSnapshots:
type: boolean
headJobCpus:
format: int32
type: integer
headJobMemoryMb:
format: int32
type: integer
headJobRole:
type: string
headQueue:
type: string
logGroup:
type: string
lustreId:
deprecated: true
type: string
nvnmeStorageEnabled:
type: boolean
region:
type: string
storageType:
deprecated: true
type: string
volumes:
items:
type: string
type: array
waveEnabled:
type: boolean
type: object
title: AWS Batch configuration
type: object
AzBatchPoolConfig:
description: Azure Batch pool configuration for head or worker pool
properties:
autoScale:
type: boolean
bootDiskSizeGB:
description: Boot disk size in GB for this pool's nodes. Overrides the forge-level bootDiskSizeGB. When omitted, falls back to the forge-level value or Azure's default.
example: 100
format: int32
maximum: 4095
minimum: 50
type:
- integer
- 'null'
vmCount:
format: int32
type: integer
vmType:
type: string
type: object
GkeComputeConfig:
allOf:
- $ref: '#/components/schemas/K8sComputeConfig'
- properties:
clusterName:
description: The GKE cluster name
type: string
fusion2Enabled:
type: boolean
region:
description: The GKE cluster region - or - zone
type: string
waveEnabled:
type: boolean
type: object
title: Google GKE cluster configuration
type: object
GoogleBatchConfig:
allOf:
- $ref: '#/components/schemas/ComputeConfig'
- properties:
bootDiskImage:
type: string
bootDiskSizeGb:
format: int32
type: integer
computeJobsInstanceTemplate:
type: string
computeJobsMachineType:
items:
type: string
type: array
copyImage:
type: string
cpuPlatform:
type: string
debugMode:
format: int32
type: integer
fusion2Enabled:
type: boolean
fusionSnapshots:
type: boolean
headJobCpus:
format: int32
type: integer
headJobInstanceTemplate:
type: string
headJobMemoryMb:
format: int32
type: integer
labels:
additionalProperties:
type: string
type: object
location:
type: string
machineType:
type: string
network:
type: string
networkTags:
items:
type: string
type: array
nfsMount:
type: string
nfsTarget:
type: string
projectId:
type: string
serviceAccount:
type: string
spot:
type: boolean
sshDaemon:
type: boolean
sshImage:
type: string
subnetwork:
type: string
usePrivateAddress:
type: boolean
waveEnabled:
type: boolean
type: object
title: Google Batch service configuration
type: object
JobCleanupPolicy:
enum:
- on_success
- always
- never
type: string
x-enum-varnames:
- on_success
- always
- never
LocalComputeConfig:
allOf:
- $ref: '#/components/schemas/ComputeConfig'
- properties:
fusion2Enabled:
type: boolean
schedConfig:
$ref: '#/components/schemas/SchedConfig'
schedEnabled:
type: boolean
waveEnabled:
type: boolean
type: object
title: Local execution configuration
type: object
GoogleCloudConfig:
allOf:
- $ref: '#/components/schemas/ComputeConfig'
- properties:
arm64Enabled:
type: boolean
bootDiskSizeGb:
format: int32
type: integer
deletedResources:
items:
additionalProperties:
type: object
type: object
readOnly: true
type: array
forgedResources:
items:
additionalProperties:
type: object
type: object
type: array
fusion2Enabled:
type: boolean
gpuEnabled:
type: boolean
imageId:
type: string
instanceType:
type: string
projectId:
type: string
region:
type: string
schedConfig:
$ref: '#/components/schemas/SchedConfig'
schedEnabled:
type: boolean
serviceAccountEmail:
type: string
waveEnabled:
type: boolean
zone:
type: string
type: object
title: Google Cloud configuratio
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/seqera-labs/refs/heads/main/openapi/seqera-labs-compute-envs-api-openapi.yml