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

# List sandboxes

> Returns your Neo-managed cloud sandbox and any self-hosted sandboxes you
have installed. Self-hosted entries include available actions such as
connect and disconnect. Cloud entries may include resource usage while
running.




## OpenAPI

````yaml https://neo.api.projectdiscovery.io/api/openapi.json get /api/v1/sandboxes
openapi: 3.1.0
info:
  contact:
    name: ProjectDiscovery
    url: https://neo.projectdiscovery.io
  description: Neo API Server - Security agent orchestration platform
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  title: Neo API
  version: 1.0.0
servers:
  - description: Production
    url: https://neo.api.projectdiscovery.io
  - description: Development
    url: https://neo.api.dev.projectdiscovery.io
  - description: Local development
    url: http://localhost:8080
security: []
tags:
  - description: Task execution and management
    name: Tasks
  - description: Agent listing and management
    name: Agents
  - description: Public agent directory
    name: Agent Directory
  - description: User file storage management
    name: Files
  - description: User working memory management
    name: Memory
  - description: Scheduled and recurring task management
    name: Schedules
  - description: Knowledge base and semantic search
    name: Knowledge
  - description: Encrypted user credentials and API keys
    name: Secrets
  - description: Neo API key management for programmatic access
    name: API Keys
  - description: User profile and account information
    name: User
  - description: Task and LLM usage tracking
    name: Usage
  - description: Bring Your Own Key provider management
    name: BYOK
  - description: Model discovery and capabilities
    name: Models
  - description: Third-party integrations
    name: Integrations
  - description: Skill knowledge documents for agent prompts
    name: Skills
  - description: Team management and member invitations
    name: Teams
  - description: Prompt library management and discovery
    name: Prompts
  - description: Slack bot integration for workspace installation and OAuth
    name: Slack
  - description: GitHub integration for PR reviews and repository management
    name: GitHub
  - description: Vulnerability issue tracking and management
    name: Issues
  - description: Subscription billing and plans
    name: Billing
  - description: Project management and member assignments
    name: Projects
  - description: SSH key pair generation and management for remote server access
    name: SSH Keys
  - description: Codebase structural analysis and mapping
    name: Codemaps
  - description: AI-generated codebase documentation and security analysis
    name: CodeWiki
  - description: Captured HTTP traffic query and replay
    name: Network Events
  - description: Vulnerability triage for HackerOne, GitHub, and Security Inbox
    name: Triage
  - description: >-
      Application-internal endpoints used by the Neo UI. Not part of the public
      customer API surface.
    name: Internal
paths:
  /api/v1/sandboxes:
    get:
      tags:
        - Sandboxes
      summary: List sandboxes
      description: |
        Returns your Neo-managed cloud sandbox and any self-hosted sandboxes you
        have installed. Self-hosted entries include available actions such as
        connect and disconnect. Cloud entries may include resource usage while
        running.
      operationId: get-v1-sandboxes
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SandboxListResponse'
          description: Sandbox list
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    SandboxListResponse:
      properties:
        sandboxes:
          items:
            $ref: '#/components/schemas/SandboxSummary'
          type: array
      required:
        - sandboxes
      type: object
    ErrorResponse:
      properties:
        code:
          description: >
            Stable machine-readable error code — branch on this rather than

            matching the human `error`/`message` strings. Domain codes include

            `user_spending_cap_reached`, `project_spending_cap_reached`, and

            `insufficient_neo_credits`; otherwise it mirrors the error kind

            (e.g. `forbidden`, `invalid_request`, `not_exists`,
            `already_exists`).
          example: user_spending_cap_reached
          type: string
        error:
          example: Bad request
          type: string
        error_id:
          description: Correlation id for a specific error instance, when present.
          type: string
        kind:
          description: Coarse error category (e.g. "forbidden request", "invalid request").
          example: forbidden request
          type: string
        message:
          description: |
            Human-readable detail (the kind prefixed to the error). For display,
            not for branching.
          type: string
      required:
        - error
      type: object
    SandboxSummary:
      properties:
        actions:
          items:
            enum:
              - pause
              - resume
              - start
              - connect
              - disconnect
            type: string
          type: array
        arch:
          type: string
        created_at:
          format: date-time
          type: string
        display_name:
          type: string
        hostname:
          type: string
        id:
          description: |
            Sandbox id from GET /api/v1/sandboxes. Present for provisioned cloud
            sandboxes and all self-hosted sandboxes.
          format: uuid
          type: string
        last_seen_at:
          format: date-time
          type: string
        name:
          type: string
        os:
          type: string
        purpose:
          type: string
        ready:
          description: >
            Self-hosted only. True when the sandbox is connected and ready to
            run

            commands and accept terminal sessions.
          type: boolean
        resources:
          $ref: '#/components/schemas/SandboxResources'
        sandbox_ids:
          items:
            format: uuid
            type: string
          type: array
        sandbox_mode:
          type: string
        sandbox_version:
          type: string
        status:
          description: >
            Current state, such as running, inactive, disconnected, absent,
            paused,

            failed, or provisioning.
          type: string
        tunnel_url:
          type: string
        type:
          enum:
            - cloud
            - self_hosted
          type: string
        updated_at:
          format: date-time
          type: string
      required:
        - type
        - name
        - status
      type: object
    SandboxResources:
      properties:
        cpu:
          $ref: '#/components/schemas/SandboxResourceUsage'
        memory:
          $ref: '#/components/schemas/SandboxResourceUsage'
      type: object
    SandboxResourceUsage:
      properties:
        limit:
          type: string
        remaining:
          type: string
        used:
          type: string
        used_pct:
          format: double
          type: number
      required:
        - limit
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT authentication token
      scheme: bearer
      type: http
    ApiKeyAuth:
      description: Neo API key (neo_sk_* prefix)
      in: header
      name: X-Api-Key
      type: apiKey

````