Skip to content

Documentation for scw mongodb

This API allows you to manage your Managed Databases for MongoDB®.

Endpoint management commands

Instance endpoints enable connection to your instance.

Create a new Instance endpoint

Create a new endpoint for a MongoDB® Database Instance. You can add public_network or private_network specifications to the body of the request.

Usage:

scw mongodb endpoint create <instance-id ...> [arg=value ...]

Args:

Name Description
instance-id Required UUID of the Database Instance
endpoint.private-network.private-network-id UUID of the Private Network
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

Delete a Database Instance endpoint

Delete the endpoint of a Database Instance. You must specify the endpoint_id parameter of the endpoint you want to delete. Note that you might need to update any environment configurations that point to the deleted endpoint.

Usage:

scw mongodb endpoint delete <endpoint-id ...> [arg=value ...]

Args:

Name Description
endpoint-id Required UUID of the Endpoint to delete
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

Instance management commands

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

Create a MongoDB® Database Instance

Create a new MongoDB® Database Instance.

Usage:

scw mongodb instance create [arg=value ...]

Args:

Name Description
project-id Project ID to use. If none is passed the default project ID will be used
name Default: <generated> Name of the Database Instance
version Required
Default: ``		 Version of the MongoDB® engine
tags.{index} Tags to apply to the Database Instance
node-number Required
Default: 1		 Number of node to use for the Database Instance
node-type Required Type of node to use for the Database Instance
user-name Required Username created when the Database Instance is created
password Required Password of the initial user
volume.volume-size Default: 5GB Volume size
volume.volume-type Default: sbs_5k
One of: unknown_type, sbs_5k, sbs_15k		 Type of volume where data is stored
endpoints.{index}.private-network.private-network-id UUID of the Private Network
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

Delete a MongoDB® Database Instance

Delete a given MongoDB® Database Instance, specified by the region and instance_id parameters. Deleting a MongoDB® Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.

Usage:

scw mongodb instance delete <instance-id ...> [arg=value ...]

Args:

Name Description
instance-id Required UUID of the Database Instance to delete
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

Get a MongoDB® Database Instance

Retrieve information about a given MongoDB® Database Instance, specified by the region and instance_id parameters. Its full details, including name, status, IP address and port, are returned in the response object.

Usage:

scw mongodb instance get <instance-id ...> [arg=value ...]

Args:

Name Description
instance-id Required UUID of the Database Instance
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

Get the certificate of a Database Instance

Retrieve the certificate of a given Database Instance, specified by the instance_id parameter.

Usage:

scw mongodb instance get-certificate <instance-id ...> [arg=value ...]

Args:

Name Description
instance-id Required UUID of the Database Instance
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

List MongoDB® Database Instances

List all MongoDB® Database Instances in the specified region. By default, the MongoDB® Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as tags and name. For the name parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.

Usage:

scw mongodb instance list [arg=value ...]

Args:

Name Description
tags.{index} List Database Instances that have a given tag
name Lists Database Instances that match a name pattern
order-by One of: created_at_asc, created_at_desc, name_asc, name_desc, status_asc, status_desc Criteria to use when ordering Database Instance listings
project-id Project ID
organization-id Organization ID of the Database Instance
region Default: fr-par
One of: fr-par, all		 Region to target. If none is passed will use default region from the config

Update a MongoDB® Database Instance

Update the parameters of a MongoDB® Database Instance.

Usage:

scw mongodb instance update <instance-id ...> [arg=value ...]

Args:

Name Description
instance-id Required UUID of the Database Instance to update
name Name of the Database Instance
tags.{index} Tags of a Database Instance
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

Upgrade a Database Instance

Upgrade your current Database Instance specifications like volume size.

Usage:

scw mongodb instance upgrade <instance-id ...> [arg=value ...]

Args:

Name Description
instance-id Required UUID of the Database Instance you want to upgrade
volume-size Increase your Block Storage volume size
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

Wait for an instance to reach a stable state

Wait for an instance to reach a stable state. This is similar to using --wait flag.

Usage:

scw mongodb instance wait <instance-id ...> [arg=value ...]

Args:

Name Description
instance-id Required ID of the instance you want to wait for.
region Default: fr-par
One of: fr-par, nl-ams		 Region to target. If none is passed will use default region from the config
timeout Default: 20m0s Timeout of the wait

Examples:

Wait for an instance to reach a stable state 

scw mongodb instance wait 11111111-1111-1111-1111-111111111111

