Scaleway logo
Managed MongoDB®
Managed MongoDB®

Snapshots

Download schema

A snapshot is a consistent, instantaneous copy of the Block Storage volume of your Database Instance at a certain point in time.

List snapshots

GET
https://api.scaleway.com
/mongodb/v1/regions/{region}/snapshots

List snapshots. You can include the instance_id or project_id in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.

List snapshots › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par

List snapshots › query Parameters

instance_id
​string

Instance ID the snapshots belongs to.

name
​string

Lists database snapshots that match a name pattern.

Criteria to use when ordering snapshot listings.

Enum values:
created_at_asc
created_at_desc
name_asc
name_desc
expires_at_asc
expires_at_desc
Default: created_at_asc
organization_id
​string

Organization ID the snapshots belongs to.

project_id
​string

Project ID to list the snapshots of.

page
​integer · int32
page_size
​integer · uint32

List snapshots › Responses

200
scaleway.mongodb.v1.ListSnapshotsResponse

List of all database snapshots available in an Organization or Project.

total_count
​integer · uint64

Total count of database snapshots available in a Organization or Project.

Create a Database Instance snapshot

POST
https://api.scaleway.com
/mongodb/v1/regions/{region}/snapshots

Create a new snapshot of a Database Instance. You must define the name and instance_id parameters in the request.

Create a Database Instance snapshot › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par

Create a Database Instance snapshot › Request Body

instance_id
​string · required

UUID of the Database Instance to snapshot.

name
​string

Name of the snapshot.

expires_at
​string | null · date-time

Expiration date of the snapshot (must follow the ISO 8601 format). (RFC 3339 format)

Create a Database Instance snapshot › Responses

200
scaleway.mongodb.v1.Snapshot
id
​string

UUID of the snapshot. (UUID format)

instance_id
​string | null

UUID of the Database Instance. (UUID format)

name
​string

Name of the snapshot.

Status of the snapshot.

Enum values:
unknown_status
creating
ready
restoring
deleting
error
locked
Default: unknown_status
size_bytes
​integer · uint64

Size of the snapshot. (in bytes)

expires_at
​string | null · date-time

Expiration date (must follow the ISO 8601 format). (RFC 3339 format)

created_at
​string | null · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

updated_at
​string | null · date-time

Updated date (must follow the ISO 8601 format). (RFC 3339 format)

instance_name
​string

Name of the Database Instance of the snapshot.

node_type
​string

Source node type.

volume_type
​scaleway.mongodb.v1.Volume.Type · enum

Type of volume where data is stored - sbs_5k or sbs_15k.

Enum values:
unknown_type
sbs_5k
sbs_15k
Default: unknown_type
region
​string

Region of the snapshot.

Get a Database Instance snapshot

GET
https://api.scaleway.com
/mongodb/v1/regions/{region}/snapshots/{snapshot_id}

Retrieve information about a given snapshot of a Database Instance. You must specify, in the endpoint, the snapshot_id parameter of the snapshot you want to retrieve.

Get a Database Instance snapshot › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
snapshot_id
​string · required

UUID of the snapshot.

Get a Database Instance snapshot › Responses

200
scaleway.mongodb.v1.Snapshot
id
​string

UUID of the snapshot. (UUID format)

instance_id
​string | null

UUID of the Database Instance. (UUID format)

name
​string

Name of the snapshot.

Status of the snapshot.

Enum values:
unknown_status
creating
ready
restoring
deleting
error
locked
Default: unknown_status
size_bytes
​integer · uint64

Size of the snapshot. (in bytes)

expires_at
​string | null · date-time

Expiration date (must follow the ISO 8601 format). (RFC 3339 format)

created_at
​string | null · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

updated_at
​string | null · date-time

Updated date (must follow the ISO 8601 format). (RFC 3339 format)

instance_name
​string

Name of the Database Instance of the snapshot.

node_type
​string

Source node type.

volume_type
​scaleway.mongodb.v1.Volume.Type · enum

Type of volume where data is stored - sbs_5k or sbs_15k.

Enum values:
unknown_type
sbs_5k
sbs_15k
Default: unknown_type
region
​string

Region of the snapshot.

Delete a Database Instance snapshot

DELETE
https://api.scaleway.com
/mongodb/v1/regions/{region}/snapshots/{snapshot_id}

Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the snapshot_id parameter of the snapshot you want to delete.

Delete a Database Instance snapshot › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
snapshot_id
​string · required

UUID of the snapshot.

Delete a Database Instance snapshot › Responses

200
scaleway.mongodb.v1.Snapshot
id
​string

UUID of the snapshot. (UUID format)

instance_id
​string | null

UUID of the Database Instance. (UUID format)

name
​string

Name of the snapshot.

Status of the snapshot.

Enum values:
unknown_status
creating
ready
restoring
deleting
error
locked
Default: unknown_status
size_bytes
​integer · uint64

Size of the snapshot. (in bytes)

expires_at
​string | null · date-time

Expiration date (must follow the ISO 8601 format). (RFC 3339 format)

created_at
​string | null · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

updated_at
​string | null · date-time

Updated date (must follow the ISO 8601 format). (RFC 3339 format)

instance_name
​string

Name of the Database Instance of the snapshot.

node_type
​string

Source node type.

volume_type
​scaleway.mongodb.v1.Volume.Type · enum

Type of volume where data is stored - sbs_5k or sbs_15k.

Enum values:
unknown_type
sbs_5k
sbs_15k
Default: unknown_type
region
​string

Region of the snapshot.

Update a Database Instance snapshot

PATCH
https://api.scaleway.com
/mongodb/v1/regions/{region}/snapshots/{snapshot_id}

Update the parameters of a snapshot of a Database Instance. You can update the name and expires_at parameters.

Update a Database Instance snapshot › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
snapshot_id
​string · required

UUID of the Snapshot.

Update a Database Instance snapshot › Request Body

name
​string | null

Name of the snapshot.

expires_at
​string | null · date-time

Expiration date of the snapshot (must follow the ISO 8601 format). (RFC 3339 format)

Update a Database Instance snapshot › Responses

200
scaleway.mongodb.v1.Snapshot
id
​string

UUID of the snapshot. (UUID format)

instance_id
​string | null

UUID of the Database Instance. (UUID format)

name
​string

Name of the snapshot.

Status of the snapshot.

Enum values:
unknown_status
creating
ready
restoring
deleting
error
locked
Default: unknown_status
size_bytes
​integer · uint64

Size of the snapshot. (in bytes)

expires_at
​string | null · date-time

Expiration date (must follow the ISO 8601 format). (RFC 3339 format)

created_at
​string | null · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

updated_at
​string | null · date-time

Updated date (must follow the ISO 8601 format). (RFC 3339 format)

instance_name
​string

Name of the Database Instance of the snapshot.

node_type
​string

Source node type.

volume_type
​scaleway.mongodb.v1.Volume.Type · enum

Type of volume where data is stored - sbs_5k or sbs_15k.

Enum values:
unknown_type
sbs_5k
sbs_15k
Default: unknown_type
region
​string

Region of the snapshot.

Restore a Database Instance snapshot

POST
https://api.scaleway.com
/mongodb/v1/regions/{region}/snapshots/{snapshot_id}/restore

Restore a given snapshot of a Database Instance. You must specify, in the endpoint, the snapshot_id parameter of the snapshot you want to restore, the instance_name of the new Database Instance, node_type of the new Database Instance and node_amount of the new Database Instance.

Restore a Database Instance snapshot › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
snapshot_id
​string · required

UUID of the snapshot.

Restore a Database Instance snapshot › Request Body

instance_name
​string · required

Name of the new Database Instance.

node_type
​string · required

Node type to use for the new Database Instance.

node_amount
​integer · uint32 · required

Number of nodes to use for the new Database Instance.

volume_type
​scaleway.mongodb.v1.Volume.Type · enum · required

Instance volume type.

Enum values:
unknown_type
sbs_5k
sbs_15k
Default: unknown_type

Restore a Database Instance snapshot › Responses

200
scaleway.mongodb.v1.Instance
id
​string

UUID of the Database Instance. (UUID format)

name
​string

Name of the Database Instance.

project_id
​string

Project ID the Database Instance belongs to. (UUID format)

organization_id
​string

Organization ID the Database Instance belongs to. (UUID format)

Status of the Database Instance.

Enum values:
unknown_status
ready
provisioning
configuring
deleting
error
initializing
locked
Default: unknown_status
version
​string

MongoDB® major engine version of the Database Instance.

tags
​string[]

List of tags applied to the Database Instance.

node_amount
​integer · uint32

Number of node in the Database Instance.

node_type
​string

Node type of the Database Instance.

Volumes of the Database Instance.

List of Database Instance endpoints.

created_at
​string | null · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

region
​string

Region the Database Instance is in.

Snapshot schedule configuration of the Database Instance.

List of settings applied to the Database Instance.

List of pending maintenances applicable to the Database Instance.

upgradable_versions
​string[]

List of MongoDB® versions the Database Instance can be upgraded to.

MongoDB® VersionsUsers