# Services

## List Services

> Retrieve a list of services managed by the user/team.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.ServiceResponse":{"description":"ServiceResponse","type":"object","properties":{"analytics":{"type":"boolean"},"architecture":{"type":"string"},"assigned_on":{"type":"integer"},"availability_zone":{"type":"string"},"config_id":{"type":"string"},"created_by":{"type":"string"},"created_on":{"type":"integer"},"custom_ssl":{"type":"boolean"},"data_center":{"type":"string"},"domains":{"type":"array","items":{"type":"string"}},"endpoints":{"type":"array","items":{"$ref":"#/components/schemas/v1.ServiceEndpoint"}},"errors":{"type":"array","items":{"type":"string"}},"fqdn":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"maintenance_window":{"type":"string"},"maxscale_nodes":{"type":"integer"},"maxscale_size":{"type":"string"},"name":{"type":"string"},"nodes":{"type":"integer"},"nosql_enabled":{"type":"boolean"},"outbound_ips":{"type":"array","items":{"type":"string"}},"primary_host":{"type":"string"},"project_id":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"replication_enabled":{"type":"boolean"},"scale_options":{"$ref":"#/components/schemas/v1.ScaleOptions"},"service_type":{"type":"string"},"size":{"type":"string"},"ssl_enabled":{"type":"boolean"},"status":{"type":"string","enum":["pending_create","pending_start","pending_stop","pending_scale","pending_delete","pending_modifying","ready","failed","stopped","retired","unknown"]},"storage_volume":{"$ref":"#/components/schemas/v1.StorageVolume"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"tenancy":{"type":"string"},"tier":{"type":"string"},"topology":{"type":"string"},"updated_by":{"type":"string"},"updated_on":{"type":"integer"},"upgrades":{"$ref":"#/components/schemas/v1.Upgrades"},"version":{"type":"string"},"volume_modified_on":{"type":"integer"}}},"v1.ServiceEndpoint":{"type":"object","properties":{"allow_list":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListItem"}},"allowed_accounts":{"type":"array","items":{"type":"string"}},"endpoint_service":{"type":"string"},"fqdn":{"type":"string"},"ips":{"type":"array","items":{"type":"string"}},"mechanism":{"type":"string"},"name":{"type":"string"},"ports":{"type":"array","items":{"$ref":"#/components/schemas/v1.PurposePort"}},"private_link":{"$ref":"#/components/schemas/v1.PrivateLink"},"private_service_connect":{"$ref":"#/components/schemas/v1.PrivateServiceConnect"},"visibility":{"type":"string"}}},"v1.AllowListItem":{"type":"object","properties":{"comment":{"type":"string"},"ip":{"type":"string"}}},"v1.PurposePort":{"type":"object","properties":{"name":{"type":"string","enum":["readwrite","readonly","nosql","api","replication","sparksql","https","http"]},"port":{"type":"integer"},"purpose":{"type":"string"}}},"v1.PrivateLink":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"v1.PrivateConnectAccount":{"type":"object","properties":{"alias":{"type":"string"},"id":{"type":"string"}}},"v1.PrivateServiceConnect":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"v1.ScaleOptions":{"type":"object","properties":{"max_compute":{"type":"integer"},"min_compute":{"type":"integer"},"suspend_enabled":{"description":"Enable serverless suspension. Valid values: true or false. Defaults to true if not specified.","type":"boolean"}}},"v1.StorageVolume":{"type":"object","properties":{"iops":{"type":"integer"},"size":{"type":"integer"},"throughput":{"type":"integer"},"volume_type":{"type":"string"}}},"v1.Upgrades":{"type":"object","properties":{"kubernetes_upgrade_deadline":{"type":"string"},"kubernetes_upgrade_in_progress":{"type":"boolean"},"kubernetes_upgrade_status":{"enum":["available","required","ok"],"allOf":[{"$ref":"#/components/schemas/v1.KubernetesUpgradeStatus"}]}}},"v1.KubernetesUpgradeStatus":{"type":"string","enum":["available","required","ok"]},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services":{"get":{"description":"Retrieve a list of services managed by the user/team.","tags":["Services"],"summary":"List Services","parameters":[{"schema":{"type":"integer","maximum":100,"minimum":1},"description":"Set the maximum number (limit) of results to fetch per page.","name":"page_size","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"description":"Set the sort order (ascending or descending) for results.","name":"page_order","in":"query"},{"schema":{"type":"string"},"description":"When iterating through results, retrieve the page with the specified token.","name":"page_token","in":"query"}],"responses":{"200":{"description":"OK","headers":{"X-SkySQL-Page-Token-Previous":{"schema":{"type":"string"},"description":"Page iterator token to move to the previous page of results."},"X-SkySQL-Page-Token-Next":{"schema":{"type":"string"},"description":"Page iterator token to move to the next page of results."}},"content":{"application/json":{"schema":{"description":"Services of user or team","type":"array","items":{"$ref":"#/components/schemas/v1.ServiceResponse"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Create a Service

