Oxide Vpcs API is one of 30 APIs that Oxide publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include VPC. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes
33 operations
across 16 paths,
and defines 56 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.
VpcFirewallRuleStatus
string
InternetGatewayIpAddressCreate
object
Create-time identity-related parameters
3 properties
3 required
VpcSubnet
object
A VPC subnet represents a logical grouping for instances that allows network traffic between them, within an IPv4 subnetwork or optionally an IPv6 subnetwork.
9 properties
8 required
InstanceNetworkInterfaceResultsPage
object
A single page of results
2 properties
1 required
VpcResultsPage
object
A single page of results
2 properties
1 required
VpcFirewallRuleUpdateParams
object
Updated list of firewall rules. Will replace all existing rules.
1 property
VpcFirewallRuleFilter
object
Filters reduce the scope of a firewall rule. Without filters, the rule applies to all packets to the targets (or from the targets, if it's an outbound rule). W…
3 properties
InternetGatewayIpPoolResultsPage
object
A single page of results
2 properties
1 required
L4PortRange
string
An inclusive-inclusive range of IP ports. The second port may be omitted to represent a single port.
NameOrIdSortMode
Supported set of sort modes for scanning by name or id
InternetGatewayCreate
object
Create-time parameters for an InternetGateway
2 properties
2 required
VpcSubnetUpdate
object
Updateable properties of a VpcSubnet
3 properties
MacAddr
string
A Media Access Control address, in EUI-48 format
IcmpParamRange
string
An inclusive-inclusive range of ICMP(v6) types or codes. The second value may be omitted to represent a single parameter.
InternetGatewayIpPoolCreate
object
Create-time identity-related parameters
3 properties
3 required
VpcFirewallRuleHostFilter
The VpcFirewallRuleHostFilter is used to filter traffic on the basis of its source or destination host.
Error
object
Error information from a response.
3 properties
2 required
VpcFirewallRuleTarget
A VpcFirewallRuleTarget is used to specify the set of instances to which a firewall rule applies. You can target instances directly by name, or specify a VPC,…
InternetGateway
object
An internet gateway provides a path between VPC networks and external networks.
6 properties
6 required
InternetGatewayIpAddressResultsPage
object
A single page of results
2 properties
1 required
InternetGatewayIpAddress
object
An IP address that is attached to an internet gateway
7 properties
7 required
VpcSubnetResultsPage
object
A single page of results
2 properties
1 required
VpcRouterCreate
object
Create-time parameters for a VpcRouter
2 properties
2 required
RouteDestination
A RouteDestination is used to match traffic with a routing rule based on the destination of that traffic. When traffic is to be sent to a destination that is w…
VpcUpdate
object
Updateable properties of a Vpc
3 properties
RouterRouteResultsPage
object
A single page of results
2 properties
1 required
VpcFirewallIcmpFilter
object
2 properties
1 required
RouteTarget
A RouteTarget describes the possible locations that traffic matching a route destination can be sent.
RouterRoute
object
A route defines a rule that governs where traffic should be sent based on its destination.
9 properties
9 required
RouterRouteUpdate
object
Updateable properties of a RouterRoute
4 properties
2 required
RouterRouteKind
The kind of a RouterRoute The kind determines certain attributes such as if the route is modifiable and describes how or where the route was created.
RouterRouteCreate
object
Create-time parameters for a RouterRoute
4 properties
4 required
VpcRouter
object
A VPC router defines a series of rules that indicate where traffic should be sent depending on its destination.
7 properties
7 required
Ipv6Net
string
An IPv6 subnet, including prefix and subnet mask
InternetGatewayIpPool
object
An IP pool that is attached to an internet gateway
7 properties
7 required
VpcFirewallRuleUpdate
object
A single rule in a VPC firewall
8 properties
8 required
VpcFirewallRuleProtocol
The protocols that may be specified in a firewall rule's filter
Ipv4Net
string
An IPv4 subnet, including prefix and prefix length
PrivateIpStack
The VPC-private IP stack for a network interface.
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…
InstanceNetworkInterface
object
An InstanceNetworkInterface represents a virtual network interface device attached to an instance.
11 properties
11 required
PrivateIpv6Stack
object
The VPC-private IPv6 stack for a network interface
2 properties
2 required
VpcFirewallRule
object
A single rule in a VPC firewall
12 properties
12 required
InternetGatewayResultsPage
object
A single page of results
2 properties
1 required
VpcFirewallRuleAction
string
VpcRouterUpdate
object
Updateable properties of a VpcRouter
2 properties
VpcFirewallRuleDirection
string
VpcSubnetCreate
object
Create-time parameters for a VpcSubnet
5 properties
3 required
VpcRouterResultsPage
object
A single page of results
2 properties
1 required
VpcFirewallRules
object
Collection of a Vpc's firewall rules
1 property
1 required
Vpc
object
View of a VPC
9 properties
9 required
VpcCreate
object
Create-time parameters for a Vpc
4 properties
3 required
PrivateIpv4Stack
object
The VPC-private IPv4 stack for a network interface
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oxide publishes across the network.
