> For the complete documentation index, see [llms.txt](https://mariadb.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mariadb.com/docs/mariadb-cloud/reference/mariadb-cloud-api-reference-guide/models.md). # Models ## The errr.ErrorDetails object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"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"]}}}} ``` ## The errr.ErrorResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"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"]}}}} ``` ## The errr.Type object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}}} ``` ## The v1.AccountResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.AccountResponse":{"type":"object","properties":{"account_id":{"type":"string"},"domains":{"$ref":"#/components/schemas/v1.Domains"},"legacy_dns":{"type":"boolean"},"org_id":{"type":"string"},"provider":{"type":"string"},"status":{"type":"string"},"tier":{"type":"string"}}},"v1.Domains":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v1.DNSZone"}},"v1.DNSZone":{"type":"object","properties":{"link":{"type":"boolean"},"name":{"type":"string"}}}}}} ``` ## The v1.AddAllowListIPAddressRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.AddAllowListIPAddressRequest":{"type":"object","properties":{"ip_address":{"type":"string"}}}}}} ``` ## The v1.AllowListEndpoint object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"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"}}}}}} ``` ## The v1.AllowListItem object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.AllowListItem":{"type":"object","properties":{"comment":{"type":"string"},"ip":{"type":"string"}}}}}} ``` ## The v1.ApplicationResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ApplicationResponse":{"description":"ApplicationResponse that is installed on a cluster","type":"object","properties":{"app":{"type":"string"},"level":{"type":"string"},"ref_id":{"type":"string"},"value":{"type":"string"}}}}}} ``` ## The v1.Architecture object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Architecture":{"description":"Architecture, supported by cloud provider, such as amd64 or arm64","type":"object","properties":{"display_name":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The v1.BillableAccount object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.BillableAccount":{"type":"object","properties":{"account_id":{"type":"string"},"billing_id":{"type":"string"},"domains":{"$ref":"#/components/schemas/v1.Domains"},"legacy_dns":{"type":"boolean"},"org_id":{"type":"string"},"provider":{"type":"string"},"status":{"type":"string"},"tier":{"type":"string"}}},"v1.Domains":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v1.DNSZone"}},"v1.DNSZone":{"type":"object","properties":{"link":{"type":"boolean"},"name":{"type":"string"}}}}}} ``` ## The v1.CPUOptions object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.CPUOptions":{"type":"object","properties":{"default":{"type":"array","items":{"type":"integer"}},"range":{"type":"array","items":{"type":"integer"}}}}}}} ``` ## The v1.Certificate object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Certificate":{"type":"object","properties":{"certificate":{"type":"string"},"expires":{"type":"string"},"serial":{"type":"string"}}}}}} ``` ## The v1.CleanEmptyFoundationTierResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.CleanEmptyFoundationTierResponse":{"type":"object","properties":{"clusters":{"type":"array","items":{"$ref":"#/components/schemas/v1.ClusterResponse"}},"dry_run":{"type":"boolean"}}},"v1.ClusterResponse":{"type":"object","properties":{"applications":{"type":"array","items":{"$ref":"#/components/schemas/v1.ClusterApplication"}},"availability_zones":{"type":"array","items":{"type":"string"}},"ca_cert":{"type":"string"},"cloud_account":{"type":"string"},"endpoint":{"type":"string"},"history":{"type":"array","items":{"$ref":"#/components/schemas/v1.ClusterHistory"}},"id":{"type":"string"},"kubernetes_version":{"type":"string"},"monitoring_fqdn":{"type":"string"},"nat_ips":{"type":"array","items":{"type":"string"}},"org_id":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"sa_enabled":{"type":"boolean"},"serverless_instance_type":{"type":"string"},"status":{"type":"string"},"tier":{"type":"string"}}},"v1.ClusterApplication":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}}},"v1.ClusterHistory":{"type":"object","properties":{"cluster_state":{},"created_on":{"type":"string"},"id":{"type":"string"}}}}}} ``` ## The v1.ClusterApplication object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ClusterApplication":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}}}}}} ``` ## The v1.ClusterHistory object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ClusterHistory":{"type":"object","properties":{"cluster_state":{},"created_on":{"type":"string"},"id":{"type":"string"}}}}}} ``` ## The v1.ClusterResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ClusterResponse":{"type":"object","properties":{"applications":{"type":"array","items":{"$ref":"#/components/schemas/v1.ClusterApplication"}},"availability_zones":{"type":"array","items":{"type":"string"}},"ca_cert":{"type":"string"},"cloud_account":{"type":"string"},"endpoint":{"type":"string"},"history":{"type":"array","items":{"$ref":"#/components/schemas/v1.ClusterHistory"}},"id":{"type":"string"},"kubernetes_version":{"type":"string"},"monitoring_fqdn":{"type":"string"},"nat_ips":{"type":"array","items":{"type":"string"}},"org_id":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"sa_enabled":{"type":"boolean"},"serverless_instance_type":{"type":"string"},"status":{"type":"string"},"tier":{"type":"string"}}},"v1.ClusterApplication":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}}},"v1.ClusterHistory":{"type":"object","properties":{"cluster_state":{},"created_on":{"type":"string"},"id":{"type":"string"}}}}}} ``` ## The v1.Config object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Config":{"type":"object","properties":{"created_by":{"type":"string"},"created_date":{"type":"integer"},"id":{"type":"string"},"name":{"type":"string"},"public":{"type":"boolean"},"services":{"type":"array","items":{"type":"string"}},"topology_id":{"type":"string"},"updated_by":{"type":"string"},"updated_date":{"type":"integer"},"version_id":{"type":"string"}}}}}} ``` ## The v1.ConfigKey object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ConfigKey":{"description":"A single configurable parameter","type":"object","properties":{"allowed_values":{"type":"array","items":{"type":"string"}},"component":{"$ref":"#/components/schemas/v1.ConfigKeyComponent"},"config_section":{"type":"string"},"default_value":{"type":"array","items":{"type":"string"}},"documentation_url":{"type":"string"},"flags":{"type":"integer"},"id":{"type":"string"},"maximum_value":{"type":"string"},"minimum_value":{"type":"string"},"multiselect":{"type":"boolean"},"name":{"type":"string"},"readonly":{"type":"boolean"},"requires_restart":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}}}},"v1.ConfigKeyComponent":{"type":"string","enum":["server","maxscale"]}}}} ``` ## The v1.ConfigKeyComponent object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ConfigKeyComponent":{"type":"string","enum":["server","maxscale"]}}}} ``` ## The v1.ConfigValue object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ConfigValue":{"type":"object","properties":{"config_key_id":{"type":"string"},"selected_values":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The v1.ConfigValueRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ConfigValueRequest":{"type":"object","properties":{"value":{"type":"string"}}}}}} ``` ## The v1.CreateAccountRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.CreateAccountRequest":{"type":"object","properties":{"account_id":{"type":"string"},"domains":{"$ref":"#/components/schemas/v1.Domains"},"legacy_dns":{"type":"boolean"},"org_id":{"type":"string"},"provider":{"type":"string"},"status":{"type":"string"},"tier":{"type":"string"}}},"v1.Domains":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v1.DNSZone"}},"v1.DNSZone":{"type":"object","properties":{"link":{"type":"boolean"},"name":{"type":"string"}}}}}} ``` ## The v1.CreateClusterRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.CreateClusterRequest":{"type":"object","properties":{"applications":{"type":"array","items":{"$ref":"#/components/schemas/v1.ClusterApplication"}},"availability_zones":{"type":"array","items":{"type":"string"}},"ca_cert":{"type":"string"},"endpoint":{"type":"string"},"id":{"type":"string"},"kubernetes_version":{"type":"string"},"monitoring_fqdn":{"type":"string"},"nat_ips":{"type":"array","items":{"type":"string"}},"org_id":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"sa_enabled":{"type":"boolean"},"status":{"type":"string"},"tier":{"type":"string"}}},"v1.ClusterApplication":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}}}}}} ``` ## The v1.CreateConfigRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.CreateConfigRequest":{"type":"object","properties":{"name":{"type":"string"},"topology_id":{"type":"string"},"version_id":{"type":"string"}}}}}} ``` ## The v1.CreateReleaseRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.CreateReleaseRequest":{"description":"Create release payload","type":"object","properties":{"date":{"type":"string"},"default":{"type":"boolean"},"is_active":{"type":"boolean"},"is_major":{"type":"boolean"},"name":{"type":"string"},"notes_url":{"type":"string"},"product_name":{"type":"string"},"release":{"type":"string"},"topology_name":{"type":"string"},"version":{"type":"string"}}}}}} ``` ## The v1.CreateServerlessRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.CreateServerlessRequest":{"type":"object","properties":{"architecture":{"type":"string","enum":["amd64","arm64"]},"provider":{"type":"string","enum":["aws","gcp","azure"]},"region":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"topology":{"type":"string","enum":["serverless-standalone","serverless-replicated"]},"version":{"type":"string"}}}}}} ``` ## The v1.CreateServerlessResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.CreateServerlessResponse":{"type":"object","properties":{"id":{"type":"string"}}}}}} ``` ## The v1.CreateServiceEndpointRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"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"}}}}}} ``` ## The v1.CreateServiceInternalRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.CreateServiceInternalRequest":{"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"},"created_by":{"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"},"dry_run":{"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 applicable if maxscale_nodes > 0","type":"string"},"migration_source_database_id":{"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"},"org_id":{"type":"string"},"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"]},"tier":{"type":"string"},"tls_san_hosts":{"type":"array","items":{"type":"string"}},"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.AllowListItem":{"type":"object","properties":{"comment":{"type":"string"},"ip":{"type":"string"}}},"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"}}},"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"}}}}}} ``` ## The v1.CreateServiceRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"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 applicable 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.AllowListItem":{"type":"object","properties":{"comment":{"type":"string"},"ip":{"type":"string"}}},"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"}}},"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"}}}}}} ``` ## The v1.CredentialsResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.CredentialsResponse":{"type":"object","properties":{"host":{"type":"string"},"password":{"type":"string"},"username":{"type":"string"}}}}}} ``` ## The v1.DNSZone object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.DNSZone":{"type":"object","properties":{"link":{"type":"boolean"},"name":{"type":"string"}}}}}} ``` ## The v1.DeleteAllowedAddressRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.DeleteAllowedAddressRequest":{"type":"object","properties":{"ip_address":{"type":"string"}}}}}} ``` ## The v1.Domains object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Domains":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v1.DNSZone"}},"v1.DNSZone":{"type":"object","properties":{"link":{"type":"boolean"},"name":{"type":"string"}}}}}} ``` ## The v1.Endpoint object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Endpoint":{"type":"object","properties":{"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"}},"visibility":{"type":"string"},"whitelist":{"type":"array","items":{"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"}}}}}} ``` ## The v1.Entitlement object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Entitlement":{"type":"object","properties":{"name":{"type":"string"},"topologies":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The v1.InternalConfig object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.InternalConfig":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"public":{"type":"boolean"},"selected_values":{"type":"array","items":{"$ref":"#/components/schemas/v1.InternalSelectedValue"}}}},"v1.InternalSelectedValue":{"type":"object","properties":{"component":{"type":"string"},"config_section":{"type":"string"},"name":{"type":"string"},"requires_restart":{"type":"boolean"},"value":{"type":"string"}}}}}} ``` ## The v1.InternalSelectedValue object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.InternalSelectedValue":{"type":"object","properties":{"component":{"type":"string"},"config_section":{"type":"string"},"name":{"type":"string"},"requires_restart":{"type":"boolean"},"value":{"type":"string"}}}}}} ``` ## The v1.IsIpAllowedRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.IsIpAllowedRequest":{"description":"Request to identify if an ip is whitelisted","type":"object","properties":{"ip_address":{"type":"string"}}}}}} ``` ## The v1.IsIpAllowedResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.IsIpAllowedResponse":{"description":"Response if an ip is whitelisted","type":"object","properties":{"ip_address":{"type":"string"},"is_allowed":{"type":"boolean"}}}}}} ``` ## The v1.KubernetesUpgradeStatus object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.KubernetesUpgradeStatus":{"type":"string","enum":["available","required","ok"]}}}} ``` ## The v1.MaintenanceWindow object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.MaintenanceWindow":{"type":"object","properties":{"display_name":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The v1.ModifyServiceEndpoint object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"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"}]}}},"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"}}}}}}} ``` ## The v1.NamedPort object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.NamedPort":{"type":"object","properties":{"name":{"type":"string","enum":["readwrite","readonly","nosql","api","replication","sparksql","https","http"]},"port":{"type":"integer"}}}}}} ``` ## The v1.Organization object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Organization":{"type":"object","properties":{"created_on":{"type":"integer"},"org_id":{"type":"string"},"organization_usage":{"type":"array","items":{"$ref":"#/components/schemas/v1.OrganizationUsage"}},"quotas":{"type":"array","items":{"$ref":"#/components/schemas/v1.OrganizationQuota"}},"services":{"type":"integer"}}},"v1.OrganizationUsage":{"type":"object","properties":{"provider":{"type":"string"},"region":{"type":"string"},"services":{"type":"integer"},"storage_volume_iops":{"type":"integer"},"storage_volume_size":{"type":"integer"}}},"v1.OrganizationQuota":{"type":"object","properties":{"created_on":{"type":"integer"},"description":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"updated_on":{"type":"integer"},"value":{"type":"integer"}}}}}} ``` ## The v1.OrganizationQuota object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.OrganizationQuota":{"type":"object","properties":{"created_on":{"type":"integer"},"description":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"updated_on":{"type":"integer"},"value":{"type":"integer"}}}}}} ``` ## The v1.OrganizationUsage object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.OrganizationUsage":{"type":"object","properties":{"provider":{"type":"string"},"region":{"type":"string"},"services":{"type":"integer"},"storage_volume_iops":{"type":"integer"},"storage_volume_size":{"type":"integer"}}}}}} ``` ## The v1.OverrideResponseInternal object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.OverrideResponseInternal":{"description":"Override object","type":"object","properties":{"app":{"type":"string"},"level":{"type":"string"},"ref_id":{"type":"string"},"value":{"type":"string"}}}}}} ``` ## The v1.PatchAccountRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.PatchAccountRequest":{"type":"object","properties":{"account_id":{"type":"string"},"domains":{"$ref":"#/components/schemas/v1.Domains"},"legacy_dns":{"type":"boolean"},"status":{"type":"string"},"tier":{"type":"string"}}},"v1.Domains":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/v1.DNSZone"}},"v1.DNSZone":{"type":"object","properties":{"link":{"type":"boolean"},"name":{"type":"string"}}}}}} ``` ## The v1.PatchClusterRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.PatchClusterRequest":{"type":"object","properties":{"applications":{"type":"array","items":{"$ref":"#/components/schemas/v1.ClusterApplication"}},"availability_zones":{"type":"array","items":{"type":"string"}},"ca_cert":{"type":"string"},"endpoint":{"type":"string"},"kubernetes_version":{"type":"string"},"monitoring_fqdn":{"type":"string"},"nat_ips":{"type":"array","items":{"type":"string"}},"sa_enabled":{"type":"boolean"},"status":{"type":"string"},"tier":{"type":"string"}}},"v1.ClusterApplication":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}}}}}} ``` ## The v1.PatchRegion object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.PatchRegion":{"type":"object","properties":{"is_active":{"type":"boolean"},"name":{"type":"string"},"region_overrides":{"type":"array","items":{"$ref":"#/components/schemas/v1.PatchRegionOverride"}}}},"v1.PatchRegionOverride":{"type":"object","properties":{"is_active":{"type":"boolean"},"tier":{"type":"string"}}}}}} ``` ## The v1.PatchRegionOverride object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.PatchRegionOverride":{"type":"object","properties":{"is_active":{"type":"boolean"},"tier":{"type":"string"}}}}}} ``` ## The v1.PatchReleaseRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.PatchReleaseRequest":{"description":"Update release payload","type":"object","properties":{"date":{"type":"string"},"default":{"type":"boolean"},"is_active":{"type":"boolean"},"notes_url":{"type":"string"},"version":{"type":"string"}}}}}} ``` ## The v1.PatchServiceRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.PatchServiceRequest":{"description":"Update service request","type":"object","properties":{"applications":{},"cert":{"$ref":"#/components/schemas/v1.Certificate"},"domains":{"type":"array","items":{"type":"string"}},"endpoints":{"type":"array","items":{"$ref":"#/components/schemas/v1.Endpoint"}},"fqdn":{"type":"string"},"ips":{"type":"array","items":{"type":"string"}},"kubernetes_version":{"type":"string"},"migration_status":{"type":"string"},"override_status":{"type":"boolean"},"status":{"type":"string"},"tags":{"type":"object","additionalProperties":{"type":"string"}}}},"v1.Certificate":{"type":"object","properties":{"certificate":{"type":"string"},"expires":{"type":"string"},"serial":{"type":"string"}}},"v1.Endpoint":{"type":"object","properties":{"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"}},"visibility":{"type":"string"},"whitelist":{"type":"array","items":{"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"}}}}}} ``` ## The v1.PowerState object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.PowerState":{"description":"Start/Stop Service","type":"object","properties":{"is_active":{"type":"boolean"}}}}}} ``` ## The v1.PrivateConnectAccount object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.PrivateConnectAccount":{"type":"object","properties":{"alias":{"type":"string"},"id":{"type":"string"}}}}}} ``` ## The v1.PrivateLink object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"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"}}}}}} ``` ## The v1.PrivateServiceConnect object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.PrivateServiceConnect":{"type":"object","properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/v1.PrivateConnectAccount"}}}},"v1.PrivateConnectAccount":{"type":"object","properties":{"alias":{"type":"string"},"id":{"type":"string"}}}}}} ``` ## The v1.Product object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Product":{"description":"Product","type":"object","properties":{"display_name":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The v1.Provider object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Provider":{"type":"object","properties":{"active":{"type":"boolean"},"default":{"type":"boolean"},"display_name":{"type":"string"},"id":{"type":"string"},"iops_min":{"type":"integer"},"iops_per_gb":{"type":"integer"},"name":{"type":"string"},"volume_size_max_gb":{"type":"integer"},"volume_size_min_gb":{"type":"integer"}}}}}} ``` ## The v1.ProviderIOPSResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ProviderIOPSResponse":{"description":"cloud provider iops values","type":"object","properties":{"default_iops_per_gb":{"type":"integer"},"id":{"type":"string"},"iops_range_max":{"type":"integer"},"iops_range_min":{"type":"integer"},"provider":{"type":"string"},"storage_range_max":{"type":"integer"},"storage_range_min":{"type":"integer"},"throughput_range_max":{"type":"integer"},"throughput_range_min":{"type":"integer"},"tier":{"type":"string"},"total_iops_range_max":{"type":"integer"},"total_iops_range_min":{"type":"integer"},"volume_type_name":{"type":"string"}}}}}} ``` ## The v1.ProvisionClusterRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ProvisionClusterRequest":{"type":"object","properties":{"id":{"type":"string"},"org_id":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"tier":{"type":"string"}}}}}} ``` ## The v1.PurposePort object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.PurposePort":{"type":"object","properties":{"name":{"type":"string","enum":["readwrite","readonly","nosql","api","replication","sparksql","https","http"]},"port":{"type":"integer"},"purpose":{"type":"string"}}}}}} ``` ## The v1.ReadTopologyOptionsResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ReadTopologyOptionsResponse":{"description":"All options for a topology","type":"object","properties":{"nosql_available":{"type":"boolean"},"scale_options":{"$ref":"#/components/schemas/v1.TopologyOptionScaleOptions"}}},"v1.TopologyOptionScaleOptions":{"type":"object","properties":{"cpu":{"$ref":"#/components/schemas/v1.CPUOptions"}}},"v1.CPUOptions":{"type":"object","properties":{"default":{"type":"array","items":{"type":"integer"}},"range":{"type":"array","items":{"type":"integer"}}}}}}} ``` ## The v1.Region object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Region":{"description":"Geographic region, as defined by the provider","type":"object","properties":{"default":{"type":"boolean"},"foundation_tier_maintenance_window":{"type":"string"},"has_clusters":{"type":"boolean"},"id":{"type":"string"},"is_available":{"type":"boolean"},"name":{"type":"string"},"order":{"type":"integer"},"provider":{"type":"string"},"region":{"type":"string"}}}}}} ``` ## The v1.RegionInternal object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.RegionInternal":{"description":"Geographic region, as defined by the provider","type":"object","properties":{"default":{"type":"boolean"},"foundation_tier_maintenance_window":{"type":"string"},"has_clusters":{"type":"boolean"},"id":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"order":{"type":"integer"},"provider":{"type":"string"},"region_overrides":{"type":"array","items":{"$ref":"#/components/schemas/v1.RegionOverride"}}}},"v1.RegionOverride":{"type":"object","properties":{"is_active":{"type":"boolean"},"tier":{"type":"string"}}}}}} ``` ## The v1.RegionOverride object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.RegionOverride":{"type":"object","properties":{"is_active":{"type":"boolean"},"tier":{"type":"string"}}}}}} ``` ## The v1.Release object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Release":{"type":"object","properties":{"created_by":{"type":"string"},"created_on":{"type":"string"},"date":{"type":"string"},"default":{"type":"boolean"},"id":{"type":"string"},"is_active":{"type":"boolean"},"is_major":{"type":"boolean"},"name":{"type":"string"},"notes_url":{"type":"string"},"product_name":{"type":"string"},"release":{"type":"string"},"topology_name":{"type":"string"},"updated_by":{"type":"string"},"updated_on":{"type":"string"},"version":{"type":"string"}}}}}} ``` ## The v1.ScaleOptions object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"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"}}}}}} ``` ## The v1.ServiceConfigState object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ServiceConfigState":{"description":"Config for a service","type":"object","properties":{"config_id":{"type":"string"}}}}}} ``` ## The v1.ServiceEndpoint object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"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"}}}}}}} ``` ## The v1.ServiceNodesState object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ServiceNodesState":{"description":"Update the number of nodes for a service","type":"object","properties":{"nodes":{"type":"integer"}}}}}} ``` ## The v1.ServiceReplication object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"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"]}}}}}} ``` ## The v1.ServiceResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"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"]}}}} ``` ## The v1.ServiceResponseInternal object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ServiceResponseInternal":{"description":"Service object","type":"object","properties":{"analytics":{"type":"boolean"},"applications":{},"architecture":{"type":"string"},"availability_zone":{"type":"string"},"cert":{},"cloud_account":{"type":"string"},"cluster_id":{"type":"string"},"created_by":{"type":"string"},"created_on":{"type":"integer"},"custom_image_versions":{},"custom_ssl":{"type":"boolean"},"data_center":{"type":"string"},"deleted_on":{"type":"integer"},"domains":{"type":"array","items":{"type":"string"}},"endpoints":{"type":"array","items":{"$ref":"#/components/schemas/v1.Endpoint"}},"errors":{"type":"array","items":{"type":"string"}},"fqdn":{"type":"string"},"id":{"type":"string"},"instance_type":{"type":"string"},"ips":{},"is_active":{"type":"boolean"},"kubernetes_version":{"type":"string"},"maintenance_window":{"type":"string"},"maxscale_instance_type":{"type":"string"},"maxscale_nodes":{"type":"integer"},"maxscale_size":{"type":"string"},"migration_source_database_id":{"type":"string"},"migration_status":{"type":"string"},"name":{"type":"string"},"nodes":{"type":"integer"},"nosql_enabled":{"type":"boolean"},"org_id":{"type":"string"},"outbound_ips":{"type":"array","items":{"type":"string"}},"owner_org_id":{"type":"string"},"pgsql_enabled":{"type":"boolean"},"primary_host":{"type":"string"},"project_id":{"type":"string"},"provider":{"type":"string"},"proxy_options":{},"region":{"type":"string"},"release":{"type":"string"},"replication_enabled":{"type":"boolean"},"scale_options":{"$ref":"#/components/schemas/v1.ScaleOptions"},"service_number":{"type":"string"},"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"}},"tasks":{"type":"array","items":{"$ref":"#/components/schemas/v1.ServiceTask"}},"tenancy":{"type":"string"},"tier":{"type":"string"},"tls_san_hosts":{"type":"array","items":{"type":"string"}},"topology":{"type":"string"},"topology_alias":{"type":"string"},"updated_by":{"type":"string"},"updated_on":{"type":"integer"},"upgrades":{"$ref":"#/components/schemas/v1.Upgrades"},"version":{"type":"string"}}},"v1.Endpoint":{"type":"object","properties":{"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"}},"visibility":{"type":"string"},"whitelist":{"type":"array","items":{"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.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.ServiceTask":{"description":"ServiceTask object","type":"object","properties":{"action":{"type":"string"},"created_on":{"type":"integer"},"id":{"type":"string"},"service_id":{"type":"string"},"service_state":{},"status":{"type":"string"},"updated_on":{"type":"integer"}}},"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"]}}}} ``` ## The v1.ServiceSizeState object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ServiceSizeState":{"description":"Nodes size for a service","type":"object","properties":{"size":{"type":"string"}}}}}} ``` ## The v1.ServiceTask object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ServiceTask":{"description":"ServiceTask object","type":"object","properties":{"action":{"type":"string"},"created_on":{"type":"integer"},"id":{"type":"string"},"service_id":{"type":"string"},"service_state":{},"status":{"type":"string"},"updated_on":{"type":"integer"}}}}}} ``` ## The v1.ServiceType object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ServiceType":{"description":"a database services type, e.g. Distributed Transactions","type":"object","properties":{"description":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer"},"short_description":{"type":"string"}}}}}} ``` ## The v1.SetMaintenanceWindowRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.SetMaintenanceWindowRequest":{"type":"object","properties":{"name":{"type":"string"}}}}}} ``` ## The v1.MaintenanceActivityResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.MaintenanceActivityResponse":{"type":"object","properties":{"auto_apply_after":{"type":"string"},"classification":{"type":"string","enum":["infrastructure","security","database"]},"completed_at":{"type":"string"},"created_by":{"type":"string"},"created_on":{"type":"string"},"current_version":{"type":"string"},"deferral_count":{"type":"integer"},"deferred_until":{"type":"string"},"description":{"type":"string"},"expected_impact":{"type":"string","enum":["no_downtime","brief_downtime","extended_downtime"]},"expected_impact_description":{"type":"string"},"expected_impact_label":{"description":"ExpectedImpactLabel / ExpectedImpactDescription are the backend-owned display strings for ExpectedImpact — the UI renders them verbatim instead of mapping the enum itself.","type":"string"},"forced_apply_by":{"type":"string"},"id":{"type":"string"},"is_critical":{"type":"boolean"},"metadata":{"type":"object"},"priority":{"type":"string","enum":["recommended","required"]},"reschedule_count":{"type":"integer"},"scheduled_at":{"type":"string"},"scheduled_window":{"type":"string"},"service_id":{"type":"string"},"started_at":{"type":"string"},"state":{"type":"string","enum":["available","scheduled","deferred","in_progress","completed","failed","cancelled"]},"target_completion_date":{"type":"string"},"target_version":{"type":"string"},"updated_on":{"type":"string"}}}}}} ``` ## The v1.ScheduleMaintenanceRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ScheduleMaintenanceRequest":{"type":"object","properties":{"activity_ids":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}}}} ``` ## The v1.UpgradeDatabaseVersionRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.UpgradeDatabaseVersionRequest":{"type":"object","properties":{"version":{"type":"string"}}}}}} ``` ## The v1.SetQuotaRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.SetQuotaRequest":{"type":"object","properties":{"name":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"value":{"type":"integer"}}}}}} ``` ## The v1.SetSSLRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.SetSSLRequest":{"type":"object","properties":{"ssl_enabled":{"type":"boolean"}}}}}} ``` ## The v1.SetStorageRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"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}}}}}} ``` ## The v1.Size object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Size":{"type":"object","properties":{"architecture":{"type":"string"},"cpu":{"type":"string"},"created_on":{"type":"string"},"default_maxscale_size_name":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"provider":{"type":"string"},"ram":{"type":"string"},"service_type":{"type":"string"},"tier":{"type":"string"},"topology":{"type":"string"},"type":{"type":"string"},"updated_on":{"type":"string"}}}}}} ``` ## The v1.SlaAction object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.SlaAction":{"type":"object","properties":{"action_group":{"type":"string"},"action_id":{"type":"string"},"created_at":{"type":"string"},"enabled":{"type":"boolean"},"group_id":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"params":{"type":"string"},"service_id":{"type":"string"},"service_name":{"type":"string"},"tenant_id":{"type":"string"},"updated_at":{"type":"string"}}}}}} ``` ## The v1.StorageVolume object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.StorageVolume":{"type":"object","properties":{"iops":{"type":"integer"},"size":{"type":"integer"},"throughput":{"type":"integer"},"volume_type":{"type":"string"}}}}}} ``` ## The v1.Tier object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Tier":{"type":"object","properties":{"description":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"topologies":{"type":"array","items":{"$ref":"#/components/schemas/v1.Topology"}}}},"v1.Topology":{"description":"Cluster topology valid for a particular product, e.g. Standalone or MaxScale","type":"object","properties":{"database":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer"},"service_type":{"type":"string"},"storage_engine":{"type":"string"}}}}}} ``` ## The v1.Topology object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Topology":{"description":"Cluster topology valid for a particular product, e.g. Standalone or MaxScale","type":"object","properties":{"database":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer"},"service_type":{"type":"string"},"storage_engine":{"type":"string"}}}}}} ``` ## The v1.TopologyNodeOptionsResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.TopologyNodeOptionsResponse":{"type":"object","properties":{"default_maxscale_nodes":{"type":"integer"},"id":{"type":"string"},"maxscale_nodes":{"type":"array","items":{"type":"integer"}},"nodes":{"type":"array","items":{"type":"integer"}},"tier":{"type":"string"},"topology":{"type":"string"}}}}}} ``` ## The v1.TopologyOptionScaleOptions object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.TopologyOptionScaleOptions":{"type":"object","properties":{"cpu":{"$ref":"#/components/schemas/v1.CPUOptions"}}},"v1.CPUOptions":{"type":"object","properties":{"default":{"type":"array","items":{"type":"integer"}},"range":{"type":"array","items":{"type":"integer"}}}}}}} ``` ## The v1.TopologyStorageSizeResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.TopologyStorageSizeResponse":{"type":"object","properties":{"id":{"type":"string"},"storage_sizes":{"type":"array","items":{"type":"integer"}},"tier":{"type":"string"},"topology":{"type":"string"}}}}}} ``` ## The v1.UpdateConfigRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.UpdateConfigRequest":{"type":"object","properties":{"name":{"type":"string"}}}}}} ``` ## The v1.UpdateServiceTagsRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"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"}}}}}}} ``` ## The v1.UpgradeClusterGroupRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.UpgradeClusterGroupRequest":{"type":"object","properties":{"org_id":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"tier":{"type":"string"}}}}}} ``` ## The v1.UpgradeClusterGroupResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.UpgradeClusterGroupResponse":{"type":"object","properties":{"failed":{"type":"array","items":{"type":"string"}},"succeeded":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The v1.UpgradeServiceReleaseRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.UpgradeServiceReleaseRequest":{"type":"object","properties":{"release":{"type":"string"}}}}}} ``` ## The v1.Upgrades object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"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"]}}}} ``` ## The v1.Version object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Version":{"description":"Database version, e.g. 10.4 or 10.5","type":"object","properties":{"default":{"type":"boolean"},"display_name":{"type":"string"},"id":{"type":"string"},"is_major":{"type":"boolean"},"name":{"type":"string"},"product":{"type":"string"},"release_date":{"type":"string"},"release_notes_url":{"type":"string"},"topology":{"type":"string"},"version":{"type":"string"}}}}}} ``` ## The v1.VolumeTypeResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.VolumeTypeResponse":{"description":"cloud storage volume type","type":"object","properties":{"created_on":{"type":"integer"},"display_name":{"type":"string"},"id":{"type":"string"},"iops":{"type":"array","items":{"$ref":"#/components/schemas/v1.ProviderIOPSResponse"}},"is_default":{"type":"boolean"},"name":{"type":"string"},"provider":{"type":"string"},"updated_on":{"type":"integer"}}},"v1.ProviderIOPSResponse":{"description":"cloud provider iops values","type":"object","properties":{"default_iops_per_gb":{"type":"integer"},"id":{"type":"string"},"iops_range_max":{"type":"integer"},"iops_range_min":{"type":"integer"},"provider":{"type":"string"},"storage_range_max":{"type":"integer"},"storage_range_min":{"type":"integer"},"throughput_range_max":{"type":"integer"},"throughput_range_min":{"type":"integer"},"tier":{"type":"string"},"total_iops_range_max":{"type":"integer"},"total_iops_range_min":{"type":"integer"},"volume_type_name":{"type":"string"}}}}}} ``` ## The v1.Zone object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Zone":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"provider":{"type":"string"},"region_name":{"type":"string"}}}}}} ``` ## The dto.ChannelEmail object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.ChannelEmail":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"string"}},"channel_name":{"type":"string"},"id":{"type":"string"},"org_id":{"type":"string"},"receivers":{"type":"array","items":{"$ref":"#/components/schemas/dto.EmailRecipients"}},"subscriber_id":{"type":"string"}}},"dto.EmailRecipients":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The dto.CreateChannelEmail object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.CreateChannelEmail":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"string"}},"channel_name":{"type":"string"},"receivers":{"type":"array","items":{"$ref":"#/components/schemas/dto.EmailRecipients"}}}},"dto.EmailRecipients":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The dto.EmailRecipients object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.EmailRecipients":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The dto.Notification object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Notification":{"type":"object","properties":{"category":{"type":"string"},"created_by":{"type":"string"},"created_on":{"type":"integer"},"display_string":{"type":"string"},"event_type":{"type":"string"},"id":{"type":"string"},"level":{"type":"string"},"marked_read":{"type":"boolean"},"org_id":{"type":"string"},"subscriber_id":{"type":"string"}}}}}} ``` ## The dto.Preference object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Preference":{"type":"object","properties":{"categories":{"type":"object","additionalProperties":{"type":"boolean"}},"org_id":{"type":"string"},"subscriber_id":{"type":"string"}}}}}} ``` ## The dto.ProgressStep object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.ProgressStep":{"type":"object","properties":{"name":{"type":"string"},"state":{"type":"string"}}}}}} ``` ## The dto.SaveLastReadNotification object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.SaveLastReadNotification":{"type":"object","properties":{"last_read_on":{"type":"integer"}}}}}} ``` ## The dto.ServiceProgress object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.ServiceProgress":{"type":"object","properties":{"service_id":{"type":"string"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/dto.ProgressStep"}}}},"dto.ProgressStep":{"type":"object","properties":{"name":{"type":"string"},"state":{"type":"string"}}}}}} ``` ## The dto.UpdateChannelEmail object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.UpdateChannelEmail":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"string"}},"channel_name":{"type":"string"},"receivers":{"type":"array","items":{"$ref":"#/components/schemas/dto.EmailRecipients"}}}},"dto.EmailRecipients":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The dto.UpdatePreference object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.UpdatePreference":{"type":"object","properties":{"categories":{"type":"object","additionalProperties":{"type":"boolean"}}}}}}} ``` ## The dto.ApiKey object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.ApiKey":{"type":"object","properties":{"api_key":{"type":"string"},"created_by":{"type":"string"},"created_date":{"type":"integer"},"is_active":{"type":"boolean"},"key_id":{"type":"string"},"label":{"type":"string"},"updated_by":{"type":"string"},"updated_date":{"type":"integer"}}}}}} ``` ## The dto.ApiKeyWithUser object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.ApiKeyWithUser":{"type":"object","properties":{"created_by":{"type":"string"},"created_date":{"type":"integer"},"is_active":{"type":"boolean"},"key_id":{"type":"string"},"label":{"type":"string"},"org_id":{"type":"string"},"pbkdf2_hash":{"type":"string"},"pbkdf2_iterations":{"type":"integer"},"pbkdf2_salt":{"type":"string"},"updated_by":{"type":"string"},"updated_date":{"type":"integer"},"user":{"$ref":"#/components/schemas/dto.User"},"version":{"type":"string"}}},"dto.User":{"type":"object","properties":{"created_by":{"type":"string"},"created_on":{"type":"integer"},"email":{"type":"string"},"first_name":{"type":"string"},"id":{"type":"string"},"invited":{"type":"boolean"},"is_active":{"type":"boolean"},"is_deleted":{"type":"boolean"},"last_name":{"type":"string"},"mfa_enabled":{"type":"boolean"},"org":{"$ref":"#/components/schemas/dto.Org"},"org_id":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"updated_by":{"type":"string"},"updated_on":{"type":"integer"}}},"dto.Org":{"type":"object","properties":{"created_by":{"type":"string"},"created_on":{"type":"integer"},"current_owner":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"is_deleted":{"type":"boolean"},"name":{"type":"string"},"tier":{"type":"string"},"updated_by":{"type":"string"},"updated_on":{"type":"integer"}}}}}} ``` ## The dto.Auth0Org object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Auth0Org":{"type":"object","properties":{"org_id":{"type":"string"},"org_name":{"type":"string"}}}}}} ``` ## The dto.Auth0User object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Auth0User":{"type":"object","properties":{"email":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"},"provider_user_id":{"type":"string"},"user_id":{"type":"string"}}}}}} ``` ## The dto.ChangeRole object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.ChangeRole":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The dto.CreateAPIKey object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.CreateAPIKey":{"type":"object","properties":{"label":{"type":"string"}}}}}} ``` ## The dto.CreateAuth0User object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.CreateAuth0User":{"type":"object","properties":{"org":{"$ref":"#/components/schemas/dto.Auth0Org"},"user":{"$ref":"#/components/schemas/dto.Auth0User"}}},"dto.Auth0Org":{"type":"object","properties":{"org_id":{"type":"string"},"org_name":{"type":"string"}}},"dto.Auth0User":{"type":"object","properties":{"email":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"},"provider_user_id":{"type":"string"},"user_id":{"type":"string"}}}}}} ``` ## The dto.CreateInviteResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.CreateInviteResponse":{"type":"object","properties":{"failed":{"type":"object","additionalProperties":{"type":"string"}},"invite":{"$ref":"#/components/schemas/dto.Invite"}}},"dto.Invite":{"type":"object","properties":{"created_on":{"type":"integer"},"expire_on":{"type":"integer"},"id":{"type":"string"},"invitees":{"type":"array","items":{"$ref":"#/components/schemas/dto.Invitee"}},"issuer":{"$ref":"#/components/schemas/dto.User"},"org_id":{"type":"string"},"updated_on":{"type":"integer"}}},"dto.Invitee":{"type":"object","properties":{"email":{"type":"string"},"id":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"url":{"type":"string"}}},"dto.User":{"type":"object","properties":{"created_by":{"type":"string"},"created_on":{"type":"integer"},"email":{"type":"string"},"first_name":{"type":"string"},"id":{"type":"string"},"invited":{"type":"boolean"},"is_active":{"type":"boolean"},"is_deleted":{"type":"boolean"},"last_name":{"type":"string"},"mfa_enabled":{"type":"boolean"},"org":{"$ref":"#/components/schemas/dto.Org"},"org_id":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"updated_by":{"type":"string"},"updated_on":{"type":"integer"}}},"dto.Org":{"type":"object","properties":{"created_by":{"type":"string"},"created_on":{"type":"integer"},"current_owner":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"is_deleted":{"type":"boolean"},"name":{"type":"string"},"tier":{"type":"string"},"updated_by":{"type":"string"},"updated_on":{"type":"integer"}}}}}} ``` ## The dto.CreateOrg object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.CreateOrg":{"type":"object","properties":{"created_by":{"type":"string"},"created_date":{"type":"integer"},"name":{"type":"string"},"org_id":{"type":"string"},"owner":{"$ref":"#/components/schemas/dto.Owner"},"updated_by":{"type":"string"},"updated_date":{"type":"integer"}}},"dto.Owner":{"type":"object","properties":{"first_name":{"type":"string"},"id":{"type":"string"},"last_name":{"type":"string"}}}}}} ``` ## The dto.CreateProject object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.CreateProject":{"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The dto.CreateTeam object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.CreateTeam":{"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"},"users":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The dto.CreateUser object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.CreateUser":{"type":"object","properties":{"created_by":{"type":"string"},"created_date":{"type":"integer"},"email":{"type":"string"},"first_name":{"type":"string"},"invite_id":{"type":"string"},"invitee_id":{"type":"string"},"last_name":{"type":"string"},"updated_by":{"type":"string"},"updated_date":{"type":"integer"},"user_id":{"type":"string"}}}}}} ``` ## The dto.Invite object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Invite":{"type":"object","properties":{"created_on":{"type":"integer"},"expire_on":{"type":"integer"},"id":{"type":"string"},"invitees":{"type":"array","items":{"$ref":"#/components/schemas/dto.Invitee"}},"issuer":{"$ref":"#/components/schemas/dto.User"},"org_id":{"type":"string"},"updated_on":{"type":"integer"}}},"dto.Invitee":{"type":"object","properties":{"email":{"type":"string"},"id":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"url":{"type":"string"}}},"dto.User":{"type":"object","properties":{"created_by":{"type":"string"},"created_on":{"type":"integer"},"email":{"type":"string"},"first_name":{"type":"string"},"id":{"type":"string"},"invited":{"type":"boolean"},"is_active":{"type":"boolean"},"is_deleted":{"type":"boolean"},"last_name":{"type":"string"},"mfa_enabled":{"type":"boolean"},"org":{"$ref":"#/components/schemas/dto.Org"},"org_id":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"updated_by":{"type":"string"},"updated_on":{"type":"integer"}}},"dto.Org":{"type":"object","properties":{"created_by":{"type":"string"},"created_on":{"type":"integer"},"current_owner":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"is_deleted":{"type":"boolean"},"name":{"type":"string"},"tier":{"type":"string"},"updated_by":{"type":"string"},"updated_on":{"type":"integer"}}}}}} ``` ## The dto.Invitee object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Invitee":{"type":"object","properties":{"email":{"type":"string"},"id":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"url":{"type":"string"}}}}}} ``` ## The dto.Org object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Org":{"type":"object","properties":{"created_by":{"type":"string"},"created_on":{"type":"integer"},"current_owner":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"is_deleted":{"type":"boolean"},"name":{"type":"string"},"tier":{"type":"string"},"updated_by":{"type":"string"},"updated_on":{"type":"integer"}}}}}} ``` ## The dto.Owner object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Owner":{"type":"object","properties":{"first_name":{"type":"string"},"id":{"type":"string"},"last_name":{"type":"string"}}}}}} ``` ## The dto.Project object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Project":{"type":"object","properties":{"created_by":{"type":"string"},"created_on":{"type":"integer"},"description":{"type":"string"},"id":{"type":"string"},"is_default":{"type":"boolean"},"name":{"type":"string"},"updated_by":{"type":"string"},"updated_on":{"type":"integer"}}}}}} ``` ## The dto.PubKey object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.PubKey":{"type":"object","properties":{"algo":{"type":"string"},"data":{"type":"string"},"id":{"type":"string"},"version":{"type":"string"}}}}}} ``` ## The dto.RequestOrgUpgrade object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.RequestOrgUpgrade":{"type":"object","properties":{"tier":{"type":"string"}}}}}} ``` ## The dto.Role object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Role":{"type":"object","properties":{"created_by":{"type":"string"},"created_on":{"type":"integer"},"default":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"updated_by":{"type":"string"},"updated_on":{"type":"integer"}}}}}} ``` ## The dto.Team object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Team":{"type":"object","properties":{"created_by":{"type":"string"},"created_on":{"type":"integer"},"description":{"type":"string"},"id":{"type":"string"},"is_default":{"type":"boolean"},"name":{"type":"string"},"updated_by":{"type":"string"},"updated_on":{"type":"integer"},"users":{"type":"array","items":{"$ref":"#/components/schemas/dto.User"}}}},"dto.User":{"type":"object","properties":{"created_by":{"type":"string"},"created_on":{"type":"integer"},"email":{"type":"string"},"first_name":{"type":"string"},"id":{"type":"string"},"invited":{"type":"boolean"},"is_active":{"type":"boolean"},"is_deleted":{"type":"boolean"},"last_name":{"type":"string"},"mfa_enabled":{"type":"boolean"},"org":{"$ref":"#/components/schemas/dto.Org"},"org_id":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"updated_by":{"type":"string"},"updated_on":{"type":"integer"}}},"dto.Org":{"type":"object","properties":{"created_by":{"type":"string"},"created_on":{"type":"integer"},"current_owner":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"is_deleted":{"type":"boolean"},"name":{"type":"string"},"tier":{"type":"string"},"updated_by":{"type":"string"},"updated_on":{"type":"integer"}}}}}} ``` ## The dto.UpdateOrg object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.UpdateOrg":{"type":"object","properties":{"tier":{"type":"string"}}}}}} ``` ## The dto.UpdateUser object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.UpdateUser":{"type":"object","properties":{"activate":{"type":"boolean"},"first_name":{"type":"string"},"last_name":{"type":"string"}}}}}} ``` ## The dto.User object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.User":{"type":"object","properties":{"created_by":{"type":"string"},"created_on":{"type":"integer"},"email":{"type":"string"},"first_name":{"type":"string"},"id":{"type":"string"},"invited":{"type":"boolean"},"is_active":{"type":"boolean"},"is_deleted":{"type":"boolean"},"last_name":{"type":"string"},"mfa_enabled":{"type":"boolean"},"org":{"$ref":"#/components/schemas/dto.Org"},"org_id":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"updated_by":{"type":"string"},"updated_on":{"type":"integer"}}},"dto.Org":{"type":"object","properties":{"created_by":{"type":"string"},"created_on":{"type":"integer"},"current_owner":{"type":"string"},"id":{"type":"string"},"is_active":{"type":"boolean"},"is_deleted":{"type":"boolean"},"name":{"type":"string"},"tier":{"type":"string"},"updated_by":{"type":"string"},"updated_on":{"type":"integer"}}}}}} ``` ## The dto.ValidateAuth0InviteResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.ValidateAuth0InviteResponse":{"type":"object","properties":{"org_id":{"type":"string"}}}}}} ``` ## The dto.Account object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Account":{"type":"object","properties":{"active":{"type":"boolean"},"legal_entity_identifier":{"type":"string"},"number":{"type":"string"},"organization_id":{"type":"string"},"remittance":{"type":"boolean"},"scu_consumed_mtd":{"type":"number"},"scu_remaining_mtd":{"type":"number"},"start_date":{"type":"string"},"status":{"type":"string"},"subscription":{"$ref":"#/components/schemas/dto.Subscription"},"tier":{"type":"string"},"trial_credit":{"type":"number"}}},"dto.Subscription":{"type":"object","properties":{"payment_collection_method":{"type":"string"},"status":{"type":"string"}}}}}} ``` ## The dto.AccountContact object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.AccountContact":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/dto.ContactAddress"},"email":{"type":"string"},"first_name":{"type":"string"},"id":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"},"type":{"type":"string"}}},"dto.ContactAddress":{"type":"object","properties":{"address_line_1":{"type":"string"},"address_line_2":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}}}}}} ``` ## The dto.AddFreeTrialCredit object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.AddFreeTrialCredit":{"type":"object","properties":{"amount":{"type":"number"}}}}}} ``` ## The dto.Bill object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Bill":{"type":"object","properties":{"additional_compute_discount":{"type":"number"},"billing_mode":{"type":"string"},"currency":{"type":"string"},"currency_symbol":{"type":"string"},"data_transfer_cost":{"type":"number"},"discount":{"type":"number"},"discounted_compute_cost":{"type":"number"},"id":{"type":"string"},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/dto.BillingLineItem"}},"min_compute_cost":{"type":"number"},"org_id":{"type":"string"},"period":{"type":"string"},"remaining_credit":{"type":"number"},"support_cost":{"type":"number"},"support_type":{"type":"string"},"tier":{"type":"string"},"total":{"type":"number"},"total_compute_cost":{"type":"number"},"total_storage_cost":{"type":"number"},"undiscounted_compute_cost":{"type":"number"},"unused_compute_commit":{"type":"number"},"unused_compute_commit_ledger":{"type":"number"},"usage_days":{"type":"integer"}}},"dto.BillingLineItem":{"type":"object","properties":{"bill_id":{"type":"string"},"cost":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/dto.BillingLineItemCost"}}},"id":{"type":"string"},"service":{"$ref":"#/components/schemas/dto.BillingLineItemService"}}},"dto.BillingLineItemCost":{"type":"object","properties":{"active_nodes":{"type":"integer"},"instance":{"type":"string"},"name":{"type":"string"},"price_per_hour":{"type":"number"},"total_cost":{"type":"number"},"total_hours":{"type":"number"}}},"dto.BillingLineItemService":{"type":"object","properties":{"name":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"service_id":{"type":"string"},"topology":{"type":"string"}}}}}} ``` ## The dto.BillV2 object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.BillV2":{"type":"object","properties":{"additional_compute_discount":{"type":"number"},"billing_mode":{"type":"string"},"currency":{"type":"string"},"currency_symbol":{"type":"string"},"data_transfer_cost":{"type":"number"},"discount":{"type":"number"},"discounted_compute_cost":{"type":"number"},"id":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/dto.ResourceLineItemDTO"}},"min_compute_cost":{"type":"number"},"org_id":{"type":"string"},"other_cost":{"type":"number"},"period":{"type":"string"},"remaining_credit":{"type":"number"},"support_cost":{"type":"number"},"support_type":{"type":"string"},"tier":{"type":"string"},"total":{"type":"number"},"total_compute_cost":{"type":"number"},"total_storage_cost":{"type":"number"},"undiscounted_compute_cost":{"type":"number"},"unused_compute_commit":{"type":"number"},"usage_days":{"type":"integer"}}},"dto.ResourceLineItemDTO":{"type":"object","properties":{"id":{"type":"string"},"line_items":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/dto.BillingLineItemCostDTO"}}},"resource":{"$ref":"#/components/schemas/dto.ResourceLineDetailsDTO"},"total":{"type":"number"}}},"dto.BillingLineItemCostDTO":{"type":"object","properties":{"billable_usage":{"type":"number"},"dimensions":{"type":"object","additionalProperties":{"type":"string"}},"included_usage":{"type":"number"},"included_usage_amount":{"type":"number"},"included_usage_limit":{"type":"number"},"meter":{"type":"string"},"price_id":{"type":"string"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"total":{"type":"number"},"unit":{"type":"string"}}},"dto.ResourceLineDetailsDTO":{"type":"object","properties":{"dimensions":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"resource_id":{"type":"string"}}}}}} ``` ## The dto.BillingDetails object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.BillingDetails":{"type":"object","properties":{"country":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The dto.BillingLineItem object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.BillingLineItem":{"type":"object","properties":{"bill_id":{"type":"string"},"cost":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/dto.BillingLineItemCost"}}},"id":{"type":"string"},"service":{"$ref":"#/components/schemas/dto.BillingLineItemService"}}},"dto.BillingLineItemCost":{"type":"object","properties":{"active_nodes":{"type":"integer"},"instance":{"type":"string"},"name":{"type":"string"},"price_per_hour":{"type":"number"},"total_cost":{"type":"number"},"total_hours":{"type":"number"}}},"dto.BillingLineItemService":{"type":"object","properties":{"name":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"service_id":{"type":"string"},"topology":{"type":"string"}}}}}} ``` ## The dto.BillingLineItemCost object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.BillingLineItemCost":{"type":"object","properties":{"active_nodes":{"type":"integer"},"instance":{"type":"string"},"name":{"type":"string"},"price_per_hour":{"type":"number"},"total_cost":{"type":"number"},"total_hours":{"type":"number"}}}}}} ``` ## The dto.BillingLineItemCostDTO object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.BillingLineItemCostDTO":{"type":"object","properties":{"billable_usage":{"type":"number"},"dimensions":{"type":"object","additionalProperties":{"type":"string"}},"included_usage":{"type":"number"},"included_usage_amount":{"type":"number"},"included_usage_limit":{"type":"number"},"meter":{"type":"string"},"price_id":{"type":"string"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"total":{"type":"number"},"unit":{"type":"string"}}}}}} ``` ## The dto.BillingLineItemService object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.BillingLineItemService":{"type":"object","properties":{"name":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"service_id":{"type":"string"},"topology":{"type":"string"}}}}}} ``` ## The dto.Card object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Card":{"type":"object","properties":{"card_type":{"type":"string"},"cvc_validation":{"type":"boolean"},"expiration_month":{"type":"integer"},"expiration_year":{"type":"integer"},"masked_card_number":{"type":"string"}}}}}} ``` ## The dto.CommitLedger object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.CommitLedger":{"type":"object","properties":{"contract_entitlement_id":{"type":"string"},"created_at":{"type":"string"},"id":{"type":"string"},"invoice_amount":{"type":"number"},"min_compute_commit":{"type":"number"},"org_id":{"type":"string"},"period":{"type":"string"},"unused_compute_commit":{"type":"number"}}}}}} ``` ## The dto.ContactAddress object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.ContactAddress":{"type":"object","properties":{"address_line_1":{"type":"string"},"address_line_2":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}}}}}} ``` ## The dto.Contract object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Contract":{"type":"object","properties":{"billing_mode":{"type":"string"},"created_at":{"type":"string"},"created_by":{"type":"string"},"currency":{"type":"string"},"end_date":{"type":"string"},"entitlements":{"type":"array","items":{"$ref":"#/components/schemas/dto.Entitlement"}},"estimated_contract_commit":{"type":"number"},"estimated_contract_value":{"type":"number"},"execution_date":{"type":"string"},"id":{"type":"string"},"integration_id":{"type":"string"},"marketing_collaboration_discount":{"type":"boolean"},"org_id":{"type":"string"},"renewal_date":{"type":"string"},"renewal_id":{"type":"string"},"start_date":{"type":"string"},"state":{"type":"string"},"updated_at":{"type":"string"},"updated_by":{"type":"string"}}},"dto.Entitlement":{"type":"object","properties":{"contract_id":{"type":"string"},"created_at":{"type":"string"},"end_date":{"type":"string"},"entitlement_id":{"type":"string"},"id":{"type":"string"},"spec":{},"start_date":{"type":"string"}}}}}} ``` ## The dto.Country object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Country":{"type":"object","properties":{"active":{"type":"boolean"},"iso3166_2":{"type":"string"},"iso3166_3":{"type":"string"},"lei":{"type":"string"},"name":{"type":"string"},"vat":{"type":"boolean"}}}}}} ``` ## The dto.CreateContract object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.CreateContract":{"type":"object","properties":{"billing_mode":{"type":"string"},"compute_commit":{"type":"number"},"compute_credit":{"type":"number"},"created_by":{"type":"string"},"currency":{"type":"string"},"discount":{"type":"number"},"end_date":{"$ref":"#/components/schemas/dto.CustomDate"},"estimated_contract_value":{"type":"number"},"estimated_egress_value":{"type":"number"},"estimated_storage_value":{"type":"number"},"execution_date":{"$ref":"#/components/schemas/dto.CustomDate"},"integration_id":{"type":"string"},"marketing_collaboration_discount":{"type":"boolean"},"marketplace_monthly_commit":{"type":"number"},"org_id":{"type":"string"},"renewal_date":{"$ref":"#/components/schemas/dto.CustomDate"},"renewal_id":{"type":"string"},"start_date":{"$ref":"#/components/schemas/dto.CustomDate"},"support_amount":{"type":"number"},"support_type":{"type":"string"}}},"dto.CustomDate":{"type":"object","properties":{"time.Time":{"type":"string"}}}}}} ``` ## The dto.CreditLedger object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.CreditLedger":{"type":"object","properties":{"amount":{"type":"number"},"batch":{"type":"integer"},"contract_id":{"type":"string"},"created_at":{"type":"string"},"id":{"type":"string"},"org_id":{"type":"string"},"reason":{"type":"string"},"type":{"type":"string"}}}}}} ``` ## The dto.CustomDate object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.CustomDate":{"type":"object","properties":{"time.Time":{"type":"string"}}}}}} ``` ## The dto.Entitlement object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Entitlement":{"type":"object","properties":{"contract_id":{"type":"string"},"created_at":{"type":"string"},"end_date":{"type":"string"},"entitlement_id":{"type":"string"},"id":{"type":"string"},"spec":{},"start_date":{"type":"string"}}}}}} ``` ## The dto.IOPSUsage object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.IOPSUsage":{"type":"object","properties":{"cost":{"type":"number"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"unit":{"type":"string"}}}}}} ``` ## The dto.Invoice object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Invoice":{"type":"object","properties":{"invoice_amount":{"type":"number"},"invoice_date":{"type":"string"},"invoice_due_date":{"type":"string"},"invoice_id":{"type":"string"},"invoice_pdf_url":{"type":"string"},"org_id":{"type":"string"},"period":{"type":"string"}}}}}} ``` ## The dto.InvoiceWithDetails object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.InvoiceWithDetails":{"type":"object","properties":{"bill_date":{"type":"string"},"currency":{"type":"string"},"invoice_amount":{"type":"number"},"invoice_date":{"type":"string"},"invoice_due_date":{"type":"string"},"invoice_id":{"type":"string"},"invoice_pdf_url":{"type":"string"},"org_id":{"type":"string"},"period":{"type":"string"},"scu_consumed":{"type":"number"},"scu_remaining":{"type":"number"},"services":{"type":"array","items":{"$ref":"#/components/schemas/dto.ServiceUsage"}},"status":{"type":"string"},"symbol":{"type":"string"},"usage_end_date":{"type":"string"},"usage_start_date":{"type":"string"}}},"dto.ServiceUsage":{"type":"object","properties":{"cost":{"type":"number"},"node_cost":{"type":"number"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/dto.NodeUsage"}},"service":{"$ref":"#/components/schemas/dto.Service"},"storage":{"$ref":"#/components/schemas/dto.StorageUsage"}}},"dto.NodeUsage":{"type":"object","properties":{"active_nodes":{"type":"integer"},"cost":{"type":"number"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"size":{"type":"string"},"unit":{"type":"string"}}},"dto.Service":{"type":"object","properties":{"arch":{"type":"string"},"instance":{"type":"string"},"name":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"service_id":{"type":"string"},"tier":{"type":"string"},"topology":{"type":"string"}}},"dto.StorageUsage":{"type":"object","properties":{"cost":{"type":"number"},"iops":{"$ref":"#/components/schemas/dto.IOPSUsage"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"throughput":{"$ref":"#/components/schemas/dto.ThroughputUsage"},"total_cost":{"type":"number"},"type":{"type":"string"},"unit":{"type":"string"}}},"dto.IOPSUsage":{"type":"object","properties":{"cost":{"type":"number"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"unit":{"type":"string"}}},"dto.ThroughputUsage":{"type":"object","properties":{"cost":{"type":"number"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"unit":{"type":"string"}}}}}} ``` ## The dto.Meter object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Meter":{"type":"object","properties":{"class":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"},"meter_id":{"type":"string"},"name":{"type":"string"},"offering_id":{"type":"string"},"price_dimensions":{"type":"object","additionalProperties":{"type":"boolean"}},"unit":{"type":"string"}}}}}} ``` ## The dto.MeterPrice object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.MeterPrice":{"type":"object","properties":{"dimensions":{"type":"object","additionalProperties":{"type":"string"}},"end_range":{"type":"number"},"id":{"type":"string"},"meter":{"$ref":"#/components/schemas/dto.Meter"},"price":{"$ref":"#/components/schemas/dto.Price"},"start_range":{"type":"number"},"type":{"type":"string"}}},"dto.Meter":{"type":"object","properties":{"class":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"},"meter_id":{"type":"string"},"name":{"type":"string"},"offering_id":{"type":"string"},"price_dimensions":{"type":"object","additionalProperties":{"type":"boolean"}},"unit":{"type":"string"}}},"dto.Price":{"type":"object","properties":{"currency":{"type":"string"},"monthly_commit":{"type":"number"},"multiplier":{"type":"number"},"price_per_hour":{"type":"number"},"price_per_min":{"type":"number"},"price_per_month":{"type":"number"},"scale_fabric_price_per_hour":{"type":"number"},"scale_fabric_price_per_min":{"type":"number"},"scale_fabric_price_per_month":{"type":"number"}}}}}} ``` ## The dto.NodeUsage object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.NodeUsage":{"type":"object","properties":{"active_nodes":{"type":"integer"},"cost":{"type":"number"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"size":{"type":"string"},"unit":{"type":"string"}}}}}} ``` ## The dto.OfferingDTO object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.OfferingDTO":{"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"},"offering_id":{"type":"string"},"product_mapping":{"type":"string"}}}}}} ``` ## The dto.PaymentMethod object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.PaymentMethod":{"type":"object","properties":{"billing_details":{"$ref":"#/components/schemas/dto.BillingDetails"},"card":{"$ref":"#/components/schemas/dto.Card"},"default_payment_method":{"type":"boolean"},"payment_method_id":{"type":"string"},"type":{"type":"string"}}},"dto.BillingDetails":{"type":"object","properties":{"country":{"type":"string"},"name":{"type":"string"}}},"dto.Card":{"type":"object","properties":{"card_type":{"type":"string"},"cvc_validation":{"type":"boolean"},"expiration_month":{"type":"integer"},"expiration_year":{"type":"integer"},"masked_card_number":{"type":"string"}}}}}} ``` ## The dto.Price object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Price":{"type":"object","properties":{"currency":{"type":"string"},"monthly_commit":{"type":"number"},"multiplier":{"type":"number"},"price_per_hour":{"type":"number"},"price_per_min":{"type":"number"},"price_per_month":{"type":"number"},"scale_fabric_price_per_hour":{"type":"number"},"scale_fabric_price_per_min":{"type":"number"},"scale_fabric_price_per_month":{"type":"number"}}}}}} ``` ## The dto.RequestAccountTax object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.RequestAccountTax":{"type":"object","properties":{"country":{"type":"string"},"postal_code":{"type":"string"},"registration":{"type":"string"}}}}}} ``` ## The dto.ResourceLineDetailsDTO object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.ResourceLineDetailsDTO":{"type":"object","properties":{"dimensions":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"resource_id":{"type":"string"}}}}}} ``` ## The dto.ResourceLineItemDTO object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.ResourceLineItemDTO":{"type":"object","properties":{"id":{"type":"string"},"line_items":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/dto.BillingLineItemCostDTO"}}},"resource":{"$ref":"#/components/schemas/dto.ResourceLineDetailsDTO"},"total":{"type":"number"}}},"dto.BillingLineItemCostDTO":{"type":"object","properties":{"billable_usage":{"type":"number"},"dimensions":{"type":"object","additionalProperties":{"type":"string"}},"included_usage":{"type":"number"},"included_usage_amount":{"type":"number"},"included_usage_limit":{"type":"number"},"meter":{"type":"string"},"price_id":{"type":"string"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"total":{"type":"number"},"unit":{"type":"string"}}},"dto.ResourceLineDetailsDTO":{"type":"object","properties":{"dimensions":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"resource_id":{"type":"string"}}}}}} ``` ## The dto.Service object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Service":{"type":"object","properties":{"arch":{"type":"string"},"instance":{"type":"string"},"name":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"service_id":{"type":"string"},"tier":{"type":"string"},"topology":{"type":"string"}}}}}} ``` ## The dto.ServiceUsage object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.ServiceUsage":{"type":"object","properties":{"cost":{"type":"number"},"node_cost":{"type":"number"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/dto.NodeUsage"}},"service":{"$ref":"#/components/schemas/dto.Service"},"storage":{"$ref":"#/components/schemas/dto.StorageUsage"}}},"dto.NodeUsage":{"type":"object","properties":{"active_nodes":{"type":"integer"},"cost":{"type":"number"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"size":{"type":"string"},"unit":{"type":"string"}}},"dto.Service":{"type":"object","properties":{"arch":{"type":"string"},"instance":{"type":"string"},"name":{"type":"string"},"provider":{"type":"string"},"region":{"type":"string"},"service_id":{"type":"string"},"tier":{"type":"string"},"topology":{"type":"string"}}},"dto.StorageUsage":{"type":"object","properties":{"cost":{"type":"number"},"iops":{"$ref":"#/components/schemas/dto.IOPSUsage"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"throughput":{"$ref":"#/components/schemas/dto.ThroughputUsage"},"total_cost":{"type":"number"},"type":{"type":"string"},"unit":{"type":"string"}}},"dto.IOPSUsage":{"type":"object","properties":{"cost":{"type":"number"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"unit":{"type":"string"}}},"dto.ThroughputUsage":{"type":"object","properties":{"cost":{"type":"number"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"unit":{"type":"string"}}}}}} ``` ## The dto.SetupIntentResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.SetupIntentResponse":{"type":"object","properties":{"intent":{"type":"string"},"key":{"type":"string"},"secret":{"type":"string"}}}}}} ``` ## The dto.StateProvince object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.StateProvince":{"type":"object","properties":{"active":{"type":"boolean"},"country":{"type":"string"},"iso_short":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The dto.StorageUsage object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.StorageUsage":{"type":"object","properties":{"cost":{"type":"number"},"iops":{"$ref":"#/components/schemas/dto.IOPSUsage"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"throughput":{"$ref":"#/components/schemas/dto.ThroughputUsage"},"total_cost":{"type":"number"},"type":{"type":"string"},"unit":{"type":"string"}}},"dto.IOPSUsage":{"type":"object","properties":{"cost":{"type":"number"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"unit":{"type":"string"}}},"dto.ThroughputUsage":{"type":"object","properties":{"cost":{"type":"number"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"unit":{"type":"string"}}}}}} ``` ## The dto.Subscription object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.Subscription":{"type":"object","properties":{"payment_collection_method":{"type":"string"},"status":{"type":"string"}}}}}} ``` ## The dto.ThroughputUsage object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.ThroughputUsage":{"type":"object","properties":{"cost":{"type":"number"},"quantity":{"type":"number"},"rate":{"type":"number"},"rate_unit":{"type":"string"},"unit":{"type":"string"}}}}}} ``` ## The dto.UpdateAccount object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"dto.UpdateAccount":{"type":"object","properties":{"remittance":{"type":"boolean"}}}}}} ``` ## The errr.MetadataField object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"errr.MetadataField":{"type":"object","properties":{"key":{"type":"string"},"value":{}}}}}} ``` ## The errr.SkySQLError object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"errr.SkySQLError":{"type":"object","properties":{"code":{"description":"http status code to return","type":"integer"},"err":{"type":"string"},"exception":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/errr.MetadataField"}},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.MetadataField":{"type":"object","properties":{"key":{"type":"string"},"value":{}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}}} ``` ## The v1.Backup object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.Backup":{"description":"holds a related data for the given backup","type":"object","properties":{"binlog_file":{"description":"name of the binary log file","type":"string"},"binlog_gtid_position":{"description":"looks up the position in the current binlog, and returns a string representation of the corresponding GTID position","type":"string"},"binlog_position":{"description":"position inside the binary log file","type":"string"},"cloud_provider":{"description":"represents the cloud provider Enum=gcp;aws;onprem","type":"string","enum":["gcp","aws","onpred"]},"disk_size":{"description":"required disk size in order to restore this backup in human readable format","type":"string"},"disk_size_bytes":{"description":"disk size in order to restore this backup in bytes","type":"integer"},"end_time":{"description":"execution end time of the backup","type":"string"},"id":{"description":"unique id of the backup","type":"string"},"is_external_storage":{"description":"determines if the backup is stored in external storage","type":"boolean"},"method":{"description":"binary tool or implementation used to create a backup","type":"string"},"point_in_time":{"description":"timestamp represents date and time value in 'CCYY-MM-DD hh:mm:ss' format","type":"string"},"reference_full_backup":{"description":"reference to the full backup","type":"string"},"server_pod":{"description":"name of the database pod from which the backup is created","type":"string"},"service_id":{"description":"unique id of the database service","type":"string"},"service_name":{"description":"name of the database service","type":"string"},"start_time":{"description":"execution start time of the backup","type":"string"},"status":{"description":"status of the backup execution","type":"string"},"storage_bytes":{"description":"represents size of the backup in bytes","type":"integer"},"type":{"description":"supported types of the backups are:\n* full - Full backups create a complete backup of the database server in an remote bucket directory. The time the backup takes depends on the size of the databases you're backing up.\n* incremental - incremental backups update a previous backup with whatever changes to the data have occurred since the backup\n* binarylog - backups the binary log, which contains a record of all changes to the databases, both data and structure. It consists of a set of closed binary log files.\n* dump - a backup that reproduces table structure and data, without copying the actual data files.\n* snapshot - a backup that captures the state of the database persistent volume at a specific point in time.","type":"string"}}}}}} ``` ## The v1.BackupScheduleRequest object ````json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.BackupScheduleRequest":{"type":"object","required":["backup_type","schedule","service_id"],"properties":{"backup_type":{"description":"supported types of the backups are:\n* full - Full backups create a complete backup of the database server in an remote bucket directory. The time the backup takes depends on the size of the databases you're backing up.\n* incremental - incremental backups update a previous backup with whatever changes to the data have occurred since the backup\n* binarylog - backups the binary log, which contains a record of all changes to the databases, both data and structure. It consists of a set of closed binary log files.\n* dump - a backup that reproduces table structure and data, without copying the actual data files.\n* snapshot - a backup that captures the state of the database persistent volume at a specific point in time.","type":"string","enum":["full","incremental","binarylog","dump","snapshot"]},"external_storage":{"description":"external backup storage","$ref":"#/components/schemas/v1.ExternalBackupStorage"},"schedule":{"description":"Schedules supported:\n* once - one time execution\n* cron - Example for cron schedule '0 2 * * *' for more information about cron format: https://en.wikipedia.org/wiki/Cron","type":"string","enum":["once","0 2 * * *"]},"service_id":{"description":"unique id of the database service","type":"string"}}},"v1.ExternalBackupStorage":{"type":"object","required":["bucket"],"properties":{"bucket":{"description":"Bucket for external storage","$ref":"#/components/schemas/v1.ExternalBackupStorageBucket"}}},"v1.ExternalBackupStorageBucket":{"type":"object","required":["path"],"properties":{"credentials":{"description":"Credentials to access external storage bucket. base64 encoded\nExamples\n* Encode GCP Credentials with Base64\n\n ```\n echo '{\n \"type\": \"service_account\",\n \"project_id\": \"XXXXXXX\",\n \"private_key_id\": \"XXXXXXX\",\n \"private_key\": \"-----BEGIN PRIVATE KEY-----\\nXXXXXXX\\n-----END PRIVATE KEY-----\\n\",\n \"client_email\": \"XXXXXXXXXXXXXXXXXXXXXXXXXXXX.iam.gserviceaccount.com\",\n \"client_id\": \"XXXXXXX\",\n \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\",\n \"token_uri\": \"https://oauth2.googleapis.com/token\",\n \"auth_provider_x509_cert_url\": \"https://www.googleapis.com/oauth2/v1/certs\",\n \"client_x509_cert_url\": \"https://www.googleapis.com/robot/v1/metadata/x509/XXXXXXXXXXXXXX.iam.gserviceaccount.com\",\n \"universe_domain\": \"googleapis.com\"\n }' | base64\n```\n\n* Encode AWS Credentials with Base64\n\n``` echo '[default]\\naws_access_key_id = XXXXX\\naws_secret_access_key = XXXX\\nregion = XXX' | base64 ```","type":"array","items":{"type":"integer"}},"path":{"description":"Bucket path to external storage","type":"string"}}}}}} ```` ## The v1.BackupScheduleResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.BackupScheduleResponse":{"type":"object","properties":{"cloud_provider":{"description":"represents the cloud provider Enum=gcp;aws;onprem","type":"string","enum":["gcp","aws","onpred"]},"created_at":{"description":"CreatedAt represents the time when the schedule was created","type":"string"},"id":{"description":"id of the operation","type":"integer"},"labels":{"description":"Labels holds metadata about the schedule labels","type":"object","additionalProperties":{}},"message":{"description":"Message holds details about the backup","type":"string"},"schedule":{"description":"Schedules supported:\n* once - one time execution\n* cron - Example: '0 2 * * *' from more information about cron format: https://en.wikipedia.org/wiki/Cron","type":"string","enum":["once","cron"]},"scheduled_at":{"description":"ScheduledAt represents schedule time of the backup","type":"string"},"service_id":{"description":"service id of the database","type":"string"},"service_name":{"description":"name of the database service","type":"string"},"status":{"description":"status of the backup","type":"string"},"suspended":{"description":"Suspended determines if the backup schedule is suspended or not\nwhen a backup schedule is suspended no new backups will be created\ndefault value is false","type":"boolean"},"type":{"description":"Type of the backup","type":"string"},"updated_at":{"description":"UpdatedAt represents the time when the schedule was updated","type":"string"}}}}}} ``` ## The v1.ExternalBackupStorage object ````json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ExternalBackupStorage":{"type":"object","required":["bucket"],"properties":{"bucket":{"description":"Bucket for external storage","$ref":"#/components/schemas/v1.ExternalBackupStorageBucket"}}},"v1.ExternalBackupStorageBucket":{"type":"object","required":["path"],"properties":{"credentials":{"description":"Credentials to access external storage bucket. base64 encoded\nExamples\n* Encode GCP Credentials with Base64\n\n ```\n echo '{\n \"type\": \"service_account\",\n \"project_id\": \"XXXXXXX\",\n \"private_key_id\": \"XXXXXXX\",\n \"private_key\": \"-----BEGIN PRIVATE KEY-----\\nXXXXXXX\\n-----END PRIVATE KEY-----\\n\",\n \"client_email\": \"XXXXXXXXXXXXXXXXXXXXXXXXXXXX.iam.gserviceaccount.com\",\n \"client_id\": \"XXXXXXX\",\n \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\",\n \"token_uri\": \"https://oauth2.googleapis.com/token\",\n \"auth_provider_x509_cert_url\": \"https://www.googleapis.com/oauth2/v1/certs\",\n \"client_x509_cert_url\": \"https://www.googleapis.com/robot/v1/metadata/x509/XXXXXXXXXXXXXX.iam.gserviceaccount.com\",\n \"universe_domain\": \"googleapis.com\"\n }' | base64\n```\n\n* Encode AWS Credentials with Base64\n\n``` echo '[default]\\naws_access_key_id = XXXXX\\naws_secret_access_key = XXXX\\nregion = XXX' | base64 ```","type":"array","items":{"type":"integer"}},"path":{"description":"Bucket path to external storage","type":"string"}}}}}} ```` ## The v1.ExternalBackupStorageBucket object ````json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ExternalBackupStorageBucket":{"type":"object","required":["path"],"properties":{"credentials":{"description":"Credentials to access external storage bucket. base64 encoded\nExamples\n* Encode GCP Credentials with Base64\n\n ```\n echo '{\n \"type\": \"service_account\",\n \"project_id\": \"XXXXXXX\",\n \"private_key_id\": \"XXXXXXX\",\n \"private_key\": \"-----BEGIN PRIVATE KEY-----\\nXXXXXXX\\n-----END PRIVATE KEY-----\\n\",\n \"client_email\": \"XXXXXXXXXXXXXXXXXXXXXXXXXXXX.iam.gserviceaccount.com\",\n \"client_id\": \"XXXXXXX\",\n \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\",\n \"token_uri\": \"https://oauth2.googleapis.com/token\",\n \"auth_provider_x509_cert_url\": \"https://www.googleapis.com/oauth2/v1/certs\",\n \"client_x509_cert_url\": \"https://www.googleapis.com/robot/v1/metadata/x509/XXXXXXXXXXXXXX.iam.gserviceaccount.com\",\n \"universe_domain\": \"googleapis.com\"\n }' | base64\n```\n\n* Encode AWS Credentials with Base64\n\n``` echo '[default]\\naws_access_key_id = XXXXX\\naws_secret_access_key = XXXX\\nregion = XXX' | base64 ```","type":"array","items":{"type":"integer"}},"path":{"description":"Bucket path to external storage","type":"string"}}}}}} ```` ## The v1.ExternalSource object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.ExternalSource":{"type":"object","required":["bucket","method"],"properties":{"bucket":{"description":"Bucket source","type":"string"},"credentials":{"description":"Credentials to access external source. base64 encoded\nDon't provide credentials in case of managed buckets","type":"array","items":{"type":"integer"}},"encryption_key":{"description":"EncryptionKey represents encryption key for the bucket data","type":"string"},"method":{"description":"Method represents the different variations of the cloud backup utilities\nvalid types: mariabackup,mysqldump","type":"string"}}}}}} ``` ## The v1.LookupPointInTimeRestoreResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.LookupPointInTimeRestoreResponse":{"type":"object","properties":{"services":{"description":"Services represents the list of services that can provide backups for point in time restore.","type":"array","items":{"$ref":"#/components/schemas/v1.LookupPointInTimeRestoreService"}}}},"v1.LookupPointInTimeRestoreService":{"type":"object","properties":{"end_time":{"description":"EndTime represents the last time when point in time restore can be used","type":"string"},"service_id":{"description":"service id represents unique database id","type":"string"},"service_name":{"description":"name of the database service","type":"string"},"start_time":{"description":"StartTime represents the first time when point in time restore can be used","type":"string"}}}}}} ``` ## The v1.LookupPointInTimeRestoreService object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.LookupPointInTimeRestoreService":{"type":"object","properties":{"end_time":{"description":"EndTime represents the last time when point in time restore can be used","type":"string"},"service_id":{"description":"service id represents unique database id","type":"string"},"service_name":{"description":"name of the database service","type":"string"},"start_time":{"description":"StartTime represents the first time when point in time restore can be used","type":"string"}}}}}} ``` ## The v1.LookupRestoreRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.LookupRestoreRequest":{"type":"object","properties":{"backup_id":{"description":"BackupID unique backup id","type":"string"},"service_id":{"description":"ServiceID represents unique database id of the source service","type":"string"}}}}}} ``` ## The v1.LookupRestoreResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.LookupRestoreResponse":{"type":"object","properties":{"services":{"description":"Services represents the list of services that can be restored","type":"array","items":{"$ref":"#/components/schemas/v1.LookupService"}}}},"v1.LookupService":{"type":"object","properties":{"service_id":{"description":"service id represents unique database id","type":"string"},"service_name":{"description":"name of the database service","type":"string"}}}}}} ``` ## The v1.LookupService object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.LookupService":{"type":"object","properties":{"service_id":{"description":"service id represents unique database id","type":"string"},"service_name":{"description":"name of the database service","type":"string"}}}}}} ``` ## The v1.PagedBackupSchedulesResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.PagedBackupSchedulesResponse":{"type":"object","properties":{"pages_count":{"description":"PagesCount counter of all pages","type":"integer"},"schedules":{"description":"Backups Schedules results","type":"array","items":{"$ref":"#/components/schemas/v1.BackupScheduleResponse"}},"schedules_count":{"description":"SchedulesCount holds count of the backups schedules","type":"integer"}}},"v1.BackupScheduleResponse":{"type":"object","properties":{"cloud_provider":{"description":"represents the cloud provider Enum=gcp;aws;onprem","type":"string","enum":["gcp","aws","onpred"]},"created_at":{"description":"CreatedAt represents the time when the schedule was created","type":"string"},"id":{"description":"id of the operation","type":"integer"},"labels":{"description":"Labels holds metadata about the schedule labels","type":"object","additionalProperties":{}},"message":{"description":"Message holds details about the backup","type":"string"},"schedule":{"description":"Schedules supported:\n* once - one time execution\n* cron - Example: '0 2 * * *' from more information about cron format: https://en.wikipedia.org/wiki/Cron","type":"string","enum":["once","cron"]},"scheduled_at":{"description":"ScheduledAt represents schedule time of the backup","type":"string"},"service_id":{"description":"service id of the database","type":"string"},"service_name":{"description":"name of the database service","type":"string"},"status":{"description":"status of the backup","type":"string"},"suspended":{"description":"Suspended determines if the backup schedule is suspended or not\nwhen a backup schedule is suspended no new backups will be created\ndefault value is false","type":"boolean"},"type":{"description":"Type of the backup","type":"string"},"updated_at":{"description":"UpdatedAt represents the time when the schedule was updated","type":"string"}}}}}} ``` ## The v1.PagedBackupsResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.PagedBackupsResponse":{"type":"object","properties":{"backups":{"description":"Backups results","type":"array","items":{"$ref":"#/components/schemas/v1.Backup"}},"backups_count":{"description":"BackupsCount holds count of the backups","type":"integer"},"pages_count":{"description":"PagesCount counter of all pages","type":"integer"}}},"v1.Backup":{"description":"holds a related data for the given backup","type":"object","properties":{"binlog_file":{"description":"name of the binary log file","type":"string"},"binlog_gtid_position":{"description":"looks up the position in the current binlog, and returns a string representation of the corresponding GTID position","type":"string"},"binlog_position":{"description":"position inside the binary log file","type":"string"},"cloud_provider":{"description":"represents the cloud provider Enum=gcp;aws;onprem","type":"string","enum":["gcp","aws","onpred"]},"disk_size":{"description":"required disk size in order to restore this backup in human readable format","type":"string"},"disk_size_bytes":{"description":"disk size in order to restore this backup in bytes","type":"integer"},"end_time":{"description":"execution end time of the backup","type":"string"},"id":{"description":"unique id of the backup","type":"string"},"is_external_storage":{"description":"determines if the backup is stored in external storage","type":"boolean"},"method":{"description":"binary tool or implementation used to create a backup","type":"string"},"point_in_time":{"description":"timestamp represents date and time value in 'CCYY-MM-DD hh:mm:ss' format","type":"string"},"reference_full_backup":{"description":"reference to the full backup","type":"string"},"server_pod":{"description":"name of the database pod from which the backup is created","type":"string"},"service_id":{"description":"unique id of the database service","type":"string"},"service_name":{"description":"name of the database service","type":"string"},"start_time":{"description":"execution start time of the backup","type":"string"},"status":{"description":"status of the backup execution","type":"string"},"storage_bytes":{"description":"represents size of the backup in bytes","type":"integer"},"type":{"description":"supported types of the backups are:\n* full - Full backups create a complete backup of the database server in an remote bucket directory. The time the backup takes depends on the size of the databases you're backing up.\n* incremental - incremental backups update a previous backup with whatever changes to the data have occurred since the backup\n* binarylog - backups the binary log, which contains a record of all changes to the databases, both data and structure. It consists of a set of closed binary log files.\n* dump - a backup that reproduces table structure and data, without copying the actual data files.\n* snapshot - a backup that captures the state of the database persistent volume at a specific point in time.","type":"string"}}}}}} ``` ## The v1.PagedRestoresResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.PagedRestoresResponse":{"type":"object","properties":{"pages_count":{"description":"PagesCount counter of all pages","type":"integer"},"restores":{"description":"Restores results","type":"array","items":{"$ref":"#/components/schemas/v1.RestoreResponse"}},"restores_count":{"description":"RestoresCount holds count of the restores","type":"integer"}}},"v1.RestoreResponse":{"type":"object","properties":{"backup_id":{"description":"unique backup id","type":"string"},"bucket":{"description":"bucket where the backup is located","type":"string"},"created_at":{"description":"CreatedAt represents the time when the restore operation was triggered","type":"string"},"id":{"description":"id of the restore operation","type":"integer"},"message":{"description":"message","type":"string"},"service_id":{"description":"service id represents unique database id","type":"string"},"service_name":{"description":"name of the database service","type":"string"},"status":{"description":"status of the restore operation","type":"string"},"type":{"description":"type of the restore operation","type":"string"}}}}}} ``` ## The v1.RestoreRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.RestoreRequest":{"type":"object","required":["id","service_id"],"properties":{"external_source":{"description":"External Source is the external storage where the backup is kept","$ref":"#/components/schemas/v1.ExternalSource"},"id":{"description":"key represents unique backup id","type":"string"},"point_in_time":{"description":"timestamp represents date and time value in 'CCYY-MM-DD hh:mm:ss' format","type":"string"},"service_id":{"description":"service id represents unique database id","type":"string"}}},"v1.ExternalSource":{"type":"object","required":["bucket","method"],"properties":{"bucket":{"description":"Bucket source","type":"string"},"credentials":{"description":"Credentials to access external source. base64 encoded\nDon't provide credentials in case of managed buckets","type":"array","items":{"type":"integer"}},"encryption_key":{"description":"EncryptionKey represents encryption key for the bucket data","type":"string"},"method":{"description":"Method represents the different variations of the cloud backup utilities\nvalid types: mariabackup,mysqldump","type":"string"}}}}}} ``` ## The v1.RestoreResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.RestoreResponse":{"type":"object","properties":{"backup_id":{"description":"unique backup id","type":"string"},"bucket":{"description":"bucket where the backup is located","type":"string"},"created_at":{"description":"CreatedAt represents the time when the restore operation was triggered","type":"string"},"id":{"description":"id of the restore operation","type":"integer"},"message":{"description":"message","type":"string"},"service_id":{"description":"service id represents unique database id","type":"string"},"service_name":{"description":"name of the database service","type":"string"},"status":{"description":"status of the restore operation","type":"string"},"type":{"description":"type of the restore operation","type":"string"}}}}}} ``` ## The v1.UpdateBackupScheduleRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"v1.UpdateBackupScheduleRequest":{"type":"object","properties":{"backup_type":{"description":"supported types of the backups are:\n* full - Full backups create a complete backup of the database server in an remote bucket directory. The time the backup takes depends on the size of the databases you're backing up.\n* incremental - incremental backups update a previous backup with whatever changes to the data have occurred since the backup\n* binarylog - backups the binary log, which contains a record of all changes to the databases, both data and structure. It consists of a set of closed binary log files.\n* dump - a backup that reproduces table structure and data, without copying the actual data files.\n* snapshot - a backup that captures the state of the database persistent volume at a specific point in time.","type":"string","enum":["full","incremental","binarylog","dump","snapshot"]},"schedule":{"description":"Schedules supported:\n* once - one time execution\n* cron - Example for cron schedule '0 2 * * *' for more information about cron format: https://en.wikipedia.org/wiki/Cron","type":"string","enum":["once","cron"]},"suspended":{"description":"determines if the backup schedule is suspended or not\nwhen a backup schedule is suspended no new backups will be created\ndefault value is false","type":"boolean"}}}}}} ``` ## The web.ErrorDetails object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"web.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The web.ErrorResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"web.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/web.ErrorDetails"}},"exception":{"type":"string"},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"web.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The LogQuery object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"LogQuery":{"properties":{"fromDate":{"description":"The start date to filter logs","format":"date-time","type":"string"},"limit":{"description":"The maximum number of logs to return","type":"integer"},"logType":{"description":"The log types to filter logs","items":{"type":"string"},"type":"array"},"offset":{"description":"The number of logs to skip before starting to collect the result set","type":"integer"},"orderByDirection":{"description":"The direction to order the logs (asc or desc)","type":"string"},"orderByField":{"description":"The field to order the logs by","type":"string"},"serverContext":{"description":"The server contexts to filter logs","items":{"type":"string"},"type":"array"},"toDate":{"description":"The end date to filter logs","format":"date-time","type":"string"}},"type":"object"}}}} ``` ## The PutRetentionPolicyRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"PutRetentionPolicyRequest":{"properties":{"bucket_name":{"description":"The name of the bucket","type":"string"},"provider":{"description":"The provider of the bucket","type":"string"},"retention_policy_days":{"description":"The number of days for the retention policy","type":"integer"}},"type":"object"}}}} ``` ## The AgentCreateRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"AgentCreateRequest":{"description":"Request for creating a new agent.","properties":{"context_id":{"format":"uuid","title":"Context Id","type":"string"},"description":{"title":"Description"},"name":{"title":"Name","type":"string"}},"required":["context_id","name","description"],"title":"AgentCreateRequest","type":"object"}}}} ``` ## The AgentExport-Input object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"AgentExport-Input":{"description":"Response for exporting an agent.","properties":{"context":{"$ref":"#/components/schemas/ContextExport-Input"},"description":{"title":"Description"},"name":{"title":"Name","type":"string"}},"required":["name","description","context"],"title":"AgentExport","type":"object"},"ContextExport-Input":{"description":"Response for exporting a context.","properties":{"description":{"title":"Description"},"name":{"title":"Name","type":"string"},"tables":{"items":{"$ref":"#/components/schemas/TableExport-Input"},"title":"Tables","type":"array"}},"required":["name","description","tables"],"title":"ContextExport","type":"object"},"TableExport-Input":{"description":"Response for exporting a table.","properties":{"columns":{"items":{"$ref":"#/components/schemas/ColumnExport"},"title":"Columns","type":"array"},"description":{"title":"Description"},"name":{"title":"Name","type":"string"}},"required":["name","description","columns"],"title":"TableExport","type":"object"},"ColumnExport":{"description":"Response for exporting a column.","properties":{"data_role":{},"description":{"title":"Description"},"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"}},"required":["name","type","description","data_role"],"title":"ColumnExport","type":"object"}}}} ``` ## The AgentExport-Output object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"AgentExport-Output":{"description":"Response for exporting an agent.","properties":{"context":{"$ref":"#/components/schemas/ContextExport-Output"},"description":{"title":"Description"},"name":{"title":"Name","type":"string"}},"required":["name","description","context"],"title":"AgentExport","type":"object"},"ContextExport-Output":{"description":"Response for exporting a context.","properties":{"description":{"title":"Description"},"name":{"title":"Name","type":"string"},"tables":{"items":{"$ref":"#/components/schemas/TableExport-Output"},"title":"Tables","type":"array"}},"required":["name","description","tables"],"title":"ContextExport","type":"object"},"TableExport-Output":{"description":"Response for exporting a table.","properties":{"columns":{"items":{"$ref":"#/components/schemas/ColumnExport"},"title":"Columns","type":"array"},"description":{"title":"Description"},"name":{"title":"Name","type":"string"}},"required":["name","description","columns"],"title":"TableExport","type":"object"},"ColumnExport":{"description":"Response for exporting a column.","properties":{"data_role":{},"description":{"title":"Description"},"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"}},"required":["name","type","description","data_role"],"title":"ColumnExport","type":"object"}}}} ``` ## The AgentImportRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"AgentImportRequest":{"description":"Request for importing an agent.","properties":{"data":{"$ref":"#/components/schemas/AgentExport-Input"},"datasource_id":{"format":"uuid","title":"Datasource Id","type":"string"}},"required":["datasource_id","data"],"title":"AgentImportRequest","type":"object"},"AgentExport-Input":{"description":"Response for exporting an agent.","properties":{"context":{"$ref":"#/components/schemas/ContextExport-Input"},"description":{"title":"Description"},"name":{"title":"Name","type":"string"}},"required":["name","description","context"],"title":"AgentExport","type":"object"},"ContextExport-Input":{"description":"Response for exporting a context.","properties":{"description":{"title":"Description"},"name":{"title":"Name","type":"string"},"tables":{"items":{"$ref":"#/components/schemas/TableExport-Input"},"title":"Tables","type":"array"}},"required":["name","description","tables"],"title":"ContextExport","type":"object"},"TableExport-Input":{"description":"Response for exporting a table.","properties":{"columns":{"items":{"$ref":"#/components/schemas/ColumnExport"},"title":"Columns","type":"array"},"description":{"title":"Description"},"name":{"title":"Name","type":"string"}},"required":["name","description","columns"],"title":"TableExport","type":"object"},"ColumnExport":{"description":"Response for exporting a column.","properties":{"data_role":{},"description":{"title":"Description"},"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"}},"required":["name","type","description","data_role"],"title":"ColumnExport","type":"object"}}}} ``` ## The AgentIndexState object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"AgentIndexState":{"description":"Agent Index State Enum","enum":["INSYNC","OUTOFSYNC"],"title":"AgentIndexState","type":"string"}}}} ``` ## The AgentPublic object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"AgentPublic":{"description":"Response for an agent.","properties":{"context_id":{"title":"Context Id"},"created_on":{"format":"date-time","title":"Created On","type":"string"},"datasource_id":{"title":"Datasource Id"},"description":{"title":"Description"},"id":{"format":"uuid","title":"Id","type":"string"},"index_status":{"$ref":"#/components/schemas/AgentIndexState"},"name":{"title":"Name","type":"string"},"status":{"$ref":"#/components/schemas/AgentStatus"},"type":{"$ref":"#/components/schemas/AgentType"}},"required":["id","name","description","type","status","context_id","datasource_id","created_on","index_status"],"title":"AgentPublic","type":"object"},"AgentIndexState":{"description":"Agent Index State Enum","enum":["INSYNC","OUTOFSYNC"],"title":"AgentIndexState","type":"string"},"AgentStatus":{"description":"Agent Status Enum","enum":["DEVELOPMENT","DEPLOYED","RETIRED"],"title":"AgentStatus","type":"string"},"AgentType":{"description":"Agent Type Enum","enum":["SYSTEM","USER"],"title":"AgentType","type":"string"}}}} ``` ## The AgentStatus object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"AgentStatus":{"description":"Agent Status Enum","enum":["DEVELOPMENT","DEPLOYED","RETIRED"],"title":"AgentStatus","type":"string"}}}} ``` ## The AgentType object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"AgentType":{"description":"Agent Type Enum","enum":["SYSTEM","USER"],"title":"AgentType","type":"string"}}}} ``` ## The AgentUpdateRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"AgentUpdateRequest":{"description":"Request for updating a agent.","properties":{"context_id":{"title":"Context Id"},"description":{"title":"Description"},"name":{"title":"Name"},"status":{}},"title":"AgentUpdateRequest","type":"object"}}}} ``` ## The Chat object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"Chat":{"description":"Response for the app chat API.","properties":{"prompt":{"title":"Prompt","type":"string"},"response":{"$ref":"#/components/schemas/LlamaResponse"}},"required":["prompt","response"],"title":"Chat","type":"object"},"LlamaResponse":{"description":"Response for the app chat API.","properties":{"col_keys":{"items":{"type":"string"},"title":"Col Keys","type":"array"},"content":{"title":"Content"},"error_text":{"title":"Error Text","type":"string"},"sql_text":{"title":"Sql Text","type":"string"}},"required":["content","sql_text","error_text","col_keys"],"title":"LlamaResponse","type":"object"}}}} ``` ## The ChatFeedbackType object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"ChatFeedbackType":{"description":"Chat Feedback Type Enum","enum":["LIKE","DISLIKE"],"title":"ChatFeedbackType","type":"string"}}}} ``` ## The ChatRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"ChatRequest":{"description":"Request for the app chat API.","properties":{"agent_id":{"format":"uuid","title":"Agent Id","type":"string"},"config":{"default":{},"title":"Config","type":"object"},"prompt":{"title":"Prompt","type":"string"}},"required":["prompt","agent_id"],"title":"ChatRequest","type":"object"}}}} ``` ## The ColumnDataRole object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"ColumnDataRole":{"const":"CATEGORICAL","description":"Column Data Role Enum","enum":["CATEGORICAL"],"title":"ColumnDataRole","type":"string"}}}} ``` ## The ColumnExport object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"ColumnExport":{"description":"Response for exporting a column.","properties":{"data_role":{},"description":{"title":"Description"},"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"}},"required":["name","type","description","data_role"],"title":"ColumnExport","type":"object"}}}} ``` ## The ColumnPublic object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"ColumnPublic":{"description":"API Response for a column.","properties":{"data_role":{},"description":{"title":"Description"},"id":{"title":"Id"},"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"}},"required":["id","name","type","description","data_role"],"title":"ColumnPublic","type":"object"}}}} ``` ## The ContextExport-Input object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"ContextExport-Input":{"description":"Response for exporting a context.","properties":{"description":{"title":"Description"},"name":{"title":"Name","type":"string"},"tables":{"items":{"$ref":"#/components/schemas/TableExport-Input"},"title":"Tables","type":"array"}},"required":["name","description","tables"],"title":"ContextExport","type":"object"},"TableExport-Input":{"description":"Response for exporting a table.","properties":{"columns":{"items":{"$ref":"#/components/schemas/ColumnExport"},"title":"Columns","type":"array"},"description":{"title":"Description"},"name":{"title":"Name","type":"string"}},"required":["name","description","columns"],"title":"TableExport","type":"object"},"ColumnExport":{"description":"Response for exporting a column.","properties":{"data_role":{},"description":{"title":"Description"},"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"}},"required":["name","type","description","data_role"],"title":"ColumnExport","type":"object"}}}} ``` ## The ContextExport-Output object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"ContextExport-Output":{"description":"Response for exporting a context.","properties":{"description":{"title":"Description"},"name":{"title":"Name","type":"string"},"tables":{"items":{"$ref":"#/components/schemas/TableExport-Output"},"title":"Tables","type":"array"}},"required":["name","description","tables"],"title":"ContextExport","type":"object"},"TableExport-Output":{"description":"Response for exporting a table.","properties":{"columns":{"items":{"$ref":"#/components/schemas/ColumnExport"},"title":"Columns","type":"array"},"description":{"title":"Description"},"name":{"title":"Name","type":"string"}},"required":["name","description","columns"],"title":"TableExport","type":"object"},"ColumnExport":{"description":"Response for exporting a column.","properties":{"data_role":{},"description":{"title":"Description"},"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"}},"required":["name","type","description","data_role"],"title":"ColumnExport","type":"object"}}}} ``` ## The ContextPublic object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"ContextPublic":{"description":"API Response for a context.","properties":{"created_on":{"format":"date-time","title":"Created On","type":"string"},"datasource_id":{"format":"uuid","title":"Datasource Id","type":"string"},"description":{"title":"Description"},"id":{"format":"uuid","title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"tables":{"items":{"$ref":"#/components/schemas/TablePublic"},"title":"Tables","type":"array"}},"required":["id","name","description","datasource_id","created_on","tables"],"title":"ContextPublic","type":"object"},"TablePublic":{"description":"API Response for a table.","properties":{"available_columns":{"items":{"$ref":"#/components/schemas/ColumnPublic"},"title":"Available Columns","type":"array"},"columns":{"items":{"$ref":"#/components/schemas/ColumnPublic"},"title":"Columns","type":"array"},"context_id":{"format":"uuid","title":"Context Id","type":"string"},"created_on":{"format":"date-time","title":"Created On","type":"string"},"description":{"title":"Description"},"id":{"format":"uuid","title":"Id","type":"string"},"name":{"title":"Name","type":"string"}},"required":["id","name","description","context_id","created_on","columns","available_columns"],"title":"TablePublic","type":"object"},"ColumnPublic":{"description":"API Response for a column.","properties":{"data_role":{},"description":{"title":"Description"},"id":{"title":"Id"},"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"}},"required":["id","name","type","description","data_role"],"title":"ColumnPublic","type":"object"}}}} ``` ## The DataSourceCreateRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"DataSourceCreateRequest":{"description":"Request for creating a new data source connection","properties":{"host":{"title":"Host","type":"string"},"name":{"title":"Name","type":"string"},"password":{"title":"Password","type":"string"},"port":{"title":"Port","type":"integer"},"username":{"title":"Username","type":"string"}},"required":["name","host","username","port","password"],"title":"DataSourceCreateRequest","type":"object"}}}} ``` ## The DataSourceListItem object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"DataSourceListItem":{"description":"Response for a data source connection list","properties":{"host":{"title":"Host","type":"string"},"created_on":{"format":"date-time","title":"Created On","type":"string"},"id":{"format":"uuid","title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"port":{"title":"Port","type":"integer"},"type":{"$ref":"#/components/schemas/DataSourceType"},"username":{"title":"Username","type":"string"}},"required":["id","name","host","username","port","type","created_on"],"title":"DataSourceListItem","type":"object"},"DataSourceType":{"description":"Data Source Type Enum","enum":["SYSTEM","USER"],"title":"DataSourceType","type":"string"}}}} ``` ## The DataSourcePublic object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"DataSourcePublic":{"description":"Response for a data source connection","properties":{"host":{"title":"Host","type":"string"},"created_on":{"format":"date-time","title":"Created On","type":"string"},"id":{"format":"uuid","title":"Id","type":"string"},"name":{"title":"Name","type":"string"},"port":{"title":"Port","type":"integer"},"schemas":{"items":{"$ref":"#/components/schemas/Schema"},"title":"Schemas","type":"array"},"type":{"$ref":"#/components/schemas/DataSourceType"},"username":{"title":"Username","type":"string"}},"required":["id","name","host","username","port","type","created_on","schemas"],"title":"DataSourcePublic","type":"object"},"Schema":{"description":"Schema model.","properties":{"name":{"title":"Name","type":"string"},"tables":{"items":{"type":"string"},"title":"Tables","type":"array"}},"required":["name","tables"],"title":"Schema","type":"object"},"DataSourceType":{"description":"Data Source Type Enum","enum":["SYSTEM","USER"],"title":"DataSourceType","type":"string"}}}} ``` ## The DataSourceType object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"DataSourceType":{"description":"Data Source Type Enum","enum":["SYSTEM","USER"],"title":"DataSourceType","type":"string"}}}} ``` ## The DataSourceUpdateRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"DataSourceUpdateRequest":{"description":"Request for updating a data source connection","properties":{"name":{"title":"Name"},"password":{"title":"Password"},"username":{"title":"Username"}},"title":"DataSourceUpdateRequest","type":"object"}}}} ``` ## The HTTPValidationError object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"},"ValidationError":{"properties":{"loc":{"items":{},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}} ``` ## The LlamaResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"LlamaResponse":{"description":"Response for the app chat API.","properties":{"col_keys":{"items":{"type":"string"},"title":"Col Keys","type":"array"},"content":{"title":"Content"},"error_text":{"title":"Error Text","type":"string"},"sql_text":{"title":"Sql Text","type":"string"}},"required":["content","sql_text","error_text","col_keys"],"title":"LlamaResponse","type":"object"}}}} ``` ## The QuotaItem object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"QuotaItem":{"properties":{"description":{"title":"Description","type":"string"},"name":{"title":"Name","type":"string"},"unit":{"title":"Unit","type":"string"},"usage":{"title":"Usage","type":"integer"},"value":{"title":"Value","type":"integer"}},"required":["name","description","unit","value","usage"],"title":"QuotaItem","type":"object"}}}} ``` ## The Schema object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"Schema":{"description":"Schema model.","properties":{"name":{"title":"Name","type":"string"},"tables":{"items":{"type":"string"},"title":"Tables","type":"array"}},"required":["name","tables"],"title":"Schema","type":"object"}}}} ``` ## The SessionChatRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"SessionChatRequest":{"description":"Request for chatting with a session","properties":{"prompt":{"title":"Prompt","type":"string"}},"required":["prompt"],"title":"SessionChatRequest","type":"object"}}}} ``` ## The SessionCreateRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"SessionCreateRequest":{"description":"Request for creating a new session","properties":{"agent_id":{"format":"uuid","title":"Agent Id","type":"string"},"chat":{},"config":{"additionalProperties":{"type":"string"},"default":{},"title":"Config","type":"object"}},"required":["agent_id"],"title":"SessionCreateRequest","type":"object"}}}} ``` ## The SessionEntryPatchRequest object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"SessionEntryPatchRequest":{"description":"Request for patching a session entry","properties":{"chat":{},"feedback":{}},"title":"SessionEntryPatchRequest","type":"object"}}}} ``` ## The SessionEntryPublic object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"SessionEntryPublic":{"description":"Public session entry model","properties":{"chat":{"$ref":"#/components/schemas/Chat"},"confidence":{"title":"Confidence"},"created_on":{"format":"date-time","title":"Created On","type":"string"},"feedback":{},"id":{"format":"uuid","title":"Id","type":"string"}},"required":["id","confidence","created_on","chat","feedback"],"title":"SessionEntryPublic","type":"object"},"Chat":{"description":"Response for the app chat API.","properties":{"prompt":{"title":"Prompt","type":"string"},"response":{"$ref":"#/components/schemas/LlamaResponse"}},"required":["prompt","response"],"title":"Chat","type":"object"},"LlamaResponse":{"description":"Response for the app chat API.","properties":{"col_keys":{"items":{"type":"string"},"title":"Col Keys","type":"array"},"content":{"title":"Content"},"error_text":{"title":"Error Text","type":"string"},"sql_text":{"title":"Sql Text","type":"string"}},"required":["content","sql_text","error_text","col_keys"],"title":"LlamaResponse","type":"object"}}}} ``` ## The SessionListResponse object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"SessionListResponse":{"description":"Session list response model","properties":{"agent_config":{"title":"Agent Config","type":"object"},"agent_id":{"title":"Agent Id"},"created_on":{"format":"date-time","title":"Created On","type":"string"},"id":{"format":"uuid","title":"Id","type":"string"},"summary":{"title":"Summary"}},"required":["id","summary","agent_id","agent_config","created_on"],"title":"SessionListResponse","type":"object"}}}} ``` ## The SessionPublic object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"SessionPublic":{"description":"Public session model","properties":{"agent_config":{"title":"Agent Config","type":"object"},"agent_id":{"title":"Agent Id"},"created_on":{"format":"date-time","title":"Created On","type":"string"},"entries":{"items":{"$ref":"#/components/schemas/SessionEntryPublic"},"title":"Entries","type":"array"},"id":{"format":"uuid","title":"Id","type":"string"},"summary":{"title":"Summary"}},"required":["id","summary","agent_id","agent_config","created_on","entries"],"title":"SessionPublic","type":"object"},"SessionEntryPublic":{"description":"Public session entry model","properties":{"chat":{"$ref":"#/components/schemas/Chat"},"confidence":{"title":"Confidence"},"created_on":{"format":"date-time","title":"Created On","type":"string"},"feedback":{},"id":{"format":"uuid","title":"Id","type":"string"}},"required":["id","confidence","created_on","chat","feedback"],"title":"SessionEntryPublic","type":"object"},"Chat":{"description":"Response for the app chat API.","properties":{"prompt":{"title":"Prompt","type":"string"},"response":{"$ref":"#/components/schemas/LlamaResponse"}},"required":["prompt","response"],"title":"Chat","type":"object"},"LlamaResponse":{"description":"Response for the app chat API.","properties":{"col_keys":{"items":{"type":"string"},"title":"Col Keys","type":"array"},"content":{"title":"Content"},"error_text":{"title":"Error Text","type":"string"},"sql_text":{"title":"Sql Text","type":"string"}},"required":["content","sql_text","error_text","col_keys"],"title":"LlamaResponse","type":"object"}}}} ``` ## The TableExport-Input object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"TableExport-Input":{"description":"Response for exporting a table.","properties":{"columns":{"items":{"$ref":"#/components/schemas/ColumnExport"},"title":"Columns","type":"array"},"description":{"title":"Description"},"name":{"title":"Name","type":"string"}},"required":["name","description","columns"],"title":"TableExport","type":"object"},"ColumnExport":{"description":"Response for exporting a column.","properties":{"data_role":{},"description":{"title":"Description"},"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"}},"required":["name","type","description","data_role"],"title":"ColumnExport","type":"object"}}}} ``` ## The TableExport-Output object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"TableExport-Output":{"description":"Response for exporting a table.","properties":{"columns":{"items":{"$ref":"#/components/schemas/ColumnExport"},"title":"Columns","type":"array"},"description":{"title":"Description"},"name":{"title":"Name","type":"string"}},"required":["name","description","columns"],"title":"TableExport","type":"object"},"ColumnExport":{"description":"Response for exporting a column.","properties":{"data_role":{},"description":{"title":"Description"},"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"}},"required":["name","type","description","data_role"],"title":"ColumnExport","type":"object"}}}} ``` ## The TablePublic object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"TablePublic":{"description":"API Response for a table.","properties":{"available_columns":{"items":{"$ref":"#/components/schemas/ColumnPublic"},"title":"Available Columns","type":"array"},"columns":{"items":{"$ref":"#/components/schemas/ColumnPublic"},"title":"Columns","type":"array"},"context_id":{"format":"uuid","title":"Context Id","type":"string"},"created_on":{"format":"date-time","title":"Created On","type":"string"},"description":{"title":"Description"},"id":{"format":"uuid","title":"Id","type":"string"},"name":{"title":"Name","type":"string"}},"required":["id","name","description","context_id","created_on","columns","available_columns"],"title":"TablePublic","type":"object"},"ColumnPublic":{"description":"API Response for a column.","properties":{"data_role":{},"description":{"title":"Description"},"id":{"title":"Id"},"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"}},"required":["id","name","type","description","data_role"],"title":"ColumnPublic","type":"object"}}}} ``` ## The UsageEvent object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"UsageEvent":{"description":"Usage Event Enum","enum":["CHAT","AGENT_BUILDER"],"title":"UsageEvent","type":"string"}}}} ``` ## The ValidationError object ```json {"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"components":{"schemas":{"ValidationError":{"properties":{"loc":{"items":{},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"}}}} ```