Oxide System/networking API
This provides rack-level network configuration.
Oxide System/networking 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/networking. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes 36 operations across 23 paths, and defines 82 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}.
36 operations
23 paths
82 schemas
5 DELETE19 GET7 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 36
Across 23 paths, the API surfaces 36 operations — 5 DELETE, 19 GET, 7 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
system/networking 36
This provides rack-level network configuration.
GET
/v1/system/hardware/rack-switch-port/{rack_id}/{switch_slot}/{port}/lldp/neighbors
Fetch LLDP neighbors for switch port
GET
/v1/system/hardware/switch-port/{port}/lldp/config
Fetch LLDP configuration for switch port
POST
/v1/system/hardware/switch-port/{port}/lldp/config
Update LLDP configuration for switch port
GET
/v1/system/networking/address-lot
List address lots
POST
/v1/system/networking/address-lot
Create address lot
GET
/v1/system/networking/address-lot/{address_lot}
Fetch address lot
DELETE
/v1/system/networking/address-lot/{address_lot}
Delete address lot
GET
/v1/system/networking/address-lot/{address_lot}/blocks
List blocks in address lot
GET
/v1/system/networking/allow-list
Get user-facing services IP allowlist
PUT
/v1/system/networking/allow-list
Update user-facing services IP allowlist
POST
/v1/system/networking/bfd-disable
Disable BFD session
POST
/v1/system/networking/bfd-enable
Enable BFD session
GET
/v1/system/networking/bfd-status
Get BFD status
GET
/v1/system/networking/bgp
List BGP configurations
PUT
/v1/system/networking/bgp
Update the mutable fields of an existing BGP configuration
POST
/v1/system/networking/bgp
Create BGP configuration
DELETE
/v1/system/networking/bgp
Delete BGP configuration
GET
/v1/system/networking/bgp-announce-set
List BGP announce sets
PUT
/v1/system/networking/bgp-announce-set
Update BGP announce set
DELETE
/v1/system/networking/bgp-announce-set/{announce_set}
Delete BGP announce set
GET
/v1/system/networking/bgp-announce-set/{announce_set}/announcement
Get originated routes for a specified BGP announce set
GET
/v1/system/networking/bgp-exported
List BGP exported routes
GET
/v1/system/networking/bgp-imported
Get imported IPv4 BGP routes
GET
/v1/system/networking/bgp-message-history
Get BGP router message history
GET
/v1/system/networking/bgp-status
Get BGP peer status
GET
/v1/system/networking/inbound-icmp
Return whether API services can receive limited ICMP traffic
PUT
/v1/system/networking/inbound-icmp
Set whether API services can receive limited ICMP traffic
GET
/v1/system/networking/loopback-address
List loopback addresses
POST
/v1/system/networking/loopback-address
Create loopback address
DELETE
/v1/system/networking/loopback-address/{rack_id}/{switch_slot}/{address}/{subnet_mask}
Delete loopback address
GET
/v1/system/networking/settings
Fetch fleet-wide networking settings
PUT
/v1/system/networking/settings
Update fleet-wide networking settings
GET
/v1/system/networking/switch-port-settings
List switch port settings
POST
/v1/system/networking/switch-port-settings
Create switch port settings
DELETE
/v1/system/networking/switch-port-settings
Delete switch port settings
GET
/v1/system/networking/switch-port-settings/{port}
Get information about switch port
Schemas 82
The contract defines 82 schemas that model the data the API accepts and returns. The most detailed are BgpPeer (17 properties), SwitchPortSettings (12 properties), LldpNeighbor (9 properties), SwitchPortSettingsCreate (9 properties). Each schema is shown below with its type and property counts.
BgpImported
object
A route imported from a BGP peer.
4 properties
4 required
InterfaceNum
NetworkAddress
LldpNeighborResultsPage
object
A single page of results
2 properties
1 required
AddressLotBlockResultsPage
object
A single page of results
2 properties
1 required
SystemNetworkingSettingsUpdate
object
Parameters for updating the fleet-wide networking settings.
1 property
LoopbackAddress
object
A loopback address is an address that is assigned to a rack switch but is not associated with any particular port.
5 properties
5 required
LoopbackAddressCreate
object
Parameters for creating a loopback address on a particular rack switch.
6 properties
6 required
Error
object
Error information from a response.
3 properties
2 required
BgpConfigUpdate
object
Parameters for updating a BGP configuration If a value is not specified, it will remain unchanged.
4 properties
LinkSpeed
The speed of a link.
Ipv4Net
string
An IPv4 subnet, including prefix and prefix length
SystemNetworkingSettings
object
Fleet-wide networking settings. Only fleet viewers may view these settings. Only fleet admins can modify them.
1 property
1 required
AddressLotCreateResponse
object
An address lot and associated blocks resulting from creating an address lot.
2 properties
2 required
SwitchPortConfig
object
A physical port configuration for a port settings object.
2 properties
2 required
LinkConfigCreate
object
Switch link configuration.
7 properties
5 required
AddressLotResultsPage
object
A single page of results
2 properties
1 required
BgpConfigResultsPage
object
A single page of results
2 properties
1 required
RouterPeerType
ImportExportPolicy
Define policy relating to the import and export of prefixes from a BGP peer.
BgpPeerConfig
object
2 properties
2 required
ManagementAddress
object
3 properties
2 required
LinkFec
The forward error correction mode of a link.
SwitchPortConfigCreate
object
Physical switch port configuration.
1 property
1 required
MaxPathConfig
integer
BgpConfig
object
A base BGP configuration.
8 properties
7 required
SwitchPortRouteConfig
object
A route configuration for a port settings object.
6 properties
4 required
BfdMode
string
BFD connection mode.
SwitchBgpHistory
object
BGP message history for a particular switch.
2 properties
2 required
BgpAnnounceSet
object
Represents a BGP announce set by id. The id can be used with other API calls to view and manage the announce set.
5 properties
5 required
AddressLotCreate
object
Parameters for creating an address lot.
4 properties
4 required
Ipv6Net
string
An IPv6 subnet, including prefix and subnet mask
SwitchInterfaceConfig
object
A switch port interface configuration for a port settings object.
5 properties
5 required
SwitchPortGeometry
The link geometry associated with a switch port.
BgpPeerStatus
object
The current status of a BGP peer.
7 properties
7 required
SwitchPortSettings
object
This structure contains all port settings information in one place. It's a convenience data structure for getting a complete view of a particular port's settin…
12 properties
12 required
Address
object
An address tied to an address lot.
3 properties
2 required
AddressLotKind
The kind associated with an address lot.
SwitchInterfaceConfigCreate
object
A layer-3 switch interface configuration. When IPv6 is enabled, a link local address will be created for the interface.
3 properties
3 required
AggregateBgpMessageHistory
object
BGP message history for rack switches.
1 property
1 required
LldpLinkConfigCreate
object
The LLDP configuration associated with a port.
7 properties
1 required
NameOrIdSortMode
Supported set of sort modes for scanning by name or id
SwitchPortSettingsGroups
object
This structure maps a port settings object to a port settings groups. Port settings objects may inherit settings from groups. This mapping defines the relation…
2 properties
2 required
BfdSessionEnable
object
Information about a bidirectional forwarding detection (BFD) session.
6 properties
5 required
BgpPeerState
The current state of a BGP peer.
Route
object
A route to a destination network through a gateway address.
4 properties
2 required
LoopbackAddressResultsPage
object
A single page of results
2 properties
1 required
SwitchPortSettingsIdentityResultsPage
object
A single page of results
2 properties
1 required
AddressLotBlock
object
An address lot block is a part of an address lot and contains a range of addresses. The range is inclusive.
3 properties
3 required
TxEqConfig
object
Per-port tx-eq overrides. This can be used to fine-tune the transceiver equalization settings to improve signal integrity.
5 properties
ServiceIcmpConfig
object
Configuration of inbound ICMP allowed by API services.
1 property
1 required
BgpPeer
object
A BGP peer configuration for an interface. Includes the set of announcements that will be advertised to the peer. The bgpconfig parameter is a reference to glo…
17 properties
11 required
BgpExported
object
Route exported to a peer.
3 properties
3 required
SwitchPortSettingsIdentity
object
A switch port settings identity whose id may be used to view additional details.
5 properties
5 required
AddressLotViewResponse
object
An address lot and associated blocks resulting from viewing an address lot.
2 properties
2 required
SwitchPortLinkConfig
object
A link configuration for a port settings object.
8 properties
5 required
SwitchSlot
Identifies switch physical location
SwitchPortAddressView
object
An IP address configuration for a port settings object.
7 properties
6 required
AllowList
object
Allowlist of IPs or subnets that can make requests to user-facing services.
3 properties
3 required
BfdSessionDisable
object
Information needed to disable a BFD session
2 properties
2 required
BgpConfigCreate
object
Parameters for creating a BGP configuration. This includes an autonomous system number (ASN) and a virtual routing and forwarding (VRF) identifier.
6 properties
4 required
BfdStatus
object
7 properties
6 required
BgpAnnouncement
object
A BGP announcement tied to an address lot block.
3 properties
3 required
LldpLinkConfig
object
A link layer discovery protocol (LLDP) service configuration.
8 properties
2 required
AllowedSourceIps
Description of source IPs allowed to reach rack services.
RouterLifetimeConfig
integer
Router lifetime in seconds for unnumbered BGP peers
IdSortMode
Supported set of sort modes for scanning by id only. Currently, we only support scanning in ascending order.
SwitchInterfaceKind
Indicates the kind for a switch interface.
BgpAnnounceSetCreate
object
Parameters for creating a named set of BGP announcements.
3 properties
3 required
AddressConfig
object
A set of addresses associated with a port configuration.
2 properties
2 required
BfdState
AddressLot
object
Represents an address lot object, containing the id of the lot that can be used in other API calls.
6 properties
6 required
NameOrId
AddressLotBlockCreate
object
Parameters for creating an address lot block. First and last addresses are inclusive.
2 properties
2 required
AllowListUpdate
object
Parameters for updating allowed source IPs
1 property
1 required
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…
IpNet
LldpNeighbor
object
Information about LLDP advertisements from other network entities directly connected to a switch port. This structure contains both metadata about when and whe…
9 properties
6 required
SwitchPortSettingsCreate
object
Parameters for creating switch port settings. Switch port settings are the central data structure for setting up external networking. Switch port settings incl…
9 properties
5 required
BgpAnnouncementCreate
object
A BGP announcement tied to a particular address lot block.
2 properties
2 required
BgpMessageHistory
RouteConfig
object
Route configuration data associated with a switch port configuration.
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oxide 12
Other APIs Oxide publishes across the network.
Oxide Affinity API
Oxide Console Auth API
Oxide Current User API
Oxide Disks API
Oxide Experimental API
Oxide External Subnets API
Oxide Floating Ips API
Oxide Images API
Oxide Instances API
Oxide Ip Pools API
Oxide Login API
Oxide Metrics API
#system/networking
Where this information came from
This is an independent, third-party profile of Oxide System/networking 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.