Maintenance Operations

Download schema

Maintenance operations for managing scheduled updates to your Database Instance.

List all the maintenances of a MongoDB® Database Instance.

GET

https://api.scaleway.com

/mongodb/v1/regions/{region}/maintenances

List all the maintenances of a MongoDB® Database Instance. › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

List all the maintenances of a MongoDB® Database Instance. › query Parameters

instance_id

string · required

ID of the instance. (UUID format)

order_by

string · enum

Criteria to use when requesting user listing.

Enum values:

created_at_asc

created_at_desc

starts_at_asc

starts_at_desc

stops_at_asc

stops_at_desc

Default: created_at_asc

page

integer · int32

page_size

integer · uint32

List all the maintenances of a MongoDB® Database Instance. › Responses

200

scaleway.mongodb.v1.ListMaintenancesResponse

scaleway.mongodb.v1.Maintenance[]

List of maintenances of a MongoDB© instance.

total_count

integer · uint64

Total count of maintenances of a MongoDB© instance.

GET/mongodb/v1/regions/{region}/maintenances

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/mongodb/v1/regions/{region}/maintenances?instance_id=6170692e-7363-616c-6577-61792e636f6d"

Example Responses

{
  "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"
    }
  ],
  "total_count": 0
}

json

application/json

Get a maintenance of a MongoDB® Database Instance.

GET

https://api.scaleway.com

/mongodb/v1/regions/{region}/maintenances/{maintenance_id}

Get a maintenance of a MongoDB® Database Instance. › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

maintenance_id

string · required

ID of the maintenance. (UUID format)

Get a maintenance of a MongoDB® Database Instance. › Responses

200

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 · date-time

Creation date of the maintenance. (RFC 3339 format)

starts_at

string · date-time

Start date of the maintenance. (RFC 3339 format)

stops_at

string · date-time

Stop date of the maintenance. (RFC 3339 format)

status

string · enum

Current status of the maintenance.

Enum values:

unknown_status

planned

done

cancelled

ongoing

Default: unknown_status

forced_at

string · date-time

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

applied_at

string · date-time

Application date of the maintenance. (RFC 3339 format)

applied_by

string · enum

Usertype who launched the maintenance.

Enum values:

unknown_applied_by

user

admin

Default: unknown_applied_by

object

Workflow to be applied during maintenance.

reason

string

Reason of the maintenance.

GET/mongodb/v1/regions/{region}/maintenances/{maintenance_id}

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

Example Responses

{
  "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"
}

json

application/json

Apply a maintenance of a MongoDB® Database Instance.

POST

https://api.scaleway.com

/mongodb/v1/regions/{region}/maintenances/{maintenance_id}/apply

Apply a maintenance of a MongoDB® Database Instance. › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

maintenance_id

string · required

(UUID format)

Apply a maintenance of a MongoDB® Database Instance. › Request Body

Apply a maintenance of a MongoDB® Database Instance. › Responses

200

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 · date-time

Creation date of the maintenance. (RFC 3339 format)

starts_at

string · date-time

Start date of the maintenance. (RFC 3339 format)

stops_at

string · date-time

Stop date of the maintenance. (RFC 3339 format)

status

string · enum

Current status of the maintenance.

Enum values:

unknown_status

planned

done

cancelled

ongoing

Default: unknown_status

forced_at

string · date-time

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

applied_at

string · date-time

Application date of the maintenance. (RFC 3339 format)

applied_by

string · enum

Usertype who launched the maintenance.

Enum values:

unknown_applied_by

user

admin

Default: unknown_applied_by

object

Workflow to be applied during maintenance.

reason

string

Reason of the maintenance.

POST/mongodb/v1/regions/{region}/maintenances/{maintenance_id}/apply

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

Example Request Body

{}

json

Example Responses

{
  "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"
}

json

application/json

Databases

List all the maintenances of a MongoDB® Database Instance.

GET

https://api.scaleway.com

/mongodb/v1/regions/{region}/maintenances

List all the maintenances of a MongoDB® Database Instance. › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

List all the maintenances of a MongoDB® Database Instance. › query Parameters

instance_id

string · required

ID of the instance. (UUID format)

order_by

string · enum

Criteria to use when requesting user listing.

Enum values:

created_at_asc

created_at_desc

starts_at_asc

starts_at_desc

stops_at_asc

stops_at_desc

Default: created_at_asc

page

integer · int32

page_size

integer · uint32

List all the maintenances of a MongoDB® Database Instance. › Responses

200

scaleway.mongodb.v1.ListMaintenancesResponse

scaleway.mongodb.v1.Maintenance[]

List of maintenances of a MongoDB© instance.

total_count

integer · uint64

Total count of maintenances of a MongoDB© instance.

Get a maintenance of a MongoDB® Database Instance.

GET

https://api.scaleway.com

/mongodb/v1/regions/{region}/maintenances/{maintenance_id}

Get a maintenance of a MongoDB® Database Instance. › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

maintenance_id

string · required

ID of the maintenance. (UUID format)

Get a maintenance of a MongoDB® Database Instance. › Responses

200

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 · date-time

Creation date of the maintenance. (RFC 3339 format)

starts_at

string · date-time

Start date of the maintenance. (RFC 3339 format)

stops_at

string · date-time

Stop date of the maintenance. (RFC 3339 format)

status

string · enum

Current status of the maintenance.

Enum values:

unknown_status

planned

done

cancelled

ongoing

Default: unknown_status

forced_at

string · date-time

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

applied_at

string · date-time

Application date of the maintenance. (RFC 3339 format)

applied_by

string · enum

Usertype who launched the maintenance.

Enum values:

unknown_applied_by

user

admin

Default: unknown_applied_by

object

Workflow to be applied during maintenance.

reason

string

Reason of the maintenance.

Apply a maintenance of a MongoDB® Database Instance.

POST

https://api.scaleway.com

/mongodb/v1/regions/{region}/maintenances/{maintenance_id}/apply

Apply a maintenance of a MongoDB® Database Instance. › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

maintenance_id

string · required

(UUID format)

Apply a maintenance of a MongoDB® Database Instance. › Request Body

Apply a maintenance of a MongoDB® Database Instance. › Responses

200

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 · date-time

Creation date of the maintenance. (RFC 3339 format)

starts_at

string · date-time

Start date of the maintenance. (RFC 3339 format)

stops_at

string · date-time

Stop date of the maintenance. (RFC 3339 format)

status

string · enum

Current status of the maintenance.

Enum values:

unknown_status

planned

done

cancelled

ongoing

Default: unknown_status

forced_at

string · date-time

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

applied_at

string · date-time

Application date of the maintenance. (RFC 3339 format)

applied_by

string · enum

Usertype who launched the maintenance.

Enum values:

unknown_applied_by

user

admin

Default: unknown_applied_by

object

Workflow to be applied during maintenance.

reason

string

Reason of the maintenance.