Managed Databases v4.119.0

Managed Database Engines List

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

Beta

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

Beta: This endpoint is in open beta. During the beta period, Managed Databases will not incur any charges. If you deploy a Managed Database during this time, you will receive a notice with pricing details in advance of the GA (general availability) release. When accessing this endpoint, please make sure to prepend all requests with /v4beta instead of /v4, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of beta.

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

{
  "data": [
    {
      "engine": "mysql",
      "id": "mysql/8.0.26",
      "version": "8.0.26"
    }
  ],
  "page": 1,
  "pages": 1,
  "results": 1
}

Responses

Managed Database Engine View

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

Beta

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

Authorizations

Path Parameters

engineId

string

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

{
  "engine": "mysql",
  "id": "mysql/8.0.26",
  "version": "8.0.26"
}

Responses

Managed Databases List

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

Beta

Display all accessible Managed Databases on your Account, regardless of engine type.

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

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

Authorizations

personalAccessToken
oauth

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

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4beta/databases/instances

Response Samples

{
  "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",
      "version": "8.0.26"
    }
  ],
  "page": 1,
  "pages": 1,
  "results": 1
}

Responses

Returns a paginated list of all accessible Managed Databases on your Account.

data

array of objects

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

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

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

created

string <date-time>

When this Managed Database was created.

encrypted

boolean

Whether the Managed Databases is encrypted. Defaults to false.

engine

Filterable

string

The Managed Database engine type. Currently, only MySQL is available.

hosts

object

The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete.

primary

Nullable

string

The primary host for the Managed Database.

secondary

Nullable

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

A unique ID that can be used to identify and reference the Managed Database.

instance_uri

string

Append this to https://api.linode.com to run commands for the Managed Database.

label

Filterable

string 3..32 characters

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

region

Filterable

string

The Region ID for the Managed Database.

status

Filterable

string

Enum: provisioning active suspending suspended resuming restoring failed degraded

The operating status of the Managed Database.

type

Filterable

string

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

updated

string <date-time>

When this Managed Database was last updated.

version

Filterable

string

The Managed Database engine version.

page

integer

The current page.

pages

integer

The total number of pages.

results

integer

The total number of results.

Managed MySQL Databases List

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

Beta

Display all accessible Managed MySQL Databases on your Account.

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

Authorizations

personalAccessToken
oauth

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4beta/databases/mysql/instances/

Response Samples

{
  "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",
      "region": "us-east",
      "replication_type": "semi_synch",
      "ssl_connection": true,
      "status": "active",
      "type": "g6-dedicated-2",
      "updated": "2022-01-01T00:01:01",
      "version": "8.0.26"
    }
  ],
  "page": 1,
  "pages": 1,
  "results": 1
}

Responses

Returns a paginated list of all accessible Managed MySQL Databases on your Account.

data

array of objects

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

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

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

created

string <date-time>

When this Managed Database was created.

encrypted

boolean

Whether the Managed Databases is encrypted. Defaults to false.

engine

Filterable

string

The Managed Database engine type.

hosts

object

The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete.

primary

Nullable

string

The primary host for the Managed Database.

secondary

Nullable

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

A unique ID that can be used to identify and reference the Managed Database.

label

Filterable

string 3..32 characters

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

region

Filterable

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

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

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

status

Filterable

string

Enum: provisioning active suspending suspended resuming restoring failed degraded

The operating status of the Managed Database.

type

Filterable

string

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

updated

string <date-time>

When this Managed Database was last updated.

version

Filterable

string

The Managed Database engine version.

page

integer

The current page.

pages

integer

The total number of pages.

results

integer

The total number of results.

Managed MySQL Database Create

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

Beta

Provision a Managed MySQL Database.

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

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.
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, daily backups. Up to seven backups are stored for each Managed Database, providing restore points for each day of the past week.

Authorizations

