Database Instances

scaleway.mongodb.v1.EndpointSpec[]

Instance volume information.

One or multiple EndpointSpec used to expose your Database Instance.

Create a MongoDB® Database Instance › Responses

200

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

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.

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

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "node_amount": 42,
    "node_type": "string",
    "password": "string",
    "project_id": "string",
    "user_name": "string",
    "version": "string"
  }' \
  "https://api.scaleway.com/mongodb/v1/regions/{region}/instances"

Example Request Body

{
  "project_id": "project_id",
  "name": "name",
  "version": "version",
  "tags": [
    "string"
  ],
  "node_amount": 0,
  "node_type": "node_type",
  "user_name": "user_name",
  "password": "password",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "public_network": {},
      "private_network": {
        "private_network_id": "private_network_id"
      }
    }
  ]
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "version": "version",
  "tags": [
    "string"
  ],
  "node_amount": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "port": 0,
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public_network": {}
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "region": "region",
  "snapshot_schedule": {
    "frequency_hours": 0,
    "retention_days": 0,
    "enabled": true,
    "next_update": "2022-03-22T12:34:56.123456Z",
    "last_run": "2022-03-22T12:34:56.123456Z"
  },
  "settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "maintenances": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "instance_id": "6170692e-7363-616c-6577-61792e636f6d",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "starts_at": "2022-03-22T12:34:56.123456Z",
      "stops_at": "2022-03-22T12:34:56.123456Z",
      "status": "unknown_status",
      "forced_at": "2022-03-22T12:34:56.123456Z",
      "applied_at": "2022-03-22T12:34:56.123456Z",
      "applied_by": "unknown_applied_by",
      "workflow": {
        "engine_upgrade": {
          "new_version_id": "new_version_id"
        },
        "service_update": {
          "service_name": "service_name"
        }
      },
      "reason": "reason"
    }
  ],
  "upgradable_versions": [
    "string"
  ]
}

json

application/json

Get a MongoDB® Database Instance

GET

https://api.scaleway.com

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

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.

Get a MongoDB® Database Instance › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

instance_id

string · required

UUID of the Database Instance.

Get a MongoDB® Database Instance › Responses

200

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

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.

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

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/mongodb/v1/regions/{region}/instances/{instance_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "version": "version",
  "tags": [
    "string"
  ],
  "node_amount": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "port": 0,
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public_network": {}
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "region": "region",
  "snapshot_schedule": {
    "frequency_hours": 0,
    "retention_days": 0,
    "enabled": true,
    "next_update": "2022-03-22T12:34:56.123456Z",
    "last_run": "2022-03-22T12:34:56.123456Z"
  },
  "settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "maintenances": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "instance_id": "6170692e-7363-616c-6577-61792e636f6d",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "starts_at": "2022-03-22T12:34:56.123456Z",
      "stops_at": "2022-03-22T12:34:56.123456Z",
      "status": "unknown_status",
      "forced_at": "2022-03-22T12:34:56.123456Z",
      "applied_at": "2022-03-22T12:34:56.123456Z",
      "applied_by": "unknown_applied_by",
      "workflow": {
        "engine_upgrade": {
          "new_version_id": "new_version_id"
        },
        "service_update": {
          "service_name": "service_name"
        }
      },
      "reason": "reason"
    }
  ],
  "upgradable_versions": [
    "string"
  ]
}

json

application/json

Delete a MongoDB® Database Instance

DELETE

https://api.scaleway.com

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

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.

Delete a MongoDB® Database Instance › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

instance_id

string · required

UUID of the Database Instance to delete.

Delete a MongoDB® Database Instance › Responses

