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-peers API

The network-peers API from Incus — 3 operation(s) for network-peers.

Incus network-peers 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-peers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a GitHub repository.

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

7 operations 3 paths 3 schemas 1 DELETE3 GET1 PATCH1 POST1 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 7

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

network-peers 7
GET
/1.0/networks/{networkName}/peers
Get the network peers
network_peers_get 3 params → 200403500
POST
/1.0/networks/{networkName}/peers
Add a network peer
network_peers_post 3 params → 200202400403500
DELETE
/1.0/networks/{networkName}/peers/{peerName}
Delete the network peer
network_peer_delete 3 params → 200400403500
GET
/1.0/networks/{networkName}/peers/{peerName}
Get the network peer
network_peer_get 3 params → 200403500
PATCH
/1.0/networks/{networkName}/peers/{peerName}
Partially update the network peer
network_peer_patch 4 params → 200400403412500
PUT
/1.0/networks/{networkName}/peers/{peerName}
Update the network peer
network_peer_put 4 params → 200400403412500
GET
/1.0/networks/{networkName}/peers?recursion=1
Get the network peers
network_peer_get_recursion1 3 params → 200403500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are NetworkPeer (9 properties), NetworkPeersPost (7 properties), NetworkPeerPut (2 properties). Each schema is shown below with its type and property counts.

NetworkPeer
object
9 properties
NetworkPeerPut
object
NetworkPeerPut represents the modifiable fields of a network peering
2 properties
NetworkPeersPost
object
NetworkPeersPost represents the fields of a new network peering
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

incus-network-peers-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