personalAccessToken
oauth

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` The number of Linode Instance nodes deployed to the Managed Database. Defaults to `1`. 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. Defaults to `false`.
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` Whether to require SSL credentials to establish a connection to the Managed Database. Defaults to `false`. 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

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X POST -d '{
        "label": "example-db",
        "region": "us-east",
        "type": "g6-dedicated-2",
        "cluster_size": 3,
        "engine": "mysql/8.0.26",
        "encrypted": false,
        "ssl_connection": false,
        "replication_type": "semi_synch",
        "allow_list": [
          "203.0.113.1",
          "192.0.1.0/24"
        ]
    }' \
    https://api.linode.com/v4beta/databases/mysql/instances

Response Samples

{
  "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",
  "region": "us-east",
  "replication_type": "semi_synch",
  "ssl_connection": true,
  "status": "active",
  "type": "g6-dedicated-2",
  "updated": "2022-01-01T00:01:01",
  "version": "8.0.26"
}

Responses

A new Managed MySQL Database is provisioning.

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

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

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

created

string <date-time>

When this Managed Database was created.

encrypted

boolean

Whether the Managed Databases is encrypted. Defaults to false.

engine

Filterable

string

The Managed Database engine type.

hosts

object

The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete.

primary

Nullable

string

The primary host for the Managed Database.

secondary

Nullable

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

A unique ID that can be used to identify and reference the Managed Database.

label

Filterable

string 3..32 characters

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

region

Filterable

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

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

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

status

Filterable

string

Enum: provisioning active suspending suspended resuming restoring failed degraded

The operating status of the Managed Database.

type

Filterable

string

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

updated

string <date-time>

When this Managed Database was last updated.

version

Filterable

string

The Managed Database engine version.

Managed MySQL Database Delete

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

Beta

Remove a Managed MySQL Database from your Account.

The Database must have an active 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

Path Parameters

instanceId

integer

Required

The ID of the Managed MySQL Database.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    -X DELETE \
    https://api.linode.com/v4beta/databases/mysql/instances/123

Response Samples

Responses

Managed MySQL Database View

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

Beta

Display information for a single, accessible Managed MySQL Database on your Account.

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

Authorizations

personalAccessToken
oauth

Path Parameters

instanceId

integer

Required

The ID of the Managed MySQL Database.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4beta/databases/mysql/instances/123

Response Samples

{
  "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",
  "region": "us-east",
  "replication_type": "semi_synch",
  "ssl_connection": true,
  "status": "active",
  "type": "g6-dedicated-2",
  "updated": "2022-01-01T00:01:01",
  "version": "8.0.26"
}

Responses

Returns information for a single Managed MySQL Database.

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

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

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

created

string <date-time>

When this Managed Database was created.

encrypted

boolean

Whether the Managed Databases is encrypted. Defaults to false.

engine

Filterable

string

The Managed Database engine type.

hosts

object

The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete.

primary

Nullable

string

The primary host for the Managed Database.

secondary

Nullable

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

A unique ID that can be used to identify and reference the Managed Database.

label

Filterable

string 3..32 characters

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

region

Filterable

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

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

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

status

Filterable

string

Enum: provisioning active suspending suspended resuming restoring failed degraded

The operating status of the Managed Database.

type

Filterable

string

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

updated

string <date-time>

When this Managed Database was last updated.

version

Filterable

string

The Managed Database engine version.

Managed MySQL Database Update

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

Beta

Update a Managed MySQL Database.

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

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

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.

Authorizations

personalAccessToken
oauth

Path Parameters

instanceId

integer

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.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X PUT -d '{
        "label": "example-db",
        "allow_list": [
          "203.0.113.1",
          "192.0.1.0/24"
        ]
    }' \
    https://api.linode.com/v4beta/databases/mysql/instances/123

Response Samples

{
  "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",
  "region": "us-east",
  "replication_type": "semi_synch",
  "ssl_connection": true,
  "status": "active",
  "type": "g6-dedicated-2",
  "updated": "2022-01-01T00:01:01",
  "version": "8.0.26"
}

Responses

Managed Database updated successfully.

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

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

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

