Skip to main content

Platforms

Use the Platforms API to retrieve the details of available computing platforms (such as AWS Batch, Google Cloud Batch, and Grid Engine) in Seqera.

Path and query parameters​

Name

Type

Location

Req/Opt

Description

orgId

integer

query

Optional

Organization identifier

workspaceId

integer

query

Optional

Workspace identifier

platformId

string

path

Required

Platform identifier

sched

boolean

query

Optional

If true, returns only instance types compatible with the Seqera Scheduler. AWS only. Default: false.

nvme

boolean

query

Optional

If true, returns only instance types with NVMe local storage. AWS only. Default: false.

regionId

string

query

Required

Cloud region identifier, for example us-east-1. Must be a region returned by List platform regions for the platform.

credentialsId

string

query

Required

Credentials identifier. Platform uses these credentials to retrieve the cloud resources available to the platform.