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
Oxide

Oxide Instances API

Virtual machine instances are the basic unit of computation. These operations are used for provisioning, controlling, and destroying instances.

Documentation Provider Profile APIs.io OpenAPI GitHub

Oxide Instances API is one of 30 APIs that Oxide publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 24 operations across 17 paths, and defines 57 schemas. It is described by OpenAPI 3.2.0, at version 2026081901.0.0.

Requests are made against the base URL https://{oxide-control-plane-host}.

24 operations 17 paths 57 schemas 3 DELETE11 GET8 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026081901.0.0
Base URL
https://{oxide-control-plane-host}
Contact
https://oxide.computer
Resource Areas
1

Paths & Operations 24

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

instances 24

Virtual machine instances are the basic unit of computation. These operations are used for provisioning, controlling, and destroying instances.

GET
/v1/instances
List instances
instance_list 4 params → 2004XX5XX
POST
/v1/instances
Create instance
instance_create 1 param body → 2014XX5XX
GET
/v1/instances/{instance}
Fetch instance
instance_view 2 params → 2004XX5XX
PUT
/v1/instances/{instance}
Update instance
instance_update 2 params body → 2004XX5XX
DELETE
/v1/instances/{instance}
Delete instance
instance_delete 2 params → 2044XX5XX
GET
/v1/instances/{instance}/anti-affinity-groups
List anti-affinity groups containing instance
instance_anti_affinity_group_list 5 params → 2004XX5XX
GET
/v1/instances/{instance}/disks
List disks for instance
instance_disk_list 5 params → 2004XX5XX
POST
/v1/instances/{instance}/disks/attach
Attach disk to instance
instance_disk_attach 2 params body → 2024XX5XX
POST
/v1/instances/{instance}/disks/detach
Detach disk from instance
instance_disk_detach 2 params body → 2024XX5XX
GET
/v1/instances/{instance}/external-ips
List external IP addresses
instance_external_ip_list 2 params → 2004XX5XX
POST
/v1/instances/{instance}/external-ips/ephemeral
Allocate and attach ephemeral IP to instance
instance_ephemeral_ip_attach 2 params body → 2024XX5XX
DELETE
/v1/instances/{instance}/external-ips/ephemeral
Detach and deallocate ephemeral IP from instance
instance_ephemeral_ip_detach 3 params → 2044XX5XX
GET
/v1/instances/{instance}/external-subnets
List external subnets attached to instance
instance_external_subnet_list 2 params → 2004XX5XX
POST
/v1/instances/{instance}/reboot
Reboot instance
instance_reboot 2 params → 2024XX5XX
GET
/v1/instances/{instance}/serial-console
Fetch instance serial console
instance_serial_console 5 params → 2004XX5XX
GET
/v1/instances/{instance}/serial-console/stream
Stream instance serial console
instance_serial_console_stream 3 params → 1014XX5XX
GET
/v1/instances/{instance}/ssh-public-keys
List SSH public keys for instance
instance_ssh_public_key_list 5 params → 2004XX5XX
POST
/v1/instances/{instance}/start
Boot instance
instance_start 2 params → 2024XX5XX
POST
/v1/instances/{instance}/stop
Stop instance
instance_stop 2 params → 2024XX5XX
GET
/v1/network-interfaces
List network interfaces
instance_network_interface_list 5 params → 2004XX5XX
POST
/v1/network-interfaces
Create network interface
instance_network_interface_create 2 params body → 2014XX5XX
GET
/v1/network-interfaces/{interface}
Fetch network interface
instance_network_interface_view 3 params → 2004XX5XX
PUT
/v1/network-interfaces/{interface}
Update network interface
instance_network_interface_update 3 params body → 2004XX5XX
DELETE
/v1/network-interfaces/{interface}
Delete network interface
instance_network_interface_delete 3 params → 2044XX5XX

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are Instance (18 properties), InstanceCreate (17 properties), Disk (14 properties), InstanceNetworkInterface (11 properties). Each schema is shown below with its type and property counts.

