Managed Databases v4.136.0

Managed Database Engines List

GET https://api.linode.com/v4/databases/engines

Display all available Managed Database engine types and versions. Engine IDs are used when creating new Managed Databases.

Authorizations

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..100
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Managed Database Engine View

GET https://api.linode.com/v4/databases/engines/{engineId}

Display information for a single Managed Database engine type and version.

Authorizations

Path Parameters

engineIdstring
Required

The ID of the Managed Database engine.

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..100
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Managed Databases List All

GET https://api.linode.com/v4/databases/instances

Display all Managed Databases that are accessible by your User, regardless of engine type.

For more detailed information on a particular Database instance, make a request to its instance_uri.

Authorizations

personalAccessToken
oauthdatabases:read_only

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..100
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Managed MongoDB Databases List

GET https://api.linode.com/v4/databases/mongodb/instances

Display all accessible Managed MongoDB Databases. Note: New MongoDB Databases cannot currently be created.

Authorizations

personalAccessToken
oauthdatabases:read_only

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..100
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Managed MongoDB Database Delete

DELETE https://api.linode.com/v4/databases/mongodb/instances/{instanceId}

Remove a Managed MongoDB Database from your Account. Requires read_write access to the Database. The Database must have an active, failed, or degraded status to perform this command. Only unrestricted Users can access this command, and have access regardless of the acting token’s OAuth scopes. Note: New MongoDB Databases cannot currently be created.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MongoDB Database.

Request Samples

Response Samples

Responses

Managed MongoDB Database View

GET https://api.linode.com/v4/databases/mongodb/instances/{instanceId}

Display information for a single, accessible Managed MongoDB Database. Note: New MongoDB Databases cannot currently be created.

Authorizations

personalAccessToken
oauthdatabases:read_only

Path Parameters

instanceIdinteger
Required

The ID of the Managed MongoDB Database.

Request Samples

Response Samples

Responses

Managed MongoDB Database Update

PUT https://api.linode.com/v4/databases/mongodb/instances/{instanceId}

Update a Managed MongoDB Database. Requires read_write access to the Database. The Database must have an active status to perform this command. Updating addresses in the allow_list overwrites any existing addresses.

  • IP addresses on this list can access the Managed Database. All other sources are blocked.
  • Entering an empty array ([]) blocks all connections (both public and private) to the Managed Database.
  • 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. 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.
  • 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.
  • 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. Note: New MongoDB Databases cannot currently be created.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MongoDB Database.

Request Body Schema

allow_list
array of strings

A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

By default, this is an empty array ([]), which blocks all connections (both public and private) to the Managed Database.

label
Filterable
string 3..32 characters

A unique, user-defined string referring to the Managed Database.

updates
object

Configuration settings for automated patch update maintenance for the Managed Database.

day_of_week
integer 1..7

The day to perform maintenance. 1=Monday, 2=Tuesday, etc.

duration
integer 1..3

The maximum maintenance window time in hours.

frequency
string
Enum: weekly monthly Default: weekly

Whether maintenance occurs on a weekly or monthly basis.

hour_of_day
integer 0..23

The hour to begin maintenance based in UTC time.

week_of_month
Nullable
integer 1..4

The week of the month to perform monthly frequency updates. Defaults to null.

  • Required for monthly frequency updates.

  • Must be null for weekly frequency updates.

Request Samples

Response Samples

Responses

Managed MongoDB Database Backups List

GET https://api.linode.com/v4/databases/mongodb/instances/{instanceId}/backups

Display all backups for an accessible Managed MongoDB Database. The Database must not be provisioning to perform this command. Database auto type backups are created every 24 hours at 0:00 UTC. Each auto backup is retained for 7 days. Database snapshot type backups are created by accessing the Managed MongoDB Database Backup Snapshot Create ( POST /databases/mongodb/instances/{instanceId}/backups) command. Note: New MongoDB Databases cannot currently be created.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MongoDB Database.

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..100
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Managed MongoDB Database Backup Snapshot Create

