MariaDB SkySQL DBaaS API Reference

This page is part of MariaDB's Documentation.

The parent of this page is: Reference

Topics on this page:

Overview
Supported Endpoints

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.

Supported Endpoints

The supported endpoints are as follows:

API Path	Method	Summary
/billing/v1/account	GET	Returns account record based on X-SkySQL-Org-Id header value
/billing/v1/invoices	GET	Returns list of invoices
/billing/v1/invoices/{invoice_uid}	GET	Returns invoice for specified Chargify invoice uid
/billing/v1/usage/preview	GET	Returns usage allocation summary
/billing/v1/usage/service	GET	Returns usage allocation summary
/billing/v1/usage/service/{service_id}	GET	Returns usage allocation summary for specified service ID
/provisioning/v1/architectures	GET	Read Architectures
/provisioning/v1/configs	GET	List Custom Configs
/provisioning/v1/configs	POST	Create Custom Config
/provisioning/v1/configs/{config_id}	DELETE	Delete Custom Config
/provisioning/v1/configs/{config_id}	GET	Read Custom Config
/provisioning/v1/configs/{config_id}/values	GET	Get Config Values
/provisioning/v1/configs/{config_id}/values	PUT	Batch Update Config Values
/provisioning/v1/cpu-architectures	GET	Read Architectures
/provisioning/v1/maintenance-windows	GET	Read Maintenance Windows
/provisioning/v1/products	GET	List Products
/provisioning/v1/providers	GET	Read Cloud Providers
/provisioning/v1/providers/{provider_name}/iops	GET	Read Provider IOPS
/provisioning/v1/providers/{provider_name}/volume-types	GET	Read Storage Volume Types
/provisioning/v1/providers/{provider_name}/zones	GET	Read Availability Zones for a specific provider
/provisioning/v1/regions	GET	Read Regions
/provisioning/v1/regions/{region_name}/zones	GET	Read Zones
/provisioning/v1/service-types	GET	Read Service Types
/provisioning/v1/services	GET	List Services
/provisioning/v1/services	POST	Create a Service
/provisioning/v1/services/{service_id}	DELETE	Delete Service
/provisioning/v1/services/{service_id}	GET	Retrieve Service Info
/provisioning/v1/services/{service_id}/config	DELETE	Remove a Custom Config from a Service
/provisioning/v1/services/{service_id}/config	POST	Update Service Config
/provisioning/v1/services/{service_id}/endpoints	PATCH	Modifies Service Endpoints
/provisioning/v1/services/{service_id}/maintenance-window	POST	Set Service Maintenance Window
/provisioning/v1/services/{service_id}/nodes	POST	Update Service Nodes
/provisioning/v1/services/{service_id}/power	POST	Set Service Power State
/provisioning/v1/services/{service_id}/replicas	GET	List Replicas for a Service
/provisioning/v1/services/{service_id}/replication	DELETE	Delete Replication on a Service
/provisioning/v1/services/{service_id}/replication	POST	Update Replication on a Service
/provisioning/v1/services/{service_id}/security/allowlist	DELETE	Remove Allowed Address
/provisioning/v1/services/{service_id}/security/allowlist	GET	Read Allowed Addresses
/provisioning/v1/services/{service_id}/security/allowlist	POST	Add Allowed Address
/provisioning/v1/services/{service_id}/security/allowlist	PUT	Update Allowed Address
/provisioning/v1/services/{service_id}/security/credentials	GET	Retrieve Default Credentials
/provisioning/v1/services/{service_id}/security/is-ip-allowed	POST	Check an IP's Access
/provisioning/v1/services/{service_id}/size	POST	Update Service Size
/provisioning/v1/services/{service_id}/start	POST	Starts a stopped service
/provisioning/v1/services/{service_id}/stop	POST	Stops a running service
/provisioning/v1/services/{service_id}/storage	PATCH	Set Service Storage
/provisioning/v1/services/{service_id}/storage/iops	PATCH	Set Service Storage
/provisioning/v1/services/{service_id}/storage/size	PATCH	Set Service Storage
/provisioning/v1/sizes	GET	Read Node Sizes
/provisioning/v1/tiers	GET	Read Tiers
/provisioning/v1/topologies	GET	Read Topologies
/provisioning/v1/topologies/{topology_name}/configs	GET	Read Topology Configuration Manager Parameters
/provisioning/v1/topologies/{topology_name}/nodes	GET	Read Topology Node Options
/provisioning/v1/topologies/{topology_name}/options	GET	Read Topology Options
/provisioning/v1/topologies/{topology_name}/storage-sizes	GET	Read Topology Storage Sizes
/provisioning/v1/versions	GET	Read Software Versions