How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
CodeSandbox

CodeSandbox vm API

Virtual machine lifecycle management

Documentation Provider Profile APIs.io OpenAPI GitHub

CodeSandbox vm API is one of 10 APIs that CodeSandbox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include vm. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and 4 JSON Schemas.

This API exposes 11 operations across 11 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 2023-07-01.

Requests are made against a single base URL, https://api.codesandbox.io.

11 operations 11 paths 21 schemas 1 DELETE2 GET5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-07-01
Base URL
https://api.codesandbox.io
Authentication
HTTP Bearer
Contact
https://codesandbox.io/docs/sdk
Resource Areas
1

Authentication & Security 1

CodeSandbox vm API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (authorization).

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 1 DELETE, 2 GET, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

vm 11

Virtual machine lifecycle management

PUT
/vm/alias/{namespace}/{alias}
Assign a tag alias to a VM tag
vm/assign_tag_alias 2 params body → 200
GET
/vm/clusters
List all available clusters
vm/list_clusters → 200
GET
/vm/running
List information about currently running VMs
vm/list_running_vms → 200
POST
/vm/tag
Create a new tag for a VM
vm/create_tag body → 200
DELETE
/vm/{id}
Delete a VM
vm/delete 1 param → 200
POST
/vm/{id}/hibernate
Hibernate a VM
vm/hibernate 1 param body → 200
PUT
/vm/{id}/hibernation_timeout
Update VM Hibernation Timeout
vm/update_hibernation_timeout 1 param body → 200
POST
/vm/{id}/sessions
Create a new session on a VM
vm/create_session 1 param body → 200
POST
/vm/{id}/shutdown
Shutdown a VM
vm/shutdown 1 param body → 200
PUT
/vm/{id}/specs
Update VM Specs
vm/update_specs 1 param body → 200
POST
/vm/{id}/start
Start a VM
vm/start 1 param body → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are VMCreateSessionRequest (5 properties), VMStartRequest (4 properties), Response (2 properties), VMUpdateSpecsRequest (1 property). Each schema is shown below with its type and property counts.

VMCreateTagResponse
object
VMUpdateSpecsResponse
object
VMStartRequest
object
4 properties
VMCreateTagRequest
object
Create a tag for a list of VM IDs
1 property 1 required
VMUpdateHibernationTimeoutResponse
object
VMShutdownRequest
object
VMHibernateRequest
object
VMAssignTagAliasRequest
object
Assign a tag alias to a VM
1 property 1 required
VMStartResponse
object
VMAssignTagAliasResponse
object
VMCreateSessionResponse
object
VMHibernateResponse
object
VMListClustersResponse
object
VMShutdownResponse
object
Response
object
2 properties
VMDeleteResponse
object
VMUpdateSpecsRequest
object
1 property 1 required
Error
VMUpdateHibernationTimeoutRequest
object
1 property 1 required
VMListRunningVMsResponse
object
VMCreateSessionRequest
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

codesandbox-vm-api-openapi.yml Raw ↑

Other APIs CodeSandbox publishes across the network.

CodeSandbox Define API
AE Profile APIs.io
Sandpack Embed Toolkit
AE Profile APIs.io
CodeSandbox meta API
AE Profile APIs.io
CodeSandbox preview_host API
AE Profile APIs.io
CodeSandbox preview_token API
AE Profile APIs.io
CodeSandbox sandbox API
AE Profile APIs.io
CodeSandbox templates API
AE Profile APIs.io
CodeSandbox token API
AE Profile APIs.io
CodeSandbox workspace API
AE Profile APIs.io
#vm
← Back to C APIs
API Details
ID
codesandbox:codesandbox-vm-api
Base URL
https://api.codesandbox.io
Docs
https://codesandbox.io/docs/sdk
Provider
CodeSandbox
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=codesandbox-vm-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/codesandbox-vm-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of CodeSandbox vm API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.