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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Exoscale

Exoscale instance API

Instances are the virtual machines at the core of the Exoscale Compute service.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 20 operations across 17 paths, and defines 22 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.

20 operations 17 paths 22 schemas 2 DELETE4 GET4 POST10 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
Contact
Exoscale Support
Terms of Service
View terms
Resource Areas
1

Paths & Operations 20

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

instance 20

Instances are the virtual machines at the core of the Exoscale Compute service.

POST
/instance/{id}:create-snapshot
Create a Snapshot of a Compute instance
create-snapshot 1 param → 200
GET
/instance/{id}:password
Reveal the password used during instance creation or the latest password reset.
reveal-instance-password 1 param → 200
PUT
/instance/{id}:resize-disk
Resize a Compute instance disk
resize-instance-disk 1 param body → 200
PUT
/instance/{id}:reset-password
Reset a compute instance password
reset-instance-password 1 param → 200
PUT
/instance/{id}:start
Start a Compute instance
start-instance 1 param body → 200
POST
/instance/{id}:enable-tpm
Enable tpm for the instance.
enable-tpm 1 param → 200
PUT
/instance/{id}:scale
Scale a Compute instance to a new Instance Type
scale-instance 1 param body → 200
PUT
/instance/{id}:stop
Stop a Compute instance
stop-instance 1 param → 200
PUT
/instance/{id}:add-protection
Set instance destruction protection
add-instance-protection 1 param → 200
DELETE
/instance/{id}/{field}
Reset Instance field
reset-instance-field 2 params → 200
PUT
/instance/{id}:remove-protection
Remove instance destruction protection
remove-instance-protection 1 param → 200
PUT
/instance/{id}:reset
Reset a Compute instance to a base/target template
reset-instance 1 param body → 200
GET
/console/{id}
Retrieve signed url valid for 60 seconds to connect via console-proxy websocket to VM VNC console.
get-console-proxy-url 1 param → 200
DELETE
/instance/{id}
Delete a Compute instance
delete-instance 1 param → 200
PUT
/instance/{id}
Update a Compute instance
update-instance 1 param body → 200
GET
/instance/{id}
Retrieve Compute instance details
get-instance 1 param → 200
PUT
/instance/{id}:reboot
Reboot a Compute instance
reboot-instance 1 param → 200
POST
/instance
Create a Compute instance
create-instance body → 200
GET
/instance
List Compute instances
list-instances 4 params → 200
POST
/instance/{instance-id}:revert-snapshot
Revert a snapshot for an instance
revert-instance-to-snapshot 1 param body → 200

Schemas 22

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

instance-type
object
Compute instance type
8 properties
instance-type-ref
object
Instance type reference
1 property
security-group-ref
object
Security group reference
1 property
public-ip-assignment
string
template-ref
object
Template reference
1 property
zone-name
string
instance
object
Instance
25 properties
snapshot-ref
object
Snapshot reference
1 property
operation
object
Operation
5 properties
deploy-target-ref
object
Deploy target reference
1 property
ssh-key-ref
object
SSH key reference
1 property
instance-password
object
Instance password
1 property
manager
object
Resource manager
2 properties
security-group-resource
object
Security Group
3 properties
labels
object
security-group-rule
object
Security Group rule
9 properties
security-group
object
Security Group
5 properties
template
object
Instance template
18 properties
anti-affinity-group-ref
object
Anti-affinity group reference
1 property
ssh-key
object
SSH key
2 properties
elastic-ip-ref
object
Elastic IP reference
1 property
instance-state
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

exoscale-instance-api-openapi.yml Raw ↑

Other APIs Exoscale publishes across the network.

Exoscale ai-api-key API
AE Profile APIs.io
Exoscale anti-affinity-group API
AE Profile APIs.io
Exoscale api-key API
AE Profile APIs.io
Exoscale block-storage API
AE Profile APIs.io
Exoscale ccm API
AE Profile APIs.io
Exoscale cluster API
AE Profile APIs.io
Exoscale compute API
AE Profile APIs.io
Exoscale crypto API
AE Profile APIs.io
Exoscale dbaas API
AE Profile APIs.io
Exoscale deploy-target API
AE Profile APIs.io
Exoscale deployment API
AE Profile APIs.io
Exoscale domain API
AE Profile APIs.io
#instance
← Back to E APIs
API Details
ID
exoscale:exoscale-instance-api
Base URL
https://api-ch-gva-2.exoscale.com/v2
Docs
https://openapi-v2.exoscale.com/
Provider
Exoscale
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network