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

Oxide System/ip Pools API

IP pools are collections of external IPs. Linking a pool to a silo makes it available for allocation by users in that silo.

Oxide System/ip Pools 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/ip-pools. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 14 operations across 9 paths, and defines 23 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}.

14 operations 9 paths 23 schemas 2 DELETE5 GET5 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}
Resource Areas
1

Paths & Operations 14

Across 9 paths, the API surfaces 14 operations — 2 DELETE, 5 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

system/ip-pools 14

IP pools are collections of external IPs. Linking a pool to a silo makes it available for allocation by users in that silo.

GET
/v1/system/ip-pools
List IP pools
system_ip_pool_list 6 params → 2004XX5XX
POST
/v1/system/ip-pools
Create IP pool
system_ip_pool_create body → 2014XX5XX
GET
/v1/system/ip-pools/{pool}
Fetch IP pool
system_ip_pool_view 1 param → 2004XX5XX
PUT
/v1/system/ip-pools/{pool}
Update IP pool
system_ip_pool_update 1 param body → 2004XX5XX
DELETE
/v1/system/ip-pools/{pool}
Delete IP pool
system_ip_pool_delete 1 param → 2044XX5XX
POST
/v1/system/ip-pools/{pool}/assignment
Assign IP pool
system_ip_pool_assign 1 param body → 2004XX5XX
GET
/v1/system/ip-pools/{pool}/ranges
List ranges for IP pool
system_ip_pool_range_list 3 params → 2004XX5XX
POST
/v1/system/ip-pools/{pool}/ranges/add
Add range to IP pool
system_ip_pool_range_add 1 param body → 2014XX5XX
POST
/v1/system/ip-pools/{pool}/ranges/remove
Remove range from IP pool
system_ip_pool_range_remove 1 param body → 2044XX5XX
GET
/v1/system/ip-pools/{pool}/silos
List IP pool's linked silos
system_ip_pool_silo_list 4 params → 2004XX5XX
POST
/v1/system/ip-pools/{pool}/silos
Link IP pool to silo
system_ip_pool_silo_link 1 param body → 2014XX5XX
PUT
/v1/system/ip-pools/{pool}/silos/{silo}
Make IP pool default for silo
system_ip_pool_silo_update 2 params body → 2004XX5XX
DELETE
/v1/system/ip-pools/{pool}/silos/{silo}
Unlink IP pool from silo
system_ip_pool_silo_unlink 2 params → 2044XX5XX
GET
/v1/system/ip-pools/{pool}/utilization
Fetch IP pool utilization
system_ip_pool_utilization_view 1 param → 2004XX5XX

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are IpPool (8 properties), IpPoolCreate (5 properties), IpPoolRange (4 properties), Error (3 properties). Each schema is shown below with its type and property counts.

IpPoolSiloLinkResultsPage
object
A single page of results
2 properties 1 required
IpPoolRangeResultsPage
object
A single page of results
2 properties 1 required
IpPoolCreate
object
Create-time parameters for an IpPool. For multicast pools, all ranges must be either Any-Source Multicast (ASM) or Source-Specific Multicast (SSM), but not bot…
5 properties 2 required
IpPoolSiloLink
object
A link between an IP pool and a silo that allows one to allocate IPs from the pool within the silo
3 properties 3 required
Ipv4Range
object
A non-decreasing IPv4 address range, inclusive of both ends. The first address must be less than or equal to the last address.
2 properties 2 required
NameOrIdSortMode
Supported set of sort modes for scanning by name or id
IpPoolAssignment
Assignment of an IP pool to resources and services.
IdSortMode
Supported set of sort modes for scanning by id only. Currently, we only support scanning in ascending order.
IpPoolUtilization
object
The utilization of IP addresses in a pool. Note that both the count of remaining addresses and the total capacity are integers, reported as floating point numb…
2 properties 2 required
IpPool
object
A collection of IP ranges.
8 properties 8 required
IpPoolRange
object
4 properties 4 required
Error
object
Error information from a response.
3 properties 2 required
IpPoolType
Type of IP pool.
NameOrId
IpRange
IpPoolSiloUpdate
object
1 property 1 required
IpVersion
string
The IP address version.
Ipv6Range
object
A non-decreasing IPv6 address range, inclusive of both ends. The first address must be less than or equal to the last address.
2 properties 2 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…
IpPoolResultsPage
object
A single page of results
2 properties 1 required
IpPoolUpdate
object
Parameters for updating an IP Pool
2 properties
IpPoolAssignParam
object
Body parameters for reassigning an IP pool.
1 property 1 required
IpPoolLinkSilo
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oxide-computer-system-ip-pools-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Oxide System/ip Pools 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.