---
title: "Get world deployments"
method: GET
path: "/{worldId}/deployments/"
tags: ["World Deployments"]
---

# Get world deployments

`GET /{worldId}/deployments/`

Returns the specified world's deployments. Optionally can be filtered by status, provided in the query string.

## Path parameters

- `worldId` string, required

## Query parameters

- `status` union[]
  - union
    - 'Unknown'
    - 'Created'
    - 'Starting'
    - 'Running'
    - 'Degraded'
    - 'Failed'
    - 'Stopped'
    - 'Deleted'

## Headers

- `x-m2-organization-id` string, required — The ID of an organization
- `x-m2-project-id` string, required — The ID of a project

## Response `200`

Details for the World's deployments

- object[] — Details for the World's deployments
  - `organizationId` string, required — The ID of an organization
  - `projectId` string, required — The ID of a project
  - `worldId` string, required — The ID of a world
  - `runId` string — The ID of a world
  - `createdAt` string, required
  - `id` string, required — The ID of a world deployment
  - `networking` object, required
    - `scaling` object, required — The scaling configuration of a world.
      - `profile` union — The scaling profile of a world. This controls the overall capacity and configuration of a world.
        - 'Capacity30'
        - 'Tiny'
        - 'Capacity100'
        - 'Small'
        - 'Capacity500'
        - 'Medium'
        - 'Capacity1500'
        - 'Large5K'
        - 'Capacity5000'
        - 'Large'
        - 'Capacity15000'
        - 'Custom'
  - `externalId` string, required
  - `compute` object, required
    - `clusterName` string, required
    - `group` union, required — The compute group of a world. Controls where the world will be deployed.
      - 'development'
      - 'testing'
      - 'staging'
      - 'production'
      - 'bare-metal'
      - string
    - `region` union, required — The compute region of a world. Controls which region the world will be deployed in.
      - 'Europe'
      - 'europe-west1'
      - 'europe-west2'
      - 'europe-west3'
      - 'europe-west4'
      - 'europe-north1'
    - `version` string, required
  - `runtime` object, required
    - `build` object, required
      - `channelId` string, required
      - `id` string, required
      - `content` object
        - `id` string, required
    - `mapName` string, required
    - `liveConfigUrl` string
    - `durationMinute` number
    - `args` string[]
  - `status` union, required
    - 'Unknown'
    - 'Created'
    - 'Starting'
    - 'Running'
    - 'Degraded'
    - 'Failed'
    - 'Stopped'
    - 'Deleted'

## Other responses

- `4XX` — The error object returned by the API when an error occurs

---

[API](https://skmtc.net/otherside/apis/worlds.md) · [All operations](https://skmtc.net/otherside/apis/worlds/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/otherside/worlds/revisions/fe3e2eee3c6f/schema)