> ## 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 topology

> Returns an AWS architecture view of a running Cloud Box's account. A starting, stopped or idle Cloud Box answers 409 cloudbox_not_running; one whose template predates the view answers 409 topology_unsupported. GET /v1/cloudbox/{id}/events streams its changes.



## OpenAPI

````yaml /openapi/simulation.yaml get /v1/cloudbox/{id}/topology
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}/topology:
    get:
      tags:
        - cloudbox
      summary: Get Cloud Box topology
      description: >-
        Returns an AWS architecture view of a running Cloud Box's account. A
        starting, stopped or idle Cloud Box answers 409 cloudbox_not_running;
        one whose template predates the view answers 409 topology_unsupported.
        GET /v1/cloudbox/{id}/events streams its changes.
      operationId: get-cloudbox-topology
      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/CloudBoxTopology'
          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
        '409':
          content:
            application/problem+json:
              examples:
                cloudbox_not_running:
                  $ref: '#/components/examples/cloudbox_not_running'
                topology_unsupported:
                  $ref: '#/components/examples/topology_unsupported'
              schema:
                $ref: '#/components/schemas/Error'
          description: Conflict
        '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:
    CloudBoxTopology:
      additionalProperties: false
      properties:
        account:
          $ref: '#/components/schemas/CloudBoxTopologyAccount'
          description: The Cloud Box's AWS account.
        edges:
          description: Edges between resources, by ID.
          items:
            $ref: '#/components/schemas/CloudBoxTopologyEdge'
          type: array
        epoch:
          description: >-
            The Cloud Box's boot this view belongs to. A start or Snapshot
            restore changes it; compare for equality only.
          format: int64
          type: integer
        internals:
          $ref: '#/components/schemas/CloudBoxTopologyInternals'
          description: What Cloud Box runs the account on.
        recent:
          description: The last 20 writes, oldest first.
          items:
            $ref: '#/components/schemas/CloudBoxTopologyEvent'
          type: array
        regions:
          description: Regions that hold resources, and the Cloud Box's default region.
          items:
            $ref: '#/components/schemas/CloudBoxTopologyRegion'
          type: array
        resources:
          description: Resources, by ID.
          items:
            $ref: '#/components/schemas/CloudBoxTopologyResource'
          type: array
        security_groups:
          description: Security groups, by ID.
          items:
            $ref: '#/components/schemas/CloudBoxTopologySecurityGroup'
          type: array
        subnets:
          description: Subnets, by ID.
          items:
            $ref: '#/components/schemas/CloudBoxTopologySubnet'
          type: array
        vpcs:
          description: VPCs, by ID.
          items:
            $ref: '#/components/schemas/CloudBoxTopologyVPC'
          type: array
      required:
        - account
        - regions
        - vpcs
        - subnets
        - security_groups
        - resources
        - edges
        - internals
        - recent
        - epoch
      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
    CloudBoxTopologyAccount:
      additionalProperties: false
      properties:
        alias:
          description: 'Account alias: the Cloud Box''s name.'
          type: string
        id:
          description: AWS account ID.
          type: string
      required:
        - id
        - alias
      type: object
    CloudBoxTopologyEdge:
      additionalProperties: false
      properties:
        from:
          description: Resource ID.
          type: string
        id:
          description: Edge ID.
          type: string
        kind:
          description: >-
            target: load balancer to target. sg: security-group ingress. calls:
            a workload's calls, labelled with the operation. member_of: a
            cluster to each task, node or container instance of it.
          enum:
            - target
            - sg
            - replication
            - event_source
            - redrive
            - calls
            - member_of
          type: string
        label:
          description: Port or operation, for example :8080 or SendMessage.
          type: string
        to:
          description: Resource ID.
          type: string
      required:
        - id
        - from
        - to
        - kind
        - label
      type: object
    CloudBoxTopologyInternals:
      additionalProperties: false
      properties:
        hub:
          $ref: '#/components/schemas/CloudBoxTopologyHub'
          description: The Cloud Box's hub VM.
        members:
          description: Every workload VM of the hub, by key.
          items:
            $ref: '#/components/schemas/CloudBoxTopologyMember'
          type: array
      required:
        - hub
        - members
      type: object
    CloudBoxTopologyEvent:
      additionalProperties: false
      properties:
        actor:
          description: Principal, or the service that called on its behalf, or null.
          type:
            - string
            - 'null'
        error:
          description: Error code, or null.
          type:
            - string
            - 'null'
        label:
          description: Resource name, or null.
          type:
            - string
            - 'null'
        op:
          description: Operation, for example CreateDBInstanceReadReplica.
          type: string
        resource_id:
          description: Resource it changed, or null.
          type:
            - string
            - 'null'
        service:
          description: Service, for example rds.
          type: string
        status:
          description: HTTP status.
          format: int64
          type: integer
        time:
          description: When cloudbox handled the call, RFC 3339 with milliseconds.
          type: string
      required:
        - time
        - op
        - service
        - status
        - error
        - actor
        - resource_id
        - label
      type: object
    CloudBoxTopologyRegion:
      additionalProperties: false
      properties:
        label:
          description: Full name, for example US East (N. Virginia).
          type: string
        name:
          description: Region name, for example us-east-1.
          type: string
      required:
        - name
        - label
      type: object
    CloudBoxTopologyResource:
      additionalProperties: false
      properties:
        cluster_id:
          description: >-
            Cluster it belongs to: an ECS task's or container instance's, or an
            EKS node's; otherwise null.
          type:
            - string
            - 'null'
        details:
          description: Components, such as listeners or containers and their ports.
          items:
            $ref: '#/components/schemas/CloudBoxTopologyDetail'
          type: array
        id:
          description: >-
            ARN, or AWS ID when the resource has no ARN. Unique across the
            topology.
          type: string
        kind:
          description: snake_case kind, for example ec2_instance, nat_gateway or sqs_queue.
          type: string
        name:
          description: Name.
          type: string
        parent_id:
          description: >-
            Resource it runs inside, such as an ECS task's container instance,
            or null.
          type:
            - string
            - 'null'
        private_ip:
          description: Private IPv4 address, or null.
          type:
            - string
            - 'null'
        public_ip:
          description: Public IPv4 address, or null.
          type:
            - string
            - 'null'
        region:
          description: Region name.
          type: string
        role_label:
          description: What it is in its cluster, for example EKS node · workers, or null.
          type:
            - string
            - 'null'
        security_group_ids:
          description: Security groups.
          items:
            type: string
          type: array
        service:
          description: ARN namespace, for example elasticloadbalancing.
          type: string
        status:
          description: Normalized status.
          enum:
            - creating
            - available
            - deleting
            - failed
          type: string
        subnet_id:
          description: Subnet, or null for a regional service.
          type:
            - string
            - 'null'
        summary:
          description: One-line subtitle, for example t3.micro · i-07c1e2, or null.
          type:
            - string
            - 'null'
        type_label:
          description: Type as the console names it, for example EC2 instance.
          type: string
      required:
        - id
        - kind
        - service
        - type_label
        - name
        - region
        - subnet_id
        - private_ip
        - public_ip
        - security_group_ids
        - status
        - summary
        - details
        - parent_id
        - cluster_id
        - role_label
      type: object
    CloudBoxTopologySecurityGroup:
      additionalProperties: false
      properties:
        id:
          description: Security group ID.
          type: string
        name:
          description: Group name.
          type: string
        vpc_id:
          description: VPC ID.
          type: string
      required:
        - id
        - vpc_id
        - name
      type: object
    CloudBoxTopologySubnet:
      additionalProperties: false
      properties:
        az:
          description: Availability Zone.
          type: string
        cidr:
          description: CIDR block.
          type: string
        id:
          description: Subnet ID.
          type: string
        name:
          description: Name tag, else the ID.
          type: string
        public:
          description: Whether its route table routes to an internet gateway.
          type: boolean
        vpc_id:
          description: VPC ID.
          type: string
      required:
        - id
        - vpc_id
        - az
        - cidr
        - public
        - name
      type: object
    CloudBoxTopologyVPC:
      additionalProperties: false
      properties:
        cidr:
          description: Primary CIDR block.
          type: string
        id:
          description: VPC ID.
          type: string
        internet_gateway_id:
          description: Attached internet gateway, or null.
          type:
            - string
            - 'null'
        name:
          description: Name tag, else the ID.
          type: string
        region:
          description: Region name.
          type: string
      required:
        - id
        - region
        - cidr
        - name
        - internet_gateway_id
      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'
    CloudBoxTopologyHub:
      additionalProperties: false
      properties:
        cloudbox:
          description: cloudbox's host:port.
          type: string
        overlay_ip:
          description: The hub's overlay address.
          type: string
      required:
        - overlay_ip
        - cloudbox
      type: object
    CloudBoxTopologyMember:
      additionalProperties: false
      properties:
        key:
          description: >-
            The hub's key for the VM, which identifies it in upserts and
            removes.
          type: string
        kind:
          description: Kind of node, for example ec2, ecs, eks, rds or lambda.
          type: string
        note:
          description: Shown as is, for example starts on invoke.
          type: string
        overlay_ip:
          description: Overlay address, or empty before the VM first joins.
          type: string
        resource_id:
          description: >-
            Resource the VM runs, or null for one that runs no resource the
            topology shows.
          type:
            - string
            - 'null'
        status:
          description: VM state, for example running, connecting, pending or idle.
          type: string
      required:
        - resource_id
        - key
        - kind
        - overlay_ip
        - status
        - note
      type: object
    CloudBoxTopologyDetail:
      additionalProperties: false
      properties:
        label:
          description: Component, for example listener or postgres 16.4.
          type: string
        value:
          description: Its value, for example :443 → orders-api.
          type: string
      required:
        - label
        - value
      type: object
    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
    cloudbox_not_running:
      value:
        code: cloudbox_not_running
        detail: >-
          The Cloud Box is starting, stopped or idle. Start a stopped Cloud Box;
          a starting one runs shortly, and an idle one resumes on its next
          request.
        validation: null
    topology_unsupported:
      value:
        code: topology_unsupported
        detail: >-
          The Cloud Box was created before Cloud Boxes had a live topology.
          Create a new Cloud Box to see one.
        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.