---
title: "Describe platform"
method: GET
path: "/platforms/{platformId}"
tags: ["platforms"]
---

# Describe platform

`GET /platforms/{platformId}`

Retrieves the details of the computing platform identified by the given `platformId`.

## Path parameters

- `platformId` string, required

## Query parameters

- `workspaceId` integer
- `sched` boolean
- `nvme` boolean
- `regionId` string, required
- `credentialsId` string, required

## Response `200`

OK

- DescribePlatformResponse
  - `metainfo` union
    - object
      - `discriminator` string — property to select the platform metainfo type
      - `allocStrategy` string[]
      - `buckets` Bucket[]
        - `path` string
      - `efsFileSystems` EfsFileSystem[]
        - `id` string
      - `fileSystems` FsxFileSystem[]
        - `dns` string
        - `id` string
        - `mount` string
      - `images` Image[]
        - `arch` string, required
        - `description` string, required
        - `id` string, required
        - `name` string, required
      - `instanceFamilies` string[]
      - `jobQueues` JobQueue[]
        - `name` string, required
        - `state` string, required
      - `keyPairs` string[]
      - `securityGroups` SecurityGroup[]
        - `id` string
        - `name` string
        - `vpcId` string
      - `subnets` Subnet[]
        - `id` string
        - `vpcId` string
        - `zone` string
      - `vpcs` Vpc[]
        - `id` string
        - `isDefault` boolean
      - `warnings` string[]
    - object
      - `discriminator` string — property to select the platform metainfo type
      - `buckets` Bucket[]
        - `path` string
      - `images` Image[]
        - `arch` string, required
        - `description` string, required
        - `id` string, required
        - `name` string, required
      - `instanceTypes` InstanceType[]
        - `arch` string, required
        - `features` Feature[] — Capability features advertised for this instance type (e.g. GPU, NVMe). Absent when the data source does not publish features; an empty list means none.
        - `id` string
      - `keyPairs` string[]
      - `securityGroups` SecurityGroup[]
        - `id` string
        - `name` string
        - `vpcId` string
      - `subnets` Subnet[]
        - `id` string
        - `vpcId` string
        - `zone` string
      - `vpcs` Vpc[]
        - `id` string
        - `isDefault` boolean
      - `warnings` string[]
    - object
      - `discriminator` string — property to select the platform metainfo type
      - `buckets` GooglePlatformMetainfoBucket[]
        - `path` string
      - `filestores` GooglePlatformMetainfoFilestore[]
        - `location` string
        - `name` string
        - `target` string
      - `images` GoogleImage[]
        - `arch` string
        - `description` string
        - `id` string
        - `name` string
        - `qualifiedName` string
      - `instanceTypes` GoogleInstanceType[]
        - `arch` string
        - `features` Feature[] — Capability features advertised for this instance type (e.g. GPU). Absent when the data source does not publish features; an empty list means none.
        - `id` string
      - `locations` string[]
      - `warnings` string[]
      - `zones` string[]
    - object
      - `discriminator` string — property to select the platform metainfo type
      - `buckets` GoogleBucket[]
        - `path` string
      - `images` GoogleImage[]
        - `arch` string
        - `description` string
        - `id` string
        - `name` string
        - `qualifiedName` string
      - `instanceTypes` GoogleInstanceType[]
        - `arch` string
        - `features` Feature[] — Capability features advertised for this instance type (e.g. GPU). Absent when the data source does not publish features; an empty list means none.
        - `id` string
      - `warnings` string[]
      - `zones` string[]
    - object
      - `discriminator` string — property to select the platform metainfo type
      - `containers` string[]
      - `pools` string[]
      - `vmTypes` string[]
      - `warnings` string[]
    - object
      - `discriminator` string — property to select the platform metainfo type
      - `containers` string[]
      - `instanceTypes` string[]
      - `networks` AzNetwork[]
        - `id` string
        - `name` string
        - `region` string
        - `resourceGroup` string
      - `subnets` AzSubnet[]
        - `name` string
        - `networkId` string
        - `region` string
      - `warnings` string[]
    - object
      - `discriminator` string — property to select the platform metainfo type
      - `clusters` string[]
      - `warnings` string[]
    - object
      - `discriminator` string — property to select the platform metainfo type
      - `clusters` string[]
      - `warnings` string[]
    - object
      - `discriminator` string — property to select the platform metainfo type
    - object
      - `discriminator` string — property to select the platform metainfo type
    - object
      - `discriminator` string — property to select the platform metainfo type
      - `allocStrategy` string[]
      - `buckets` Bucket[]
        - `path` string
      - `efsFileSystems` EfsFileSystem[]
        - `id` string
      - `fileSystems` FsxFileSystem[]
        - `dns` string
        - `id` string
        - `mount` string
      - `images` Image[]
        - `arch` string, required
        - `description` string, required
        - `id` string, required
        - `name` string, required
      - `instanceFamilies` string[]
      - `instanceTypes` InstanceType[]
        - `arch` string, required
        - `features` Feature[] — Capability features advertised for this instance type (e.g. GPU, NVMe). Absent when the data source does not publish features; an empty list means none.
        - `id` string
      - `jobQueues` JobQueue[]
        - `name` string, required
        - `state` string, required
      - `keyPairs` string[]
      - `securityGroups` SecurityGroup[]
        - `id` string
        - `name` string
        - `vpcId` string
      - `subnets` Subnet[]
        - `id` string
        - `vpcId` string
        - `zone` string
      - `vpcs` Vpc[]
        - `id` string
        - `isDefault` boolean
      - `warnings` string[]
    - object
      - `discriminator` string — property to select the platform metainfo type

## Other responses

- `400` — Bad request
- `403` — Operation not allowed

---

[API](https://skmtc.net/seqeralabs/apis/seqera-api.md) · [All operations](https://skmtc.net/seqeralabs/apis/seqera-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/seqeralabs/seqera-api/revisions/13316c9fe5ff/schema)