canonical: https://jentic.com/apis/scaleway.com/scaleway

# Scaleway Instance API

Scaleway Instances are virtual machines in the cloud. Different [Instance types](https://www.scaleway.com/en/docs/instances/reference-content/choosing-instance-type/) offer different technical specifications in terms of vCPU, RAM, bandwidth and storage. Once you have created your Instance and installed your image of choice (e.g. an operating system), you can [connect to your Instance via SSH](http. The API exposes 76 endpoints secured with apiKey authentication.

## For AI agents

Programmatically migrate a volume and/or snapshots to sbs (scaleway block storage), checkblockmigrationorganizationquotas. Covers 76 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for cloud infrastructure only.

## Capabilities

- Migrate a volume and/or snapshots to SBS (Scaleway Block Storage)
- checkblockmigrationorganizationquotas
- Get a volume or snapshot's migration plan
- Create an Instance image
- List Instance images
- Update image

## Use cases

### Cloud Infrastructure Operations

Use the Instance API to perform cloud infrastructure operations programmatically. The API provides 76 endpoints covering core functionality including migrate a volume and/or snapshots to sbs (scaleway block storage), checkblockmigrationorganizationquotas, get a volume or snapshot's migration plan.

Example prompt: Call POST /instance/v1/zones/{zone}/block-migration/apply to migrate a volume and/or snapshots to sbs (scaleway block storage)

### Automated Instances Management

Automate instances operations by combining multiple Instance API endpoints. Agents can checkblockmigrationorganizationquotas and then get a volume or snapshot's migration plan in a single workflow.

Example prompt: Call POST /instance/v1/zones/{zone}/block-migration/check-organization-quotas to checkblockmigrationorganizationquotas, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Instance API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'migrate a volume and/or snapshots to sbs (scaleway block storage)', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /instance/v1/zones/{zone}/block-migration/apply | Migrate a volume and/or snapshots to SBS (Scaleway Block Storage) |
| POST | /instance/v1/zones/{zone}/block-migration/check-organization-quotas | checkblockmigrationorganizationquotas |
| POST | /instance/v1/zones/{zone}/block-migration/plan | Get a volume or snapshot's migration plan |
| GET | /instance/v1/zones/{zone}/dashboard | getdashboard |
| POST | /instance/v1/zones/{zone}/images | Create an Instance image |
| GET | /instance/v1/zones/{zone}/images | List Instance images |
| PUT | /instance/v1/zones/{zone}/images/{id} | Update image |
| GET | /instance/v1/zones/{zone}/images/{image_id} | Get an Instance image |

## Key resources

- **Instances** — Instances are computing units providing resources to run your applications on.
Scaleway offers vario
- **Images** — Images are backups of your Instances.
One image will contain all the volumes of your Instance and ca
- **Security Groups** — A security group is a set of firewall rules on a set of Instances.
Security groups enable you to cre
- **User Data** — User data is a key/value store you can use to provide your instance with introspective data.

As an
- **Instance Types** — All Instance types available in a specified zone.
Each type contains all the features of the Instanc

## Why Jentic

- **Setup:** Wiring the Scaleway Instance API by hand means passing your key in the X-Auth-Token header, threading the zone into every path, and managing image and migration ids yourself. Through Jentic you install once, import the Instance API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** Scaleway puts the zone and image id in the URL path (/instance/v1/zones/{zone}/images/{id}), so a rule can pin your agent to one image in one zone. You choose the operations it may call, so a write like updating an image or applying a block migration is not included unless you add it alongside the reads.
- **Credential handling:** Your Scaleway API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list instance images in a zone' or 'read the zone dashboard', and Jentic returns the matching Instance API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Amazonaws** — Alternative cloud infrastructure API
- **Azure** — Alternative cloud infrastructure API
- **Googleapis** — Complementary cloud infrastructure API
- **Digitalocean** — Complementary cloud infrastructure API

## FAQ

### What authentication does the Instance API use?

The Instance API uses an API key passed in the `X-Auth-Token` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I migrate a volume and/or snapshots to sbs (scaleway block storage) with the Instance API?

Yes. Use the POST /instance/v1/zones/{zone}/block-migration/apply endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Instance API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I migrate a volume and/or snapshots to sbs (scaleway block storage) through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'migrate a volume and/or snapshots to sbs (scaleway block storage)'. Jentic returns the matching Instance API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Instance API have?

The Instance API exposes 76 endpoints covering instances, images, security groups operations.

### Can I limit what my agent is allowed to do with the Instance API?

Yes. Because you run Jentic One yourself, your own rules decide which Instance API operations and credentials the agent may use. Scaleway puts the zone and image id in the URL path, such as /instance/v1/zones/{zone}/images/{id}, so a rule can pin the agent to one image in one zone. You choose the operations it may call, so a write like updating an image or applying a block migration stays out of reach unless you add it alongside the read operations.