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

# Get Cloud Box

> Returns a Cloud Box. Reading a Cloud Box does not resume an idle one. A Cloud Box that failed to start is removed; for a week, reading it answers 404 cloudbox_boot_failed with the reason.



## OpenAPI

````yaml /openapi/simulation.yaml get /v1/cloudbox/{id}
openapi: 3.1.0
info:
  description: >-
    Start API Boxes, Web Boxes, MCP Boxes and Cloud Boxes from Snapshots.
    Authenticate every request with an API key sent as a Bearer token.
  title: Continuous API
  version: v1
servers:
  - description: Continuous production API.
    url: https://api.continuouslabs.ai
security: []
tags:
  - description: >-
      Start API Boxes from API Box Snapshots. Each API Box serves its Snapshot's
      API at its own endpoint, with its own state, in real time. Stop, start and
      delete them.
    name: apibox
    x-group: API Boxes
  - description: >-
      Build API Box Snapshots from an OpenAPI, WSDL or GraphQL document, or use
      the catalog's. API Boxes start from a ready Snapshot.
    name: apibox-snapshots
    x-group: API Box Snapshots
  - description: >-
      Start Web Boxes from Web Box Snapshots. Each Web Box serves its Snapshot's
      web app at a host of its own, with its own state, in real time. Stop,
      start and delete them.
    name: webbox
    x-group: Web Boxes
  - description: >-
      Build Web Box Snapshots from a vendor's live web app, or use the
      catalog's. Web Boxes start from a ready Snapshot.
    name: webbox-snapshots
    x-group: Web Box Snapshots
  - description: >-
      Start MCP Boxes from MCP Box Snapshots. Each MCP Box serves its Snapshot's
      tools over MCP in front of an API Box. Stop, start and delete them.
    name: mcpbox
    x-group: MCP Boxes
  - description: >-
      List, rename and delete the MCP Box Snapshots that Continuous publishes
      into your workspace. Each holds an MCP server's tools, built against an
      API Box Snapshot.
    name: mcpbox-snapshots
    x-group: MCP Box Snapshots
  - description: >-
      Create emulated cloud accounts from Cloud Box Snapshots, start and stop
      them, and manage their Keys and connections.
    name: cloudbox
    x-group: Cloud Boxes
  - description: >-
      Save a Cloud Box's state as a Snapshot that new Cloud Boxes start from,
      and inspect, rename or delete Snapshots.
    name: cloudbox-snapshots
    x-group: Cloud Box Snapshots
  - description: >-
      Deprecated. Use API Box for APIs and Web Box for web apps. Build
      Simulators from OpenAPI, WSDL or GraphQL documents, check or cancel a
      build, clone Simulators into other workspaces, and rename and delete
      Simulators.
    name: simulators
    x-group: Simulators
  - description: >-
      Deprecated. Use API Box for APIs and Web Box for web apps. Create
      Simulations from ready Simulators or Snapshots, then rename, stop, start,
      and delete them.
    name: simulations
    x-group: Simulations
  - description: >-
      Deprecated. Use API Box for APIs and Web Box for web apps. Save a running
      Simulation's state as a Snapshot, create Simulations from it, and rename
      and delete it.
    name: simulation-snapshots
    x-group: Simulation Snapshots
  - description: >-
      Store connections to real systems: a base URL, the header that carries the
      credential, and its value. The API never returns a value.
    name: credentials
    x-group: Credentials
paths:
  /v1/cloudbox/{id}:
    get:
      tags:
        - cloudbox
      summary: Get Cloud Box
      description: >-
        Returns a Cloud Box. Reading a Cloud Box does not resume an idle one. A
        Cloud Box that failed to start is removed; for a week, reading it
        answers 404 cloudbox_boot_failed with the reason.
      operationId: get-cloudbox
      parameters:
        - description: Cloud Box ID.
          in: path
          name: id
          required: true
          schema:
            pattern: ^box_[0-9A-HJKMNP-TV-Z]{26}$
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudBox'
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          content:
            application/problem+json:
              examples:
                cloudbox_not_found:
                  $ref: '#/components/examples/cloudbox_not_found'
              schema:
                $ref: '#/components/schemas/Error'
          description: Not Found
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          content:
            application/problem+json:
              examples:
                auth_provider_unavailable:
                  $ref: '#/components/examples/auth_provider_unavailable'
                internal_unavailable:
                  $ref: '#/components/examples/internal_unavailable'
              schema:
                $ref: '#/components/schemas/Error'
          description: Service Unavailable
      security:
        - apiKeyAuth: []
