This command is currently only available for customers who already have an active Managed Database.
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..500
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}
This command is currently only available for customers who already have an active Managed Database.
Display information for a single Managed Database engine type and version.
Authorizations
Path Parameters
engineId
stringRequired
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..500
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
This command is currently only available for customers who already have an active Managed Database.
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
oauth
databases:read_only
Query Parameters
page
Type:
integer
>=
1
Default:
1
Default:
1
The page of a collection to return.
page_size
Type:
integer
25..500
Default:
100
Default:
100
The number of items to return per page.
Request Samples
Response Samples
Responses
Managed MySQL Databases List
GET
https://api.linode.com/v4/databases/mysql/instances
This command is currently only available for customers who already have an active Managed Database.
Display all accessible Managed MySQL Databases.
Authorizations
personalAccessToken
oauth
databases:read_only
Query Parameters
page
Type:
integer
>=
1
Default:
1
Default:
1
The page of a collection to return.
page_size
Type:
integer
25..500
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
This command is currently only available for customers who already have an active Managed Database.
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 and ranges in this list can access the Managed Database. All other sources are blocked.
If 0.0.0.0/0 is a value in this list, then all IP addresses can access the Managed Database.
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.
This command is currently only available for customers who already have an active Managed Database.
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
oauth
databases:read_write
Path Parameters
instanceId
integerRequired
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}
This command is currently only available for customers who already have an active Managed Database.
Display information for a single, accessible Managed MySQL Database.
Authorizations
personalAccessToken
oauth
databases:read_only
Path Parameters
instanceId
integerRequired
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}
This command is currently only available for customers who already have an active Managed Database.
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 and ranges in this list can access the Managed Database. All other sources are blocked.
If 0.0.0.0/0 is a value in this list, then all IP addresses can access the Managed Database.
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
oauth
databases:read_write
Path Parameters
instanceId
integerRequired
The ID of the Managed MySQL Database.
Request Samples
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.
If 0.0.0.0/0 is a value in this list, then all IP addresses can access the Managed Database.
label
string
3..32
characters
A unique, user-defined string referring to the Managed Database.
type
string
Request re-sizing of your cluster to a Linode Type with more disk space. For example, you could request a Linode Type that uses a higher plan.
Needs to be a Linode Type with more disk space than your current Linode.
Resizing to a larger Linode Type can accrue additional cost. Review the price output in the
Types List
operation for more information.
You can’t update the allow_list and set a new type in the same request.
Any active updates to your cluster need to complete before you can request a resize. The reverse is also true: An active resizing needs to complete before you can perform any other update.
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:
weeklymonthly
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.
Response Samples
Responses
Managed MySQL Database Backups List
GET
https://api.linode.com/v4/databases/mysql/instances/{instanceId}/backups
This command is currently only available for customers who already have an active Managed Database.
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.
POST
https://api.linode.com/v4/databases/mysql/instances/{instanceId}/backups
This command is currently only available for customers who already have an active Managed Database.
Creates a snapshot backup of a Managed MySQL Database.
Requires read_write access to the Database.
Up to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made.
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. If another backup is in progress, it must complete before a new backup can be initiated.
Authorizations
personalAccessToken
oauth
databases:read_write
Path Parameters
instanceId
integerRequired
The ID of the Managed MySQL Database.
Request Samples
Request Body Schema
label
Required
string
1..30
characters
The label for the Database snapshot backup.
Can only contain ASCII letters, numbers, and underscores (_).
Must be unique among other backup labels for this Database.
target
string
Enum:
primarysecondary
Default:
primary
The Database cluster target.
If the Database is a high availability cluster, choosing secondary creates a snapshot backup of a replica node.
This command is currently only available for customers who already have an active Managed Database.
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
oauth
databases:read_write
Path Parameters
instanceId
integerRequired
The ID of the Managed MySQL Database.
backupId
integerRequired
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}
This command is currently only available for customers who already have an active Managed Database.
Display information for a single backup for an accessible Managed MySQL Database.
The Database must not be provisioning to perform this command.
Authorizations
personalAccessToken
oauth
databases:read_write
Path Parameters
instanceId
integerRequired
The ID of the Managed MySQL Database.
backupId
integerRequired
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
This command is currently only available for customers who already have an active Managed Database.
Restore a backup to a Managed MySQL Database on your Account.
Requires read_write access to the Database.
The Database must have an active, degraded, or failed 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
oauth
databases:read_write
Path Parameters
instanceId
integerRequired
The ID of the Managed MySQL Database.
backupId
integerRequired
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
This command is currently only available for customers who already have an active Managed Database.
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
oauth
databases:read_only
Path Parameters
instanceId
integerRequired
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
This command is currently only available for customers who already have an active Managed Database.
Reset the root password for a Managed MySQL Database.
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
oauth
databases:read_write
Path Parameters
instanceId
integerRequired
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
This command is currently only available for customers who already have an active Managed Database.
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
oauth
databases:read_write
Path Parameters
instanceId
integerRequired
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
This command is currently only available for customers who already have an active Managed Database.
Display the SSL CA certificate for an accessible Managed MySQL Database.
The Database must have an active status to perform this command.
Authorizations
personalAccessToken
oauth
databases:read_only
Path Parameters
instanceId
integerRequired
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
This command is currently only available for customers who already have an active Managed Database.
Display all accessible Managed PostgreSQL Databases.
Authorizations
personalAccessToken
oauth
databases:read_only
Query Parameters
page
Type:
integer
>=
1
Default:
1
Default:
1
The page of a collection to return.
page_size
Type:
integer
25..500
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
This command is currently only available for customers who already have an active Managed Database.
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 and ranges in this list can access the Managed Database. All other sources are blocked.
If 0.0.0.0/0 is a value in this list, then all IP addresses can access the Managed Database.
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.
This command is currently only available for customers who already have an active Managed Database.
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
oauth
databases:read_write
Path Parameters
instanceId
integerRequired
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}
This command is currently only available for customers who already have an active Managed Database.
Display information for a single, accessible Managed PostgreSQL Database.
Authorizations
personalAccessToken
oauth
databases:read_only
Path Parameters
instanceId
integerRequired
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}
This command is currently only available for customers who already have an active Managed Database.
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 and ranges in this list can access the Managed Database. All other sources are blocked.
If 0.0.0.0/0 is a value in this list, then all IP addresses can access the Managed Database.
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
oauth
databases:read_write
Path Parameters
instanceId
integerRequired
The ID of the Managed PostgreSQL Database.
Request Samples
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.
If 0.0.0.0/0 is a value in this list, then all IP addresses can access the Managed Database.
label
string
3..32
characters
A unique, user-defined string referring to the Managed Database.
type
string
Request re-sizing of your cluster to a Linode Type with more disk space. For example, you could request a Linode Type that uses a higher plan.
Needs to be a Linode Type with more disk space than your current Linode.
Resizing to a larger Linode Type can accrue additional cost. Review the price output in the
Types List
operation for more information.
You can’t update the allow_list and set a new type in the same request.
Any active updates to your cluster need to complete before you can request a resize. The reverse is also true: An active resizing needs to complete before you can perform any other update.
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:
weeklymonthly
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.
Response Samples
Responses
Managed PostgreSQL Database Backups List
GET
https://api.linode.com/v4/databases/postgresql/instances/{instanceId}/backups
This command is currently only available for customers who already have an active Managed Database.
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.
POST
https://api.linode.com/v4/databases/postgresql/instances/{instanceId}/backups
This command is currently only available for customers who already have an active Managed Database.
Creates a snapshot backup of a Managed PostgreSQL Database.
Requires read_write access to the Database.
Up to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made.
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. If another backup is in progress, it must complete before a new backup can be initiated.
Authorizations
personalAccessToken
oauth
databases:read_write
Path Parameters
instanceId
integerRequired
The ID of the Managed PostgreSQL Database.
Request Samples
Request Body Schema
label
Required
string
1..30
characters
The label for the Database snapshot backup.
Can only contain ASCII letters, numbers, and underscores (_).
Must be unique among other backup labels for this Database.
target
string
Enum:
primarysecondary
Default:
primary
The Database cluster target.
If the Database is a high availability cluster, choosing secondary creates a snapshot backup of a replica node.
This command is currently only available for customers who already have an active Managed Database.
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
oauth
databases:read_write
Path Parameters
instanceId
integerRequired
The ID of the Managed PostgreSQL Database.
backupId
integerRequired
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}
This command is currently only available for customers who already have an active Managed Database.
Display information for a single backup for an accessible Managed PostgreSQL Database.
The Database must not be provisioning to perform this command.
Authorizations
personalAccessToken
oauth
databases:read_write
Path Parameters
instanceId
integerRequired
The ID of the Managed PostgreSQL Database.
backupId
integerRequired
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
This command is currently only available for customers who already have an active Managed Database.
Restore a backup to a Managed PostgreSQL Database on your Account.
Requires read_write access to the Database.
The Database must have an active, degraded, or failed 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
oauth
databases:read_write
Path Parameters
instanceId
integerRequired
The ID of the Managed PostgreSQL Database.
backupId
integerRequired
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
This command is currently only available for customers who already have an active Managed Database.
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
oauth
databases:read_only
Path Parameters
instanceId
integerRequired
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
This command is currently only available for customers who already have an active Managed Database.
Reset the root password for a Managed PostgreSQL Database.
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
oauth
databases:read_write
Path Parameters
instanceId
integerRequired
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
This command is currently only available for customers who already have an active Managed Database.
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
oauth
databases:read_write
Path Parameters
instanceId
integerRequired
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
This command is currently only available for customers who already have an active Managed Database.
Display the SSL CA certificate for an accessible Managed PostgreSQL Database.
The Database must have an active status to perform this command.
Authorizations
personalAccessToken
oauth
databases:read_only
Path Parameters
instanceId
integerRequired
The ID of the Managed PostgreSQL Database.
Request Samples
Response Samples
Responses
Managed Database Types List
GET
https://api.linode.com/v4/databases/types
This command is currently only available for customers who already have an active Managed Database.
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 availability 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..500
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}
This command is currently only available for customers who already have an active Managed Database.
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.
