How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Scaleway Snapshots API

A snapshot is a consistent, instantaneous copy of the Block Storage volume of your Database Instance at a certain point in time. They are designed to recover your data in case of failure or accidental alterations of the data by a user. They allow you to quickly create a new Instance from a previous state of your database, regardless of the size of the volume. Their limitation is that, unlike backups, snapshots can only be stored in the same location as the original data.

Scaleway Snapshots API is one of 74 APIs that Scaleway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Snapshots. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 7 paths, and defines 23 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://api.scaleway.com.

13 operations 7 paths 23 schemas 2 DELETE4 GET2 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Server
https://api.scaleway.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Scaleway Snapshots API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (scaleway).

Paths & Operations 13

Across 7 paths, the API surfaces 13 operations — 2 DELETE, 4 GET, 2 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Snapshots 13

A snapshot is a consistent, instantaneous copy of the Block Storage volume of your Database Instance at a certain point in time. They are designed to recover your data in case of…

POST
/rdb/v1/regions/{region}/instances/{instance_id}/snapshots
Create a Database Instance snapshot
CreateSnapshot 2 params body → 200
GET
/rdb/v1/regions/{region}/snapshots
List snapshots
ListSnapshots 8 params → 200
GET
/rdb/v1/regions/{region}/snapshots/{snapshot_id}
Get a Database Instance snapshot
GetSnapshot 2 params → 200
PATCH
/rdb/v1/regions/{region}/snapshots/{snapshot_id}
Update a Database Instance snapshot
UpdateSnapshot 2 params body → 200
DELETE
/rdb/v1/regions/{region}/snapshots/{snapshot_id}
Delete a Database Instance snapshot
DeleteSnapshot 2 params → 200
POST
/rdb/v1/regions/{region}/snapshots/{snapshot_id}/create-instance
Create a new Database Instance from a snapshot
CreateInstanceFromSnapshot 2 params body → 200
GET
/instance/v1/zones/{zone}/snapshots
List snapshots
ListSnapshots 8 params → 200
POST
/instance/v1/zones/{zone}/snapshots
Create a snapshot from a specified volume or from a QCOW2 file
CreateSnapshot 1 param body → 201
GET
/instance/v1/zones/{zone}/snapshots/{snapshot_id}
Get a snapshot
GetSnapshot 2 params → 200
PUT
/instance/v1/zones/{zone}/snapshots/{snapshot_id}
Set snapshot
SetSnapshot 2 params body → 200
PATCH
/instance/v1/zones/{zone}/snapshots/{snapshot_id}
Update a snapshot
UpdateSnapshot 2 params body → 200
DELETE
/instance/v1/zones/{zone}/snapshots/{snapshot_id}
Delete a snapshot
DeleteSnapshot 2 params → 204
POST
/instance/v1/zones/{zone}/snapshots/{snapshot_id}/export
Export a snapshot
ExportSnapshot 2 params body → 200

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are scaleway.rdb.v1.Instance (23 properties), scaleway.instance.v1.Snapshot (13 properties), scaleway.rdb.v1.Snapshot (12 properties), scaleway.instance.v1.Task (9 properties). Each schema is shown below with its type and property counts.

scaleway.rdb.v1.Snapshot
object
12 properties
scaleway.instance.v1.CreateSnapshotResponse
object
2 properties
google.protobuf.Int32Value
integer
scaleway.instance.v1.Snapshot.BaseVolume
object
2 properties
scaleway.rdb.v1.InstanceSetting
object
2 properties
scaleway.instance.v1.Volume.VolumeType
string
scaleway.instance.v1.SetSnapshotResponse
object
1 property
scaleway.instance.v1.Task
object
9 properties
scaleway.rdb.v1.StorageClass
string
scaleway.instance.v1.ExportSnapshotResponse
object
1 property
scaleway.rdb.v1.Instance
object
23 properties
scaleway.std.StringsValue
array
scaleway.rdb.v1.ListSnapshotsResponse
object
2 properties
scaleway.rdb.v1.Maintenance
object
7 properties
scaleway.rdb.v1.UpgradableVersion
object
4 properties
scaleway.instance.v1.UpdateSnapshotResponse
object
1 property
scaleway.rdb.v1.Volume.Type
string
scaleway.instance.v1.Snapshot
object
13 properties
scaleway.instance.v1.GetSnapshotResponse
object
1 property
scaleway.instance.v1.ListSnapshotsResponse
object
1 property
scaleway.rdb.v1.Endpoint
object
8 properties
scaleway.instance.v1.Snapshot.State
string
scaleway.rdb.v1.ReadReplica
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scaleway-snapshots-api-openapi.yml Raw ↑

Other APIs Scaleway publishes across the network.

Scaleway Generative APIs
Scaleway Access Control List API
Scaleway ACLs API
Scaleway Alert Subscribers API
Scaleway API Keys API
Scaleway Applications API
Scaleway Backends API
Scaleway Backups API
Scaleway Blocklist API
Scaleway Certificate API
Scaleway Cluster types API
Scaleway Clusters API
Where this information came from

This is an independent, third-party profile of Scaleway Snapshots API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.