You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: openapi.yaml
+48-1Lines changed: 48 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -3218,6 +3218,7 @@ paths:
3218
3218
- $ref: '#/components/parameters/pageSize'
3219
3219
description: |
3220
3220
Display all accessible Managed MongoDB Databases.
3221
+
3221
3222
**Note**: New MongoDB Databases cannot currently be created.
3222
3223
security:
3223
3224
- personalAccessToken: []
@@ -3361,6 +3362,7 @@ paths:
3361
3362
x-linode-grant: read_only
3362
3363
description: |
3363
3364
Display information for a single, accessible Managed MongoDB Database.
3365
+
3364
3366
**Note**: New MongoDB Databases cannot currently be created.
3365
3367
security:
3366
3368
- personalAccessToken: []
@@ -3395,9 +3397,13 @@ paths:
3395
3397
x-linode-grant: read_write
3396
3398
description: |
3397
3399
Remove a Managed MongoDB Database from your Account.
3400
+
3398
3401
Requires `read_write` access to the Database.
3402
+
3399
3403
The Database must have an `active`, `failed`, or `degraded` status to perform this command.
3404
+
3400
3405
Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
3406
+
3401
3407
**Note**: New MongoDB Databases cannot currently be created.
3402
3408
security:
3403
3409
- personalAccessToken: []
@@ -3433,15 +3439,24 @@ paths:
3433
3439
x-linode-grant: read_write
3434
3440
description: |
3435
3441
Update a Managed MongoDB Database.
3442
+
3436
3443
Requires `read_write` access to the Database.
3444
+
3437
3445
The Database must have an `active` status to perform this command.
3446
+
3438
3447
Updating addresses in the `allow_list` overwrites any existing addresses.
3448
+
3439
3449
* IP addresses on this list can access the Managed Database. All other sources are blocked.
3450
+
3440
3451
* Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database.
3452
+
3441
3453
* **Note**: Updates to the `allow_list` may take a short period of time to complete, making this command inappropriate for rapid successive updates to this property.
3442
3454
All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MongoDB Database. The maintenance window for these updates is configured with the Managed Database's `updates` property.
3455
+
3443
3456
* If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance.
3457
+
3444
3458
* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.
3459
+
3445
3460
**Note**: New MongoDB Databases cannot currently be created.
3446
3461
security:
3447
3462
- personalAccessToken: []
@@ -3526,9 +3541,13 @@ paths:
3526
3541
- $ref: '#/components/parameters/pageSize'
3527
3542
description: |
3528
3543
Display all backups for an accessible Managed MongoDB Database.
3544
+
3529
3545
The Database must not be provisioning to perform this command.
3546
+
3530
3547
Database `auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days.
3548
+
3531
3549
Database `snapshot` type backups are created by accessing the **Managed MongoDB Database Backup Snapshot Create** ([POST /databases/mongodb/instances/{instanceId}/backups](/docs/api/databases/#managed-mongodb-database-backup-snapshot-create)) command.
3550
+
3532
3551
**Note**: New MongoDB Databases cannot currently be created.
3533
3552
security:
3534
3553
- personalAccessToken: []
@@ -3570,9 +3589,13 @@ paths:
3570
3589
x-linode-grant: read_write
3571
3590
description: |
3572
3591
Creates a snapshot backup of a Managed MongoDB Database.
3592
+
3573
3593
Requires `read_write` access to the Database.
3594
+
3574
3595
Backups generated by this command have the type `snapshot`. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore.
3596
+
3575
3597
The Database must have an `active` status to perform this command.
3598
+
3576
3599
**Note**: New MongoDB Databases cannot currently be created.
3577
3600
security:
3578
3601
- personalAccessToken: []
@@ -3657,7 +3680,9 @@ paths:
3657
3680
x-linode-grant: read_only
3658
3681
description: |
3659
3682
Display information for a single backup for an accessible Managed MongoDB Database.
3683
+
3660
3684
The Database must not be provisioning to perform this command.
3685
+
3661
3686
**Note**: New MongoDB Databases cannot currently be created.
3662
3687
security:
3663
3688
- personalAccessToken: []
@@ -3692,8 +3717,11 @@ paths:
3692
3717
x-linode-grant: unrestricted only
3693
3718
description: |
3694
3719
Delete a single backup for an accessible Managed MongoDB Database.
3720
+
3695
3721
Requires `read_write` access to the Database.
3722
+
3696
3723
The Database must not be provisioning to perform this command.
3724
+
3697
3725
**Note**: New MongoDB Databases cannot currently be created.
3698
3726
security:
3699
3727
- personalAccessToken: []
@@ -3744,10 +3772,15 @@ paths:
3744
3772
x-linode-grant: read_write
3745
3773
description: |
3746
3774
Restore a backup to a Managed MongoDB Database on your Account.
3775
+
3747
3776
Requires `read_write` access to the Database.
3777
+
3748
3778
The Database must have an `active` status to perform this command.
3779
+
3749
3780
**Note**: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.
3781
+
3750
3782
**Note**: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.
3783
+
3751
3784
**Note**: New MongoDB Databases cannot currently be created.
3752
3785
security:
3753
3786
- personalAccessToken: []
@@ -3791,7 +3824,9 @@ paths:
3791
3824
x-linode-grant: read_only
3792
3825
description: |
3793
3826
Display the root username and password for an accessible Managed MongoDB Database.
3827
+
3794
3828
The Database must have an `active` status to perform this command.
3829
+
3795
3830
**Note**: New MongoDB Databases cannot currently be created.
3796
3831
security:
3797
3832
- personalAccessToken: []
@@ -3835,10 +3870,15 @@ paths:
3835
3870
x-linode-grant: read_write
3836
3871
description: |
3837
3872
Reset the root password for a Managed MongoDB Database.
3873
+
3838
3874
Requires `read_write` access to the Database.
3875
+
3839
3876
A new root password is randomly generated and accessible with the **Managed MongoDB Database Credentials View** ([GET /databases/mongodb/instances/{instanceId}/credentials](/docs/api/databases/#managed-mongodb-database-credentials-view)) command.
3877
+
3840
3878
Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes.
3879
+
3841
3880
**Note**: Note that it may take several seconds for credentials to reset.
3881
+
3842
3882
**Note**: New MongoDB Databases cannot currently be created.
3843
3883
security:
3844
3884
- personalAccessToken: []
@@ -3882,7 +3922,9 @@ paths:
3882
3922
x-linode-grant: read_only
3883
3923
description: |
3884
3924
Display the SSL CA certificate for an accessible Managed MongoDB Database.
3925
+
3885
3926
The Database must have an `active` status to perform this command.
3927
+
3886
3928
**Note**: New MongoDB Databases cannot currently be created.
3887
3929
security:
3888
3930
- personalAccessToken: []
@@ -3927,10 +3969,15 @@ paths:
3927
3969
description: |
3928
3970
Apply security patches and updates to the underlying operating system of the Managed MongoDB Database. This function runs during regular maintenance windows, which are configurable with the **Managed MongoDB Database Update** ([PUT /databases/mongodb/instances/{instanceId}](/docs/api/databases/#managed-mongodb-database-update)) command.
3929
3971
Requires `read_write` access to the Database.
3972
+
3930
3973
The Database must have an `active` status to perform this command.
3931
-
**Note**
3974
+
3975
+
**Note**:
3976
+
3932
3977
* If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance.
3978
+
3933
3979
* **The database software is not updated automatically.** To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one.
3980
+
3934
3981
**Note**: New MongoDB Databases cannot currently be created.
0 commit comments