Oxide Experimental API is one of 30 APIs that Oxide publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Experimental. 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 16 paths,
and defines 53 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}.
The identity and technical contract details declared by the specification.
AffinityGroup
object
View of an Affinity Group
8 properties
8 required
ProbeInfo
object
5 properties
5 required
BaseboardId
object
A representation of a Baseboard ID as used in the inventory subsystem. This type is essentially the same as a Baseboard except it doesn't have a revision or HW…
2 properties
2 required
NetworkInterfaceKind
The type of network interface
Values
object
A single list of values, for one dimension of a timeseries.
2 properties
2 required
FailureDomain
Describes the scope of affinity for the purposes of co-location.
NetworkInterface
object
Information required to construct a virtual network interface
8 properties
8 required
ProbeCreate
object
Create time parameters for probes.
4 properties
3 required
MulticastGroupMember
object
View of a Multicast Group Member (instance belonging to a multicast group)
10 properties
10 required
PoolSelector
Specify which IP or external subnet pool to allocate from.
RackMembershipVersion
integer
A unique, monotonically increasing number representing the set of active sleds in a rack at a given point in time.
NameOrIdSortMode
Supported set of sort modes for scanning by name or id
MulticastGroupMemberResultsPage
object
A single page of results
2 properties
1 required
PrivateIpv6Config
object
VPC-private IPv6 configuration for a network interface.
3 properties
3 required
RackMembershipStatus
object
Status of the rack membership uniquely identified by the (rackid, version) pair
8 properties
6 required
AffinityGroupResultsPage
object
A single page of results
2 properties
1 required
OxqlTable
object
A table represents one or more timeseries with the same schema. A table is the result of an OxQL query. It contains a name, usually the name of the timeseries…
2 properties
2 required
MacAddr
string
A Media Access Control address, in EUI-48 format
IdSortMode
Supported set of sort modes for scanning by id only. Currently, we only support scanning in ascending order.
PrivateIpConfig
VPC-private IP address configuration for a network interface.
MulticastGroupIdentifier
string
Can be a UUID, a name, or an IP address
Timeseries
object
A timeseries contains a timestamped set of values from one source. This includes the typed key-value pairs that uniquely identify it, and the set of timestamps…
2 properties
2 required
MulticastGroupResultsPage
object
A single page of results
2 properties
1 required
MulticastGroup
object
View of a Multicast Group
10 properties
10 required
PrivateIpv4Config
object
VPC-private IPv4 configuration for a network interface.
3 properties
2 required
TimeseriesQuery
object
A timeseries query string, written in the Oximeter query language.
1 property
1 required
RackMembershipAddSledsRequest
object
1 property
1 required
Points
object
Timepoints and values for one timeseries.
3 properties
2 required
ProbeInfoResultsPage
object
A single page of results
2 properties
1 required
Distributionint64
object
A distribution is a sequence of bins and counts in those bins, and some statistical information tracked to compute the mean, standard deviation, and quantile e…
9 properties
4 required
Error
object
Error information from a response.
3 properties
2 required
AffinityGroupMemberResultsPage
object
A single page of results
2 properties
1 required
ProbeExternalIp
object
4 properties
4 required
AffinityPolicy
Affinity policy used to describe "what to do when a request cannot be satisfied" Used for both Affinity and Anti-Affinity Groups
FieldValue
The FieldValue contains the value of a target or metric field.
AffinityGroupUpdate
object
Updateable properties of an AffinityGroup
2 properties
AffinityGroupMember
A member of an Affinity Group Membership in a group is not exclusive - members may belong to multiple affinity / anti-affinity groups. Affinity Groups can cont…
MetricType
The type of the metric itself, indicating what its values represent.
ValueArray
List of data values for one timeseries. Each element is an option, where None represents a missing sample.
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…
ProbeExternalIpKind
string
OxqlQueryResult
object
The result of a successful OxQL query.
1 property
1 required
Distributiondouble
object
A distribution is a sequence of bins and counts in those bins, and some statistical information tracked to compute the mean, standard deviation, and quantile e…
9 properties
4 required
IpVersion
string
The IP address version.
Ipv6Net
string
An IPv6 subnet, including prefix and subnet mask
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…
RackMembershipChangeState
string
AffinityGroupCreate
object
Create-time parameters for an AffinityGroup
4 properties
4 required
Vni
integer
A Geneve Virtual Network Identifier
Probe
object
A networking probe
6 properties
6 required
InstanceMulticastGroupJoin
object
Parameters for joining an instance to a multicast group. When joining by IP address, the pool containing the multicast IP is auto-discovered from all linked mu…
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oxide publishes across the network.
