API Key

API keys are credentials for programmatic access to Exoscale APIs and services.

create-api-key

Create a new API key

POST /api-key

null

Request body

Content-Type: application/json

Property	Type	Required	Description
`name`	string	yes	IAM API Key Name
`role-id`	string	yes	IAM API Key Role ID

Example

{
  "name": "string",
  "role-id": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`key`	string	IAM API Key
`name`	string	IAM API Key name
`role-id`	string	IAM API Key Role ID
`secret`	string	IAM API Key Secret

Example output

{
  "key": "string",
  "name": "string",
  "role-id": "string",
  "secret": "string"
}

SDK reference for create-api-key: golang | Python | Java

CLI: exo api create-api-key

get-api-key

Get API key

GET /api-key/{id}

null

Path parameters

Name	In	Description
`id`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`key`	string	IAM API Key
`name`	string	IAM API Key name
`role-id`	string	IAM API Key Role ID

Example output

{
  "key": "string",
  "name": "string",
  "role-id": "string"
}

SDK reference for get-api-key: golang | Python | Java

CLI: exo api get-api-key

delete-api-key

Delete an API key

DELETE /api-key/{id}

null

Path parameters

Name	In	Description
`id`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	object	Related resource reference schema details
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for delete-api-key: golang | Python | Java

CLI: exo api delete-api-key

Other Operations

list-api-keys

List API keys

GET /api-key

null

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`api-keys`	array[object]	schema details

Example output

{
  "api-keys": [
    {
      "key": "string",
      "name": "string",
      "role-id": "string"
    }
  ]
}

SDK reference for list-api-keys: golang | Python | Java

CLI: exo api list-api-keys

Last updated on January 28, 2026