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

Exoscale network-load-balancer API

A Network Load Balancer (NLB) is a Layer 4 (TCP/UDP) load balancer that distributes incoming traffic to Compute instances managed by an Instance Pool.

Exoscale network-load-balancer API is one of 37 APIs that Exoscale publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include network-load-balancer. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and pricing.

This API exposes 11 operations across 6 paths, and defines 18 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

Requests are made against a single base URL, https://api-{zone}.exoscale.com/v2.

11 operations 6 paths 18 schemas 4 DELETE3 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Base URL
https://api-ch-gva-2.exoscale.com/v2
Terms of Service
Resource Areas
1

Paths & Operations 11

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

network-load-balancer 11

A Network Load Balancer (NLB) is a Layer 4 (TCP/UDP) load balancer that distributes incoming traffic to Compute instances managed by an Instance Pool.

DELETE
/load-balancer/{id}/service/{service-id}
Delete a Load Balancer Service
delete-load-balancer-service 2 params → 200
PUT
/load-balancer/{id}/service/{service-id}
Update a Load Balancer Service
update-load-balancer-service 2 params body → 200
GET
/load-balancer/{id}/service/{service-id}
Retrieve Load Balancer Service details
get-load-balancer-service 2 params → 200
POST
/load-balancer
Create a Load Balancer
create-load-balancer body → 200
GET
/load-balancer
List Load Balancers
list-load-balancers → 200
DELETE
/load-balancer/{id}/{field}
Reset a Load Balancer field to its default value
reset-load-balancer-field 2 params → 200
DELETE
/load-balancer/{id}/service/{service-id}/{field}
Reset a Load Balancer Service field to its default value
reset-load-balancer-service-field 3 params → 200
POST
/load-balancer/{id}/service
Add a Load Balancer Service
add-service-to-load-balancer 1 param body → 200
PUT
/load-balancer/{id}
Update a Load Balancer
update-load-balancer 1 param body → 200
DELETE
/load-balancer/{id}
Delete a Load Balancer
delete-load-balancer 1 param → 200
GET
/load-balancer/{id}
Retrieve Load Balancer details
get-load-balancer 1 param → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are instance-pool (24 properties), load-balancer-service (11 properties), load-balancer (8 properties), load-balancer-service-healthcheck (7 properties). Each schema is shown below with its type and property counts.

load-balancer-service-healthcheck
object
Load Balancer Service healthcheck
7 properties
instance-type-ref
object
Instance type reference
1 property
labels
object
deploy-target-ref
object
Deploy target reference
1 property
private-network-ref
object
Private network reference
1 property
security-group-ref
object
Security group reference
1 property
public-ip-assignment
string
anti-affinity-group-ref
object
Anti-affinity group reference
1 property
template-ref
object
Template reference
1 property
ssh-key-ref
object
SSH key reference
1 property
load-balancer-service
object
Load Balancer Service
11 properties
elastic-ip-ref
object
Elastic IP reference
1 property
instance-pool
object
Instance Pool
24 properties
load-balancer
object
Load Balancer
8 properties
manager
object
Resource manager
2 properties
load-balancer-server-status
object
Load Balancer Service status
2 properties
operation
object
Operation
5 properties
instance-ref
object
Target Instance
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

exoscale-network-load-balancer-api-openapi.yml Raw ↑

Other APIs Exoscale publishes across the network.

Exoscale ai-api-key API
Exoscale anti-affinity-group API
Exoscale api-key API
Exoscale block-storage API
Exoscale ccm API
Exoscale cluster API
Exoscale compute API
Exoscale crypto API
Exoscale dbaas API
Exoscale deploy-target API
Exoscale deployment API
Exoscale domain API