> Create (launch) a new service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.ServiceResponse":{"description":"ServiceResponse","type":"object","properties":{"analytics":{"type":"boolean"},"architecture":{"type":"string"},"assigned_on":{"type":"integer"},"availability_zone":{"type":"string"},"config_id":{"type":"string"},"created_by":{"type":"string"},"created_on":{"type":"integer"},"custom_ssl":{"type":"boolean"},"data_center":{"type":"string"},"domains":{"type":"array","items":{"type":"string"}},"endpoints":{"type":"array","items":{"$ref":"#/components/schemas/v1.ServiceEndpoint"}},"errors":{"type":"array","items":{"type":"string"}},"fqdn":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"maintenance_window":{"type":"string"},"maxscale_nodes":{"type":"integer"},"maxscale_size":{"type":"string"},"name":{"type":"string"},"nodes":{"type":"integer"},"nosql_enabled":{"type":"boolean"},"outbound_ips":{"type":"array","items":{"type":"string"}},"primary_host":{"type":"string"},"project_id":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"replication_enabled":{"type":"boolean"},"scale_options":{"$ref":"#/components/schemas/v1.ScaleOptions"},"service_type":{"type":"string"},"size":{"type":"string"},"ssl_enabled":{"type":"boolean"},"status":{"type":"string","enum":["pending_create","pending_start","pending_stop","pending_scale","pending_delete","pending_modifying","ready","failed","stopped","retired","unknown"]},"storage_volume":{"$ref":"#/components/schemas/v1.StorageVolume"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"tenancy":{"type":"string"},"tier":{"type":"string"},"topology":{"type":"string"},"updated_by":{"type":"string"},"updated_on":{"type":"integer"},"upgrades":{"$ref":"#/components/schemas/v1.Upgrades"},"version":{"type":"string"},"volume_modified_on":{"type":"integer"}}},"v1.ServiceEndpoint":{"type":"object","properties":{"allow_list":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListItem"}},"allowed_accounts":{"type":"array","items":{"type":"string"}},"endpoint_service":{"type":"string"},"fqdn":{"type":"string"},"ips":{"type":"array","items":{"type":"string"}},"mechanism":{"type":"string"},"name":{"type":"string"},"ports":{"type":"array","items":{"$ref":"#/components/schemas/v1.PurposePort"}},"private_link":{"$ref":"#/components/schemas/v1.PrivateLink"},"private_service_connect":{"$ref":"#/components/schemas/v1.PrivateServiceConnect"},"visibility":{"type":"string"}}},"v1.AllowListItem":{"type":"object","properties":{"comment":{"type":"string"},"ip":{"type":"string"}}},"v1.PurposePort":{"type":"object","properties":{"name":{"type":"string","enum":["readwrite","readonly","nosql","api","replication","sparksql","https","http"]},"port":{"type":"integer"},"purpose":{"type":"string"}}},"v1.PrivateLink":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"v1.PrivateConnectAccount":{"type":"object","properties":{"alias":{"type":"string"},"id":{"type":"string"}}},"v1.PrivateServiceConnect":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"v1.ScaleOptions":{"type":"object","properties":{"max_compute":{"type":"integer"},"min_compute":{"type":"integer"},"suspend_enabled":{"description":"Enable serverless suspension. Valid values: true or false. Defaults to true if not specified.","type":"boolean"}}},"v1.StorageVolume":{"type":"object","properties":{"iops":{"type":"integer"},"size":{"type":"integer"},"throughput":{"type":"integer"},"volume_type":{"type":"string"}}},"v1.Upgrades":{"type":"object","properties":{"kubernetes_upgrade_deadline":{"type":"string"},"kubernetes_upgrade_in_progress":{"type":"boolean"},"kubernetes_upgrade_status":{"enum":["available","required","ok"],"allOf":[{"$ref":"#/components/schemas/v1.KubernetesUpgradeStatus"}]}}},"v1.KubernetesUpgradeStatus":{"type":"string","enum":["available","required","ok"]},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]},"v1.CreateServiceRequest":{"type":"object","properties":{"allow_list":{"description":"The list of IPv4 addresses and netblocks that are allowed to connect to the service.","type":"array","items":{"$ref":"#/components/schemas/v1.AllowListItem"}},"analytical":{"description":"Enable embedded analytical SQL support. Valid values: true or false. Defaults to false if not specified.","type":"boolean"},"architecture":{"description":"The hardware architecture of the service.","type":"string","enum":["amd64","arm64"]},"availability_zone":{"description":"The zone where the service will be created if single zone selected. The zone value should match with the zone names used by the cloud provider.","type":"string"},"custom_image_versions":{"description":"CustomImageVersions is a key-value map of custom images for this service","type":"object","additionalProperties":{"type":"string"}},"custom_ssl":{"type":"boolean"},"endpoint_allowed_accounts":{"description":"The list of cloud accounts (AWS account IDs or GCP projects) that are allowed to access the service.\nThe \"endpoint_allowed_accounts\" attributes is required when the \"endpoint_mechanism\" is set to \"privateconnect\".","type":"array","items":{"type":"string"}},"endpoint_mechanism":{"description":"The endpoint mechanism to use.","type":"string","enum":["nlb","privateconnect","privatelink"]},"endpoints":{"type":"array","items":{"$ref":"#/components/schemas/v1.CreateServiceEndpointRequest"}},"maintenance_window":{"description":"The maintenance window. Applicable for the power tier customers only.","type":"string"},"maxscale_nodes":{"description":"Number of maxscale nodes.","type":"integer"},"maxscale_size":{"description":"The instance size. Valid values are: sky-2x4, sky-2x8 etc. Not applicable for the Serverless Analytics topology. Only aplicable if maxscale_nodes > 0","type":"string"},"name":{"description":"Name of the service.","type":"string"},"nodes":{"description":"The number of nodes in the service. Not applicable for Enterprise Server Single Node and Serverless Analytics topologies.","type":"integer"},"nosql_enabled":{"description":"Whether to enable the NoSQL Protocol Module.","type":"boolean"},"ports":{"description":"Service endpoint ports. Not applicable for the Serverless Analytics topology.","type":"array","items":{"$ref":"#/components/schemas/v1.NamedPort"}},"private_link":{"description":"PrivateLink is the AWS PrivateLink configuration","allOf":[{"$ref":"#/components/schemas/v1.PrivateLink"}]},"private_service_connect":{"description":"PrivateServiceConnect is the GCP Private Service Connect configuration","allOf":[{"$ref":"#/components/schemas/v1.PrivateServiceConnect"}]},"project_id":{"description":"The ID of the project to create the service in.","type":"string"},"provider":{"description":"The cloud provider for the service.","type":"string","enum":["aws","gcp","azure"]},"region":{"description":"The region where the service will be created. The region value should match with the region names used by the cloud provider.","type":"string"},"scale_options":{"description":"ScaleOptions are the options for serverless scaling","allOf":[{"$ref":"#/components/schemas/v1.ScaleOptions"}]},"service_type":{"description":"The type of service to create.","type":"string","enum":["transactional","transactional_serverless"]},"size":{"description":"The instance size. Valid values are: sky-2x4, sky-2x8 etc. Not applicable for the Serverless Analytics topology.","type":"string"},"ssl_enabled":{"description":"Whether to enable SSL. Valid values are: true or false","type":"boolean"},"storage":{"description":"The storage size in GB. Not applicable for Serverless Analytics topology. Valid values are: 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 2000, 3000, 4000, 5000, 6000, 7000, 8000, 9000, 10000","type":"integer"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"tenancy":{"type":"string","enum":["shared","dedicated"]},"topology":{"description":"The topology of the service. Valid values are: sa, csdw, es-replica, es-single and xpand.","type":"string","enum":["sa","csdw","es-replica","es-single","xpand","serverless-standalone"]},"version":{"description":"The service software versions. Not applicable for the Serverless Analytics topology.","type":"string"},"volume_iops":{"description":"The service storage IOPS. This is only applicable for AWS","type":"integer"},"volume_throughput":{"description":"The service storage throughput. This is only applicable for GP3(AWS) volume type.","type":"integer"},"volume_type":{"description":"The volume type. Valid values are: gp2 and io1. This is only applicable for AWS.","type":"string","enum":["gp2","io1"]}}},"v1.CreateServiceEndpointRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"ports":{"description":"Service endpoint ports. Not applicable for the Serverless Analytics topology.","type":"array","items":{"$ref":"#/components/schemas/v1.NamedPort"}}}},"v1.NamedPort":{"type":"object","properties":{"name":{"type":"string","enum":["readwrite","readonly","nosql","api","replication","sparksql","https","http"]},"port":{"type":"integer"}}}}},"paths":{"/provisioning/v1/services":{"post":{"description":"Create (launch) a new service.","tags":["Services"],"summary":"Create a Service","responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ServiceResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.CreateServiceRequest"}}},"description":"The request body.","required":true}}}}}
```

## Retrieve Service Info

> Retrieve the information and status of the specified service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.ServiceResponse":{"description":"ServiceResponse","type":"object","properties":{"analytics":{"type":"boolean"},"architecture":{"type":"string"},"assigned_on":{"type":"integer"},"availability_zone":{"type":"string"},"config_id":{"type":"string"},"created_by":{"type":"string"},"created_on":{"type":"integer"},"custom_ssl":{"type":"boolean"},"data_center":{"type":"string"},"domains":{"type":"array","items":{"type":"string"}},"endpoints":{"type":"array","items":{"$ref":"#/components/schemas/v1.ServiceEndpoint"}},"errors":{"type":"array","items":{"type":"string"}},"fqdn":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"maintenance_window":{"type":"string"},"maxscale_nodes":{"type":"integer"},"maxscale_size":{"type":"string"},"name":{"type":"string"},"nodes":{"type":"integer"},"nosql_enabled":{"type":"boolean"},"outbound_ips":{"type":"array","items":{"type":"string"}},"primary_host":{"type":"string"},"project_id":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"replication_enabled":{"type":"boolean"},"scale_options":{"$ref":"#/components/schemas/v1.ScaleOptions"},"service_type":{"type":"string"},"size":{"type":"string"},"ssl_enabled":{"type":"boolean"},"status":{"type":"string","enum":["pending_create","pending_start","pending_stop","pending_scale","pending_delete","pending_modifying","ready","failed","stopped","retired","unknown"]},"storage_volume":{"$ref":"#/components/schemas/v1.StorageVolume"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"tenancy":{"type":"string"},"tier":{"type":"string"},"topology":{"type":"string"},"updated_by":{"type":"string"},"updated_on":{"type":"integer"},"upgrades":{"$ref":"#/components/schemas/v1.Upgrades"},"version":{"type":"string"},"volume_modified_on":{"type":"integer"}}},"v1.ServiceEndpoint":{"type":"object","properties":{"allow_list":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListItem"}},"allowed_accounts":{"type":"array","items":{"type":"string"}},"endpoint_service":{"type":"string"},"fqdn":{"type":"string"},"ips":{"type":"array","items":{"type":"string"}},"mechanism":{"type":"string"},"name":{"type":"string"},"ports":{"type":"array","items":{"$ref":"#/components/schemas/v1.PurposePort"}},"private_link":{"$ref":"#/components/schemas/v1.PrivateLink"},"private_service_connect":{"$ref":"#/components/schemas/v1.PrivateServiceConnect"},"visibility":{"type":"string"}}},"v1.AllowListItem":{"type":"object","properties":{"comment":{"type":"string"},"ip":{"type":"string"}}},"v1.PurposePort":{"type":"object","properties":{"name":{"type":"string","enum":["readwrite","readonly","nosql","api","replication","sparksql","https","http"]},"port":{"type":"integer"},"purpose":{"type":"string"}}},"v1.PrivateLink":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"v1.PrivateConnectAccount":{"type":"object","properties":{"alias":{"type":"string"},"id":{"type":"string"}}},"v1.PrivateServiceConnect":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"v1.ScaleOptions":{"type":"object","properties":{"max_compute":{"type":"integer"},"min_compute":{"type":"integer"},"suspend_enabled":{"description":"Enable serverless suspension. Valid values: true or false. Defaults to true if not specified.","type":"boolean"}}},"v1.StorageVolume":{"type":"object","properties":{"iops":{"type":"integer"},"size":{"type":"integer"},"throughput":{"type":"integer"},"volume_type":{"type":"string"}}},"v1.Upgrades":{"type":"object","properties":{"kubernetes_upgrade_deadline":{"type":"string"},"kubernetes_upgrade_in_progress":{"type":"boolean"},"kubernetes_upgrade_status":{"enum":["available","required","ok"],"allOf":[{"$ref":"#/components/schemas/v1.KubernetesUpgradeStatus"}]}}},"v1.KubernetesUpgradeStatus":{"type":"string","enum":["available","required","ok"]},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}":{"get":{"description":"Retrieve the information and status of the specified service.","tags":["Services"],"summary":"Retrieve Service Info","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ServiceResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Delete Service

> Delete the specified service and its associated data.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}":{"delete":{"description":"Delete the specified service and its associated data.","tags":["Services"],"summary":"Delete Service","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Update Service Config

> Update the configuration of the specified service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.ServiceConfigState":{"description":"Config for a service","type":"object","properties":{"config_id":{"type":"string"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/config":{"post":{"description":"Update the configuration of the specified service.","tags":["Services"],"summary":"Update Service Config","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ServiceConfigState"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ServiceConfigState"}}},"description":"The request body.","required":true}}}}}
```