created

string <date-time>

When this Managed Database was created.

encrypted

boolean

Whether the Managed Databases is encrypted. Defaults to false.

engine

Filterable

string

The Managed Database engine type.

hosts

object

The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete.

primary

Nullable

string

The primary host for the Managed Database.

secondary

Nullable

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

A unique ID that can be used to identify and reference the Managed Database.

label

Filterable

string 3..32 characters

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

region

Filterable

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

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

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

status

Filterable

string

Enum: provisioning active suspending suspended resuming restoring failed degraded

The operating status of the Managed Database.

type

Filterable

string

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

updated

string <date-time>

When this Managed Database was last updated.

version

Filterable

string

The Managed Database engine version.

Managed MySQL Database Backups List

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

Beta

Display all backups for an accessible Managed MySQL Database on your Account.

The Database must not be provisioning to perform this command.

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

At this time, only automatically scheduled backups (type auto) are available.

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

Authorizations

personalAccessToken
oauth

Path Parameters

instanceId

integer

Required

The ID of the Managed MySQL Database.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4beta/databases/mysql/instances/123/backups

Response Samples

{
  "data": [
    {
      "created": "2022-01-01T00:01:01",
      "id": 123,
      "label": "Scheduled - 02/04/22 11:11 UTC-XcCRmI",
      "type": "auto"
    }
  ],
  "page": 1,
  "pages": 1,
  "results": 1
}

Responses

Returns a paginated list of backups for the Managed MySQL Database.

data

array of objects

created Filterable	`string <datetime>` A time value given in a combined date and time format that represents when the database backup was created.
id	`integer` The ID of the database backup object.
label	`string` The database backup’s label, for display purposes only.
type Filterable	`string` Enum: `snapshot` `auto` The type of database backup, determined by how the backup was created.

page

integer

The current page.

pages

integer

The total number of pages.

results

integer

The total number of results.

Managed MySQL Database Backup View

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

Beta

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

The Database must not be provisioning 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

Path Parameters

instanceId	`integer` Required The ID of the Managed MySQL Database.
backupId	`integer` Required The ID of the Managed MySQL Database backup.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4beta/databases/mysql/instances/123/backups/456

Response Samples

{
  "created": "2022-01-01T00:01:01",
  "id": 123,
  "label": "Scheduled - 02/04/22 11:11 UTC-XcCRmI",
  "type": "auto"
}

Responses

Managed MySQL Database Backup Restore

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

Beta

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

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

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

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

Path Parameters

instanceId	`integer` Required The ID of the Managed MySQL Database.
backupId	`integer` Required The ID of the Managed MySQL Database backup.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    -X POST https://api.linode.com/v4beta/databases/mysql/instances/123/backups/456/restore

Response Samples

Responses

Managed MySQL Database Credentials View

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

Beta

Display the the root username and password for a Managed MySQL Database.

The Database must have an active 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

Path Parameters

instanceId

integer

Required

The ID of the Managed MySQL Database.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4beta/databases/mysql/instances/123/credentials/

Response Samples

{
  "password": "s3cur3P@ssw0rd",
  "username": "linroot"
}

Responses

Managed MySQL Database Credentials Reset

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

Beta

Reset the root password for a Managed MySQL Database.

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

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
oauth

Path Parameters

instanceId

integer

Required

The ID of the Managed MySQL Database.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    -X POST https://api.linode.com/v4beta/databases/mysql/instances/123/credentials/reset

Response Samples

Responses

Managed MySQL Database SSL Certificate View

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

Beta

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

The Database must have an active 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

Path Parameters

instanceId

integer

Required

The ID of the Managed MySQL Database.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4beta/databases/mysql/instances/123/ssl

Response Samples

{
  "ca_certificate": "LS0tLS1CRUdJ...=="
}

Responses

Managed Database Types List

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

Beta

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

