Reference for MariaDB SkySQL DBaaS API

This page is part of MariaDB's Documentation.

The parent of this page is: Reference

Topics on this page:

Overview
Summary

Overview

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

The API endpoints are described in the API Reference pages linked below.

The API endpoints are also described in the API Documentation.

When creating a service via the API, launch-time selections are required.

Summary

A summary of the API endpoints across SkySQL DBaaS API versions:

API Path	Method	In 1.0?
/billing/v1/account	GET	1.0
/billing/v1/invoices	GET	1.0
/billing/v1/invoices/{invoice_uid}	GET	1.0
/billing/v1/usage/preview	GET	1.0
/billing/v1/usage/service	GET	1.0
/billing/v1/usage/service/{service_id}	GET	1.0
/provisioning/v1/architectures	GET	1.0
/provisioning/v1/configs	GET	1.0
/provisioning/v1/configs	POST	1.0
/provisioning/v1/configs/{config_id}	DELETE	1.0
/provisioning/v1/configs/{config_id}	GET	1.0
/provisioning/v1/configs/{config_id}/values	GET	1.0
/provisioning/v1/configs/{config_id}/values	PUT	1.0
/provisioning/v1/cpu-architectures	GET	1.0
/provisioning/v1/maintenance-windows	GET	1.0
/provisioning/v1/products	GET	1.0
/provisioning/v1/providers	GET	1.0
/provisioning/v1/providers/{provider_name}/iops	GET	1.0
/provisioning/v1/providers/{provider_name}/volume-types	GET	1.0
/provisioning/v1/providers/{provider_name}/zones	GET	1.0
/provisioning/v1/regions	GET	1.0
/provisioning/v1/regions/{region_name}/zones	GET	1.0
/provisioning/v1/service-types	GET	1.0
/provisioning/v1/services	GET	1.0
/provisioning/v1/services	POST	1.0
/provisioning/v1/services/{service_id}	DELETE	1.0
/provisioning/v1/services/{service_id}	GET	1.0
/provisioning/v1/services/{service_id}/config	DELETE	1.0
/provisioning/v1/services/{service_id}/config	POST	1.0
/provisioning/v1/services/{service_id}/endpoints	PATCH	1.0
/provisioning/v1/services/{service_id}/maintenance-window	POST	1.0
/provisioning/v1/services/{service_id}/nodes	POST	1.0
/provisioning/v1/services/{service_id}/power	POST	1.0
/provisioning/v1/services/{service_id}/replicas	GET	1.0
/provisioning/v1/services/{service_id}/replication	DELETE	1.0
/provisioning/v1/services/{service_id}/replication	POST	1.0
/provisioning/v1/services/{service_id}/security/allowlist	DELETE	1.0
/provisioning/v1/services/{service_id}/security/allowlist	GET	1.0
/provisioning/v1/services/{service_id}/security/allowlist	POST	1.0
/provisioning/v1/services/{service_id}/security/allowlist	PUT	1.0
/provisioning/v1/services/{service_id}/security/credentials	GET	1.0
/provisioning/v1/services/{service_id}/security/is-ip-allowed	POST	1.0
/provisioning/v1/services/{service_id}/size	POST	1.0
/provisioning/v1/services/{service_id}/start	POST	1.0
/provisioning/v1/services/{service_id}/stop	POST	1.0
/provisioning/v1/services/{service_id}/storage	PATCH	1.0
/provisioning/v1/services/{service_id}/storage/iops	PATCH	1.0
/provisioning/v1/services/{service_id}/storage/size	PATCH	1.0
/provisioning/v1/sizes	GET	1.0
/provisioning/v1/tiers	GET	1.0
/provisioning/v1/topologies	GET	1.0
/provisioning/v1/topologies/{topology_name}/configs	GET	1.0
/provisioning/v1/topologies/{topology_name}/nodes	GET	1.0
/provisioning/v1/topologies/{topology_name}/options	GET	1.0
/provisioning/v1/topologies/{topology_name}/storage-sizes	GET	1.0
/provisioning/v1/versions	GET	1.0