## Remove a Custom Config from a Service

> Remove a custom configuration (Configuration Manager) from the specified service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.ServiceConfigState":{"description":"Config for a service","type":"object","properties":{"config_id":{"type":"string"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/config":{"delete":{"description":"Remove a custom configuration (Configuration Manager) from the specified service.","tags":["Services"],"summary":"Remove a Custom Config from a Service","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ServiceConfigState"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Creates Service Endpoints

> Creates Service Endpoints

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.ServiceEndpoint":{"type":"object","properties":{"allow_list":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListItem"}},"allowed_accounts":{"type":"array","items":{"type":"string"}},"endpoint_service":{"type":"string"},"fqdn":{"type":"string"},"ips":{"type":"array","items":{"type":"string"}},"mechanism":{"type":"string"},"name":{"type":"string"},"ports":{"type":"array","items":{"$ref":"#/components/schemas/v1.PurposePort"}},"private_link":{"$ref":"#/components/schemas/v1.PrivateLink"},"private_service_connect":{"$ref":"#/components/schemas/v1.PrivateServiceConnect"},"visibility":{"type":"string"}}},"v1.AllowListItem":{"type":"object","properties":{"comment":{"type":"string"},"ip":{"type":"string"}}},"v1.PurposePort":{"type":"object","properties":{"name":{"type":"string","enum":["readwrite","readonly","nosql","api","replication","sparksql","https","http"]},"port":{"type":"integer"},"purpose":{"type":"string"}}},"v1.PrivateLink":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"v1.PrivateConnectAccount":{"type":"object","properties":{"alias":{"type":"string"},"id":{"type":"string"}}},"v1.PrivateServiceConnect":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]},"v1.CreateServiceEndpointRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"ports":{"description":"Service endpoint ports. Not applicable for the Serverless Analytics topology.","type":"array","items":{"$ref":"#/components/schemas/v1.NamedPort"}}}},"v1.NamedPort":{"type":"object","properties":{"name":{"type":"string","enum":["readwrite","readonly","nosql","api","replication","sparksql","https","http"]},"port":{"type":"integer"}}}}},"paths":{"/provisioning/v1/services/{service_id}/endpoints":{"post":{"description":"Creates Service Endpoints","tags":["Services"],"summary":"Creates Service Endpoints","parameters":[{"schema":{"type":"string"},"description":"Identifier for a services","name":"service_id","in":"path","required":true}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/v1.ServiceEndpoint"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.CreateServiceEndpointRequest"}}},"description":"The request body.","required":true}}}}}
```

## Modifies Service Endpoints

> Modifies Service Endpoints\
> This operation modifies the primary endpoint for a specified service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.ServiceEndpoint":{"type":"object","properties":{"allow_list":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListItem"}},"allowed_accounts":{"type":"array","items":{"type":"string"}},"endpoint_service":{"type":"string"},"fqdn":{"type":"string"},"ips":{"type":"array","items":{"type":"string"}},"mechanism":{"type":"string"},"name":{"type":"string"},"ports":{"type":"array","items":{"$ref":"#/components/schemas/v1.PurposePort"}},"private_link":{"$ref":"#/components/schemas/v1.PrivateLink"},"private_service_connect":{"$ref":"#/components/schemas/v1.PrivateServiceConnect"},"visibility":{"type":"string"}}},"v1.AllowListItem":{"type":"object","properties":{"comment":{"type":"string"},"ip":{"type":"string"}}},"v1.PurposePort":{"type":"object","properties":{"name":{"type":"string","enum":["readwrite","readonly","nosql","api","replication","sparksql","https","http"]},"port":{"type":"integer"},"purpose":{"type":"string"}}},"v1.PrivateLink":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"v1.PrivateConnectAccount":{"type":"object","properties":{"alias":{"type":"string"},"id":{"type":"string"}}},"v1.PrivateServiceConnect":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]},"v1.ModifyServiceEndpoint":{"type":"object","properties":{"allowed_accounts":{"description":"AllowedAccounts is the list of cloud accounts (aws account ids or gcp projects) that are allowed to access the service","type":"array","items":{"type":"string"}},"mechanism":{"description":"Mechanism is the endpoint mechanism to use. Valid values are: privateconnect or nlb","type":"string"},"private_link":{"description":"PrivateLink is the AWS PrivateLink configuration","allOf":[{"$ref":"#/components/schemas/v1.PrivateLink"}]},"private_service_connect":{"description":"PrivateServiceConnect is the GCP Private Service Connect configuration","allOf":[{"$ref":"#/components/schemas/v1.PrivateServiceConnect"}]}}}}},"paths":{"/provisioning/v1/services/{service_id}/endpoints":{"patch":{"description":"Modifies Service Endpoints\nThis operation modifies the primary endpoint for a specified service.","tags":["Services"],"summary":"Modifies Service Endpoints","parameters":[{"schema":{"type":"string"},"description":"Identifier for a services","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/v1.ServiceEndpoint"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/v1.ModifyServiceEndpoint"}}}},"description":"The request body.","required":true}}}}}
```

