Skip to main content
GET
Check sandbox name availability

Authorizations

Authorization
string
header
required

Personal access token (msb_pat_…) or session JWT - the credential an agent acts with on a user's behalf.

Path Parameters

slug
string
required

Organization slug

Query Parameters

sandbox_slug
string
required

Candidate slug to validate + check. Named sandbox_slug in the query to disambiguate from the org :slug route param.

Response

Slug validity + availability

Whether a candidate slug is well-formed and currently unused. valid is the format check; available is the global-uniqueness check (only meaningful when valid). reason explains an invalid format. Lets the create form guide the user before the sandbox is created.

available
boolean
required
slug
string
required
valid
boolean
required
reason
string | null