POST https://api.linode.com/v4/databases/mongodb/instances/{instanceId}/backups

Creates a snapshot backup of a Managed MongoDB Database. Requires read_write access to the Database. 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. The Database must have an active status to perform this command. Note: New MongoDB Databases cannot currently be created.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MongoDB Database.

Request Body Schema

label
Required
string 3..64 characters

The label for the Database snapshot backup.

  • Must use only letters, numbers, underscores, dashes, and periods.
  • Must begin and end with a letter or number.
  • Must not include two dashes, underscores, or periods in a row.

target
string
Enum: primary secondary Default: primary

The Database cluster target. If the Database is a high availability cluster, choosing secondary creates a snapshot backup of a replica node.

Request Samples

Response Samples

Responses

Managed MongoDB Database Backup Delete

DELETE https://api.linode.com/v4/databases/mongodb/instances/{instanceId}/backups/{backupId}

Delete a single backup for an accessible Managed MongoDB Database. Requires read_write access to the Database. The Database must not be provisioning to perform this command. Note: New MongoDB Databases cannot currently be created.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MongoDB Database.

backupIdinteger
Required

The ID of the Managed MongoDB Database backup.

Request Samples

Response Samples

Responses

Managed MongoDB Database Backup View

GET https://api.linode.com/v4/databases/mongodb/instances/{instanceId}/backups/{backupId}

Display information for a single backup for an accessible Managed MongoDB Database. The Database must not be provisioning to perform this command. Note: New MongoDB Databases cannot currently be created.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MongoDB Database.

backupIdinteger
Required

The ID of the Managed MongoDB Database backup.

Request Samples

Response Samples

Responses

Managed MongoDB Database Backup Restore

POST https://api.linode.com/v4/databases/mongodb/instances/{instanceId}/backups/{backupId}/restore

Restore a backup to a Managed MongoDB Database on your Account. Requires read_write access to the Database. The Database must have an active status to perform this command. Note: Restoring from a backup will erase all existing data on the database instance and replace it with backup data. Note: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs. Note: New MongoDB Databases cannot currently be created.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MongoDB Database.

backupIdinteger
Required

The ID of the Managed MongoDB Database backup.

Request Samples

Response Samples

Responses

Managed MongoDB Database Credentials View

GET https://api.linode.com/v4/databases/mongodb/instances/{instanceId}/credentials

Display the root username and password for an accessible Managed MongoDB Database. The Database must have an active status to perform this command. Note: New MongoDB Databases cannot currently be created.

Authorizations

personalAccessToken
oauthdatabases:read_only

Path Parameters

instanceIdinteger
Required

The ID of the Managed MongoDB Database.

Request Samples

Response Samples

Responses

Managed MongoDB Database Credentials Reset

POST https://api.linode.com/v4/databases/mongodb/instances/{instanceId}/credentials/reset

Reset the root password for a Managed MongoDB Database. Requires read_write access to the Database. A new root password is randomly generated and accessible with the Managed MongoDB Database Credentials View ( GET /databases/mongodb/instances/{instanceId}/credentials) command. Only unrestricted Users can access this command, and have access regardless of the acting token’s OAuth scopes. Note: Note that it may take several seconds for credentials to reset. Note: New MongoDB Databases cannot currently be created.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MongoDB Database.

Request Samples

Response Samples

Responses

Managed MongoDB Database Patch

POST https://api.linode.com/v4/databases/mongodb/instances/{instanceId}/patch

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}) command. Requires read_write access to the Database. The Database must have an active status to perform this command. Note

  • 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.
  • 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. Note: New MongoDB Databases cannot currently be created.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MongoDB Database.

Request Samples

Response Samples

Responses

Managed MongoDB Database SSL Certificate View

GET https://api.linode.com/v4/databases/mongodb/instances/{instanceId}/ssl