## Deletes Service Endpoints

> Deletes Service Endpoints

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.ServiceEndpoint":{"type":"object","properties":{"allow_list":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListItem"}},"allowed_accounts":{"type":"array","items":{"type":"string"}},"endpoint_service":{"type":"string"},"fqdn":{"type":"string"},"ips":{"type":"array","items":{"type":"string"}},"mechanism":{"type":"string"},"name":{"type":"string"},"ports":{"type":"array","items":{"$ref":"#/components/schemas/v1.PurposePort"}},"private_link":{"$ref":"#/components/schemas/v1.PrivateLink"},"private_service_connect":{"$ref":"#/components/schemas/v1.PrivateServiceConnect"},"visibility":{"type":"string"}}},"v1.AllowListItem":{"type":"object","properties":{"comment":{"type":"string"},"ip":{"type":"string"}}},"v1.PurposePort":{"type":"object","properties":{"name":{"type":"string","enum":["readwrite","readonly","nosql","api","replication","sparksql","https","http"]},"port":{"type":"integer"},"purpose":{"type":"string"}}},"v1.PrivateLink":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"v1.PrivateConnectAccount":{"type":"object","properties":{"alias":{"type":"string"},"id":{"type":"string"}}},"v1.PrivateServiceConnect":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/endpoints/{name}":{"delete":{"description":"Deletes Service Endpoints","tags":["Services"],"summary":"Deletes Service Endpoints","parameters":[{"schema":{"type":"string"},"description":"Identifier for a services","name":"service_id","in":"path","required":true},{"schema":{"type":"string"},"description":"Endpoint name","name":"name","in":"path","required":true}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/v1.ServiceEndpoint"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Set Service Maintenance Window

