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

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

Incus network-forwards 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-forwards. 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 4 schemas. It is described by OpenAPI 2.0, at version 1.0.

7 operations 3 paths 4 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-forwards 7
GET
/1.0/networks/{networkName}/forwards
Get the network address forwards
network_forwards_get 3 params → 200403500
POST
/1.0/networks/{networkName}/forwards
Add a network address forward
network_forwards_post 3 params → 200400403500
DELETE
/1.0/networks/{networkName}/forwards/{listenAddress}
Delete the network address forward
network_forward_delete 3 params → 200400403500
GET
/1.0/networks/{networkName}/forwards/{listenAddress}
Get the network address forward
network_forward_get 3 params → 200403500
PATCH
/1.0/networks/{networkName}/forwards/{listenAddress}
Partially update the network address forward
network_forward_patch 4 params → 200400403412500
PUT
/1.0/networks/{networkName}/forwards/{listenAddress}
Update the network address forward
network_forward_put 4 params → 200400403412500
GET
/1.0/networks/{networkName}/forwards?recursion=1
Get the network address forwards
network_forward_get_recursion1 3 params → 200403500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are NetworkForwardPort (6 properties), NetworkForward (5 properties), NetworkForwardsPost (4 properties), NetworkForwardPut (3 properties). Each schema is shown below with its type and property counts.

NetworkForwardPort
object
NetworkForwardPort represents a port specification in a network address forward
6 properties
NetworkForward
object
5 properties
NetworkForwardPut
object
NetworkForwardPut represents the modifiable fields of a network address forward
3 properties
NetworkForwardsPost
object
NetworkForwardsPost represents the fields of a new network address forward
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

incus-network-forwards-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-integrations API
Incus network-load-balancers API