Display the SSL CA certificate for an accessible Managed MongoDB Database. The Database must have an active status to perform this command. Note: New MongoDB Databases cannot currently be created.

Authorizations

personalAccessToken
oauthdatabases:read_only

Path Parameters

instanceIdinteger
Required

The ID of the Managed MongoDB Database.

Request Samples

Response Samples

Responses

Managed MySQL Databases List

GET https://api.linode.com/v4/databases/mysql/instances

Display all accessible Managed MySQL Databases.

Authorizations

personalAccessToken
oauthdatabases:read_only

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..100
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Managed MySQL Database Create

POST https://api.linode.com/v4/databases/mysql/instances

Provision a Managed MySQL Database.

Restricted Users must have the add_databases grant to use this command.

New instances can take approximately 15 to 30 minutes to provision.

The allow_list is used to control access to the Managed Database.

  • IP addresses on this list can access the Managed Database. All other sources are blocked.
  • Entering an empty array ([]) blocks all connections (both public and private) to the Managed Database.

All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week.

All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MySQL Database during configurable maintenance windows.

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

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

  • To modify update the maintenance window for a Database, use the Managed MySQL Database Update ( PUT /databases/mysql/instances/{instanceId}) command.

Authorizations

personalAccessToken
oauthdatabases:read_write

Request Body Schema

allow_list
array of strings

A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

By default, this is an empty array ([]), which blocks all connections (both public and private) to the Managed Database.

cluster_size
integer
Enum: 1 3 Default: 1

The number of Linode Instance nodes deployed to the Managed Database.

Choosing 3 nodes creates a high availability cluster consisting of 1 primary node and 2 replica nodes.

encrypted
boolean

Whether the Managed Databases is encrypted.

engine
Required
string

The Managed Database engine in engine/version format.

label
Filterable
Required
string 3..32 characters

A unique, user-defined string referring to the Managed Database.

region
Filterable
Required
string

The Region ID for the Managed Database.

replication_type
string
Enum: none asynch semi_synch

The replication method used for the Managed Database.

Defaults to none for a single cluster and semi_synch for a high availability cluster.

Must be none for a single node cluster.

Must be asynch or semi_synch for a high availability cluster.

ssl_connection
boolean
Default: true

Whether to require SSL credentials to establish a connection to the Managed Database.

Use the Managed MySQL Database Credentials View ( GET /databases/mysql/instances/{instanceId}/credentials) command for access information.

type
Filterable
Required
string

The Linode Instance type used by the Managed Database for its nodes.

Request Samples

Response Samples

Responses

Managed MySQL Database Delete

DELETE https://api.linode.com/v4/databases/mysql/instances/{instanceId}

Remove a Managed MySQL Database from your Account.

Requires read_write access to the Database.

The Database must have an active, failed, or degraded status to perform this command.

Only unrestricted Users can access this command, and have access regardless of the acting token’s OAuth scopes.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MySQL Database.

Request Samples

Response Samples

Responses

Managed MySQL Database View

GET https://api.linode.com/v4/databases/mysql/instances/{instanceId}

Display information for a single, accessible Managed MySQL Database.

Authorizations

personalAccessToken
oauthdatabases:read_only

Path Parameters

instanceIdinteger
Required

The ID of the Managed MySQL Database.

Request Samples

Response Samples

Responses

Managed MySQL Database Update

PUT https://api.linode.com/v4/databases/mysql/instances/{instanceId}

Update a Managed MySQL Database.

Requires read_write access to the Database.

The Database must have an active status to perform this command.

Updating addresses in the allow_list overwrites any existing addresses.

  • IP addresses on this list can access the Managed Database. All other sources are blocked.
  • Entering an empty array ([]) blocks all connections (both public and private) to the Managed Database.
  • 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.

All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MySQL Database. The maintenance window for these updates is configured with the Managed Database’s updates property.

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

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

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MySQL Database.