200

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

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.

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

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/mongodb/v1/regions/{region}/instances/{instance_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "version": "version",
  "tags": [
    "string"
  ],
  "node_amount": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "port": 0,
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public_network": {}
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "region": "region",
  "snapshot_schedule": {
    "frequency_hours": 0,
    "retention_days": 0,
    "enabled": true,
    "next_update": "2022-03-22T12:34:56.123456Z",
    "last_run": "2022-03-22T12:34:56.123456Z"
  },
  "settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "maintenances": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "instance_id": "6170692e-7363-616c-6577-61792e636f6d",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "starts_at": "2022-03-22T12:34:56.123456Z",
      "stops_at": "2022-03-22T12:34:56.123456Z",
      "status": "unknown_status",
      "forced_at": "2022-03-22T12:34:56.123456Z",
      "applied_at": "2022-03-22T12:34:56.123456Z",
      "applied_by": "unknown_applied_by",
      "workflow": {
        "engine_upgrade": {
          "new_version_id": "new_version_id"
        },
        "service_update": {
          "service_name": "service_name"
        }
      },
      "reason": "reason"
    }
  ],
  "upgradable_versions": [
    "string"
  ]
}

json

application/json

Update a MongoDB® Database Instance

PATCH

https://api.scaleway.com

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

Update the parameters of a MongoDB® Database Instance.

Update a MongoDB® Database Instance › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

instance_id

string · required

UUID of the Database Instance to update.

Update a MongoDB® Database Instance › Request Body

name

string | null

Name of the Database Instance.

tags

array | null

Tags of a Database Instance.

snapshot_schedule_frequency_hours

integer | null · uint32

In hours.

snapshot_schedule_retention_days

integer | null · uint32

In days.

is_snapshot_schedule_enabled

boolean | null

Defines whether or not the snapshot schedule is enabled.

Update a MongoDB® Database Instance › Responses

200

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

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.

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

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/mongodb/v1/regions/{region}/instances/{instance_id}"

Example Request Body

{
  "name": "name",
  "tags": [],
  "snapshot_schedule_frequency_hours": 0,
  "snapshot_schedule_retention_days": 0,
  "is_snapshot_schedule_enabled": true
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "version": "version",
  "tags": [
    "string"
  ],
  "node_amount": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "port": 0,
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      },
      "public_network": {}
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "region": "region",
  "snapshot_schedule": {
    "frequency_hours": 0,
    "retention_days": 0,
    "enabled": true,
    "next_update": "2022-03-22T12:34:56.123456Z",
    "last_run": "2022-03-22T12:34:56.123456Z"
  },
  "settings": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "maintenances": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "instance_id": "6170692e-7363-616c-6577-61792e636f6d",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "starts_at": "2022-03-22T12:34:56.123456Z",
      "stops_at": "2022-03-22T12:34:56.123456Z",
      "status": "unknown_status",
      "forced_at": "2022-03-22T12:34:56.123456Z",
      "applied_at": "2022-03-22T12:34:56.123456Z",
      "applied_by": "unknown_applied_by",
      "workflow": {
        "engine_upgrade": {
          "new_version_id": "new_version_id"
        },
        "service_update": {
          "service_name": "service_name"
        }
      },
      "reason": "reason"
    }
  ],
  "upgradable_versions": [
    "string"
  ]
}

json

application/json

Get the certificate of a Database Instance

GET

https://api.scaleway.com

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

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

Get the certificate of a Database Instance › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

instance_id

string · required

UUID of the Database Instance.

Get the certificate of a Database Instance › Responses

200

scaleway.std.File

name

string

content_type

string

content

string

Upgrade a Database Instance

POST

https://api.scaleway.com

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

Upgrade your current Database Instance specifications like volume size.

Upgrade a Database Instance › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

instance_id

string · required

UUID of the Database Instance you want to upgrade. (UUID format)

Upgrade a Database Instance › Request Body

volume_size_bytes

integer | null · uint64

Increase your Block Storage volume size. (in bytes)

version

string | null

MongoDB version to upgrade to (e.g., 8.0, 7.0, 8.2).

Upgrade a Database Instance › Responses

200

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

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.