API
Understanding APIs
Full-ecosystem compatibility
Scaleway’s APIs are a key part of the Scaleway Ecosystem: anything you can do from the web console can be done through APIs. Therefore, APIs give you access to all Scaleway products, including storage, compute, and much more.
Accessing Cloud APIs
Scaleway APIs can be accessed via conventional HTTP requests or via the provided client library.
We use conventional HTTP response codes to indicate the success or failure of an API request.
Authentication
Each request made to Scaleway APIs must be authenticated. Scaleway APIs handle this with a X-Auth-Token HTTP header that must be provided with the request.
Endpoints
Every Scaleway API can be accessed through a single endpoint: api.scaleway.com. Each endpoint follows this pattern: api.scaleway.com/{product}/{version}/…
The Public Interface for developers
Popular use cases
By integrating Scaleway APIs into a cloud reseller interface, you can provision and start selling cloud resources through the API calls. Resell virtual instances, storage or any cloud product through your own white-labelled platform.
Pilot your entire infrastructure directly from your information system or your own devOps interfaces. Additionally, when provisioning infrastructure resources using the Cloud Providers’ APIs, it is easier to develop a multi-cloud strategy.
Some use cases require some time spent on writing advanced scripts using the public APIs that will automatically create or delete instances, or add or remove storage to an application based on custom metrics.
API basic commands
Scaleway- 1$
- 2
- 3
Frequently asked questions
Scaleway API is the Scaleway public interface for you to pilot your cloud resources without the Scaleway console. API is the acronym for Application Programming Interface. You can get information about your infrastructure, create instances, perform backups and much more with just a few HTTP(S) requests.
To use the API, you need at least to retrieve your SECRET_KEY (or TOKEN). You can use the console to retrieve these API credentials. Just navigate under the credentials tab in your project’s dashboard and generate a new API key.
Yes. All new features are first integrated to be compatible with the public API and then available in the console. This means you can also have access to features not yet available in the console but already integrated with the public API.
The Command Line Interface (CLI) is the software you use on a terminal that is supposed to be more intuitive. Behind the CLI is an API request (see the technical diagram above).
With the CLI you would use the following command:
scw instance server list
Whereas the API call looks like this:
curl -H "X-Auth-Token: $TOKEN" https://api.scaleway.com/instance/v1/zones/fr-par-1/servers
Feel free to join the Scaleway Community Slack. We can be found hanging out on the #opensource and #cli channels.