CodeSandbox

CodeSandbox preview_token API

Preview token management for private sandboxes

GitHub OpenAPI

Operations 4

GET /sandbox/{id}/tokens List Preview Tokens #
POST /sandbox/{id}/tokens Create a Preview Token #
DELETE /sandbox/{id}/tokens Revoke preview tokens #
PATCH /sandbox/{id}/tokens/{token_id} Update a Preview Token #

Documentation

📖
Documentation
https://codesandbox.io/docs/sdk

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/codesandbox/refs/heads/main/openapi/codesandbox-preview-token-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/codesandbox/codesandbox-sdk

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/codesandbox/refs/heads/main/json-schema/codesandbox-sandbox-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/codesandbox/refs/heads/main/json-schema/codesandbox-vm-start-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/codesandbox/refs/heads/main/json-schema/codesandbox-preview-token-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/codesandbox/refs/heads/main/json-schema/codesandbox-meta-information-schema.json

Other Resources

🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/codesandbox/refs/heads/main/vocabulary/codesandbox-vocabulary.yml
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/codesandbox/refs/heads/main/json-ld/codesandbox-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/codesandbox-preview-token-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

codesandbox-preview-token-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: CodeSandbox meta Preview Token API
  version: '2023-07-01'
  description: The CodeSandbox API provides programmatic access to create, manage, and control sandboxes and virtual machines (devboxes) backed by Firecracker microVMs. Authenticated via Bearer token obtained from codesandbox.io/t/api.
  contact:
    url: https://codesandbox.io/docs/sdk
  x-source: https://raw.githubusercontent.com/codesandbox/codesandbox-sdk/main/openapi.json
servers:
- url: https://api.codesandbox.io
security: []
tags:
- name: preview_token
  description: Preview token management for private sandboxes
paths:
  /sandbox/{id}/tokens:
    get:
      operationId: preview_token/list
      summary: List Preview Tokens
      description: 'List information about the preview tokens associated with the current sandbox

        '
      tags:
      - preview_token
      parameters:
      - name: id
        in: path
        required: true
        description: Shortid of the sandbox to list the tokens for
        example: 1ab3c
        schema:
          type: string
      responses:
        '201':
          description: Token List Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewTokenListResponse'
      security:
      - authorization:
        - preview_token:manage
    post:
      operationId: preview_token/create
      summary: Create a Preview Token
      description: 'Create a new Preview token that allow access to a private sandbox

        '
      tags:
      - preview_token
      parameters:
      - name: id
        in: path
        required: true
        description: Shortid of the sandbox to create the token for
        example: 1ab3c
        schema:
          type: string
      requestBody:
        description: Token Create Request
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewTokenCreateRequest'
      responses:
        '201':
          description: Token Create Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewTokenCreateResponse'
      security:
      - authorization:
        - preview_token:manage
    delete:
      operationId: preview_token/revoke_all
      summary: Revoke preview tokens
      description: 'Immediately expires all active preview tokens associated with this sandbox

        '
      tags:
      - preview_token
      parameters:
      - name: id
        in: path
        required: true
        description: Shortid of the sandbox to revoke tokens for
        example: 1ab3c
        schema:
          type: string
      responses:
        '200':
          description: RevokeAllPreviewTokensResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewTokenRevokeAllResponse'
      security:
      - authorization:
        - preview_token:manage
  /sandbox/{id}/tokens/{token_id}:
    patch:
      operationId: preview_token/update
      summary: Update a Preview Token
      description: 'Update a Preview token that allow access to a private sandbox

        '
      tags:
      - preview_token
      parameters:
      - name: id
        in: path
        required: true
        description: Shortid of the sandbox to create the token for
        example: 1ab3c
        schema:
          type: string
      - name: token_id
        in: path
        required: true
        description: ID of the token to update. Does not accept the token itself.
        example: prv_abcd12345
        schema:
          type: string
      requestBody:
        description: Token Update Request
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewTokenUpdateRequest'
      responses:
        '201':
          description: Token Update Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewTokenUpdateResponse'
      security:
      - authorization:
        - preview_token:manage
components:
  schemas:
    Response:
      title: Response
      type: object
      properties:
        success:
          type: boolean
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    PreviewTokenRevokeAllResponse:
      title: PreviewTokenRevokeAllResponse
      type: object
      allOf:
      - $ref: '#/components/schemas/Response'
      - type: object
        properties:
          data:
            type: object
            properties: {}
    PreviewTokenCreateResponse:
      title: PreviewTokenCreateResponse
      type: object
      allOf:
      - $ref: '#/components/schemas/Response'
      - type: object
        properties:
          data:
            type: object
            required:
            - sandbox_id
            - token
            properties:
              sandbox_id:
                type: string
              token:
                allOf:
                - $ref: '#/components/schemas/PreviewToken'
                - type: object
                  required:
                  - token
                  properties:
                    token:
                      type: string
    Error:
      title: Error
      oneOf:
      - type: string
      - type: object
        additionalProperties: true
    PreviewTokenListResponse:
      title: PreviewTokenListResponse
      type: object
      allOf:
      - $ref: '#/components/schemas/Response'
      - type: object
        properties:
          data:
            type: object
            required:
            - tokens
            - sandbox_id
            properties:
              sandbox_id:
                type: string
              tokens:
                type: array
                items:
                  $ref: '#/components/schemas/PreviewToken'
    PreviewTokenUpdateRequest:
      title: PreviewTokenUpdateRequest
      type: object
      properties:
        expires_at:
          type:
          - string
          - 'null'
          format: date-time
          description: UTC Timestamp until when this token is valid.
    PreviewTokenUpdateResponse:
      title: PreviewTokenUpdateResponse
      type: object
      allOf:
      - $ref: '#/components/schemas/Response'
      - type: object
        properties:
          data:
            type: object
            required:
            - sandbox_id
            - token
            properties:
              sandbox_id:
                type: string
              token:
                $ref: '#/components/schemas/PreviewToken'
    PreviewTokenCreateRequest:
      title: PreviewTokenCreateRequest
      type: object
      properties:
        expires_at:
          type:
          - string
          - 'null'
          format: date-time
          description: UTC Timestamp until when this token is valid. Omitting this field will create a token without an expiry.
    PreviewToken:
      title: PreviewToken
      type: object
      required:
      - expires_at
      - last_used_at
      - token_id
      - token_prefix
      properties:
        token_id:
          type: string
        token_prefix:
          type: string
        expires_at:
          type:
          - string
          - 'null'
        last_used_at:
          type:
          - string
          - 'null'
  securitySchemes:
    authorization:
      type: http
      scheme: bearer