MariaDB SkySQL DBaaS API

Overview

The MariaDB SkySQL DBaaS API is a REST API that can perform operations in MariaDB SkySQL using automation:

  • It does not require a web browser

  • It supports multiple interfaces, including REST clients, and a command-line interface

  • It can be used in scripts and automation

The MariaDB SkySQL DBaaS API is available as a Technical Preview. Software in Tech Preview should not be used for production workloads.

Alternatively, SkySQL services can be managed interactively using your web browser and the SkySQL Portal.

Having trouble? Contact us.

Interfaces

The MariaDB SkySQL DBaaS API provides multiple interfaces:

Sign Up for SkySQL

Using the MariaDB SkySQL DBaaS API requires setting up an account:

  1. Register for a MariaDB ID or log in to your MariaDB ID account.

  2. Set up a Billing Profile.

  3. Accept the SkySQL Terms of Service.

Authentication and Authorization

The MariaDB SkySQL DBaaS API requires an API key for authentication and authorization.

API keys are available in two scopes:

  • Read: The API key will only be allowed to make GET requests

  • Write: The API key will be allowed to make any requests

To generate an API key:

  1. Go to the API Keys page.

  2. If you don't already have an API key listed, click on the link with the text "generate one".

  3. After the "Generate API Key" page loads, fill out the API key details:

    • In the "Description" field, describe the purpose of the API key.

    • In the "Scopes" field, select "read" or "write" under "SkySQL API: Databases", depending on the desired privileges.

  4. Click the "Generate API Key" button.

  5. After the page refreshes, click the "Copy to clipboard" button to copy the API key.

  6. Paste the API key somewhere safe and do not lose it.