> Set the maintenance window the service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]},"v1.SetMaintenanceWindowRequest":{"type":"object","properties":{"name":{"type":"string"}}}}},"paths":{"/provisioning/v1/services/{service_id}/maintenance-window":{"post":{"description":"Set the maintenance window the service.","tags":["Services"],"summary":"Set Service Maintenance Window","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.SetMaintenanceWindowRequest"}}},"description":"The request body.","required":true}}}}}
```

## Update Service Nodes

> Update the number of nodes for the specified service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.ServiceNodesState":{"description":"Update the number of nodes for a service","type":"object","properties":{"nodes":{"type":"integer"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/nodes":{"post":{"description":"Update the number of nodes for the specified service.","tags":["Services"],"summary":"Update Service Nodes","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ServiceNodesState"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ServiceNodesState"}}},"description":"The request body.","required":true}}}}}
```

## Set Service Power State

> Set the power state of the service. This starts or stops the service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]},"v1.PowerState":{"description":"Start/Stop Service","type":"object","properties":{"is_active":{"type":"boolean"}}}}},"paths":{"/provisioning/v1/services/{service_id}/power":{"post":{"description":"Set the power state of the service. This starts or stops the service.","tags":["Services"],"summary":"Set Service Power State","deprecated":true,"parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.PowerState"}}},"description":"The request body.","required":true}}}}}
```

## List Replicas for a Service

> Retrieve a list of services that are replicas for the specified service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.ServiceResponse":{"description":"ServiceResponse","type":"object","properties":{"analytics":{"type":"boolean"},"architecture":{"type":"string"},"assigned_on":{"type":"integer"},"availability_zone":{"type":"string"},"config_id":{"type":"string"},"created_by":{"type":"string"},"created_on":{"type":"integer"},"custom_ssl":{"type":"boolean"},"data_center":{"type":"string"},"domains":{"type":"array","items":{"type":"string"}},"endpoints":{"type":"array","items":{"$ref":"#/components/schemas/v1.ServiceEndpoint"}},"errors":{"type":"array","items":{"type":"string"}},"fqdn":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"maintenance_window":{"type":"string"},"maxscale_nodes":{"type":"integer"},"maxscale_size":{"type":"string"},"name":{"type":"string"},"nodes":{"type":"integer"},"nosql_enabled":{"type":"boolean"},"outbound_ips":{"type":"array","items":{"type":"string"}},"primary_host":{"type":"string"},"project_id":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"replication_enabled":{"type":"boolean"},"scale_options":{"$ref":"#/components/schemas/v1.ScaleOptions"},"service_type":{"type":"string"},"size":{"type":"string"},"ssl_enabled":{"type":"boolean"},"status":{"type":"string","enum":["pending_create","pending_start","pending_stop","pending_scale","pending_delete","pending_modifying","ready","failed","stopped","retired","unknown"]},"storage_volume":{"$ref":"#/components/schemas/v1.StorageVolume"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"tenancy":{"type":"string"},"tier":{"type":"string"},"topology":{"type":"string"},"updated_by":{"type":"string"},"updated_on":{"type":"integer"},"upgrades":{"$ref":"#/components/schemas/v1.Upgrades"},"version":{"type":"string"},"volume_modified_on":{"type":"integer"}}},"v1.ServiceEndpoint":{"type":"object","properties":{"allow_list":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListItem"}},"allowed_accounts":{"type":"array","items":{"type":"string"}},"endpoint_service":{"type":"string"},"fqdn":{"type":"string"},"ips":{"type":"array","items":{"type":"string"}},"mechanism":{"type":"string"},"name":{"type":"string"},"ports":{"type":"array","items":{"$ref":"#/components/schemas/v1.PurposePort"}},"private_link":{"$ref":"#/components/schemas/v1.PrivateLink"},"private_service_connect":{"$ref":"#/components/schemas/v1.PrivateServiceConnect"},"visibility":{"type":"string"}}},"v1.AllowListItem":{"type":"object","properties":{"comment":{"type":"string"},"ip":{"type":"string"}}},"v1.PurposePort":{"type":"object","properties":{"name":{"type":"string","enum":["readwrite","readonly","nosql","api","replication","sparksql","https","http"]},"port":{"type":"integer"},"purpose":{"type":"string"}}},"v1.PrivateLink":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"v1.PrivateConnectAccount":{"type":"object","properties":{"alias":{"type":"string"},"id":{"type":"string"}}},"v1.PrivateServiceConnect":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"v1.ScaleOptions":{"type":"object","properties":{"max_compute":{"type":"integer"},"min_compute":{"type":"integer"},"suspend_enabled":{"description":"Enable serverless suspension. Valid values: true or false. Defaults to true if not specified.","type":"boolean"}}},"v1.StorageVolume":{"type":"object","properties":{"iops":{"type":"integer"},"size":{"type":"integer"},"throughput":{"type":"integer"},"volume_type":{"type":"string"}}},"v1.Upgrades":{"type":"object","properties":{"kubernetes_upgrade_deadline":{"type":"string"},"kubernetes_upgrade_in_progress":{"type":"boolean"},"kubernetes_upgrade_status":{"enum":["available","required","ok"],"allOf":[{"$ref":"#/components/schemas/v1.KubernetesUpgradeStatus"}]}}},"v1.KubernetesUpgradeStatus":{"type":"string","enum":["available","required","ok"]},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/replicas":{"get":{"description":"Retrieve a list of services that are replicas for the specified service.","tags":["Services"],"summary":"List Replicas for a Service","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Services of user or team","type":"array","items":{"$ref":"#/components/schemas/v1.ServiceResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Update Replication on a Service

> Sets up a service to serve as a replica for another service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.ServiceReplication":{"description":"Enable replication for a service","type":"object","properties":{"primary_host":{"type":"string"},"replication_type":{"type":"string","enum":["uni-directional","bi-directional"]}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/replication":{"post":{"description":"Sets up a service to serve as a replica for another service.","tags":["Services"],"summary":"Update Replication on a Service","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ServiceReplication"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ServiceReplication"}}},"description":"The request body.","required":true}}}}}
```