Node types management commands

Two node type ranges are available:

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

List available node types

List available node types.

Usage:

scw mongodb node-type list [arg=value ...]

Args:

Name Description
include-disabled-types Defines whether or not to include disabled types
region Default: fr-par
One of: fr-par, all		 Region to target. If none is passed will use default region from the config

Snapshot management commands

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

Create a Database Instance snapshot

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

Usage:

scw mongodb snapshot create <instance-id ...> [arg=value ...]

Args:

Name Description
instance-id Required UUID of the Database Instance to snapshot
name Name of the snapshot
expires-at Expiration date of the snapshot (must follow the ISO 8601 format)
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

Delete a Database Instance snapshot

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.

Usage:

scw mongodb snapshot delete <snapshot-id ...> [arg=value ...]

Args:

Name Description
snapshot-id Required UUID of the snapshot
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

Get a Database Instance snapshot

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.

Usage:

scw mongodb snapshot get <snapshot-id ...> [arg=value ...]

Args:

Name Description
snapshot-id Required UUID of the snapshot
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

List 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.

Usage:

scw mongodb snapshot list [arg=value ...]

Args:

Name Description
instance-id Instance ID the snapshots belongs to
name Lists database snapshots that match a name pattern
order-by One of: created_at_asc, created_at_desc, name_asc, name_desc, expires_at_asc, expires_at_desc Criteria to use when ordering snapshot listings
project-id Project ID to list the snapshots of
organization-id Organization ID the snapshots belongs to
region Default: fr-par
One of: fr-par, all		 Region to target. If none is passed will use default region from the config

Restore a Database Instance snapshot

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_number of the new Database Instance.

Usage:

scw mongodb snapshot restore <snapshot-id ...> [arg=value ...]

Args:

Name Description
snapshot-id Required UUID of the snapshot
instance-name Required Name of the new Database Instance
node-type Required Node type to use for the new Database Instance
node-number Required Number of nodes to use for the new Database Instance
volume.volume-type One of: unknown_type, sbs_5k, sbs_15k Type of volume where data is stored
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

Update a Database Instance snapshot

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

Usage:

scw mongodb snapshot update <snapshot-id ...> [arg=value ...]

Args:

Name Description
snapshot-id Required UUID of the Snapshot
name Name of the snapshot
expires-at Expiration date of the snapshot (must follow the ISO 8601 format)
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

User management commands

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

Create an user on a Database Instance

Create an user on a Database Instance. You must define the name, password of the user and instance_id parameters in the request.

Usage:

scw mongodb user create [arg=value ...]

Args:

Name Description
instance-id Required UUID of the Database Instance the user belongs to
name Name of the database user
password Password of the database user
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

Delete a user on a Database Instance

Delete an existing user on a Database Instance.

Usage:

scw mongodb user delete [arg=value ...]

Args:

Name Description
instance-id Required UUID of the Database Instance the user belongs to
name Required Name of the database user
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

List users of a Database Instance

List all users of a given Database Instance.

Usage:

scw mongodb user list [arg=value ...]

Args:

Name Description
name Name of the user
order-by One of: name_asc, name_desc Criteria to use when requesting user listing
instance-id Required UUID of the Database Instance
region Default: fr-par
One of: fr-par, all		 Region to target. If none is passed will use default region from the config

Apply user roles

Apply preset roles for a user in a Database Instance.

Usage:

scw mongodb user set-role [arg=value ...]

Args:

Name Description
instance-id Required UUID of the Database Instance the user belongs to
user-name Name of the database user
roles.{index}.role One of: unknown_role, read, read_write, db_admin, sync Name of the preset role
roles.{index}.database Name of the database on which the preset role will be used
roles.{index}.any-database Flag to enable the preset role in all databases
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

Update a user on a Database Instance

Update the parameters of a user on a Database Instance. You can update the password parameter, but you cannot change the name of the user.

Usage:

scw mongodb user update [arg=value ...]

Args:

Name Description
instance-id Required UUID of the Database Instance the user belongs to
name Required Name of the database user
password Password of the database user
region Default: fr-par
One of: fr-par		 Region to target. If none is passed will use default region from the config

MongoDB® version management commands

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

List available MongoDB® versions

List available MongoDB® versions.

Usage:

scw mongodb version list [arg=value ...]

Args:

Name Description
version
region Default: fr-par
One of: fr-par, all		 Region to target. If none is passed will use default region from the config