API

  • API Endpoint
    ? api.scaleway.com
  • Authentication
    X-Auth-Token
  • Request & Response Formats
    JSON based
  • TLS Support
    Yes
  • OpenAPI Specification
    v3
  • HTTP Status Code
    2xx, 4xx, 5xx
Cloud resellers
On-demand provisioning
Custom scaling strategies
Available Regions
  • PAR
  • AMS
  • WAW
  • Full-ecosystem compatibility
  • Access alpha features
  • Extensive documentation
Free tool

Most Used Resources

  • Virtual Instances
  • Bare Metal Servers
  • Object Storage
  • Load Balancers
  • Kubernetes Clusters
  • Databases
  • Container Registries
  • IoT Hub

The Public Interface for developers

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 access through a single endpoint: api.scaleway.com. Each endpoint follows this pattern:

api.scaleway.com/{product}/{version}/...

Please, see below for some examples.

Region and Zone

Scaleway’s products are deployed across multiple data-centers in the world.

For performance and legal reasons, some products are split by Region or by Availability Zones. When using such a product, you can choose the location that best fits your needs (country, latency, …).

24/7 Ticket Support

We ensure your services are always up and running. Our technical assistance is available 24 hours a day, 7 days a week to answer all your questions and to assist you. Simply open a new ticket in case of a problem. You can also reach our support directly by phone or to get faster responses if you upgrade your support plan.

API basic commands

Integrate Scaleway ecosystem with your solutions

$

Popular use cases

Cloud Resellers

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.

On-demand provisioning

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.

Fine-tune your scaling strategies

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.

Want to understand what is behind Scaleway APIs?

WEBINAR | The odyssey of an HTTP request in Scaleway | Intermediate level

You have a project? Call us:

Discover our compute resources you can pilot from the public API

Frequently Asked Questions

What is Scaleway API?

Scaleway API is the Scaleway public interface for your to pilot your cloud ressources without the Scaleway console. API is the acronym for Application Programming Interface. You can get informations about your infrastructure, create instances, perform backups and much more with just few HTTP(S) requests.

Do any features not available in the console exist with API?

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.

How to allow access to the API?

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.

How can I talk with the API team?

Feel free to join the Scaleway Community Slack. We can be found hanging out on the #opensource and #cli channels.

What is the difference between the CLI and the API?

The Command Line Interface (CLI) is a 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

Need more information?

You have a project? Call us: