Scaleway Managed Database for MongoDB® API (original) (raw)

Introduction

Database Instances

A Managed MongoDB® Database Instance is composed of one or multiple dedicated compute nodes running a single database engine.

GET`

/mongodb/v1/regions/{region}/instances

`

POST`

/mongodb/v1/regions/{region}/instances

`

GET`

/mongodb/v1/regions/{region}/instances/{instance_id}

`

PATCH`

/mongodb/v1/regions/{region}/instances/{instance_id}

`

DELETE`

/mongodb/v1/regions/{region}/instances/{instance_id}

`

GET`

/mongodb/v1/regions/{region}/instances/{instance_id}/certificate

`

POST`

/mongodb/v1/regions/{region}/instances/{instance_id}/upgrade

`

Node Types

Two node type ranges are available:

• Shared vCPU: a complete and highly reliable node range with shared resources that is made for scaling from development to production needs, at affordable prices.
• Dedicated vCPU: database nodes with dedicated vCPU for the most demanding workloads and mission-critical applications.

GET`

/mongodb/v1/regions/{region}/node-types

`

MongoDB® Versions

A database engine is the core software that handles the storage, retrieval, and management of data in your Database Instance.

GET`

/mongodb/v1/regions/{region}/versions

`

Snapshots

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

GET`

/mongodb/v1/regions/{region}/snapshots

`

POST`

/mongodb/v1/regions/{region}/snapshots

`

GET`

/mongodb/v1/regions/{region}/snapshots/{snapshot_id}

`

PATCH`

/mongodb/v1/regions/{region}/snapshots/{snapshot_id}

`

DELETE`

/mongodb/v1/regions/{region}/snapshots/{snapshot_id}

`

POST`

/mongodb/v1/regions/{region}/snapshots/{snapshot_id}/restore

`

Users

Users are profiles to which you can attribute database-level permissions. They allow you to define permissions specific to each type of database usage.

PUT`

/mongodb/v1/regions/{region}/instances/{instance_id}/set-user-roles

`

GET`

/mongodb/v1/regions/{region}/instances/{instance_id}/users

`

POST`

/mongodb/v1/regions/{region}/instances/{instance_id}/users

`

PATCH`

/mongodb/v1/regions/{region}/instances/{instance_id}/users/{name}

`

DELETE`

/mongodb/v1/regions/{region}/instances/{instance_id}/users/{name}

`

Instance Endpoints

Instance endpoints enable connection to your instance.

POST`

/mongodb/v1/regions/{region}/endpoints

`

DELETE`

/mongodb/v1/regions/{region}/endpoints/{endpoint_id}

`

Databases

Databases can be used to store and manage sets of information, or data. The interaction between the user and a database is done using a database engine, which provides a query language to add, modify, or delete information from the database.

GET`

/mongodb/v1/regions/{region}/instances/{instance_id}/databases

`