# Offering

## Read Architectures

> Retrieve a list of available hardware architectures for the specified cloud provider and specified topology.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.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"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/architectures":{"get":{"description":"Retrieve a list of available hardware architectures for the specified cloud provider and specified topology.","tags":["Offering"],"summary":"Read Architectures","deprecated":true,"parameters":[{"schema":{"type":"string","enum":["aws","gcp","azure"]},"description":"The cloud provider whose hardware architectures will be retrieved.","name":"provider","in":"query"},{"schema":{"type":"string","enum":["sa","csdw","es-replica","es-single","xpand"]},"description":"The topology whose hardware architectures will be retrieved.","name":"topology","in":"query"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Available hardware architectures","type":"array","items":{"$ref":"#/components/schemas/v1.Architecture"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Architectures

> Retrieve a list of available hardware architectures for the specified cloud provider and specified topology.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.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"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/cpu-architectures":{"get":{"description":"Retrieve a list of available hardware architectures for the specified cloud provider and specified topology.","tags":["Offering"],"summary":"Read Architectures","parameters":[{"schema":{"type":"string","enum":["aws","gcp","azure"]},"description":"Provider name","name":"provider","in":"query"},{"schema":{"type":"string","enum":["sa","csdw","es-replica","es-single","xpand"]},"description":"Topology name","name":"topology","in":"query"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Available hardware architectures","type":"array","items":{"$ref":"#/components/schemas/v1.Architecture"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Entitlements

> Retrieve a list of entitlements for the current organization.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.Entitlement":{"type":"object","properties":{"name":{"type":"string"},"topologies":{"type":"array","items":{"type":"string"}}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/entitlements":{"get":{"description":"Retrieve a list of entitlements for the current organization.","tags":["Offering"],"summary":"Read Entitlements","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/v1.Entitlement"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Maintenance Windows

> Retrieve a list of available maintenance windows

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.MaintenanceWindow":{"type":"object","properties":{"display_name":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/maintenance-windows":{"get":{"description":"Retrieve a list of available maintenance windows","tags":["Offering"],"summary":"Read Maintenance Windows","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/v1.MaintenanceWindow"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Cloud Providers

> Retrieve a list of available cloud providers.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.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"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/providers":{"get":{"description":"Retrieve a list of available cloud providers.","tags":["Offering"],"summary":"Read Cloud Providers","parameters":[{"schema":{"type":"string","enum":["aws","gcp","azure"]},"description":"Filter the list of cloud providers to the specified cloud provider.","name":"name","in":"query"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Cloud provider, e.g. AWS, GCP, BLU","type":"array","items":{"$ref":"#/components/schemas/v1.Provider"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Provider IOPS

> Retrieve a list of available IOPS settings for the specified cloud provider.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.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"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/providers/{provider_name}/iops":{"get":{"description":"Retrieve a list of available IOPS settings for the specified cloud provider.","tags":["Offering"],"summary":"Read Provider IOPS","parameters":[{"schema":{"type":"integer","maximum":100,"minimum":1},"description":"Set the maximum number (limit) of results to fetch per page.","name":"page_size","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"description":"Set the sort order (ascending or descending) for results.","name":"page_order","in":"query"},{"schema":{"type":"string"},"description":"When iterating through results, retrieve the page with the specified token.","name":"page_token","in":"query"},{"schema":{"type":"string","enum":["aws","gcp","azure"]},"description":"The cloud provider whose available IOPS settings will be retrieved.","name":"provider_name","in":"path","required":true}],"responses":{"200":{"description":"OK","headers":{"X-SkySQL-Page-Token-Previous":{"schema":{"type":"string"},"description":"Page iterator token to move to the previous page of results."},"X-SkySQL-Page-Token-Next":{"schema":{"type":"string"},"description":"Page iterator token to move to the next page of results."}},"content":{"application/json":{"schema":{"description":"Available IOPS settings for specified cloud provider","type":"array","items":{"$ref":"#/components/schemas/v1.ProviderIOPSResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Storage Volume Types

> Retrieve a list of available storage volume types for the specified cloud provider.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.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"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/providers/{provider_name}/volume-types":{"get":{"description":"Retrieve a list of available storage volume types for the specified cloud provider.","tags":["Offering"],"summary":"Read Storage Volume Types","parameters":[{"schema":{"type":"integer","maximum":100,"minimum":1},"description":"Set the maximum number (limit) of results to fetch per page.","name":"page_size","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"description":"Set the sort order (ascending or descending) for results.","name":"page_order","in":"query"},{"schema":{"type":"string"},"description":"When iterating through results, retrieve the page with the specified token.","name":"page_token","in":"query"},{"schema":{"type":"string","enum":["aws","gcp","azure"]},"description":"The cloud provider whose storage volume types will be retrieved.","name":"provider_name","in":"path","required":true}],"responses":{"200":{"description":"OK","headers":{"X-SkySQL-Page-Token-Previous":{"schema":{"type":"string"},"description":"Page iterator token to move to the previous page of results."},"X-SkySQL-Page-Token-Next":{"schema":{"type":"string"},"description":"Page iterator token to move to the next page of results."}},"content":{"application/json":{"schema":{"description":"list of cloud storage volume types","type":"array","items":{"$ref":"#/components/schemas/v1.VolumeTypeResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Availability Zones for a specific provider

> Retrieve a list of availability zones for a specific provider.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.Zone":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"provider":{"type":"string"},"region_name":{"type":"string"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/providers/{provider_name}/zones":{"get":{"description":"Retrieve a list of availability zones for a specific provider.","tags":["Offering"],"summary":"Read Availability Zones for a specific provider","parameters":[{"schema":{"type":"string","enum":["aws","gcp","azure"]},"description":"The cloud provider whose availability zones will be retrieved.","name":"provider_name","in":"path","required":true},{"schema":{"type":"string"},"description":"Filter the list of zones by the specified region.","name":"region","in":"query"},{"schema":{"type":"string","enum":["aws","gcp","azure"]},"description":"Filter the list of zones by the specified cloud provider.","name":"provider","in":"query"},{"schema":{"type":"integer","maximum":100,"minimum":1},"description":"Set the maximum number (limit) of results to fetch per page.","name":"page_size","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"description":"Set the sort order (ascending or descending) for results.","name":"page_order","in":"query"},{"schema":{"type":"string"},"description":"When iterating through results, retrieve the page with the specified token.","name":"page_token","in":"query"}],"responses":{"200":{"description":"OK","headers":{"X-SkySQL-Page-Token-Previous":{"schema":{"type":"string"},"description":"Page iterator token to move to the previous page of results."},"X-SkySQL-Page-Token-Next":{"schema":{"type":"string"},"description":"Page iterator token to move to the next page of results."}},"content":{"application/json":{"schema":{"description":"Available zones for region","type":"array","items":{"$ref":"#/components/schemas/v1.Zone"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Regions

> Retrieve a list of available geographic regions for a cloud provider.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.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"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/regions":{"get":{"description":"Retrieve a list of available geographic regions for a cloud provider.","tags":["Offering"],"summary":"Read Regions","parameters":[{"schema":{"type":"string","enum":["aws","gcp","azure"]},"description":"Filter the list of regions to the specified cloud provider.","name":"provider","in":"query"},{"schema":{"type":"integer","maximum":100,"minimum":1},"description":"Set the maximum number (limit) of results to fetch per page.","name":"page_size","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"description":"Set the sort order (ascending or descending) for results.","name":"page_order","in":"query"},{"schema":{"type":"string"},"description":"When iterating through results, retrieve the page with the specified token.","name":"page_token","in":"query"}],"responses":{"200":{"description":"OK","headers":{"X-SkySQL-Page-Token-Previous":{"schema":{"type":"string"},"description":"Page iterator token to move to the previous page of results."},"X-SkySQL-Page-Token-Next":{"schema":{"type":"string"},"description":"Page iterator token to move to the next page of results."}},"content":{"application/json":{"schema":{"description":"Available regions","type":"array","items":{"$ref":"#/components/schemas/v1.Region"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Zones

> Retrieve a list of zones for specific region

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.Zone":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"provider":{"type":"string"},"region_name":{"type":"string"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/regions/{region_name}/zones":{"get":{"description":"Retrieve a list of zones for specific region","tags":["Offering"],"summary":"Read Zones","parameters":[{"schema":{"type":"string"},"description":"The name of the region","name":"region_name","in":"path","required":true},{"schema":{"type":"string","enum":["aws","gcp","azure"]},"description":"Filter the list of zones by the specified cloud provider.","name":"provider","in":"query"},{"schema":{"type":"integer","maximum":100,"minimum":1},"description":"Set the maximum number (limit) of results to fetch per page.","name":"page_size","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"description":"Set the sort order (ascending or descending) for results.","name":"page_order","in":"query"},{"schema":{"type":"string"},"description":"When iterating through results, retrieve the page with the specified token.","name":"page_token","in":"query"}],"responses":{"200":{"description":"OK","headers":{"X-SkySQL-Page-Token-Previous":{"schema":{"type":"string"},"description":"Page iterator token to move to the previous page of results."},"X-SkySQL-Page-Token-Next":{"schema":{"type":"string"},"description":"Page iterator token to move to the next page of results."}},"content":{"application/json":{"schema":{"description":"Available zones for region","type":"array","items":{"$ref":"#/components/schemas/v1.Zone"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Service Types

> Retrieve a list of available service types.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.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"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/service-types":{"get":{"description":"Retrieve a list of available service types.","tags":["Offering"],"summary":"Read Service Types","parameters":[{"schema":{"type":"integer","maximum":100,"minimum":1},"description":"Set the maximum number (limit) of results to fetch per page.","name":"page_size","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"description":"Set the sort order (ascending or descending) for results.","name":"page_order","in":"query"},{"schema":{"type":"string"},"description":"When iterating through results, retrieve the page with the specified token.","name":"page_token","in":"query"}],"responses":{"200":{"description":"OK","headers":{"X-SkySQL-Page-Token-Previous":{"schema":{"type":"string"},"description":"Page iterator token to move to the previous page of results."},"X-SkySQL-Page-Token-Next":{"schema":{"type":"string"},"description":"Page iterator token to move to the next page of results."}},"content":{"application/json":{"schema":{"description":"Available service types","type":"array","items":{"$ref":"#/components/schemas/v1.ServiceType"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Node Sizes

> Retrieve a list of available node sizes.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.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"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/sizes":{"get":{"description":"Retrieve a list of available node sizes.","tags":["Offering"],"summary":"Read Node Sizes","parameters":[{"schema":{"type":"string","enum":["amd64","arm64"]},"description":"Filter the list of node sizes to the specified hardware architecture.","name":"architecture","in":"query"},{"schema":{"type":"string"},"description":"Filter the list of node sizes to the specified service type.","name":"service_type","in":"query"},{"schema":{"type":"string"},"description":"Filter the list of node sizes to the specified cloud provider.","name":"provider","in":"query"},{"schema":{"type":"string"},"description":"Filter the list of node sizes to the specified topology.","name":"topology","in":"query"},{"schema":{"type":"string"},"description":"Filter the list of node sizes to the specified type. Either server or proxy.","name":"type","in":"query"},{"schema":{"type":"integer","maximum":100,"minimum":1},"description":"Set the maximum number (limit) of results to fetch per page.","name":"page_size","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"description":"Set the sort order (ascending or descending) for results.","name":"page_order","in":"query"},{"schema":{"type":"string"},"description":"When iterating through results, retrieve the page with the specified token.","name":"page_token","in":"query"}],"responses":{"200":{"description":"OK","headers":{"X-SkySQL-Page-Token-Previous":{"schema":{"type":"string"},"description":"Page iterator token to move to the previous page of results."},"X-SkySQL-Page-Token-Next":{"schema":{"type":"string"},"description":"Page iterator token to move to the next page of results."}},"content":{"application/json":{"schema":{"description":"Available node sizes","type":"array","items":{"$ref":"#/components/schemas/v1.Size"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Tiers

> Retrieve a list of available tiers and the topologies they support.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.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"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/tiers":{"get":{"description":"Retrieve a list of available tiers and the topologies they support.","tags":["Offering"],"summary":"Read Tiers","parameters":[{"schema":{"type":"integer","maximum":100,"minimum":1},"description":"Set the maximum number (limit) of results to fetch per page.","name":"page_size","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"description":"Set the sort order (ascending or descending) for results.","name":"page_order","in":"query"},{"schema":{"type":"string"},"description":"When iterating through results, retrieve the page with the specified token.","name":"page_token","in":"query"}],"responses":{"200":{"description":"OK","headers":{"X-SkySQL-Page-Token-Previous":{"schema":{"type":"string"},"description":"Page iterator token to move to the previous page of results."},"X-SkySQL-Page-Token-Next":{"schema":{"type":"string"},"description":"Page iterator token to move to the next page of results."}},"content":{"application/json":{"schema":{"description":"Available tiers","type":"array","items":{"$ref":"#/components/schemas/v1.Tier"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Topologies

> Retrieve a list of available topologies for the specified service type.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.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"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/topologies":{"get":{"description":"Retrieve a list of available topologies for the specified service type.","tags":["Offering"],"summary":"Read Topologies","parameters":[{"schema":{"type":"string"},"description":"The service type whose topologies will be retrieved.","name":"service_type","in":"query"},{"schema":{"type":"boolean"},"description":"Whether to returns legacy topologies only.","name":"only_legacy","in":"query"},{"schema":{"type":"integer","maximum":100,"minimum":1},"description":"Set the maximum number (limit) of results to fetch per page.","name":"page_size","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"description":"Set the sort order (ascending or descending) for results.","name":"page_order","in":"query"},{"schema":{"type":"string"},"description":"When iterating through results, retrieve the page with the specified token.","name":"page_token","in":"query"}],"responses":{"200":{"description":"OK","headers":{"X-SkySQL-Page-Token-Previous":{"schema":{"type":"string"},"description":"Page iterator token to move to the previous page of results."},"X-SkySQL-Page-Token-Next":{"schema":{"type":"string"},"description":"Page iterator token to move to the next page of results."}},"content":{"application/json":{"schema":{"description":"Cluster topology valid for a particular product, e.g. Standalone or MaxScale","type":"array","items":{"$ref":"#/components/schemas/v1.Topology"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Topology Node Options

> Retrieve a list of available node options for the specified topology.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.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"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/topologies/{topology_name}/nodes":{"get":{"description":"Retrieve a list of available node options for the specified topology.","tags":["Offering"],"summary":"Read Topology Node Options","parameters":[{"schema":{"type":"string","enum":["sa","csdw","es-replica","es-single","xpand"]},"description":"The topology whose node options will be retrieved.","name":"topology_name","in":"path","required":true},{"schema":{"type":"integer","maximum":100,"minimum":1},"description":"Set the maximum number (limit) of results to fetch per page.","name":"page_size","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"description":"Set the sort order (ascending or descending) for results.","name":"page_order","in":"query"},{"schema":{"type":"string"},"description":"When iterating through results, retrieve the page with the specified token.","name":"page_token","in":"query"}],"responses":{"200":{"description":"OK","headers":{"X-SkySQL-Page-Token-Previous":{"schema":{"type":"string"},"description":"Page iterator token to move to the previous page of results."},"X-SkySQL-Page-Token-Next":{"schema":{"type":"string"},"description":"Page iterator token to move to the next page of results."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/v1.TopologyNodeOptionsResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Topology Options

> Retrieve a list of available options (features) for the specified topology.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.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"}}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/topologies/{topology_name}/options":{"get":{"description":"Retrieve a list of available options (features) for the specified topology.","tags":["Offering"],"summary":"Read Topology Options","parameters":[{"schema":{"type":"string","enum":["sa","csdw","es-replica","es-single","xpand"]},"description":"The topology whose options will be retrieved.","name":"topology_name","in":"path","required":true},{"schema":{"type":"integer","maximum":100,"minimum":1},"description":"Set the maximum number (limit) of results to fetch per page.","name":"page_size","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"description":"Set the sort order (ascending or descending) for results.","name":"page_order","in":"query"},{"schema":{"type":"string"},"description":"When iterating through results, retrieve the page with the specified token.","name":"page_token","in":"query"}],"responses":{"200":{"description":"OK","headers":{"X-SkySQL-Page-Token-Previous":{"schema":{"type":"string"},"description":"Page iterator token to move to the previous page of results."},"X-SkySQL-Page-Token-Next":{"schema":{"type":"string"},"description":"Page iterator token to move to the next page of results."}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ReadTopologyOptionsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Topology Storage Sizes

> Retrieve a list of available storage sizes for the specified topology.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.TopologyStorageSizeResponse":{"type":"object","properties":{"id":{"type":"string"},"storage_sizes":{"type":"array","items":{"type":"integer"}},"tier":{"type":"string"},"topology":{"type":"string"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/topologies/{topology_name}/storage-sizes":{"get":{"description":"Retrieve a list of available storage sizes for the specified topology.","tags":["Offering"],"summary":"Read Topology Storage Sizes","parameters":[{"schema":{"type":"string","enum":["sa","csdw","es-replica","es-single","xpand"]},"description":"The topology whose storage sizes will be retrieved.","name":"topology_name","in":"path","required":true},{"schema":{"type":"integer","maximum":100,"minimum":1},"description":"Set the maximum number (limit) of results to fetch per page.","name":"page_size","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"description":"Set the sort order (ascending or descending) for results.","name":"page_order","in":"query"},{"schema":{"type":"string"},"description":"When iterating through results, retrieve the page with the specified token.","name":"page_token","in":"query"}],"responses":{"200":{"description":"OK","headers":{"X-SkySQL-Page-Token-Previous":{"schema":{"type":"string"},"description":"Page iterator token to move to the previous page of results."},"X-SkySQL-Page-Token-Next":{"schema":{"type":"string"},"description":"Page iterator token to move to the next page of results."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/v1.TopologyStorageSizeResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```

## Read Software Versions

> Retrieve a list of available software versions.

```json
{"openapi":"3.1.1","info":{"title":"MariaDB Cloud DBaaS API","version":"1.0"},"servers":[{"url":"https://api.skysql.com/"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}},"schemas":{"v1.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"}}},"errr.ErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/errr.ErrorDetails"}},"exception":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"path":{"type":"string"},"timestamp":{"type":"integer"},"trace_id":{"type":"string"}}},"errr.ErrorDetails":{"type":"object","properties":{"error":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"metadata":{"type":"object","additionalProperties":true},"solution":{"type":"string"},"type":{"$ref":"#/components/schemas/errr.Type"}}},"errr.Type":{"type":"string","enum":["fatal","error","warning"]}}},"paths":{"/provisioning/v1/versions":{"get":{"description":"Retrieve a list of available software versions.","tags":["Offering"],"summary":"Read Software Versions","parameters":[{"schema":{"type":"integer","maximum":100,"minimum":1},"description":"Set the maximum number (limit) of results to fetch per page.","name":"page_size","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"description":"Set the sort order (ascending or descending) for results.","name":"page_order","in":"query"},{"schema":{"type":"string"},"description":"When iterating through results, retrieve the page with the specified token.","name":"page_token","in":"query"},{"schema":{"type":"string"},"description":"Filter the list of versions to the specified topology.","name":"topology","in":"query"}],"responses":{"200":{"description":"OK","headers":{"X-SkySQL-Page-Token-Previous":{"schema":{"type":"string"},"description":"Page iterator token to move to the previous page of results."},"X-SkySQL-Page-Token-Next":{"schema":{"type":"string"},"description":"Page iterator token to move to the next page of results."}},"content":{"application/json":{"schema":{"description":"Available software versions","type":"array","items":{"$ref":"#/components/schemas/v1.Version"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errr.ErrorResponse"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://mariadb.com/docs/mariadb-cloud/reference/mariadb-cloud-api-reference-guide/offering.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.