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 private-network API

Private Network provides private L2 networking functionality between Compute instances.

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

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

This API exposes 9 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.

9 operations 6 paths 18 schemas 2 DELETE2 GET1 POST4 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 9

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

private-network 9

Private Network provides private L2 networking functionality between Compute instances.

PUT
/private-network/{id}:attach
Attach a Compute instance to a Private Network
attach-instance-to-private-network 1 param body → 200
PUT
/private-network/{id}:update-ip
Update the IP address of an instance attached to a managed private network
update-private-network-instance-ip 1 param body → 200
GET
/private-network
List Private Networks
list-private-networks → 200
POST
/private-network
Create a Private Network
create-private-network body → 200
PUT
/private-network/{id}:detach
Detach a Compute instance from a Private Network
detach-instance-from-private-network 1 param body → 200
PUT
/private-network/{id}
Update a Private Network
update-private-network 1 param body → 200
GET
/private-network/{id}
Retrieve Private Network details
get-private-network 1 param → 200
DELETE
/private-network/{id}
Delete a Private Network
delete-private-network 1 param → 200
DELETE
/private-network/{id}/{field}
Reset Private Network field
reset-private-network-field 2 params → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are instance (25 properties), template (18 properties), private-network (10 properties), instance-type (8 properties). Each schema is shown below with its type and property counts.

private-network-lease
object
Private Network leased IP address
2 properties
instance-type
object
Compute instance type
8 properties
ssh-key
object
SSH key
2 properties
labels
object
deploy-target-ref
object
Deploy target reference
1 property
security-group-ref
object
Security group reference
1 property
private-network
object
Private Network
10 properties
template
object
Instance template
18 properties
zone-name
string
operation
object
Operation
5 properties
elastic-ip-ref
object
Elastic IP reference
1 property
manager
object
Resource manager
2 properties
public-ip-assignment
string
instance-state
string
instance
object
Instance
25 properties
private-network-options
object
Private Network DHCP Options
4 properties
snapshot-ref
object
Snapshot reference
1 property
anti-affinity-group-ref
object
Anti-affinity group reference
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

exoscale-private-network-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