Managed Databases
v4.176.0 List managed databases GET
https://api.linode.com/v4/databases/instances
This operation 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
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli databases list
Response Samples
200
default
{
"data" : [
{
"allow_list" : [
"203.0.113.1/32" ,
"192.0.1.0/24"
],
"cluster_size" : 3 ,
"created" : "2022-01-01T00:01:01" ,
"encrypted" : false ,
"engine" : "mysql" ,
"hosts" : {
"primary" : "lin-123-456-mysql-mysql-primary.servers.linodedb.net" ,
"secondary" : "lin-123-456-mysql-primary-private.servers.linodedb.net"
},
"id" : 123 ,
"instance_uri" : "/v4/databases/mysql/instances/123" ,
"label" : "example-db" ,
"region" : "us-east" ,
"status" : "active" ,
"type" : "g6-dedicated-2" ,
"updated" : "2022-01-01T00:01:01" ,
"updates" : {
"day_of_week" : 1 ,
"duration" : 3 ,
"frequency" : "weekly" ,
"hour_of_day" : 0 ,
"week_of_month" : null
},
"version" : "8.0.26"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a paginated list of all accessible Managed Databases on your Account.
array
of objects
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.
integerEnum:
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.
string<date-time>
Read-only When this Managed Database was created.
booleanDefault:
false
Whether the Managed Databases is encrypted.
stringEnum:
mysql
postgresql
Read-only The Managed Database engine type.
object
Read-only The primary and secondary hosts for the Managed Database.
These are assigned after provisioning is complete.
string
The primary host for the Managed Database.
string
The secondary/private network host for the Managed Database.
A private network host and a private IP can only be used to access a Database Cluster from Linodes in the same data center and will not incur transfer costs.
Note : The secondary hostname is publicly viewable and accessible.
integer
Read-only A unique ID that can be used to identify and reference
the Managed Database.
string
Read-only Append this to https://api.linode.com to run commands
for the Managed Database.
string
3..32
characters
A unique, user-defined string referring to the Managed Database.
string
The Region ID for the Managed Database.
stringEnum:
provisioning
active
suspending
suspended
resuming
restoring
failed
degraded
updating
backing_up
Read-only The operating status of the Managed Database.
string
The Linode Instance type used by the Managed Database for its nodes.
string<date-time>
Read-only When this Managed Database was last updated.
object
Configuration settings for automated patch update maintenance for
the Managed Database.
integer
1..7
The day to perform maintenance. 1=Monday, 2=Tuesday, etc.
integer
1..3
The maximum maintenance window time in hours.
stringEnum:
weekly
monthly
Default:
weekly
Whether maintenance occurs on a weekly or monthly basis.
integer
0..23
The hour to begin maintenance based in UTC time.
integer
1..4
The week of the month to perform monthly frequency updates. Defaults to null.
string
Read-only The Managed Database engine version.
integer
Read-only The current page .
integer
Read-only The total number of pages .
integer
Read-only The total number of results.
Error
array
of objects
string
The field in the request that caused this error. This may be a path,
separated by periods in the case of nested fields. In
some cases this may come back as “null” if the error is
not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed
immediately by changing the data you sent in the request,
but in some cases you will be instructed to Open a support
ticket
or perform some other action before you can complete the
request successfully.
List managed MySQL databases GET
https://api.linode.com/v4/databases/mysql/instances
This operation 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
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli databases mysql-list
Response Samples
200
default
{
"data" : [
{
"allow_list" : [
"203.0.113.1/32" ,
"192.0.1.0/24"
],
"cluster_size" : 3 ,
"created" : "2022-01-01T00:01:01" ,
"encrypted" : false ,
"engine" : "mysql" ,
"hosts" : {
"primary" : "lin-123-456-mysql-mysql-primary.servers.linodedb.net" ,
"secondary" : "lin-123-456-mysql-primary-private.servers.linodedb.net"
},
"id" : 123 ,
"label" : "example-db" ,
"port" : 3306 ,
"region" : "us-east" ,
"replication_type" : "semi_synch" ,
"ssl_connection" : true ,
"status" : "active" ,
"total_disk_size_gb" : 15 ,
"type" : "g6-dedicated-2" ,
"updated" : "2022-01-01T00:01:01" ,
"updates" : {
"day_of_week" : 1 ,
"duration" : 3 ,
"frequency" : "weekly" ,
"hour_of_day" : 0 ,
"week_of_month" : null
},
"used_disk_size_gb" : 2 ,
"version" : "8.0.26"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns a paginated list of all accessible Managed MySQL Databases on your Account.
array
of objects
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.
integerEnum:
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.
string<date-time>
Read-only When this Managed Database was created.
booleanDefault:
false
Whether the Managed Databases is encrypted.
string
Read-only The Managed Database engine type.
object
Read-only The primary and secondary hosts for the Managed Database.
These are assigned after provisioning is complete.
string
The primary host for the Managed Database.
string
The secondary/private network host for the Managed Database.
A private network host and a private IP can only be used to access a Database Cluster from Linodes in the same data center and will not incur transfer costs.
Note : The secondary hostname is publicly viewable and accessible.
integer
Read-only A unique ID that can be used to identify and reference
the Managed Database.
string
3..32
characters
A unique, user-defined string referring to the Managed Database.
integer
The access port for this Managed Database.
string
The Region ID for the Managed Database.
stringEnum:
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.
booleanDefault:
true
Whether to require SSL credentials to establish a connection to the Managed Database.
Run the Get managed MySQL database credentials operation for access information.
stringEnum:
provisioning
active
suspending
suspended
resuming
restoring
failed
degraded
updating
backing_up
Read-only The operating status of the Managed Database.
integer
The total disk size of the database in GB.
string
The Linode Instance type used by the Managed Database for its nodes.
string<date-time>
Read-only When this Managed Database was last updated.
object
Configuration settings for automated patch update maintenance for
the Managed Database.
integer
1..7
The day to perform maintenance. 1=Monday, 2=Tuesday, etc.
integer
1..3
The maximum maintenance window time in hours.
stringEnum:
weekly
monthly
Default:
weekly
Whether maintenance occurs on a weekly or monthly basis.
integer
0..23
The hour to begin maintenance based in UTC time.
integer
1..4
The week of the month to perform monthly frequency updates. Defaults to null.
integer
The used space of the database in GB.
string
Read-only The Managed Database engine version.
integer
Read-only The current page .
integer
Read-only The total number of pages .
integer
Read-only The total number of results.
Error
array
of objects
string
The field in the request that caused this error. This may be a path,
separated by periods in the case of nested fields. In
some cases this may come back as “null” if the error is
not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed
immediately by changing the data you sent in the request,
but in some cases you will be instructed to Open a support
ticket
or perform some other action before you can complete the
request successfully.
Create a managed MySQL database POST
https://api.linode.com/v4/databases/mysql/instances
This operation 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 operation.
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.
To modify update the maintenance window for a Database, run the Update a managed MySQL database operation.
Authorizations personalAccessToken oauth databases:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"label": "example-db",
"region": "us-east",
"type": "g6-dedicated-2",
"cluster_size": 3,
"engine": "mysql/8.0.26",
"encrypted": false,
"ssl_connection": true,
"replication_type": "semi_synch",
"allow_list": [
"203.0.113.1",
"192.0.1.0/24"
]
}' \
linode-cli databases mysql-create \
\
\
\
3 \
\
false \
false \
\
\
Request Body Schema 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.
integerEnum:
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.
booleanDefault:
false
Whether the Managed Databases is encrypted.
string
The Managed Database engine in engine/version format.
string
3..32
characters
A unique, user-defined string referring to the Managed Database.
string
The Region ID for the Managed Database.
stringEnum:
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.
booleanDefault:
true
Whether to require SSL credentials to establish a connection to the Managed Database.
Run the Get managed MySQL database credentials operation for access information.
string
The Linode Instance type used by the Managed Database for its nodes.
Response Samples
200
default
{
"allow_list" : [
"203.0.113.1/32" ,
"192.0.1.0/24"
],
"cluster_size" : 3 ,
"created" : "2022-01-01T00:01:01" ,
"encrypted" : false ,
"engine" : "mysql" ,
"hosts" : {
"primary" : "lin-123-456-mysql-mysql-primary.servers.linodedb.net" ,
"secondary" : "lin-123-456-mysql-primary-private.servers.linodedb.net"
},
"id" : 123 ,
"label" : "example-db" ,
"port" : 3306 ,
"region" : "us-east" ,
"replication_type" : "semi_synch" ,
"ssl_connection" : true ,
"status" : "active" ,
"total_disk_size_gb" : 15 ,
"type" : "g6-dedicated-2" ,
"updated" : "2022-01-01T00:01:01" ,
"updates" : {
"day_of_week" : 1 ,
"duration" : 3 ,
"frequency" : "weekly" ,
"hour_of_day" : 0 ,
"week_of_month" : null
},
"used_disk_size_gb" : 2 ,
"version" : "8.0.26"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A new Managed MySQL Database is provisioning.
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.
integerEnum:
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.
string<date-time>
Read-only When this Managed Database was created.
booleanDefault:
false
Whether the Managed Databases is encrypted.
string
Read-only The Managed Database engine type.
object
Read-only The primary and secondary hosts for the Managed Database. These are assigned
after provisioning is complete.
string
The primary host for the Managed Database.
string
The secondary/private network host for the Managed Database.
A private network host and a private IP can only be used to access a Database Cluster from Linodes in the same data center and will not incur transfer costs.
Note : The secondary hostname is publicly viewable and accessible.
integer
Read-only A unique ID that can be used to identify and reference the Managed Database.
string
3..32
characters
A unique, user-defined string referring to the Managed Database.
integer
The access port for this Managed Database.
string
The Region ID for the Managed Database.
stringEnum:
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.
booleanDefault:
true
Whether to require SSL credentials to establish a connection to the Managed Database.
Run the Get managed MySQL database credentials operation for access information.
stringEnum:
provisioning
active
suspending
suspended
resuming
restoring
failed
degraded
updating
backing_up
Read-only The operating status of the Managed Database.
integer
The total disk size of the database in GB.
string
The Linode Instance type used by the Managed Database for its nodes.
string<date-time>
Read-only When this Managed Database was last updated.
object
Configuration settings for automated patch update maintenance for the Managed Database.
integer
1..7
The day to perform maintenance. 1=Monday, 2=Tuesday, etc.
integer
1..3
The maximum maintenance window time in hours.
stringEnum:
weekly
monthly
Default:
weekly
Whether maintenance occurs on a weekly or monthly basis.
integer
0..23
The hour to begin maintenance based in UTC time.
integer
1..4
The week of the month to perform monthly frequency updates. Defaults to null.
integer
The used space of the database in GB.
string
Read-only The Managed Database engine version.
Error
array
of objects
string
The field in the request that caused this error. This may be a path,
separated by periods in the case of nested fields. In
some cases this may come back as “null” if the error is
not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed
immediately by changing the data you sent in the request,
but in some cases you will be instructed to Open a support
ticket
or perform some other action before you can complete the
request successfully.
Delete a managed MySQL database DELETE
https://api.linode.com/v4/databases/mysql/instances/{instanceId}
This operation 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 operation.
Only unrestricted Users can access this operation, and have access regardless of the acting token’s OAuth scopes.
Authorizations personalAccessToken oauth databases:read_write
Path Parameters instanceId integer
Required The ID of the Managed PostgreSQL Database.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
\
linode-cli databases mysql-delete 123
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Managed MySQL Database successfully deleted.
Error
array
of objects
string
The field in the request that caused this error. This may be a path,
separated by periods in the case of nested fields. In
some cases this may come back as “null” if the error is
not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed
immediately by changing the data you sent in the request,
but in some cases you will be instructed to Open a support
ticket
or perform some other action before you can complete the
request successfully.
Get a managed MySQL database GET
https://api.linode.com/v4/databases/mysql/instances/{instanceId}
This operation 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 integer
Required The ID of the Managed PostgreSQL Database.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli databases mysql-view 123
Response Samples
200
default
{
"allow_list" : [
"203.0.113.1/32" ,
"192.0.1.0/24"
],
"cluster_size" : 3 ,
"created" : "2022-01-01T00:01:01" ,
"encrypted" : false ,
"engine" : "mysql" ,
"hosts" : {
"primary" : "lin-123-456-mysql-mysql-primary.servers.linodedb.net" ,
"secondary" : "lin-123-456-mysql-primary-private.servers.linodedb.net"
},
"id" : 123 ,
"label" : "example-db" ,
"port" : 3306 ,
"region" : "us-east" ,
"replication_type" : "semi_synch" ,
"ssl_connection" : true ,
"status" : "active" ,
"total_disk_size_gb" : 15 ,
"type" : "g6-dedicated-2" ,
"updated" : "2022-01-01T00:01:01" ,
"updates" : {
"day_of_week" : 1 ,
"duration" : 3 ,
"frequency" : "weekly" ,
"hour_of_day" : 0 ,
"week_of_month" : null
},
"used_disk_size_gb" : 2 ,
"version" : "8.0.26"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Returns information for a single Managed MySQL Database.
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.
integerEnum:
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.
string<date-time>
Read-only When this Managed Database was created.
booleanDefault:
false
Whether the Managed Databases is encrypted.
string
Read-only The Managed Database engine type.
object
Read-only The primary and secondary hosts for the Managed Database. These are assigned
after provisioning is complete.
string
The primary host for the Managed Database.
string
The secondary/private network host for the Managed Database.
A private network host and a private IP can only be used to access a Database Cluster from Linodes in the same data center and will not incur transfer costs.
Note : The secondary hostname is publicly viewable and accessible.
integer
Read-only A unique ID that can be used to identify and reference the Managed Database.
string
3..32
characters
A unique, user-defined string referring to the Managed Database.
integer
The access port for this Managed Database.
string
The Region ID for the Managed Database.
stringEnum:
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.
booleanDefault:
true
Whether to require SSL credentials to establish a connection to the Managed Database.
Run the Get managed MySQL database credentials operation for access information.
stringEnum:
provisioning
active
suspending
suspended
resuming
restoring
failed
degraded
updating
backing_up
Read-only The operating status of the Managed Database.
integer
The total disk size of the database in GB.
string
The Linode Instance type used by the Managed Database for its nodes.
string<date-time>
Read-only When this Managed Database was last updated.
object
Configuration settings for automated patch update maintenance for the Managed Database.
integer
1..7
The day to perform maintenance. 1=Monday, 2=Tuesday, etc.
integer
1..3
The maximum maintenance window time in hours.
stringEnum:
weekly
monthly
Default:
weekly
Whether maintenance occurs on a weekly or monthly basis.
integer
0..23
The hour to begin maintenance based in UTC time.
integer
1..4
The week of the month to perform monthly frequency updates. Defaults to null.
integer
The used space of the database in GB.
string
Read-only The Managed Database engine version.
Error
array
of objects
string
The field in the request that caused this error. This may be a path,
separated by periods in the case of nested fields. In
some cases this may come back as “null” if the error is
not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed
immediately by changing the data you sent in the request,
but in some cases you will be instructed to Open a support
ticket
or perform some other action before you can complete the
request successfully.
Update a managed MySQL database PUT
https://api.linode.com/v4/databases/mysql/instances/{instanceId}
This operation 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 operation.
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 operation 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 integer
Required The ID of the Managed PostgreSQL Database.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"label": "example-db",
"allow_list": [
"203.0.113.1",
"192.0.1.0/24"
],
"type": "g6-standard-1",
"updates": {
"frequency": "monthly",
"duration": 3,
"hour_of_day": 12,
"day_of_week": 4,
"week_of_month": 3
}
}' \
linode-cli databases mysql-update 123 \
\
\
\
\
\
3 \
12 \
4 \
3
Request Body Schema 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.
string
3..32
characters
A unique, user-defined string referring to the Managed Database.
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 List types 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.
object
Configuration settings for automated patch update maintenance for the Managed Database.
integer
1..7
The day to perform maintenance. 1=Monday, 2=Tuesday, etc.
integer
1..3
The maximum maintenance window time in hours.
stringEnum:
weekly
monthly
Default:
weekly
Whether maintenance occurs on a weekly or monthly basis.
integer
0..23
The hour to begin maintenance based in UTC time.
integer
1..4
The week of the month to perform monthly frequency updates. Defaults to null.
Response Samples
200
default
{
"allow_list" : [
"203.0.113.1/32" ,
"192.0.1.0/24"
],
"cluster_size" : 3 ,
"created" : "2022-01-01T00:01:01" ,
"encrypted" : false ,
"engine" : "mysql" ,
"hosts" : {
"primary" : "lin-123-456-mysql-mysql-primary.servers.linodedb.net" ,
"secondary" : "lin-123-456-mysql-primary-private.servers.linodedb.net"
},
"id" : 123 ,
"label" : "example-db" ,
"port" : 3306 ,
"region" : "us-east" ,
"replication_type" : "semi_synch" ,
"ssl_connection" : true ,
"status" : "active" ,
"total_disk_size_gb" : 15 ,
"type" : "g6-dedicated-2" ,
"updated" : "2022-01-01T00:01:01" ,
"updates" : {
"day_of_week" : 1 ,
"duration" : 3 ,
"frequency" : "weekly" ,
"hour_of_day" : 0 ,
"week_of_month" : null
},
"used_disk_size_gb" : 2 ,
"version" : "8.0.26"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Managed Database updated successfully.
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.
integerEnum:
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.
string<date-time>
Read-only When this Managed Database was created.
booleanDefault:
false
Whether the Managed Databases is encrypted.
string
Read-only The Managed Database engine type.
object
Read-only The primary and secondary hosts for the Managed Database. These are assigned
after provisioning is complete.
string
The primary host for the Managed Database.
string
The secondary/private network host for the Managed Database.
A private network host and a private IP can only be used to access a Database Cluster from Linodes in the same data center and will not incur transfer costs.
Note : The secondary hostname is publicly viewable and accessible.
integer
Read-only A unique ID that can be used to identify and reference the Managed Database.
string
3..32
characters
A unique, user-defined string referring to the Managed Database.
integer
The access port for this Managed Database.
string
The Region ID for the Managed Database.
stringEnum:
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.
booleanDefault:
true
Whether to require SSL credentials to establish a connection to the Managed Database.
Run the Get managed MySQL database credentials operation for access information.
stringEnum:
provisioning
active
suspending
suspended
resuming
restoring
failed
degraded
updating
backing_up
Read-only The operating status of the Managed Database.
integer
The total disk size of the database in GB.
string
The Linode Instance type used by the Managed Database for its nodes.
string<date-time>
Read-only When this Managed Database was last updated.
object
Configuration settings for automated patch update maintenance for the Managed Database.
integer
1..7
The day to perform maintenance. 1=Monday, 2=Tuesday, etc.
integer
1..3
The maximum maintenance window time in hours.
stringEnum:
weekly
monthly
Default:
weekly
Whether maintenance occurs on a weekly or monthly basis.
integer
0..23
The hour to begin maintenance based in UTC time.
integer
1..4
The week of the month to perform monthly frequency updates. Defaults to null.
integer
The used space of the database in GB.
string
Read-only The Managed Database engine version.
Error
array
of objects
string
The field in the request that caused this error. This may be a path,
separated by periods in the case of nested fields. In
some cases this may come back as “null” if the error is
not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed
immediately by changing the data you sent in the request,
but in some cases you will be instructed to Open a support
ticket
or perform some other action before you can complete the
request successfully.
Patch a managed MySQL database POST
https://api.linode.com/v4/databases/mysql/instances/{instanceId}/patch
This operation 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 Update a managed MySQL database operation.
Requires read_write access to the Database.
The Database must have an active status to perform this operation.
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 integer
Required The ID of the Managed PostgreSQL Database.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli databases mysql-patch 123
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Managed Database instance patch request successful.
Error
array
of objects
string
The field in the request that caused this error. This may be a path,
separated by periods in the case of nested fields. In
some cases this may come back as “null” if the error is
not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed
immediately by changing the data you sent in the request,
but in some cases you will be instructed to Open a support
ticket
or perform some other action before you can complete the
request successfully.
