> ## Documentation Index
> Fetch the complete documentation index at: https://docs.microsandbox.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Check sandbox name availability

> Check whether the sandbox slug is valid and available.



## OpenAPI

````yaml /api-reference/openapi.personal.json get /v1/orgs/{slug}/sandbox-slug/check
openapi: 3.1.0
info:
  title: Personal token API
  description: User-scoped API for account and organization management.
  version: 0.1.0
servers:
  - url: https://api.microsandbox.dev
security:
  - bearer: []
paths:
  /v1/orgs/{slug}/sandbox-slug/check:
    get:
      tags:
        - Sandboxes
      summary: Check sandbox name availability
      description: Check whether the sandbox slug is valid and available.
      operationId: check_slug
      parameters:
        - name: slug
          in: path
          description: Organization slug
          required: true
          schema:
            type: string
        - name: sandbox_slug
          in: query
          description: >-
            Candidate slug to validate + check. Named `sandbox_slug` in the
            query to

            disambiguate from the org `:slug` route param.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Slug validity + availability
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlugAvailability'
        '401':
          description: Unauthorized
      security:
        - bearer: []
components:
  schemas:
    SlugAvailability:
      type: object
      description: >-
        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.
      required:
        - slug
        - valid
        - available
      properties:
        available:
          type: boolean
        reason:
          type:
            - string
            - 'null'
        slug:
          type: string
        valid:
          type: boolean
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        Personal access token (msb_pat_…) or session JWT - the credential an
        agent acts with on a user's behalf.

````