{
  "data": [
    {
      "class": "nanode",
      "cluster_size": [
        {
          "price": {
            "hourly": 0.03,
            "monthly": 20
          },
          "quantity": 1
        }
      ],
      "deprecated": false,
      "disk": 25600,
      "id": "g6-nanode-1",
      "label": "DBaaS MySQL - Nanode 1GB",
      "memory": 1024,
      "vcpus": 1
    }
  ],
  "page": 1,
  "pages": 1,
  "results": 1
}

Responses

Returns a paginated list of all Managed Database types.

data

array of objects

class

string

The compute class category.

cluster_size

array of objects

A pricing list depending on the number of nodes.

price

object

Cost in US dollars, broken down into hourly and monthly charges.

hourly	`number` Cost (in US dollars) per hour.
monthly	`number` Cost (in US dollars) per month.

quantity

integer

The number of nodes.

deprecated

Filterable

boolean

Whether this Database plan type has been deprecated and is no longer available.

disk

integer

The amount of disk space set aside for Databases of this plan type. The value is represented in megabytes.

string

The ID representing the Managed Database node plan type.

label

string

A human-readable string that describes each plan type. For display purposes only.

memory

integer

The amount of RAM allocated to Database created of this plan type. The value is represented in megabytes.

vcpus

integer

The integer of number CPUs allocated to databases of this plan type.

page

integer

The current page.

pages

integer

The total number of pages.

results

integer

The total number of results.

Managed Database Type View

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

Beta

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

typeId

string

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

{
  "class": "nanode",
  "cluster_size": [
    {
      "price": {
        "hourly": 0.03,
        "monthly": 20
      },
      "quantity": 1
    }
  ],
  "deprecated": false,
  "disk": 25600,
  "id": "g6-nanode-1",
  "label": "DBaaS MySQL - Nanode 1GB",
  "memory": 1024,
  "vcpus": 1
}

Responses

Returns a single Managed Database type.

class

string

The compute class category.

cluster_size

array of objects

A pricing list depending on the number of nodes.

price

object

Cost in US dollars, broken down into hourly and monthly charges.

hourly	`number` Cost (in US dollars) per hour.
monthly	`number` Cost (in US dollars) per month.

quantity

integer

The number of nodes.

deprecated

Filterable

boolean

Whether this Database plan type has been deprecated and is no longer available.

disk

integer

The amount of disk space set aside for Databases of this plan type. The value is represented in megabytes.

string

The ID representing the Managed Database node plan type.

label

string

A human-readable string that describes each plan type. For display purposes only.

memory

integer

The amount of RAM allocated to Database created of this plan type. The value is represented in megabytes.

vcpus

integer

The integer of number CPUs allocated to databases of this plan type.

Search Results

No Results

Filters

Managed Databases v4.119.0

Managed Database Engines List

Authorizations

Query Parameters

Request Samples

Response Samples

Responses

Managed Database Engine View

Authorizations

Path Parameters

Query Parameters

Request Samples

Response Samples

Responses

Managed Databases List

Authorizations

Query Parameters

Request Samples

Response Samples

Responses

Managed MySQL Databases List

Authorizations

Request Samples

Response Samples

Responses

Managed MySQL Database Create

Authorizations

Request Body Schema

Request Samples

Response Samples

Responses

Managed MySQL Database Delete

Authorizations

Path Parameters

Request Samples

Response Samples

Responses

Managed MySQL Database View

Authorizations

Path Parameters

Request Samples

Response Samples

Responses

Managed MySQL Database Update

Authorizations

Path Parameters

Request Body Schema

Request Samples

Response Samples

Responses

Managed MySQL Database Backups List

Authorizations

Path Parameters

Request Samples

Response Samples

Responses

Managed MySQL Database Backup View

Authorizations

Path Parameters

Request Samples

Response Samples

Responses

Managed MySQL Database Backup Restore

Authorizations

Path Parameters

Request Samples

Response Samples

Responses

Managed MySQL Database Credentials View

Authorizations

Path Parameters

Request Samples

Response Samples

Responses

Managed MySQL Database Credentials Reset

Authorizations

Path Parameters