Request Body Schema

allow_list
array of strings

A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

By default, this is an empty array ([]), which blocks all connections (both public and private) to the Managed Database.

label
Filterable
string 3..32 characters

A unique, user-defined string referring to the Managed Database.

updates
object

Configuration settings for automated patch update maintenance for the Managed Database.

day_of_week
integer 1..7

The day to perform maintenance. 1=Monday, 2=Tuesday, etc.

duration
integer 1..3

The maximum maintenance window time in hours.

frequency
string
Enum: weekly monthly Default: weekly

Whether maintenance occurs on a weekly or monthly basis.

hour_of_day
integer 0..23

The hour to begin maintenance based in UTC time.

week_of_month
Nullable
integer 1..4

The week of the month to perform monthly frequency updates. Defaults to null.

  • Required for monthly frequency updates.

  • Must be null for weekly frequency updates.

Request Samples

Response Samples

Responses

Managed MySQL Database Backups List

GET https://api.linode.com/v4/databases/mysql/instances/{instanceId}/backups

Display all backups for an accessible Managed MySQL Database.

The Database must not be provisioning to perform this command.

Database auto type backups are created every 24 hours at 0:00 UTC. Each auto backup is retained for 7 days.

Database snapshot type backups are created by accessing the Managed MySQL Database Backup Snapshot Create ( POST /databases/mysql/instances/{instanceId}/backups) command.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MySQL Database.

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..100
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Managed MySQL Database Backup Snapshot Create

POST https://api.linode.com/v4/databases/mysql/instances/{instanceId}/backups

Creates a snapshot backup of a Managed MySQL Database.

Requires read_write access to the Database.

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.

The Database must have an active status to perform this command.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MySQL Database.

Request Body Schema

label
Required
string 3..64 characters

The label for the Database snapshot backup.

  • Must use only letters, numbers, underscores, dashes, and periods.
  • Must begin and end with a letter or number.
  • Must not include two dashes, underscores, or periods in a row.

target
string
Enum: primary secondary Default: primary

The Database cluster target.

If the Database is a high availability cluster, choosing secondary creates a snapshot backup of a replica node.

Request Samples

Response Samples

Responses

Managed MySQL Database Backup Delete

DELETE https://api.linode.com/v4/databases/mysql/instances/{instanceId}/backups/{backupId}

Delete a single backup for an accessible Managed MySQL Database.

Requires read_write access to the Database.

The Database must not be provisioning to perform this command.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MySQL Database.

backupIdinteger
Required

The ID of the Managed MySQL Database backup.

Request Samples

Response Samples

Responses

Managed MySQL Database Backup View

GET https://api.linode.com/v4/databases/mysql/instances/{instanceId}/backups/{backupId}

Display information for a single backup for an accessible Managed MySQL Database.

The Database must not be provisioning to perform this command.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MySQL Database.

backupIdinteger
Required

The ID of the Managed MySQL Database backup.

Request Samples

Response Samples

Responses

Managed MySQL Database Backup Restore

POST https://api.linode.com/v4/databases/mysql/instances/{instanceId}/backups/{backupId}/restore

Restore a backup to a Managed MySQL Database on your Account.

Requires read_write access to the Database.

The Database must have an active status to perform this command.

Note: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.

Note: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MySQL Database.

backupIdinteger
Required

The ID of the Managed MySQL Database backup.

Request Samples

Response Samples

Responses

Managed MySQL Database Credentials View

GET https://api.linode.com/v4/databases/mysql/instances/{instanceId}/credentials

Display the root username and password for an accessible Managed MySQL Database.

The Database must have an active status to perform this command.

Authorizations

personalAccessToken
oauthdatabases:read_only

Path Parameters

instanceIdinteger
Required

The ID of the Managed MySQL Database.

Request Samples

Response Samples

Responses

Managed MySQL Database Credentials Reset

POST https://api.linode.com/v4/databases/mysql/instances/{instanceId}/credentials/reset