Ipv4Assignment
How a VPC-private IP address is assigned to a network interface.
DiskPath
object
1 property 1 required
InstanceNetworkInterfaceResultsPage
object
A single page of results
2 properties 1 required
ExternalIpCreate
Parameters for creating an external IP address for instances.
AntiAffinityGroup
object
View of an Anti-Affinity Group
8 properties 8 required
FailureDomain
Describes the scope of affinity for the purposes of co-location.
DiskResultsPage
object
A single page of results
2 properties 1 required
PoolSelector
Specify which IP or external subnet pool to allocate from.
PrivateIpStackCreate
Create parameters for a network interface's IP stack.
DiskType
string
NameOrIdSortMode
Supported set of sort modes for scanning by name or id
DiskState
State of a Disk
MulticastGroupIdentifier
string
Can be a UUID, a name, or an IP address
SshKey
object
View of an SSH Key
7 properties 7 required
InstanceAutoRestartPolicy
A policy determining when an instance should be automatically restarted by the control plane.
InstanceNetworkInterfaceCreate
object
Create-time parameters for an InstanceNetworkInterface
5 properties 4 required
MacAddr
string
A Media Access Control address, in EUI-48 format
ByteCount
integer
Byte count to express memory or storage capacity.
PrivateIpv6StackCreate
object
Configuration for a network interface's IPv6 addressing.
2 properties 1 required
Error
object
Error information from a response.
3 properties 2 required
PrivateIpv4StackCreate
object
Configuration for a network interface's IPv4 addressing.
2 properties 1 required
AffinityPolicy
Affinity policy used to describe "what to do when a request cannot be satisfied" Used for both Affinity and Anti-Affinity Groups
EphemeralIpCreate
object
Parameters for creating an ephemeral IP address for an instance.
1 property
InstanceSerialConsoleData
object
Contents of an Instance's serial console buffer.
2 properties 2 required
ExternalSubnetResultsPage
object
A single page of results
2 properties 1 required
Disk
object
View of a Disk
14 properties 12 required
InstanceState
Running state of an Instance (primarily: booted or stopped) This typically reflects whether it's starting, running, stopping, or stopped, but also includes sta…
NameOrId
Ipv6Assignment
How a VPC-private IP address is assigned to a network interface.
SshKeyResultsPage
object
A single page of results
2 properties 1 required
ExternalSubnet
object
An external subnet allocated from a subnet pool
10 properties 9 required
InstanceCpuCount
integer
The number of CPUs in an Instance
IpVersion
string
The IP address version.
MulticastGroupJoinSpec
object
Specification for joining a multicast group with optional source filtering. Used in InstanceCreate and InstanceUpdate to specify multicast group membership alo…
3 properties 1 required
Hostname
string
A hostname identifies a host on a network, and is usually a dot-delimited sequence of labels, where each label contains only letters, digits, or the hyphen. Se…
Ipv6Net
string
An IPv6 subnet, including prefix and subnet mask
PrivateIpStack
The VPC-private IP stack for a network interface.
Ipv4Net
string
An IPv4 subnet, including prefix and prefix length
Name
string
Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Nam…
InstanceNetworkInterfaceAttachment
Describes an attachment of an InstanceNetworkInterface to an Instance, at the time the instance is created.
InstanceNetworkInterface
object
An InstanceNetworkInterface represents a virtual network interface device attached to an instance.
11 properties 11 required
IpNet
PrivateIpv6Stack
object
The VPC-private IPv6 stack for a network interface
2 properties 2 required
BlockSize
integer
Valid values are: 512, 2048, or 4096.
ExternalIpResultsPage
object
A single page of results
2 properties 1 required
Instance
object
View of an Instance
18 properties 13 required
InstanceCpuPlatform
A required CPU platform for an instance. When an instance specifies a required CPU platform: - The system may expose (to the VM) new CPU features that are only…
InstanceDiskAttachment
Describe the instance's disks at creation time
ExternalIp
InstanceNetworkInterfaceUpdate
object
Parameters for updating an InstanceNetworkInterface Note that modifying IP addresses for an interface is not yet supported, a new interface must be created ins…
4 properties
AntiAffinityGroupResultsPage
object
A single page of results
2 properties 1 required
InstanceResultsPage
object
A single page of results
2 properties 1 required
DiskSource
Different sources for a Distributed Disk
DiskBackend
The source of a Disk's blocks
InstanceCreate
object
Create-time parameters for an Instance
17 properties 5 required
PrivateIpv4Stack
object
The VPC-private IPv4 stack for a network interface
2 properties 2 required
InstanceUpdate
object
Parameters of an Instance that can be reconfigured after creation.
7 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oxide-computer-instances-api-openapi.yml Raw ↑

Other APIs Oxide publishes across the network.

Oxide Affinity API
AE Profile APIs.io
Oxide Console Auth API
AE Profile APIs.io
Oxide Current User API
AE Profile APIs.io
Oxide Disks API
AE Profile APIs.io
Oxide Experimental API
AE Profile APIs.io
Oxide External Subnets API
AE Profile APIs.io
Oxide Floating Ips API
AE Profile APIs.io
Oxide Images API
AE Profile APIs.io
Oxide Ip Pools API
AE Profile APIs.io
Oxide Login API
AE Profile APIs.io
Oxide Metrics API
AE Profile APIs.io
Oxide Policy API
AE Profile APIs.io
#Instances
← Back to O APIs
API Details
ID
oxide-computer:oxide-computer-instances-api
Base URL
https://{oxide-control-plane-host}
Docs
https://docs.oxide.computer/api
Provider
Oxide
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=oxide-computer-instances-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/oxide-computer-instances-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 Oxide Instances 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.