Exoscale Environmental Impact API
The Environmental Impact API from Exoscale — 2 operation(s) for environmental impact.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/exoscale:exoscale-environmental-impact-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: 2.0.0
termsOfService: https://exoscale.com/terms
contact:
email: support@exoscale.com
name: Exoscale Support
url: https://portal.exoscale.com/tickets
title: Exoscale Environmental Impact API
description: Infrastructure automation API, allowing programmatic access to all Exoscale products and services.
servers:
- url: https://api-{zone}.exoscale.com/v2
variables:
zone:
default: ch-gva-2
enum:
- ch-gva-2
- ch-dk-2
- de-fra-1
- de-muc-1
- at-vie-1
- at-vie-2
- bg-sof-1
- hr-zag-1
tags:
- name: Environmental Impact
paths:
/environmental-impact/estimate:
post:
tags:
- Environmental Impact
responses:
'200':
description: Impact estimate
content:
application/json:
schema:
type: object
required:
- impact
properties:
impact:
type: object
additionalProperties:
$ref: '#/components/schemas/impact-value-with-unit'
'400':
description: Invalid request (e.g. product does not exist)
content:
application/json:
schema:
$ref: '#/components/schemas/impact-error-response'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/impact-error-response'
description: ''
parameters: []
summary: Return an estimate of the impact of a given usage
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- sku
properties:
sku:
type: string
metadata:
type: object
operationId: get-impact-estimate
/environmental-impact/report:
get:
tags:
- Environmental Impact
responses:
'200':
description: Environmental impact report
content:
application/json:
schema:
$ref: '#/components/schemas/impact-breakdown'
'400':
description: Invalid request (e.g. to date before from date)
content:
application/json:
schema:
$ref: '#/components/schemas/impact-error-response'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/impact-error-response'
description: ''
parameters:
- in: query
required: false
name: from
schema:
type: string
- in: query
required: false
name: to
schema:
type: string
summary: Return an environmental impact report for the given period
operationId: get-impact-report
components:
schemas:
impact-error-response:
type: object
description: Error response
required:
- title
- status
- detail
properties:
title:
type: string
status:
type: integer
minimum: 100
maximum: 599
detail:
type: string
zone-impact:
type: object
description: Hierarchical breakdown of impact in a given zone
required:
- impact
- resources
properties:
impact:
type: object
additionalProperties:
$ref: '#/components/schemas/impact-value-with-unit'
resources:
type: object
additionalProperties:
$ref: '#/components/schemas/impact-resource-tree-node'
impact-resource-tree-node:
type: object
description: Hierarchical breakdown of impact for a given level in the catalog tree
required:
- impact
- usage
- resources
properties:
impact:
type: object
additionalProperties:
$ref: '#/components/schemas/impact-value-with-unit'
usage:
$ref: '#/components/schemas/impact-value-with-unit'
resources:
type: object
additionalProperties:
$ref: '#/components/schemas/impact-resource-tree-node'
impact-breakdown:
type: object
required:
- impact
- zones
properties:
impact:
type: object
additionalProperties:
$ref: '#/components/schemas/impact-value-with-unit'
zones:
type: object
additionalProperties:
$ref: '#/components/schemas/zone-impact'
impact-value-with-unit:
type: object
required:
- unit
- value
properties:
unit:
type: string
value:
type: number
format: double
x-topics:
- title: API Request Signature
content: '
In order to authenticate legitimate users, the Exoscale API requires incoming requests to be signed using valid Exoscale API account credentials with the following mechanism.
## Signature Mechanism
The *message* (i.e. content) to sign contains several segments concatenated using a line return character (`\n`).
All segments must be included and in the described order. For cases where a segment doesn''t fit the context of the request (e.g. no request body) **an empty line must be used instead**.
* Request method and request URL (path only), separated by a space character
* Request body
* Request URL parameters (Query String) values, concatenated without separator. The matching parameter names have to be specified in the resulting signature header `signed-query-args=` pragma, separated by semicolons (e.g. `p1;p2;pN`).
* Request header values, concatenated without separator (none at the moment, leave empty)
* Request expiration date in UNIX timestamp format
Example *message* to sign for `GET /v2/resource/a02baf5a-a3e4-49a0-857b-8a08d276c1c0?p1=v1&p2=v2`:
```
GET /v2/resource/a02baf5a-a3e4-49a0-857b-8a08d276c1c0
v1v2
1599140767
```
The two blank lines above are due to the absence of a request body and signed headers.
Example *message* to [create a security group](https://community.exoscale.com/reference/api/compute/security-group/#create-security-group)
```
POST /v2/security-group
{"name": "my-security-group"}
1599140767
```
The two blank lines above are due to the absence of query parameters and signed headers.
The request signature consists of the base64-encoded [HMAC](https://en.wikipedia.org/wiki/HMAC) hash of the UTF-8 encoded *message* and the Exoscale API secret using the SHA265 function:
```
signature = BASE64_ENCODE(HMAC_SHA256(Exoscale API secret, message))
```
Finally, the computed signature must be added to the API request in a `Authorization` header such as:
```
Authorization: EXO2-HMAC-SHA256 credential=<Exoscale API key>,expires=<expiration date UNIX timestamp>,signature=<signature>
```
Example API query:
```
GET /v2/resource/a02baf5a-a3e4-49a0-857b-8a08d276c1c0?p1=v1&p2=v2 HTTP/1.1
Host: api-ch-gva-2.exoscale.com
Authorization: EXO2-HMAC-SHA256 credential=EXO29147e9f89102b7ac1e88514,signed-query-args=p1;p2,expires=1599140767,signature=2AOBQsbElQb4FpKT/FM/9T4NobjlmZkSGvvdUth/xlY=
```
## Reference Implementations
You can look up the following existing reference implementations:
* Go: [github.com/exoscale/egoscale/api/v2 > `SecurityProviderExoscale.signRequest`](https://github.com/exoscale/egoscale/blob/master/v2/api/security.go)
* Python: [requests-exoscale-auth > `ExoscaleV2Auth`](https://github.com/exoscale/requests-exoscale-auth/blob/master/exoscale_auth.py)
'
- title: Zone local resources
content: '
The API is deployed across all Exoscale zones. When performing a compute call, you should use the relevant zone for your resource.
For example: https://api-de-fra-1.exoscale.com/v2/instance would return only the instances from `de-fra-1`, https://api-ch-gva-2.exoscale.com/v2/instance from `ch-gva-2`.
To obtain a list of all instances across all zones, you would need to do the corresponding request for each zone.
'