Reset the root password for a Managed MySQL Database.

Requires read_write access to the Database.

A new root password is randomly generated and accessible with the Managed MySQL Database Credentials View ( GET /databases/mysql/instances/{instanceId}/credentials) command.

Only unrestricted Users can access this command, and have access regardless of the acting token’s OAuth scopes.

Note: Note that it may take several seconds for credentials to reset.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MySQL Database.

Request Samples

Response Samples

Responses

Managed MySQL Database Patch

POST https://api.linode.com/v4/databases/mysql/instances/{instanceId}/patch

Apply security patches and updates to the underlying operating system of the Managed MySQL Database. This function runs during regular maintenance windows, which are configurable with the Managed MySQL Database Update ( PUT /databases/mysql/instances/{instanceId}) command.

Requires read_write access to the Database.

The Database must have an active status to perform this command.

Note

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

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

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed MySQL Database.

Request Samples

Response Samples

Responses

Managed MySQL Database SSL Certificate View

GET https://api.linode.com/v4/databases/mysql/instances/{instanceId}/ssl

Display the SSL CA certificate for an accessible Managed MySQL Database.

The Database must have an active status to perform this command.

Authorizations

personalAccessToken
oauthdatabases:read_only

Path Parameters

instanceIdinteger
Required

The ID of the Managed MySQL Database.

Request Samples

Response Samples

Responses

Managed PostgreSQL Databases List

GET https://api.linode.com/v4/databases/postgresql/instances

Display all accessible Managed PostgreSQL Databases.

Authorizations

personalAccessToken
oauthdatabases:read_only

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..100
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Managed PostgreSQL Database Create

POST https://api.linode.com/v4/databases/postgresql/instances

Provision a Managed PostgreSQL Database.

Restricted Users must have the add_databases grant to use this command.

New instances can take approximately 15 to 30 minutes to provision.

The allow_list is used to control access to the Managed Database.

  • IP addresses on this list can access the Managed Database. All other sources are blocked.
  • Entering an empty array ([]) blocks all connections (both public and private) to the Managed Database.

All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week.

All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database during configurable maintenance windows.

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

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

  • To modify update the maintenance window for a Database, use the Managed PostgreSQL Database Update ( PUT /databases/postgresql/instances/{instanceId}) command.

Authorizations

personalAccessToken
oauthdatabases:read_write

Request Body Schema

allow_list
array of strings

A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

By default, this is an empty array ([]), which blocks all connections (both public and private) to the Managed Database.

cluster_size
integer
Enum: 1 3 Default: 1

The number of Linode Instance nodes deployed to the Managed Database.

Choosing 3 nodes creates a high availability cluster consisting of 1 primary node and 2 replica nodes.

encrypted
boolean

Whether the Managed Databases is encrypted.

engine
Required
string

The Managed Database engine in engine/version format.

label
Filterable
Required
string 3..32 characters

A unique, user-defined string referring to the Managed Database.

region
Filterable
Required
string

The Region ID for the Managed Database.

replication_commit_type
string
Enum: true local remote_write remote_apply false Default: local

The synchronization level of the replicating server.

Must be local or off for the asynch replication type.

Must be on, remote_write, or remote_apply for the semi_synch replication type.

replication_type
string
Enum: none asynch semi_synch

The replication method used for the Managed Database.

Defaults to none for a single cluster and semi_synch for a high availability cluster.

Must be none for a single node cluster.

Must be asynch or semi_synch for a high availability cluster.

ssl_connection
boolean
Default: true

Whether to require SSL credentials to establish a connection to the Managed Database.

Use the Managed PostgreSQL Database Credentials View ( GET /databases/postgresql/instances/{instanceId}/credentials) command for access information.

type
Filterable
Required
string

The Linode Instance type used by the Managed Database for its nodes.

Request Samples

Response Samples

Responses

Managed PostgreSQL Database Delete

