These operations pertain to hardware inventory and management. Racks are the unit of expansion of an Oxide deployment. Racks are in turn composed of sleds, switches, power supplies, and a cabled backplane.
Oxide System/hardware API is one of 30 APIs that Oxide publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include system/hardware. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes
20 operations
across 19 paths,
and defines 39 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}.
20 operations19 paths39 schemas2 DELETE15 GET1 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Across 19 paths, the API surfaces 20 operations — 2 DELETE, 15 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
system/hardware 20
These operations pertain to hardware inventory and management. Racks are the unit of expansion of an Oxide deployment. Racks are in turn composed of sleds, switches, power supplie…
PUT
/v1/system/hardware/disk-adoption-request
Enable adoption of a physical disk for general use
The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are SledInstance (11 properties), Sled (10 properties), PhysicalDisk (10 properties), SwitchPort (5 properties). Each schema is shown below with its type and property counts.
PhysicalDiskKind
string
Describes the form factor of physical disks.
IdSortMode
Supported set of sort modes for scanning by id only. Currently, we only support scanning in ascending order.
PhysicalDiskState
The current state of the disk, as determined by Nexus.
SledInstance
object
An operator's view of an instance running on a given sled
11 properties10 required
SledResultsPage
object
A single page of results
2 properties1 required
PhysicalDiskManufacturerIdentity
object
The unique identity of a physical disk provided by the manufacturer
3 properties3 required
SledUuid
string
PhysicalDiskPolicy
The operator-defined policy of a physical disk.
PhysicalDiskResultsPage
object
A single page of results
2 properties1 required
SwitchPortApplySettings
object
Parameters for applying settings to switch ports.
1 property1 required
SledProvisionPolicyResponse
object
Response to sledsetprovisionpolicy.
2 properties2 required
ByteCount
integer
Byte count to express memory or storage capacity.
UninitializedSledResultsPage
object
A single page of results
2 properties1 required
SledProvisionPolicyParams
object
Parameters for sledsetprovisionpolicy.
1 property1 required
PhysicalDiskAdoptionRequestResultsPage
object
A single page of results
2 properties1 required
Switch
object
An operator's view of a Switch.
5 properties5 required
Sled
object
An operator's view of a Sled.
10 properties9 required
PhysicalDiskAdoptionRequest
object
A request to adopt a physical disk into the control plane
3 properties3 required
Error
object
Error information from a response.
3 properties2 required
Rack
object
View of a Rack
3 properties3 required
SledInstanceResultsPage
object
A single page of results
2 properties1 required
SledProvisionPolicy
The operator-defined provision policy of a sled. This controls whether new resources are going to be provisioned on this sled.
RackResultsPage
object
A single page of results
2 properties1 required
SwitchPortResultsPage
object
A single page of results
2 properties1 required
PhysicalDiskAdoptionRequestUuid
string
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
SwitchLinkState
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…
SledPolicy
The operator-defined policy of a sled.
SwitchPort
object
A switch port represents a physical external port on a rack switch.
5 properties4 required
UnadoptedPhysicalDiskResultsPage
object
A single page of results
2 properties1 required
SwitchResultsPage
object
A single page of results
2 properties1 required
Baseboard
object
Properties that uniquely identify an Oxide hardware component
3 properties3 required
SwitchSlot
Identifies switch physical location
SledState
The current state of the sled.
PhysicalDisk
object
View of a Physical Disk Physical disks reside in a particular sled and are used to store both Instance Disk data as well as internal metadata.
10 properties9 required
UninitializedSled
object
A sled that has not been added to an initialized rack yet
3 properties3 required
UnadoptedPhysicalDisk
object
A physical disk that has not yet been adopted by the control plane
4 properties4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 System/hardware 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.
