Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Incus network-zones API

The network-zones API from Incus — 6 operation(s) for network-zones.

Incus network-zones API is one of 22 APIs that Incus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include network-zones. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a GitHub repository.

This API exposes 14 operations across 6 paths, and defines 7 schemas. It is described by OpenAPI 2.0, at version 1.0.

14 operations 6 paths 7 schemas 2 DELETE6 GET2 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
License
Resource Areas
1

Paths & Operations 14

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

network-zones 14
GET
/1.0/network-zones
Get the network zones
network_zones_get 3 params → 200403500
POST
/1.0/network-zones
Add a network zone
network_zones_post 2 params → 200400403500
DELETE
/1.0/network-zones/{zone}
Delete the network zone
network_zone_delete 2 params → 200400403500
GET
/1.0/network-zones/{zone}
Get the network zone
network_zone_get 2 params → 200403500
PATCH
/1.0/network-zones/{zone}
Partially update the network zone
network_zone_patch 3 params → 200400403412500
PUT
/1.0/network-zones/{zone}
Update the network zone
network_zone_put 3 params → 200400403412500
GET
/1.0/network-zones/{zone}/records
Get the network zone records
network_zone_records_get 3 params → 200403500
POST
/1.0/network-zones/{zone}/records
Add a network zone record
network_zone_records_post 3 params → 200400403500
DELETE
/1.0/network-zones/{zone}/records/{name}
Delete the network zone record
network_zone_record_delete 3 params → 200400403500
GET
/1.0/network-zones/{zone}/records/{name}
Get the network zone record
network_zone_record_get 3 params → 200403500
PATCH
/1.0/network-zones/{zone}/records/{name}
Partially update the network zone record
network_zone_record_patch 4 params → 200400403412500
PUT
/1.0/network-zones/{zone}/records/{name}
Update the network zone record
network_zone_record_put 4 params → 200400403412500
GET
/1.0/network-zones/{zone}/records?recursion=1
Get the network zone records
network_zone_records_get_recursion1 3 params → 200403500
GET
/1.0/network-zones?recursion=1
Get the network zones
network_zones_get_recursion1 3 params → 200403500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are NetworkZone (5 properties), NetworkZoneRecord (4 properties), NetworkZoneRecordsPost (4 properties), NetworkZoneRecordEntry (3 properties). Each schema is shown below with its type and property counts.

NetworkZoneRecordPut
object
NetworkZoneRecordPut represents the modifiable fields of a network zone record
3 properties
NetworkZonesPost
object
NetworkZonesPost represents the fields of a new network zone
3 properties
NetworkZoneRecordsPost
object
NetworkZoneRecordsPost represents the fields of a new network zone record
4 properties
NetworkZonePut
object
NetworkZonePut represents the modifiable fields of a network zone
2 properties
NetworkZone
object
5 properties
NetworkZoneRecord
object
4 properties
NetworkZoneRecordEntry
object
NetworkZoneRecordEntry represents the fields in a record entry
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

incus-network-zones-api-openapi.yml Raw ↑

Other APIs Incus publishes across the network.

Incus certificates API
Incus cluster API
Incus cluster-groups API
Incus images API
Incus instances API
Incus Metadata API
Incus metrics API
Incus network-acls API
Incus network-address-sets API
Incus network-allocations API
Incus network-forwards API
Incus network-integrations API