---
title: "Check workspace availability"
method: POST
path: "/workspaces/availability"
tags: ["workspaces"]
---

# Check workspace availability

`POST /workspaces/availability`

Check if a workspace is available.

## Query parameters

- `withReason` boolean

## Request body

- object
  - `name` string, required

## Response `200`

successful operation

- union
  - boolean
  - WorkspaceAvailability — Result of a workspace-name availability check.
    - `available` boolean — Whether the requested workspace name is available.
    - `message` string — Human-readable explanation suitable for display in the UI. Empty when available.
    - `reason` 'taken' | 'forbidden_reserved' | 'forbidden_blaxel' | 'forbidden_v_prefix' — Machine-readable reason explaining why the name is unavailable. Empty when available.

---

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