Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Replicated vms API

The vms API from Replicated — 8 operation(s) for vms.

Replicated vms API is one of 22 APIs that Replicated publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include vms. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and an API reference.

This API exposes 9 operations across 8 paths, and defines 17 schemas. It is described by OpenAPI 2.0, at version 3.0.0.

Requests are made against the base URL https://api.replicated.com/vendor/v3.

9 operations 8 paths 17 schemas 1 DELETE4 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
3.0.0
Base URL
https://api.replicated.com/vendor/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Replicated vms API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 9

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

vms 9
POST
/vm
Create a test vm.
createVM 2 params → 200201400401403404
GET
/vm/versions
List vm versions.
listVMVersions → 200400401403404
GET
/vm/{vm_id}
Get the details for a test vm.
getVM 1 param → 200400401403404
DELETE
/vm/{vm_id}
Delete a test vm.
deleteVM 1 param → 200400401403404
POST
/vm/{vm_id}/port
Exposes a port on a vm.
createVMPort 2 params → 201401403404
GET
/vm/{vm_id}/ports
Lists ports for a vm.
listVMPorts 1 param → 200400401403404
PUT
/vm/{vm_id}/tags
Update the tags for a vm.
updateVMTags 2 params → 201401403404
PUT
/vm/{vm_id}/ttl
Update ttl for a VM.
updateVMTTL 2 params → 200400401403404
GET
/vms
List test vms.
listVMs → 200400401403404

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are VM (26 properties), CreateVMParametersBody (17 properties), VMPort (10 properties), VMAddon (10 properties). Each schema is shown below with its type and property counts.

VMAddonStatus
string
InstanceTypeSpec
object
2 properties
VMValidationError
object
2 properties
VMSupportedDistributionAndVersions
object
6 properties
VMPort
object
10 properties
VMExposedPort
object
2 properties
PortProtocol
string
VM
object
26 properties
Actor
object
5 properties
VMAddon
object
10 properties
VMDistributionStatus
object
4 properties
CreateVMParametersBody
object
17 properties
Tag
object
2 properties
VMAddonPort
object
6 properties
VMSupportedVersion
object
1 property
VMStatus
string
CreateVMError
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

replicated-vms-api-openapi.yml Raw ↑

Other APIs Replicated publishes across the network.

Replicated apps API
Replicated channelReleases API
Replicated channels API
Replicated clusterAddons API
Replicated clusters API
Replicated cmx API
Replicated customers API
Replicated customHostnames API
Replicated enterprisePortal API
Replicated externalRegistries API
Replicated instances API
Replicated networks API