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

Vers vm API

The vm API from Vers — 20 operation(s) for vm.

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

Tagged areas include vm. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 21 operations across 20 paths, and defines 25 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against the base URL https://api.vers.sh.

21 operations 20 paths 25 schemas 1 DELETE5 GET3 PATCH11 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.vers.sh
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Vers vm API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Token) (bearer_auth).

Paths & Operations 21

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

vm 21
POST
/api/v1/vm/branch/by_commit/{commit_id}
branch_by_commit 2 params → 201400401403404500
POST
/api/v1/vm/branch/by_ref/{repo_name}/{tag_name}
branch_by_ref 3 params → 201400401403404500
POST
/api/v1/vm/branch/by_tag/{tag_name}
branch_by_tag 2 params → 201400401403404500
POST
/api/v1/vm/branch/by_vm/{vm_id}
branch_by_vm 4 params → 201400401403404500
POST
/api/v1/vm/from_commit
restore_from_commit body → 201400401403404500
POST
/api/v1/vm/new_root
create_new_root_vm 1 param body → 201400401403500
DELETE
/api/v1/vm/{vm_id}
delete_vm 2 params → 200400401403404500
POST
/api/v1/vm/{vm_id}/commit
commit_vm 3 params body → 201400401403404500
PATCH
/api/v1/vm/{vm_id}/disk
resize_vm_disk 2 params body → 200400401403404500
POST
/api/v1/vm/{vm_id}/exec
exec_vm 1 param body → 200401403404500
POST
/api/v1/vm/{vm_id}/exec/stream
exec_vm_stream 1 param body → 200401403404500
POST
/api/v1/vm/{vm_id}/exec/stream/attach
exec_vm_stream_attach 1 param body → 200401403404500
GET
/api/v1/vm/{vm_id}/files
read_file_vm 2 params → 200401403404500
PUT
/api/v1/vm/{vm_id}/files
write_file_vm 1 param body → 200401403404500
PATCH
/api/v1/vm/{vm_id}/label
label_vm body → 200400401403500
GET
/api/v1/vm/{vm_id}/logs
vm_logs 4 params → 200401403404500
GET
/api/v1/vm/{vm_id}/metadata
get_vm_metadata 1 param → 200401403404500
GET
/api/v1/vm/{vm_id}/ssh_key
ssh_key 1 param → 200401403404500
PATCH
/api/v1/vm/{vm_id}/state
update_vm_state 2 params body → 200400401403404500
GET
/api/v1/vm/{vm_id}/status
vm_status 1 param → 200401403404500
POST
/api/v1/vm/{vm_or_commit_id}/branch
branch_vm 4 params → 201400401403404500

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are VmMetadataResponse (8 properties), VmExecRequest (6 properties), VmCreateVmConfig (6 properties), VM (5 properties). Each schema is shown below with its type and property counts.

VmCommitRequest
object
The request body for POST /api/vm/{vmid}/commit
3 properties
VmUpdateStateRequest
object
Request body for PATCH /api/vm/{vmid}/state
1 property 1 required
VmExecLogStream
string
Streams available for exec logging.
VmExecLogResponse
object
Response for exec log tail requests.
3 properties 3 required
VmExecLogEntry
object
Individual log entry describing emitted stdout/stderr chunk.
4 properties 3 required
VM
object
5 properties 4 required
VmCommitResponse
object
The response body for POST /api/vm/{vmid}/commit
1 property 1 required
VmExecStreamAttachRequest
object
Request body for POST /api/vm/{vmid}/exec/stream/attach
3 properties 1 required
VmUpdateStateEnum
string
Possible options for the state requested in PATCH /api/vm/{vmid}/state
NewVmsResponse
object
1 property 1 required
VmWriteFileRequest
object
Request body for PUT /api/vm/{vmid}/files
4 properties 2 required
VmMetadataResponse
object
Response for GET /api/v1/vm/{vmid}/metadata
8 properties 5 required
VmExecRequest
object
Request body for POST /api/vm/{vmid}/exec
6 properties 1 required
VmSshKeyResponse
object
Response body for GET /api/vm/{vmid}/sshkey
2 properties 2 required
VmResizeDiskRequest
object
Request body for PATCH /api/vm/{vmid}/disk
1 property 1 required
ErrorResponse
object
2 properties
VmCreateVmConfig
object
Struct representing configuration options common to all VMs
6 properties
NewRootRequest
object
1 property 1 required
FromCommitVmRequest
Request body for POST /api/v1/vm/fromcommit
LabelVmRequest
object
1 property
VmReadFileResponse
object
Response body for GET /api/vm/{vmid}/files
1 property 1 required
NewVmResponse
object
Response body for new VM requests (newroot, fromcommit, branch)
1 property 1 required
VmExecResponse
object
Response body for POST /api/vm/{vmid}/exec
4 properties 3 required
VmState
string
The state of a VM
VmDeleteResponse
object
Response body for DELETE /api/vm/{vmid}
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vers-vm-api-openapi.yml Raw ↑

Other APIs Vers publishes across the network.

Vers commit_tags API
Vers commits API
Vers deploy API
Vers domains API
Vers env_vars API
Vers images API
Vers keys API
Vers public_repositories API
Vers repositories API
Vers System API
Vers vms API
Where this information came from

This is an independent, third-party profile of Vers 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.