## Delete Replication on a Service

> Disables replication for a specified service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/replication":{"delete":{"description":"Disables replication for a specified service.","tags":["Services"],"summary":"Delete Replication on a Service","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Update Service Scale Options

> Updates the serverless instance's scale options.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]},"v1.ScaleOptions":{"type":"object","properties":{"max_compute":{"type":"integer"},"min_compute":{"type":"integer"},"suspend_enabled":{"description":"Enable serverless suspension. Valid values: true or false. Defaults to true if not specified.","type":"boolean"}}}}},"paths":{"/provisioning/v1/services/{service_id}/scale_options":{"put":{"description":"Updates the serverless instance's scale options.","tags":["Services"],"summary":"Update Service Scale Options","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ScaleOptions"}}},"description":"The request body.","required":true}}}}}
```

## Read Allowed Addresses

> Retrieve the list of IPv4 addresses and netblocks in the allowlist for the specified service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.AllowListEndpoint":{"description":"IP Address that has been added to the services network allowlist.","type":"object","properties":{"allowList":{"description":"Deprecated: This should be removed in future release. Use allow_list instead.","type":"array","items":{"type":"string"}},"allow_list":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListItem"}},"name":{"type":"string"}}},"v1.AllowListItem":{"type":"object","properties":{"comment":{"type":"string"},"ip":{"type":"string"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/security/allowlist":{"get":{"description":"Retrieve the list of IPv4 addresses and netblocks in the allowlist for the specified service.","tags":["Services"],"summary":"Read Allowed Addresses","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListEndpoint"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Add Allowed Address

> Add an IPv4 address or netblock to the allowlist of the specified service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.AllowListEndpoint":{"description":"IP Address that has been added to the services network allowlist.","type":"object","properties":{"allowList":{"description":"Deprecated: This should be removed in future release. Use allow_list instead.","type":"array","items":{"type":"string"}},"allow_list":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListItem"}},"name":{"type":"string"}}},"v1.AllowListItem":{"type":"object","properties":{"comment":{"type":"string"},"ip":{"type":"string"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]},"v1.AddAllowListIPAddressRequest":{"type":"object","properties":{"ip_address":{"type":"string"}}}}},"paths":{"/provisioning/v1/services/{service_id}/security/allowlist":{"post":{"description":"Add an IPv4 address or netblock to the allowlist of the specified service.","tags":["Services"],"summary":"Add Allowed Address","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListEndpoint"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.AddAllowListIPAddressRequest"}}},"description":"The request body","required":true}}}}}
```

## Update Allowed Address

> Update the allowlist for the specified service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.AllowListEndpoint":{"description":"IP Address that has been added to the services network allowlist.","type":"object","properties":{"allowList":{"description":"Deprecated: This should be removed in future release. Use allow_list instead.","type":"array","items":{"type":"string"}},"allow_list":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListItem"}},"name":{"type":"string"}}},"v1.AllowListItem":{"type":"object","properties":{"comment":{"type":"string"},"ip":{"type":"string"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/security/allowlist":{"put":{"description":"Update the allowlist for the specified service.","tags":["Services"],"summary":"Update Allowed Address","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListEndpoint"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListItem"}}}},"description":"The request body.","required":true}}}}}
```

## Remove Allowed Address

> Remove an IPv4 address or netblock from the allowlist of the specified service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.AllowListEndpoint":{"description":"IP Address that has been added to the services network allowlist.","type":"object","properties":{"allowList":{"description":"Deprecated: This should be removed in future release. Use allow_list instead.","type":"array","items":{"type":"string"}},"allow_list":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListItem"}},"name":{"type":"string"}}},"v1.AllowListItem":{"type":"object","properties":{"comment":{"type":"string"},"ip":{"type":"string"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]},"v1.DeleteAllowedAddressRequest":{"type":"object","properties":{"ip_address":{"type":"string"}}}}},"paths":{"/provisioning/v1/services/{service_id}/security/allowlist":{"delete":{"description":"Remove an IPv4 address or netblock from the allowlist of the specified service.","tags":["Services"],"summary":"Remove Allowed Address","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListEndpoint"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.DeleteAllowedAddressRequest"}}},"description":"The request body.","required":true}}}}}
```

