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-load-balancers API

The network-load-balancers API from Incus — 4 operation(s) for network-load-balancers.

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

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

8 operations 4 paths 8 schemas 1 DELETE4 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 8

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

network-load-balancers 8
GET
/1.0/networks/{networkName}/load-balancers
Get the network address of load balancers
network_load_balancers_get 3 params → 200403500
POST
/1.0/networks/{networkName}/load-balancers
Add a network load balancer
network_load_balancers_post 3 params → 200400403500
DELETE
/1.0/networks/{networkName}/load-balancers/{listenAddress}
Delete the network address load balancer
network_load_balancer_delete 3 params → 200400403500
GET
/1.0/networks/{networkName}/load-balancers/{listenAddress}
Get the network address load balancer
network_load_balancer_get 3 params → 200403500
PATCH
/1.0/networks/{networkName}/load-balancers/{listenAddress}
Partially update the network address load balancer
network_load_balancer_patch 4 params → 200400403412500
PUT
/1.0/networks/{networkName}/load-balancers/{listenAddress}
Update the network address load balancer
network_load_balancer_put 4 params → 200400403412500
GET
/1.0/networks/{networkName}/load-balancers/{listenAddress}/state
Get the network address load balancer state
network_load_balancer_state_get 3 params → 200403500
GET
/1.0/networks/{networkName}/load-balancers?recursion=1
Get the network address load balancers
network_load_balancer_get_recursion1 3 params → 200403500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are NetworkLoadBalancer (6 properties), NetworkLoadBalancersPost (5 properties), NetworkLoadBalancerPut (4 properties), NetworkLoadBalancerPort (4 properties). Each schema is shown below with its type and property counts.

NetworkLoadBalancerStateBackendHealthPort
object
3 properties
NetworkLoadBalancersPost
object
NetworkLoadBalancersPost represents the fields of a new network load balancer
5 properties
NetworkLoadBalancerStateBackendHealth
object
NetworkLoadBalancerStateBackendHealth represents the health of a particular load-balancer backend
2 properties
NetworkLoadBalancer
object
NetworkLoadBalancer used for displaying a network load balancer
6 properties
NetworkLoadBalancerBackend
object
NetworkLoadBalancerBackend represents a target backend specification in a network load balancer
4 properties
NetworkLoadBalancerPort
object
NetworkLoadBalancerPort represents a port specification in a network load balancer
4 properties
NetworkLoadBalancerPut
object
NetworkLoadBalancerPut represents the modifiable fields of a network load balancer
4 properties
NetworkLoadBalancerState
object
NetworkLoadBalancerState is used for showing current state of a load balancer
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

incus-network-load-balancers-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