DELETE https://api.linode.com/v4/databases/postgresql/instances/{instanceId}

Remove a Managed PostgreSQL Database from your Account.

Requires read_write access to the Database.

The Database must have an active, failed, or degraded status to perform this command.

Only unrestricted Users can access this command, and have access regardless of the acting token’s OAuth scopes.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed PostgreSQL Database.

Request Samples

Response Samples

Responses

Managed PostgreSQL Database View

GET https://api.linode.com/v4/databases/postgresql/instances/{instanceId}

Display information for a single, accessible Managed PostgreSQL Database.

Authorizations

personalAccessToken
oauthdatabases:read_only

Path Parameters

instanceIdinteger
Required

The ID of the Managed PostgreSQL Database.

Request Samples

Response Samples

Responses

Managed PostgreSQL Database Update

PUT https://api.linode.com/v4/databases/postgresql/instances/{instanceId}

Update a Managed PostgreSQL Database.

Requires read_write access to the Database.

The Database must have an active status to perform this command.

Updating addresses in the allow_list overwrites any existing addresses.

  • IP addresses on this list can access the Managed Database. All other sources are blocked.
  • Entering an empty array ([]) blocks all connections (both public and private) to the Managed Database.
  • 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.

All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database. The maintenance window for these updates is configured with the Managed Database’s updates property.

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

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

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed PostgreSQL Database.

Request Body Schema

allow_list
array of strings

A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

By default, this is an empty array ([]), which blocks all connections (both public and private) to the Managed Database.

label
Filterable
string 3..32 characters

A unique, user-defined string referring to the Managed Database.

updates
object

Configuration settings for automated patch update maintenance for the Managed Database.

day_of_week
integer 1..7

The day to perform maintenance. 1=Monday, 2=Tuesday, etc.

duration
integer 1..3

The maximum maintenance window time in hours.

frequency
string
Enum: weekly monthly Default: weekly

Whether maintenance occurs on a weekly or monthly basis.

hour_of_day
integer 0..23

The hour to begin maintenance based in UTC time.

week_of_month
Nullable
integer 1..4

The week of the month to perform monthly frequency updates. Defaults to null.

  • Required for monthly frequency updates.

  • Must be null for weekly frequency updates.

Request Samples

Response Samples

Responses

Managed PostgreSQL Database Backups List

GET https://api.linode.com/v4/databases/postgresql/instances/{instanceId}/backups

Display all backups for an accessible Managed PostgreSQL Database.

The Database must not be provisioning to perform this command.

Database auto type backups are created every 24 hours at 0:00 UTC. Each auto backup is retained for 7 days.

Database snapshot type backups are created by accessing the Managed PostgreSQL Database Backup Snapshot Create ( POST /databases/postgresql/instances/{instanceId}/backups) command.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed PostgreSQL Database.

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..100
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Managed PostgreSQL Database Backup Snapshot Create

POST https://api.linode.com/v4/databases/postgresql/instances/{instanceId}/backups

Creates a snapshot backup of a Managed PostgreSQL Database.

Requires read_write access to the Database.

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.

The Database must have an active status to perform this command.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed PostgreSQL Database.

Request Body Schema

label
Required
string 3..64 characters

The label for the Database snapshot backup.

  • Must use only letters, numbers, underscores, dashes, and periods.
  • Must begin and end with a letter or number.
  • Must not include two dashes, underscores, or periods in a row.

target
string
Enum: primary secondary Default: primary

The Database cluster target.

If the Database is a high availability cluster, choosing secondary creates a snapshot backup of a replica node.

Request Samples

Response Samples

Responses

Managed PostgreSQL Database Backup Delete

DELETE https://api.linode.com/v4/databases/postgresql/instances/{instanceId}/backups/{backupId}

Delete a single backup for an accessible Managed PostgreSQL Database.

Requires read_write access to the Database.