components:
  schemas:
    CloudBox:
      additionalProperties: false
      properties:
        ca_certificate:
          description: >-
            PEM certificate of the CA the Cloud Box's emulator signs its TLS
            with, for clients that reach the Cloud Box's service names directly;
            null until the Cloud Box reports it.
          type:
            - string
            - 'null'
        console_url:
          description: >-
            Opens the Cloud Box's web console in a browser, signing it in
            through Continuous.
          format: uri
          type: string
        created_at:
          description: Cloud Box creation time.
          format: date-time
          type: string
        digest:
          description: >-
            Digest of the catalog image the Cloud Box runs, pinned when the
            Cloud Box was created.
          pattern: ^sha256:[0-9a-f]{64}$
          type: string
        endpoint:
          description: >-
            Base URL of the Cloud Box's data plane: one hostname per Cloud Box
            and no path.
          format: uri
          type: string
        id:
          description: Cloud Box ID.
          pattern: ^box_[0-9A-HJKMNP-TV-Z]{26}$
          type: string
        last_active_at:
          description: Time of the Cloud Box's last data-plane activity.
          format: date-time
          type: string
        metadata:
          description: Customer JSON metadata, or null.
        name:
          description: >-
            Cloud Box name. The ID is its identity, and names need not be
            unique.
          maxLength: 128
          type: string
        restorable_until:
          description: >-
            While stopped, the time after which the Cloud Box can no longer
            start; otherwise null. A stopped Cloud Box is deleted 30 days after
            this time; its ready Snapshots are kept.
          format: date-time
          type:
            - string
            - 'null'
        size:
          description: Size of the Cloud Box, chosen when it was created.
          enum:
            - small
            - medium
            - large
          type: string
          x-speakeasy-unknown-values: allow
        snapshot_id:
          description: >-
            ID of the Snapshot the Cloud Box started from, or null once that
            Snapshot is deleted.
          pattern: ^bx[st]_[0-9A-HJKMNP-TV-Z]{26}$
          type:
            - string
            - 'null'
        status:
          description: >-
            Current status. starting until the Cloud Box first runs. running
            serves requests; after a period without requests, the first request
            can take longer while the Cloud Box resumes. stopping means its
            state is being saved, and requests are refused; stopped means its
            state is saved and its quota slot released until you start it.
          enum:
            - starting
            - running
            - stopping
            - stopped
          type: string
          x-speakeasy-unknown-values: allow
        status_changed_at:
          description: >-
            When the Cloud Box entered its current status, such as how long it
            has been starting.
          format: date-time
          type: string
        type:
          description: Platform the Cloud Box emulates, copied from its Snapshot.
          enum:
            - aws
          type: string
          x-speakeasy-unknown-values: allow
      required:
        - id
        - snapshot_id
        - digest
        - type
        - name
        - size
        - status
        - endpoint
        - console_url
        - restorable_until
        - metadata
        - ca_certificate
        - last_active_at
        - status_changed_at
        - created_at
      type: object
    Error:
      additionalProperties: false
      properties:
        code:
          description: Stable machine-readable error code.
          minLength: 1
          type: string
        detail:
          description: Safe human-readable error detail.
          minLength: 1
          type: string
        validation:
          $ref: '#/components/schemas/SpecificationValidation'
          description: >-
            Safe specification diagnostics for a rejected build request, when
            available.
      required:
        - validation
        - code
        - detail
      type: object
    SpecificationValidation:
      additionalProperties: false
      properties:
        issues:
          description: Specification validation problems. At most 20 are returned.
          items:
            $ref: '#/components/schemas/SpecificationIssue'
          maxItems: 20
          type: array
      required:
        - issues
      type:
        - object
        - 'null'
    SpecificationIssue:
      additionalProperties: false
      properties:
        code:
          description: Stable validation rule code.
          type: string
        kind:
          description: >-
            Whether the input is invalid, unsupported, incomplete, exceeds a
            build limit, or has no specific diagnosis.
          enum:
            - invalid
            - unsupported
            - incomplete
            - limit
            - unknown
          type: string
        location:
          description: Readable endpoint or field affected by this issue.
          maxLength: 512
          type: string
        message:
          description: What needs attention at this location.
          type: string
        operation:
          description: >-
            Affected operation ID or method and path, when available. Empty for
            document-level issues.
          maxLength: 243
          type: string
        suggestion:
          description: How to correct or address the problem.
          type: string
      required:
        - code
        - operation
        - location
        - kind
        - message
        - suggestion
      type: object
  responses:
    Unauthorized:
      content:
        application/problem+json:
          examples:
            auth_invalid:
              $ref: '#/components/examples/auth_invalid'
            auth_missing:
              $ref: '#/components/examples/auth_missing'
          schema:
            $ref: '#/components/schemas/Error'
      description: Unauthorized
    InternalServerError:
      content:
        application/problem+json:
          examples:
            internal:
              $ref: '#/components/examples/internal'
          schema:
            $ref: '#/components/schemas/Error'
      description: Internal Server Error
  examples:
    cloudbox_not_found:
      value:
        code: cloudbox_not_found
        detail: No Cloud Box was found with that ID.
        validation: null
    auth_provider_unavailable:
      value:
        code: auth_provider_unavailable
        detail: >-
          The authentication provider is unavailable. Retry the request after a
          short delay.
        validation: null
    internal_unavailable:
      value:
        code: internal_unavailable
        detail: >-
          The service is temporarily unavailable. Retry the request after a
          short delay.
        validation: null
    auth_invalid:
      value:
        code: auth_invalid
        detail: The authentication credential is invalid.
        validation: null
    auth_missing:
      value:
        code: auth_invalid
        detail: Authentication credentials are required.
        validation: null
    internal:
      value:
        code: internal
        detail: The server encountered an unexpected error.
        validation: null
  securitySchemes:
    apiKeyAuth:
      bearerFormat: Continuous API key
      description: >-
        Use a Continuous API key. Send it in the Authorization header as a
        Bearer token.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.