Exoscale API
Infrastructure automation API, allowing programmatic access to all Exoscale products and services.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Infrastructure automation API, allowing programmatic access to all Exoscale products and services.
Endpoints 385
role
- POST[BETA] Request generation of key/secret that allow caller to assume target role
/iam-role/:id/assume[BETA] Request generation of key/secret that allow caller to assume target role - GETRetrieve IAM Role
/iam-role/:id - PUTUpdate IAM Role
/iam-role/:id - DELETEDelete IAM Role
/iam-role/:id - PUTUpdate IAM Role Policy
/iam-role/:id:policy - GETList IAM System Roles
/iam-system-role - GETList IAM Roles
/iam-role - POSTCreate IAM Role
/iam-role
key-store
- POST[BETA] Disconnect Key Store
/key-store/:id/disconnectDisconnects an External Key Store and suspends periodic proxy health checks; keys backed by this store remain intact but cannot be used for cryptographic… - POST[BETA] Update Key Store
/key-store/:id/updateUpdates an External Key Store with a new description, endpoint, or credentials. - GET[BETA] List Key Stores
/key-storeLists all key stores configured for an organization. - POST[BETA] Create Key Store
/key-storeCreate an External Key Store after validating the configured customer-managed XKS proxy. - POST[BETA] Connect Key Store
/key-store/:id/connectConnects an External Key Store once its customer-managed XKS proxy passes a health check, then resumes periodic proxy health checks and lets keys backed by… - GET[BETA] Get Key Store
/key-store/:idFetch an External Key Store including its latest XKS health observation when available. - DELETE[BETA] Delete Key Store
/key-store/:idDeletes an External Key Store when no KMS keys reference it.
ai-api-key
- POST[BETA] Revoke AI API Key
/ai/api-key/:id/revokeRevoke an AI API key. Key will be deleted after 30 days of retention - GET[BETA] Get AI API Key
/ai/api-key/:idGet AI API key metadata - PUT[BETA] Update AI API Key access
/ai/api-key/:idUpdate the models and deployments accessible by an AI API key. - GET[BETA] List AI API Keys
/ai/api-keyList AI API keys for an organization - POST[BETA] Create AI API Key
/ai/api-keyCreate a new AI API key - GET[BETA] Get Organization Consumption Quota
/ai/quotaGet per-org Unit Of Measurement (UOM) consumption quota (UOM/min). Null means unlimited. UOM represents weighted units across different AI workloads (e.g.,…
elastic-ip
- GETList Elastic IPs
/elastic-ip - POSTCreate an Elastic IP
/elastic-ip - DELETEReset an Elastic IP field to its default value
/elastic-ip/:id/:field - PUTDetach a Compute instance from an Elastic IP
/elastic-ip/:id:detach - PUTAttach a Compute instance to an Elastic IP
/elastic-ip/:id:attach - GETRetrieve Elastic IP details
/elastic-ip/:id - PUTUpdate an Elastic IP
/elastic-ip/:id - DELETEDelete an Elastic IP
/elastic-ip/:id
reverse-dns
- GETQuery the PTR DNS records for an elastic IP
/reverse-dns/elastic-ip/:id - POSTUpdate/Create the PTR DNS record for an elastic IP
/reverse-dns/elastic-ip/:id - DELETEDelete the PTR DNS record for an elastic IP
/reverse-dns/elastic-ip/:id - GETQuery the PTR DNS records for an instance
/reverse-dns/instance/:id - POSTUpdate/Create the PTR DNS record for an instance
/reverse-dns/instance/:id - DELETEDelete the PTR DNS record for an instance
/reverse-dns/instance/:id
cluster
- POSTGenerate a new Kubeconfig file for a SKS cluster
/sks-cluster-kubeconfig/:idThis operation returns a Kubeconfig file encoded in base64. - GETGet the certificate for a SKS cluster authority
/sks-cluster/:id/authority/:authority/certThis operation returns the certificate for the given SKS cluster authority encoded in base64. - GETResources that are scheduled to be removed in future kubernetes releases
/sks-cluster-deprecated-resources/:idThis operation returns the deprecated resources for a given cluster - PUTUpgrade a SKS cluster to pro
/sks-cluster/:id/upgrade-service-level - PUTRotate Exoscale CSI credentials
/sks-cluster/:id/rotate-csi-credentials - GETList SKS clusters
/sks-cluster - POSTCreate an SKS cluster
/sks-cluster - GETRetrieve SKS cluster details
/sks-cluster/:id - PUTUpdate an SKS cluster
/sks-cluster/:id - DELETEDelete an SKS cluster
/sks-cluster/:id - GETGet the latest inspection result
/sks-cluster/:id/inspectionHelps troubleshoot common problems when deploying a kubernetes cluster. Inspections run every couple of minutes. - PUTRotate Exoscale CCM credentials
/sks-cluster/:id/rotate-ccm-credentials - PUTGenerate a Karpenter NodePool manifest with minimal configuration for an SKS cluster
/sks-cluster/:id/generate-karpenter-nodepool - PUTGenerate a Karpenter ExoscaleNodeClass manifest for an SKS cluster, including its default security group and feature flags if present
/sks-cluster/:id/generate-karpenter-exoscale-nodeclass - PUTRotate Exoscale Karpenter credentials
/sks-cluster/:id/rotate-karpenter-credentials - PUTRotate operators certificate authority
/sks-cluster/:id/rotate-operators-ca - GETList available versions for SKS clusters
/sks-cluster-version - PUTUpgrade an SKS cluster
/sks-cluster/:id/upgrade
instance
- POSTCreate a Snapshot of a Compute instance
/instance/:id:create-snapshot - GETReveal the password used during instance creation or the latest password reset.
/instance/:id:passwordReveal the password used during instance creation or the latest password reset. This is only available for VMs created against templates having the… - PUTResize a Compute instance disk
/instance/:id:resize-diskThis operation resizes a Compute instance's disk volume. Note: the disk can only grow, cannot be shrunk. - PUTReset a compute instance password
/instance/:id:reset-password - PUTStart a Compute instance
/instance/:id:startThis operation starts a virtual machine, potentially using a rescue profile if specified - POSTEnable tpm for the instance.
/instance/:id:enable-tpm - PUTScale a Compute instance to a new Instance Type
/instance/:id:scaleThis operation changes the Compute instance's type. Note: the new Instance Type must be within the same family (e.g. a standard instance cannot be scaled to… - PUTStop a Compute instance
/instance/:id:stop - PUTSet instance destruction protection
/instance/:id:add-protection - DELETEReset Instance field
/instance/:id/:field - PUTRemove instance destruction protection
/instance/:id:remove-protection - PUTReset a Compute instance to a base/target template
/instance/:id:resetThis operation re-installs a Compute instance to a base template. If target template is provided it will be used to recreated instance from. Warning: the… - GETRetrieve signed url valid for 60 seconds to connect via console-proxy websocket to VM VNC console.
/console/:id - GETRetrieve Compute instance details
/instance/:id - PUTUpdate a Compute instance
/instance/:id - DELETEDelete a Compute instance
/instance/:id - PUTReboot a Compute instance
/instance/:id:reboot - GETList Compute instances
/instance - POSTCreate a Compute instance
/instance - POSTRevert a snapshot for an instance
/instance/:instance-id:revert-snapshotThis operation reverts the snapshot to the Compute instance volume, restoring stored data as it was at the time of the snapshot. The Compute instance must be…
zone
- GETList Zones
/zone
dbaas
- GETget-dbaas-external-endpoint-opensearch
/dbaas-external-endpoint-opensearch/:endpoint-id[BETA] Get OpenSearch Logs external integration endpoint settings - PUTupdate-dbaas-external-endpoint-opensearch
/dbaas-external-endpoint-opensearch/:endpoint-id[BETA] Update OpenSearch Logs external integration endpoint - DELETEdelete-dbaas-external-endpoint-opensearch
/dbaas-external-endpoint-opensearch/:endpoint-id[BETA] Delete OpenSearch logs external integration endpoint - GETGet DBaaS OpenSearch ACL configuration
/dbaas-opensearch/:name/acl-config - PUTCreate a DBaaS OpenSearch ACL configuration
/dbaas-opensearch/:name/acl-config - POSTStop a DBaaS Valkey migration
/dbaas-valkey/:name/migration/stop - PUTInitiate Grafana maintenance update
/dbaas-grafana/:name/maintenance/start - POSTcreate-dbaas-pg-upgrade-check
/dbaas-postgres/:service/upgrade-checkCheck whether you can upgrade Postgres service to a newer version - PUTReset the credentials of a DBaaS mysql user
/dbaas-mysql/:service-name/user/:username/password/resetIf no password is provided one will be generated automatically. - POSTCreate a DBaaS PostgreSQL connection pool
/dbaas-postgres/:service-name/connection-pool - GETGet a DBaaS MySQL service
/dbaas-mysql/:nameGet a DBaaS MySQL service - PUTUpdate a DBaaS MySQL service
/dbaas-mysql/:nameUpdate a DBaaS MySQL service - POSTCreate a DBaaS MySQL service
/dbaas-mysql/:nameCreate a DBaaS MySQL service - DELETEDelete a MySQL service
/dbaas-mysql/:name - PUTInitiate Thanos maintenance update
/dbaas-thanos/:name/maintenance/start - POSTcreate-dbaas-mysql-upgrade-check
/dbaas-mysql/:service-name/upgrade-checkCheck whether you can upgrade MySQL service to a newer version - GETget-dbaas-external-endpoint-elasticsearch
/dbaas-external-endpoint-elasticsearch/:endpoint-id[BETA] Get ElasticSearch Logs external integration endpoint settings - PUTupdate-dbaas-external-endpoint-elasticsearch
/dbaas-external-endpoint-elasticsearch/:endpoint-id[BETA] Update ElasticSearch Logs external integration endpoint - DELETEdelete-dbaas-external-endpoint-elasticsearch
/dbaas-external-endpoint-elasticsearch/:endpoint-id[BETA] Delete ElasticSearch logs external integration endpoint - POSTCreate a DBaaS MySQL user
/dbaas-mysql/:service-name/user - GETDBaaS Service Types
/dbaas-service-typeList available service types for DBaaS - GETGet a DBaaS ClickHouse service
/dbaas-clickhouse/:name - PUTUpdate a DBaaS ClickHouse service
/dbaas-clickhouse/:name - POSTCreate a DBaaS ClickHouse service
/dbaas-clickhouse/:name - DELETEDelete a ClickHouse service
/dbaas-clickhouse/:name - GETList DBaaS services
/dbaas-serviceList DBaaS services - POSTcreate-dbaas-external-endpoint-rsyslog
/dbaas-external-endpoint-rsyslog/:name[BETA] Create RSyslog external integration endpoint - GETGet DBaaS CA Certificate
/dbaas-ca-certificateReturns a CA Certificate required to reach a DBaaS service through a TLS-protected connection. - GETGet DBaaS Grafana settings
/dbaas-settings-grafanaGet DBaaS Grafana settings - DELETEDelete a DBaaS Postgres database
/dbaas-postgres/:service-name/database/:database-name - GETList DBaaS ClickHouse roles
/dbaas-clickhouse/:service-name/role - POSTStop a DBaaS PostgreSQL migration
/dbaas-postgres/:name/migration/stop - GETGet a DBaaS Kafka service
/dbaas-kafka/:name - PUTUpdate a DBaaS Kafka service
/dbaas-kafka/:nameUpdate a DBaaS Kafka service - POSTCreate a DBaaS Kafka service
/dbaas-kafka/:nameCreate a DBaaS Kafka service - DELETEDelete a Kafka service
/dbaas-kafka/:name - POSTAdd a Kafka Schema Registry ACL entry
/dbaas-kafka/:name/schema-registry/acl-config - POSTCreate a DBaaS Postgres user
/dbaas-postgres/:service-name/user - GETlist-dbaas-external-integrations
/dbaas-external-integrations/:service-name[BETA] List all DBaaS connections between services and external endpoints - GETget-dbaas-external-integration
/dbaas-external-integration/:integration-id[BETA] Get a DBaaS external integration - GETlist-dbaas-external-endpoint-types
/dbaas-external-endpoint-types[BETA] List available external endpoint types and their schemas for DBaaS external integrations - DELETEDelete a DBaaS ClickHouse role
/dbaas-clickhouse/:service-name/role/:role-uuid - GETReveal the secrets for DBaaS Kafka Connect
/dbaas-kafka/:service-name/connect/password/reveal - DELETEDelete a DBaaS OpenSearch user
/dbaas-opensearch/:service-name/user/:username - GETget-dbaas-external-endpoint-prometheus
/dbaas-external-endpoint-prometheus/:endpoint-id[BETA] Get Prometheus external integration endpoint settings - PUTupdate-dbaas-external-endpoint-prometheus
/dbaas-external-endpoint-prometheus/:endpoint-id[BETA] Update Prometheus external integration endpoint - DELETEdelete-dbaas-external-endpoint-prometheus
/dbaas-external-endpoint-prometheus/:endpoint-id[BETA] Delete Prometheus external integration endpoint - POSTCreate a DBaaS Kafka user
/dbaas-kafka/:service-name/user - PUTReset the credentials of a DBaaS Valkey user
/dbaas-valkey/:service-name/user/:username/password/resetIf no password is provided one will be generated automatically. - GETget-dbaas-external-integration-settings-datadog
/dbaas-external-integration-settings-datadog/:integration-id[BETA] Get Datadog integration settings - POSTupdate-dbaas-external-integration-settings-datadog
/dbaas-external-integration-settings-datadog/:integration-id[BETA] Manage Datadog integration settings - GETGet DBaaS MySQL settings
/dbaas-settings-mysqlGet DBaaS MySQL settings - GETGet DBaaS Valkey settings
/dbaas-settings-valkeyReturns the default settings for Valkey. - POSTCreate a DBaaS Postgres database
/dbaas-postgres/:service-name/database - GETGet DBaaS Thanos settings
/dbaas-settings-thanosGet DBaaS Thanos settings - GET[BETA] Get DBaaS ClickHouse settings
/dbaas-settings-clickhouse - POSTCreate a DBaaS OpenSearch user
/dbaas-opensearch/:service-name/user - GETlist-dbaas-integration-types
/dbaas-integration-types[BETA] Get DBaaS integration types - DELETEDelete a DBaaS Postgres user
/dbaas-postgres/:service-name/user/:username - PUTUpdate access control for one service user
/dbaas-postgres/:service-name/user/:username/allow-replication - POSTAdd a Kafka topic ACL entry
/dbaas-kafka/:name/topic/acl-config - POSTcreate-dbaas-external-endpoint-opensearch
/dbaas-external-endpoint-opensearch/:name[BETA] Create OpenSearch Logs external integration endpoint - DELETEDelete a DBaaS MySQL database
/dbaas-mysql/:service-name/database/:database-name - POSTGet logs of DBaaS service
/dbaas-service-logs/:service-nameGet logs of DBaaS service - PUTInitiate PostgreSQL maintenance update
/dbaas-postgres/:name/maintenance/start - GETReveal the secrets of a DBaaS Grafana user
/dbaas-grafana/:service-name/user/:username/password/reveal - PUTReset the credentials of a DBaaS Grafana user
/dbaas-grafana/:service-name/user/:username/password/resetIf no password is provided one will be generated automatically. - PUTReset the credentials of a DBaaS ClickHouse user
/dbaas-clickhouse/:service-name/user/:username/password/reset - GETGet DBaaS ClickHouse ACL configuration
/dbaas-clickhouse/:service-name/acl-config - GETList DBaaS ClickHouse users
/dbaas-clickhouse/:service-name/user - POSTCreate a DBaaS ClickHouse user
/dbaas-clickhouse/:service-name/user - PUTUpdate access control for one DBaaS Valkey service user
/dbaas-valkey/:service-name/user/:username - DELETEDelete a DBaaS Valkey user
/dbaas-valkey/:service-name/user/:username - DELETEDelete a Kafka ACL entry
/dbaas-kafka/:name/schema-registry/acl-config/:acl-id - DELETEDelete a DBaaS kafka user
/dbaas-kafka/:service-name/user/:username - GETGet a DBaaS service type
/dbaas-service-type/:service-type-nameGet a DBaaS service type - POSTcreate-dbaas-external-endpoint-datadog
/dbaas-external-endpoint-datadog/:name[BETA] Create DataDog external integration endpoint - PUTInitiate MySQL maintenance update
/dbaas-mysql/:name/maintenance/start - PUTReset the credentials of a DBaaS OpenSearch user
/dbaas-opensearch/:service-name/user/:username/password/resetIf no password is provided one will be generated automatically. - GETReveal the secrets of a DBaaS MySQL user
/dbaas-mysql/:service-name/user/:username/password/reveal - POSTGet metrics of DBaaS service
/dbaas-service-metrics/:service-nameGet metrics of DBaaS service - PUTTemporarily enable writes for MySQL services in read-only mode due to filled up storage
/dbaas-mysql/:name/enable/writes - GETReveal the secrets of a DBaaS Kafka user
/dbaas-kafka/:service-name/user/:username/password/reveal - POSTcreate-dbaas-task-migration-check
/dbaas-task-migration-check/:serviceCreate a DBaaS task to check migration - GETget-dbaas-external-endpoint-datadog
/dbaas-external-endpoint-datadog/:endpoint-id[BETA] Get DataDog external endpoint settings - PUTupdate-dbaas-external-endpoint-datadog
/dbaas-external-endpoint-datadog/:endpoint-id[BETA] Update DataDog external integration endpoint - DELETEdelete-dbaas-external-endpoint-datadog
/dbaas-external-endpoint-datadog/:endpoint-id[BETA] Delete DataDog external integration endpoint - GETReveal the secrets of a DBaaS ClickHouse user
/dbaas-clickhouse/:service-name/user/:username/password/reveal - POSTcreate-dbaas-external-endpoint-prometheus
/dbaas-external-endpoint-prometheus/:name[BETA] Create Prometheus external integration endpoint - GETget-dbaas-integration
/dbaas-integration/:id[BETA] Get a DBaaS Integration - PUTupdate-dbaas-integration
/dbaas-integration/:id[BETA] Update an existing DBaaS integration - DELETEdelete-dbaas-integration
/dbaas-integration/:id[BETA] Delete a DBaaS Integration - GETlist-dbaas-integration-settings
/dbaas-integration-settings/:integration-type/:source-type/:dest-type[BETA] Get DBaaS integration settings - GETReveal the secrets of a DBaaS Thanos user
/dbaas-thanos/:service-name/user/:username/password/reveal - DELETEDelete a DBaaS ClickHouse user
/dbaas-clickhouse/:service-name/user/:user-uuid - GETGet DBaaS PostgreSQL settings
/dbaas-settings-pgGet DBaaS PostgreSQL settings - GETget-dbaas-service-valkey
/dbaas-valkey/:nameGet a DBaaS Valkey service - PUTupdate-dbaas-service-valkey
/dbaas-valkey/:nameUpdate a DBaaS Valkey service - POSTCreate a DBaaS Valkey service
/dbaas-valkey/:nameCreate a DBaaS Valkey service - DELETEDelete a Valkey service
/dbaas-valkey/:name - POSTStop a DBaaS MySQL migration
/dbaas-mysql/:name/migration/stop - GETlist-dbaas-external-endpoints
/dbaas-external-endpoints[BETA] List available external endpoints for integrations - PUTInitiate Kafka maintenance update
/dbaas-kafka/:name/maintenance/start - PUTUpdate a DBaaS PostgreSQL connection pool
/dbaas-postgres/:service-name/connection-pool/:connection-pool-name - DELETEDelete a DBaaS PostgreSQL connection pool
/dbaas-postgres/:service-name/connection-pool/:connection-pool-name - GETget-dbaas-service-thanos
/dbaas-thanos/:nameGet a DBaaS Thanos service - PUTupdate-dbaas-service-thanos
/dbaas-thanos/:nameUpdate a DBaaS Thanos service - POSTCreate a DBaaS Thanos service
/dbaas-thanos/:nameCreate a DBaaS Thanos service - DELETEDelete a Thanos service
/dbaas-thanos/:name - GETGet a DBaaS migration status
/dbaas-migration-status/:nameGet a DBaaS migration status - DELETEDelete a DBaaS MySQL user
/dbaas-mysql/:service-name/user/:username - DELETEDelete a DBaaS service
/dbaas-service/:nameDelete a DBaaS service - POSTCreate a DBaaS MySQL database
/dbaas-mysql/:service-name/database - GETGet DBaaS Kafka settings
/dbaas-settings-kafkaGet DBaaS Kafka settings - GETReveal the secrets of a DBaaS Postgres user
/dbaas-postgres/:service-name/user/:username/password/reveal - GETGet DBaaS OpenSearch settings
/dbaas-settings-opensearchGet DBaaS OpenSearch settings - PUTattach-dbaas-service-to-endpoint
/dbaas-external-endpoint/:source-service-name/attach[BETA] Create a new DBaaS connection between a DBaaS service and an external service - GETGet a DBaaS Grafana service
/dbaas-grafana/:name - PUTUpdate a DBaaS Grafana service
/dbaas-grafana/:name - POSTcreate-dbaas-service-grafana
/dbaas-grafana/:nameCreate a DBaaS Grafana service - DELETEDelete a Grafana service
/dbaas-grafana/:name - GETget-dbaas-external-endpoint-rsyslog
/dbaas-external-endpoint-rsyslog/:endpoint-id[BETA] Get RSyslog external integration endpoint settings - PUTupdate-dbaas-external-endpoint-rsyslog
/dbaas-external-endpoint-rsyslog/:endpoint-id[BETA] Update RSyslog external integration endpoint - DELETEdelete-dbaas-external-endpoint-rsyslog
/dbaas-external-endpoint-rsyslog/:endpoint-id[BETA] Delete RSyslog external integration endpoint - POSTcreate-dbaas-external-endpoint-elasticsearch
/dbaas-external-endpoint-elasticsearch/:name[BETA] Create ElasticSearch Logs external integration endpoint - PUTInitiate OpenSearch maintenance update
/dbaas-opensearch/:name/maintenance/start - GETGet DBaaS kafka ACL configuration
/dbaas-kafka/:name/acl-config - PUTReset the credentials of a DBaaS Kafka user
/dbaas-kafka/:service-name/user/:username/password/resetIf no password is provided one will be generated automatically. - GETReveal the secrets of a DBaaS OpenSearch user
/dbaas-opensearch/:service-name/user/:username/password/reveal - PUTInitiate Valkey maintenance update
/dbaas-valkey/:name/maintenance/start - GETGet a DBaaS OpenSearch service
/dbaas-opensearch/:nameGet a DBaaS OpenSearch service - PUTUpdate a DBaaS OpenSearch service
/dbaas-opensearch/:nameUpdate a DBaaS OpenSearch service - POSTCreate a DBaaS OpenSearch service
/dbaas-opensearch/:nameCreate a DBaaS OpenSearch service - DELETEDelete an OpenSearch service
/dbaas-opensearch/:name - PUTdetach-dbaas-service-from-endpoint
/dbaas-external-endpoint/:source-service-name/detach[BETA] Detach a DBaaS external integration from a service - GETReveal the secrets of a DBaaS Valkey user
/dbaas-valkey/:service-name/user/:username/password/reveal - GETGet a DBaaS PostgreSQL service
/dbaas-postgres/:nameGet a DBaaS PostgreSQL service - PUTUpdate a DBaaS PostgreSQL service
/dbaas-postgres/:nameUpdate a DBaaS PostgreSQL service - POSTCreate a DBaaS PostgreSQL service
/dbaas-postgres/:name - DELETEDelete a Postgres service
/dbaas-postgres/:name - GETList DBaaS Valkey users with ACL configuration
/dbaas-valkey/:service-name/user - POSTCreate a DBaaS Valkey user
/dbaas-valkey/:service-name/user - POSTcreate-dbaas-integration
/dbaas-integration[BETA] Create a new DBaaS integration between two services - GETGet a DBaaS task
/dbaas-task/:service/:idGet a DBaaS task - PUTInitiate ClickHouse maintenance update
/dbaas-clickhouse/:name/maintenance/start - DELETEDelete a Kafka ACL entry
/dbaas-kafka/:name/topic/acl-config/:acl-id - PUTReset the credentials of a DBaaS Postgres user
/dbaas-postgres/:service-name/user/:username/password/resetIf no password is provided one will be generated automatically.
anti-affinity-group
- GETList Anti-affinity Groups
/anti-affinity-group - POSTCreate an Anti-affinity Group
/anti-affinity-group - GETRetrieve Anti-affinity Group details
/anti-affinity-group/:id - DELETEDelete an Anti-affinity Group
/anti-affinity-group/:id
operation
- GETRetrieve Operation details
/operation/:id
instance-type
- GETRetrieve Instance Type details
/instance-type/:id - GETList Compute instance Types
/instance-type
template
- GETRetrieve Template details
/template/:id - PUTUpdate template attributes
/template/:id - POSTCopy a Template from a zone to another
/template/:id - DELETEDelete a Template
/template/:id - GETList Templates
/template - POSTRegister a Template
/template
network-load-balancer
- GETRetrieve Load Balancer Service details
/load-balancer/:id/service/:service-id - PUTUpdate a Load Balancer Service
/load-balancer/:id/service/:service-id - DELETEDelete a Load Balancer Service
/load-balancer/:id/service/:service-id - GETList Load Balancers
/load-balancer - POSTCreate a Load Balancer
/load-balancer - DELETEReset a Load Balancer field to its default value
/load-balancer/:id/:field - DELETEReset a Load Balancer Service field to its default value
/load-balancer/:id/service/:service-id/:field - POSTAdd a Load Balancer Service
/load-balancer/:id/service - GETRetrieve Load Balancer details
/load-balancer/:id - PUTUpdate a Load Balancer
/load-balancer/:id - DELETEDelete a Load Balancer
/load-balancer/:id
environmental-impact
- POST[BETA] Get an estimate of the impact of using products
/environmental-impact/estimate[BETA] Returns an estimate of the impact of a unit of usage of one or more products, e.g. the impact of using a standard medium instance for one hour in… - GET[BETA] Get an environmental impact report
/environmental-impact/report[BETA] Returns a breakdown of the impact of your organization's usage over the given period
kms-key
- POSTDisable Key Rotation
/kms-key/:id/disable-key-rotationDisable the periodic rotation of a KMS Key. - GETGet KMS Key
/kms-key/:idRetrieve KMS Key details. - POSTEnable KMS Key
/kms-key/:id/enableEnables a KMS Key by setting its state to "enabled". It restores the ability to fully use the KMS key for cryptographic operations and key lifecycle operations. - GETList KMS Key Rotations
/kms-key/:id/list-key-rotationsList all the key material versions of a KMS Key. - POSTEnable Key Rotation
/kms-key/:id/enable-key-rotationEnable the periodic rotation of a KMS Key. - POSTRotate Key
/kms-key/:id/rotatePerforms an immediate rotation of the key material for a symmetric key. - POSTDisable KMS Key
/kms-key/:id/disableDisables a KMS Key by setting its state to "disabled". This prevents the use of the KMS key for cryptographic and key lifecycle operations. - GETList KMS Keys
/kms-keyLists all KMS Keys in your organization in a given zone. - POSTCreate KMS Key
/kms-keyCreate a customer-managed unique KMS Key in your organization. A KMS Key is a logical representation of a cryptographic key material. It also includes… - POSTSchedule KMS Key Deletion
/kms-key/:id/schedule-deletionSchedules a KMS key for deletion after a delay. You can specify a delay of 7-30 days. - POSTReplicate KMS Key
/kms-key/:id/replicateReplicate a KMS key to a target zone. - POSTCancel KMS Key Deletion
/kms-key/:id/cancel-deletionCancels the scheduled deletion of a KMS Key.
ssh-key
- GETRetrieve SSH key details
/ssh-key/:name - DELETEDelete a SSH key
/ssh-key/:name - GETList SSH keys
/ssh-key - POSTImport SSH key
/ssh-key
instance-pool
- PUTScale an Instance Pool
/instance-pool/:id:scale - GETList Instance Pools
/instance-pool - POSTCreate an Instance Pool
/instance-pool - GETRetrieve Instance Pool details
/instance-pool/:id - PUTUpdate an Instance Pool
/instance-pool/:id - DELETEDelete an Instance Pool
/instance-pool/:id - DELETEReset an Instance Pool field to its default value
/instance-pool/:id/:field - PUTEvict Instance Pool members
/instance-pool/:id:evictThis operation evicts the specified Compute instances member from the Instance Pool, shrinking it to <current pool size> - <# evicted members>.
sos
- GETList SOS Buckets Usage
/sos-buckets-usage - GETRetrieve Presigned Download URL for SOS object
/sos/:bucket/presigned-urlGenerates Presigned Download URL for SOS object
vpc-route
- GETList VPC routes
/vpc/:vpc-id/route - GETList Subnet routes
/vpc/:vpc-id/subnet/:subnet-id/route - POSTCreate a route
/vpc/:vpc-id/subnet/:subnet-id/route - DELETEDelete a route
/vpc/:vpc-id/subnet/:subnet-id/route/:id
snapshot
- POSTExport a Snapshot
/snapshot/:id:export - GETRetrieve Snapshot details
/snapshot/:id - DELETEDelete a Snapshot
/snapshot/:id - GETList Snapshots
/snapshot - POSTPromote a Snapshot to a Template
/snapshot/:id:promote
security-group
- DELETEDelete a Security Group rule
/security-group/:id/rules/:rule-id - GETList Security Groups.
/security-groupLists security groups. When visibility is set to public, lists public security groups. Public security groups are objects maintained by Exoscale which contain… - POSTCreate a Security Group
/security-group - GETRetrieve Security Group details
/security-group/:id - DELETEDelete a Security Group
/security-group/:id - PUTAttach a Compute instance to a Security Group
/security-group/:id:attach - POSTCreate a Security Group rule
/security-group/:id/rules - PUTRemove an external source from a Security Group
/security-group/:id:remove-source - PUTDetach a Compute instance from a Security Group
/security-group/:id:detach - PUTAdd an external source as a member of a Security Group
/security-group/:id:add-source
event
- GETList Events
/eventRetrieve Mutation Events for a given date range. Defaults to retrieving Events for the past 24 hours. Both a from and to arguments can be specified to filter…
block-storage
- PUTAttach block storage volume to an instance
/block-storage/:id:attach - GETRetrieve block storage snapshot details
/block-storage-snapshot/:id - PUTUpdate block storage volume snapshot
/block-storage-snapshot/:id - DELETEDelete a block storage snapshot, data will be unrecoverable
/block-storage-snapshot/:id - GETRetrieve block storage volume details
/block-storage/:id - PUTUpdate block storage volume
/block-storage/:id - DELETEDelete a block storage volume, data will be unrecoverable
/block-storage/:id
Showing 300 of 385 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://api-{zone}.exoscale.com/v2- Authentication
- None declared in the description
- Operations
- 385 operations on 271 pathsGET 139POST 93PUT 90DELETE 62PATCH 1
- Main resources
- dbaas 147instance 20cluster 18block-storage 13kms-key 12network-load-balancer 11security-group 10deployment 9private-network 9elastic-ip 8
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
2.0.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Exoscale's published OpenAPI description (exoscale/egoscale) (Apache-2.0)
How to test the Exoscale API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Exoscale API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “[BETA] Request generation of key/secret that allow caller to assume target role” (POST /iam-role/:id/assume), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Exoscale API?
Infrastructure automation API, allowing programmatic access to all Exoscale products and services. It is listed under Developer tools and has 385 endpoints.
Who publishes the Exoscale API?
It is listed from Exoscale's public API description (an OpenAPI document), not published by Exoscale on Swastik Codes. Anyone who controls exoscale.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Exoscale API?
Requests go to https://api-{zone}.exoscale.com/v2. Endpoint paths are added to this base URL.
How do I authenticate with the Exoscale API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Exoscale API have?
385 operations on 271 paths (139 GET, 93 POST, 90 PUT, 62 DELETE, 1 PATCH). The largest groups are dbaas, instance, cluster, block-storage.
Is forking the Exoscale API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.