Scaleway logo
Managed MongoDB®

scaleway.mongodb.v1.Database

name
​string

scaleway.mongodb.v1.Endpoint

id
​string

UUID of the endpoint. (UUID format)

dns_record
​string

List of DNS records of the endpoint.

port
​integer · uint32

TCP port of the endpoint.

​

Private Network endpoint details.

​

Public Network endpoint details.

scaleway.mongodb.v1.Endpoint.PrivateNetworkDetails

private_network_id
​string

UUID of the Private Network. (UUID format)

scaleway.mongodb.v1.Endpoint.PublicNetworkDetails

scaleway.mongodb.v1.EndpointSpec

​
​

scaleway.mongodb.v1.EndpointSpec.PrivateNetworkDetails

private_network_id
​string

UUID of the Private Network.

scaleway.mongodb.v1.EndpointSpec.PublicNetworkDetails

scaleway.mongodb.v1.EngineUpgrade

new_version_id
​string

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.

scaleway.mongodb.v1.Instance.SnapshotSchedule

frequency_hours
​integer · int32
retention_days
​integer · int32
enabled
​boolean
next_update
​string | null · date-time

(RFC 3339 format)

last_run
​string | null · date-time

(RFC 3339 format)

scaleway.mongodb.v1.Instance.Status

string · enum
Enum values:
unknown_status
ready
provisioning
configuring
deleting
error
initializing
locked
Default: unknown_status

scaleway.mongodb.v1.InstanceSetting

name
​string
value
​string

scaleway.mongodb.v1.ListDatabasesRequest.OrderBy

string · enum
Enum values:
name_asc
name_desc
Default: name_asc

scaleway.mongodb.v1.ListDatabasesResponse

List of the databases.

total_count
​integer · uint64

Total count of databases present on a Database Instance.

scaleway.mongodb.v1.ListInstancesRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
name_asc
name_desc
status_asc
status_desc
Default: created_at_asc

scaleway.mongodb.v1.ListInstancesResponse

List of all Database Instances available in an Organization or Project.

total_count
​integer · uint64

Total count of Database Instances available in an Organization or Project.

scaleway.mongodb.v1.ListMaintenancesRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
starts_at_asc
starts_at_desc
stops_at_asc
stops_at_desc
Default: created_at_asc

scaleway.mongodb.v1.ListMaintenancesResponse

List of maintenances of a MongoDB© instance.

total_count
​integer · uint64

Total count of maintenances of a MongoDB© instance.

scaleway.mongodb.v1.ListNodeTypesResponse

Types of the node.

total_count
​integer · uint64

Total count of node-types available.

scaleway.mongodb.v1.ListSnapshotsRequest.OrderBy

string · enum
Enum values:
created_at_asc
created_at_desc
name_asc
name_desc
expires_at_asc
expires_at_desc
Default: created_at_asc

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.

scaleway.mongodb.v1.ListUsersRequest.OrderBy

string · enum
Enum values:
name_asc
name_desc
Default: name_asc

scaleway.mongodb.v1.ListUsersResponse

List of users in a Database Instance.

total_count
​integer · uint64

Total count of users present on a Database Instance.

scaleway.mongodb.v1.ListVersionsResponse

Available MongoDB® major engine version.

total_count
​integer · uint64

Total count of MongoDB® major engine version available.

scaleway.mongodb.v1.Maintenance

id
​string

ID of the maintenance. (UUID format)

instance_id
​string

ID of the instance on which the maintenance is applied. (UUID format)

created_at
​string | null · date-time

Creation date of the maintenance. (RFC 3339 format)

starts_at
​string | null · date-time

Start date of the maintenance. (RFC 3339 format)

stops_at
​string | null · date-time

Stop date of the maintenance. (RFC 3339 format)

Current status of the maintenance.

Enum values:
unknown_status
planned
done
cancelled
ongoing
Default: unknown_status
forced_at
​string | null · date-time

Forced application date of the maintenance. (RFC 3339 format)

applied_at
​string | null · date-time

Application date of the maintenance. (RFC 3339 format)

Usertype who launched the maintenance.

Enum values:
unknown_applied_by
user
admin
Default: unknown_applied_by

Workflow to be applied during maintenance.

reason
​string

Reason of the maintenance.

scaleway.mongodb.v1.Maintenance.AppliedBy

string · enum
Enum values:
unknown_applied_by
user
admin
Default: unknown_applied_by

scaleway.mongodb.v1.Maintenance.Status

string · enum
Enum values:
unknown_status
planned
done
cancelled
ongoing
Default: unknown_status

scaleway.mongodb.v1.NodeType

name
​string

Node type name identifier.

stock_status
​scaleway.mongodb.v1.NodeType.Stock · enum

Current stock status for the node type.

Enum values:
unknown_stock
low_stock
out_of_stock
available
Default: unknown_stock
description
​string

Current specs of the offer.

vcpus
​integer · uint32

Number of virtual CPUs.

memory_bytes
​integer · uint64

Quantity of RAM. (in bytes)

Available storage options for the node type.

disabled
​boolean

The node type is currently disabled.

beta
​boolean

The node type is currently in beta.

instance_range
​string

Instance range associated with the node type offer.

scaleway.mongodb.v1.NodeType.Stock

string · enum
Enum values:
unknown_stock
low_stock
out_of_stock
available
Default: unknown_stock

scaleway.mongodb.v1.NodeType.VolumeType

Volume Type.

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

The description of the volume.

min_size_bytes
​integer · uint64

Minimum size required for the volume. (in bytes)

max_size_bytes
​integer · uint64

Maximum size required for the volume. (in bytes)

chunk_size_bytes
​integer · uint64

Minimum increment level for a Block Storage volume size. (in bytes)

scaleway.mongodb.v1.ServiceUpdate

service_name
​string

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.

scaleway.mongodb.v1.Snapshot.Status

string · enum
Enum values:
unknown_status
creating
ready
restoring
deleting
error
locked
Default: unknown_status

scaleway.mongodb.v1.User

name
​string

Name of the user (Length must be between 1 and 63 characters. First character must be an alphabet character (a-zA-Z). Only a-zA-Z0-9_$- characters are accepted).

List of roles assigned to the user, along with the corresponding database where each role is granted.

scaleway.mongodb.v1.UserRole

Name of the preset role.

Enum values:
unknown_role
read
read_write
db_admin
sync
Default: unknown_role
database_name
​string | null

Name of the database on which the preset role will be used.

any_database
​boolean | null

Flag to enable the preset role in all databases.

scaleway.mongodb.v1.UserRole.Role

string · enum
Enum values:
unknown_role
read
read_write
db_admin
sync
Default: unknown_role

scaleway.mongodb.v1.Version

version
​string

MongoDB® major engine version.

end_of_life_at
​string | null · date-time

Date of End of Life. (RFC 3339 format)

released_at
​string | null · date-time

Date of Release. (RFC 3339 format)

scaleway.mongodb.v1.Volume

Type of volume where data is stored.

Enum values:
unknown_type
sbs_5k
sbs_15k
Default: unknown_type
size_bytes
​integer · uint64

Volume size. (in bytes)

scaleway.mongodb.v1.Volume.Type

string · enum
Enum values:
unknown_type
sbs_5k
sbs_15k
Default: unknown_type

scaleway.mongodb.v1.Workflow

​
​

scaleway.std.File

name
​string
content_type
​string
content
​string