workspaces

Check workspace availability

Check if a workspace is available.

post/workspaces/availability

Request

Base URL
https://api.blaxel.ai/v0
Auth
- OAuth 2
  Authorization code/oauth/authorize
  Client credentials
  Token URL/oauth/token
  Scopesadmin
- or HTTP bearer
TypeScript
https://skmtc.dev/blaxel/apis/blaxel-control-plane/docs/workspaces/availability/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

withReasonboolean

When true, return a structured WorkspaceAvailability object with a machine-readable reason and human-readable message instead of a bare boolean. Defaults to false for backwards compatibility.

Request body

namestring required

Response

successful operation

boolean required

Changes

No recorded changes to this operation across all 1 revision of this API.