## Retrieve Default Credentials

> Retrieve the default credentials for the service. These credentials are not intended for long-term\
> use, but should be replaced with credentials of your own choosing using a MariaDB client.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.CredentialsResponse":{"type":"object","properties":{"host":{"type":"string"},"password":{"type":"string"},"username":{"type":"string"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/security/credentials":{"get":{"description":"Retrieve the default credentials for the service. These credentials are not intended for long-term\nuse, but should be replaced with credentials of your own choosing using a MariaDB client.","tags":["Services"],"summary":"Retrieve Default Credentials","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.CredentialsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Check an IP's Access

> Check if the specified IP address is allowed to access the specified service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.IsIpAllowedResponse":{"description":"Response if an ip is whitelisted","type":"object","properties":{"ip_address":{"type":"string"},"is_allowed":{"type":"boolean"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]},"v1.IsIpAllowedRequest":{"description":"Request to identify if an ip is whitelisted","type":"object","properties":{"ip_address":{"type":"string"}}}}},"paths":{"/provisioning/v1/services/{service_id}/security/is-ip-allowed":{"post":{"description":"Check if the specified IP address is allowed to access the specified service.","tags":["Services"],"summary":"Check an IP's Access","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.IsIpAllowedResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.IsIpAllowedRequest"}}},"description":"The request body.","required":true}}}}}
```

## Set SSL for a Service

> Enables or disables SSL for the specified service

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.ServiceResponse":{"description":"ServiceResponse","type":"object","properties":{"analytics":{"type":"boolean"},"architecture":{"type":"string"},"assigned_on":{"type":"integer"},"availability_zone":{"type":"string"},"config_id":{"type":"string"},"created_by":{"type":"string"},"created_on":{"type":"integer"},"custom_ssl":{"type":"boolean"},"data_center":{"type":"string"},"domains":{"type":"array","items":{"type":"string"}},"endpoints":{"type":"array","items":{"$ref":"#/components/schemas/v1.ServiceEndpoint"}},"errors":{"type":"array","items":{"type":"string"}},"fqdn":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"maintenance_window":{"type":"string"},"maxscale_nodes":{"type":"integer"},"maxscale_size":{"type":"string"},"name":{"type":"string"},"nodes":{"type":"integer"},"nosql_enabled":{"type":"boolean"},"outbound_ips":{"type":"array","items":{"type":"string"}},"primary_host":{"type":"string"},"project_id":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"replication_enabled":{"type":"boolean"},"scale_options":{"$ref":"#/components/schemas/v1.ScaleOptions"},"service_type":{"type":"string"},"size":{"type":"string"},"ssl_enabled":{"type":"boolean"},"status":{"type":"string","enum":["pending_create","pending_start","pending_stop","pending_scale","pending_delete","pending_modifying","ready","failed","stopped","retired","unknown"]},"storage_volume":{"$ref":"#/components/schemas/v1.StorageVolume"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"tenancy":{"type":"string"},"tier":{"type":"string"},"topology":{"type":"string"},"updated_by":{"type":"string"},"updated_on":{"type":"integer"},"upgrades":{"$ref":"#/components/schemas/v1.Upgrades"},"version":{"type":"string"},"volume_modified_on":{"type":"integer"}}},"v1.ServiceEndpoint":{"type":"object","properties":{"allow_list":{"type":"array","items":{"$ref":"#/components/schemas/v1.AllowListItem"}},"allowed_accounts":{"type":"array","items":{"type":"string"}},"endpoint_service":{"type":"string"},"fqdn":{"type":"string"},"ips":{"type":"array","items":{"type":"string"}},"mechanism":{"type":"string"},"name":{"type":"string"},"ports":{"type":"array","items":{"$ref":"#/components/schemas/v1.PurposePort"}},"private_link":{"$ref":"#/components/schemas/v1.PrivateLink"},"private_service_connect":{"$ref":"#/components/schemas/v1.PrivateServiceConnect"},"visibility":{"type":"string"}}},"v1.AllowListItem":{"type":"object","properties":{"comment":{"type":"string"},"ip":{"type":"string"}}},"v1.PurposePort":{"type":"object","properties":{"name":{"type":"string","enum":["readwrite","readonly","nosql","api","replication","sparksql","https","http"]},"port":{"type":"integer"},"purpose":{"type":"string"}}},"v1.PrivateLink":{"type":"object","properties":{"accounts":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"v1.PrivateConnectAccount":{"type":"object","properties":{"alias":{"type":"string"},"id":{"type":"string"}}},"v1.PrivateServiceConnect":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"v1.ScaleOptions":{"type":"object","properties":{"max_compute":{"type":"integer"},"min_compute":{"type":"integer"},"suspend_enabled":{"description":"Enable serverless suspension. Valid values: true or false. Defaults to true if not specified.","type":"boolean"}}},"v1.StorageVolume":{"type":"object","properties":{"iops":{"type":"integer"},"size":{"type":"integer"},"throughput":{"type":"integer"},"volume_type":{"type":"string"}}},"v1.Upgrades":{"type":"object","properties":{"kubernetes_upgrade_deadline":{"type":"string"},"kubernetes_upgrade_in_progress":{"type":"boolean"},"kubernetes_upgrade_status":{"enum":["available","required","ok"],"allOf":[{"$ref":"#/components/schemas/v1.KubernetesUpgradeStatus"}]}}},"v1.KubernetesUpgradeStatus":{"type":"string","enum":["available","required","ok"]},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]},"v1.SetSSLRequest":{"type":"object","properties":{"ssl_enabled":{"type":"boolean"}}}}},"paths":{"/provisioning/v1/services/{service_id}/security/ssl":{"patch":{"description":"Enables or disables SSL for the specified service","tags":["Services"],"summary":"Set SSL for a Service","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ServiceResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.SetSSLRequest"}}},"description":"The request body.","required":true}}}}}
```

## Update Service Size

> Update the node size of the specified service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.ServiceSizeState":{"description":"Nodes size for a service","type":"object","properties":{"size":{"type":"string"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/size":{"post":{"description":"Update the node size of the specified service.","tags":["Services"],"summary":"Update Service Size","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ServiceSizeState"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ServiceSizeState"}}},"description":"The request body.","required":true}}}}}
```

## Starts a stopped service

> Starts a stopped service

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/start":{"post":{"description":"Starts a stopped service","tags":["Services"],"summary":"Starts a stopped service","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Stops a running service

> Stops a running service

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/stop":{"post":{"description":"Stops a running service","tags":["Services"],"summary":"Stops a running service","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Set Service Storage

> Sets the service's size or IOPS (AWS only)

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.SetStorageRequest":{"description":"Storage size and IOPS (AWS only) that is set for the service","type":"object","properties":{"iops":{"description":"Total Input/output operations of the volume\nMinimum / Maximum IOPs depend on the size of the disk and volume type.\nThis property should only be set on AWS gp3 volume types.\nThe Valid range is 3000 to 16000 IOPS.","type":"integer","format":"int64","maximum":16000,"minimum":3000},"size":{"description":"Size in GBs","type":"integer","format":"int64","minimum":1},"throughput":{"description":"Throughput in MB/s. This property should only be set on AWS services with gp3 volume typee.\nThe Valid range is 125 MiB/s to 1,000 MiB/s.","type":"integer","format":"int64","maximum":1000,"minimum":125}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/storage":{"patch":{"description":"Sets the service's size or IOPS (AWS only)","tags":["Services"],"summary":"Set Service Storage","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.SetStorageRequest"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"425":{"description":"Too Early","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.SetStorageRequest"}}},"description":"The request body.","required":true}}}}}
```

## Set Service Storage

> Sets the storage IOPS and storage type of the specified service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.SetStorageRequest":{"description":"Storage size and IOPS (AWS only) that is set for the service","type":"object","properties":{"iops":{"description":"Total Input/output operations of the volume\nMinimum / Maximum IOPs depend on the size of the disk and volume type.\nThis property should only be set on AWS gp3 volume types.\nThe Valid range is 3000 to 16000 IOPS.","type":"integer","format":"int64","maximum":16000,"minimum":3000},"size":{"description":"Size in GBs","type":"integer","format":"int64","minimum":1},"throughput":{"description":"Throughput in MB/s. This property should only be set on AWS services with gp3 volume typee.\nThe Valid range is 125 MiB/s to 1,000 MiB/s.","type":"integer","format":"int64","maximum":1000,"minimum":125}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/storage/iops":{"patch":{"description":"Sets the storage IOPS and storage type of the specified service.","tags":["Services"],"summary":"Set Service Storage","deprecated":true,"parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.SetStorageRequest"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"425":{"description":"Too Early","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.SetStorageRequest"}}},"description":"The request body.","required":true}}}}}
```

## Set Service Storage

> Sets the storage size of the specified service.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.SetStorageRequest":{"description":"Storage size and IOPS (AWS only) that is set for the service","type":"object","properties":{"iops":{"description":"Total Input/output operations of the volume\nMinimum / Maximum IOPs depend on the size of the disk and volume type.\nThis property should only be set on AWS gp3 volume types.\nThe Valid range is 3000 to 16000 IOPS.","type":"integer","format":"int64","maximum":16000,"minimum":3000},"size":{"description":"Size in GBs","type":"integer","format":"int64","minimum":1},"throughput":{"description":"Throughput in MB/s. This property should only be set on AWS services with gp3 volume typee.\nThe Valid range is 125 MiB/s to 1,000 MiB/s.","type":"integer","format":"int64","maximum":1000,"minimum":125}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/storage/size":{"patch":{"description":"Sets the storage size of the specified service.","tags":["Services"],"summary":"Set Service Storage","deprecated":true,"parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.SetStorageRequest"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.SetStorageRequest"}}},"description":"The request body.","required":true}}}}}
```

## Update Service Tags

> Update the service tags.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]},"v1.UpdateServiceTagsRequest":{"description":"Tags to be set for the service","type":"object","properties":{"tags":{"description":"Tags to be set for the service","type":"object","additionalProperties":{"type":"string"}}}}}},"paths":{"/provisioning/v1/services/{service_id}/tags":{"patch":{"description":"Update the service tags.","tags":["Services"],"summary":"Update Service Tags","parameters":[{"schema":{"type":"string"},"description":"The ID for the service.","name":"service_id","in":"path","required":true}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.UpdateServiceTagsRequest"}}},"description":"The request body.","required":true}}}}}
```

## Upgrade Kubernetes Version

> Upgrade Kubernetes Version

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/services/{service_id}/upgrade/kubernetes_version":{"post":{"description":"Upgrade Kubernetes Version","tags":["Services"],"summary":"Upgrade Kubernetes Version","parameters":[{"schema":{"type":"string"},"description":"service id","name":"service_id","in":"path","required":true}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```