The Database must not be provisioning to perform this command.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed PostgreSQL Database.

backupIdinteger
Required

The ID of the Managed PostgreSQL Database backup.

Request Samples

Response Samples

Responses

Managed PostgreSQL Database Backup View

GET https://api.linode.com/v4/databases/postgresql/instances/{instanceId}/backups/{backupId}

Display information for a single backup for an accessible Managed PostgreSQL Database.

The Database must not be provisioning to perform this command.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed PostgreSQL Database.

backupIdinteger
Required

The ID of the Managed PostgreSQL Database backup.

Request Samples

Response Samples

Responses

Managed PostgreSQL Database Backup Restore

POST https://api.linode.com/v4/databases/postgresql/instances/{instanceId}/backups/{backupId}/restore

Restore a backup to a Managed PostgreSQL Database on your Account.

Requires read_write access to the Database.

The Database must have an active status to perform this command.

Note: Restoring from a backup will erase all existing data on the database instance and replace it with backup data.

Note: Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed PostgreSQL Database.

backupIdinteger
Required

The ID of the Managed PostgreSQL Database backup.

Request Samples

Response Samples

Responses

Managed PostgreSQL Database Credentials View

GET https://api.linode.com/v4/databases/postgresql/instances/{instanceId}/credentials

Display the root username and password for an accessible Managed PostgreSQL Database.

The Database must have an active status to perform this command.

Authorizations

personalAccessToken
oauthdatabases:read_only

Path Parameters

instanceIdinteger
Required

The ID of the Managed PostgreSQL Database.

Request Samples

Response Samples

Responses

Managed PostgreSQL Database Credentials Reset

POST https://api.linode.com/v4/databases/postgresql/instances/{instanceId}/credentials/reset

Reset the root password for a Managed PostgreSQL Database.

Requires read_write access to the Database.

A new root password is randomly generated and accessible with the Managed PostgreSQL Database Credentials View ( GET /databases/postgresql/instances/{instanceId}/credentials) command.

Only unrestricted Users can access this command, and have access regardless of the acting token’s OAuth scopes.

Note: Note that it may take several seconds for credentials to reset.

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed PostgreSQL Database.

Request Samples

Response Samples

Responses

Managed PostgreSQL Database Patch

POST https://api.linode.com/v4/databases/postgresql/instances/{instanceId}/patch

Apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database. This function runs during regular maintenance windows, which are configurable with the Managed PostgreSQL Database Update ( PUT /databases/postgresql/instances/{instanceId}) command.

Requires read_write access to the Database.

The Database must have an active status to perform this command.

Note

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

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

Authorizations

personalAccessToken
oauthdatabases:read_write

Path Parameters

instanceIdinteger
Required

The ID of the Managed PostgreSQL Database.

Request Samples

Response Samples

Responses

Managed PostgreSQL Database SSL Certificate View

GET https://api.linode.com/v4/databases/postgresql/instances/{instanceId}/ssl

Display the SSL CA certificate for an accessible Managed PostgreSQL Database.

The Database must have an active status to perform this command.

Authorizations

personalAccessToken
oauthdatabases:read_only

Path Parameters

instanceIdinteger
Required

The ID of the Managed PostgreSQL Database.

Request Samples

Response Samples

Responses

Managed Database Types List

GET https://api.linode.com/v4/databases/types

Display all Managed Database node types. The type and number of nodes determine the resources and price of a Managed Database instance.

Each Managed Database can have one node type. In the case of a high availabilty Database, all nodes are provisioned according to the chosen type.

Authorizations

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..100
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Managed Database Type View

GET https://api.linode.com/v4/databases/types/{typeId}

Display the details of a single Managed Database type. The type and number of nodes determine the resources and price of a Managed Database instance.

Authorizations

Path Parameters

typeIdstring
Required

The ID of the Managed Database type.

Query Parameters

page
Type:
integer >= 1
Default: 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..100
Default: 100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses