Offering
Retrieve a list of available hardware architectures for the specified cloud provider and specified topology.
The cloud provider whose hardware architectures will be retrieved.
The topology whose hardware architectures will be retrieved.
OK
Bad Request
Unauthorized
Not Found
Internal Server Error
GET /provisioning/v1/architectures HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"display_name": "text",
"id": "text",
"name": "text"
}
]Retrieve a list of available hardware architectures for the specified cloud provider and specified topology.
Provider name
Topology name
OK
Bad Request
Unauthorized
Not Found
Internal Server Error
GET /provisioning/v1/cpu-architectures HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"display_name": "text",
"id": "text",
"name": "text"
}
]Retrieve a list of entitlements for the current organization.
OK
Bad Request
Unauthorized
Internal Server Error
GET /provisioning/v1/entitlements HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"name": "text",
"topologies": [
"text"
]
}
]Retrieve a list of available maintenance windows
OK
Unauthorized
Internal Server Error
GET /provisioning/v1/maintenance-windows HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"display_name": "text",
"id": "text",
"name": "text"
}
]Retrieve a list of available cloud providers.
Filter the list of cloud providers to the specified cloud provider.
OK
Bad Request
Unauthorized
Internal Server Error
GET /provisioning/v1/providers HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"active": true,
"default": true,
"display_name": "text",
"id": "text",
"iops_min": 1,
"iops_per_gb": 1,
"name": "text",
"volume_size_max_gb": 1,
"volume_size_min_gb": 1
}
]Retrieve a list of available IOPS settings for the specified cloud provider.
The cloud provider whose available IOPS settings will be retrieved.
Set the maximum number (limit) of results to fetch per page.
Set the sort order (ascending or descending) for results.
When iterating through results, retrieve the page with the specified token.
OK
Bad Request
Unauthorized
Not Found
Internal Server Error
GET /provisioning/v1/providers/{provider_name}/iops HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"default_iops_per_gb": 1,
"id": "text",
"iops_range_max": 1,
"iops_range_min": 1,
"provider": "text",
"storage_range_max": 1,
"storage_range_min": 1,
"throughput_range_max": 1,
"throughput_range_min": 1,
"tier": "text",
"total_iops_range_max": 1,
"total_iops_range_min": 1,
"volume_type_name": "text"
}
]Retrieve a list of available storage volume types for the specified cloud provider.
The cloud provider whose storage volume types will be retrieved.
Set the maximum number (limit) of results to fetch per page.
Set the sort order (ascending or descending) for results.
When iterating through results, retrieve the page with the specified token.
OK
Bad Request
Unauthorized
Not Found
Internal Server Error
GET /provisioning/v1/providers/{provider_name}/volume-types HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"created_on": 1,
"display_name": "text",
"id": "text",
"iops": [
{
"default_iops_per_gb": 1,
"id": "text",
"iops_range_max": 1,
"iops_range_min": 1,
"provider": "text",
"storage_range_max": 1,
"storage_range_min": 1,
"throughput_range_max": 1,
"throughput_range_min": 1,
"tier": "text",
"total_iops_range_max": 1,
"total_iops_range_min": 1,
"volume_type_name": "text"
}
],
"is_default": true,
"name": "text",
"provider": "text",
"updated_on": 1
}
]Retrieve a list of availability zones for a specific provider.
The cloud provider whose availability zones will be retrieved.
Filter the list of zones by the specified region.
Filter the list of zones by the specified cloud provider.
Set the maximum number (limit) of results to fetch per page.
Set the sort order (ascending or descending) for results.
When iterating through results, retrieve the page with the specified token.
OK
Bad Request
Unauthorized
Internal Server Error
GET /provisioning/v1/providers/{provider_name}/zones HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"id": "text",
"name": "text",
"provider": "text",
"region_name": "text"
}
]Retrieve a list of available geographic regions for a cloud provider.
Filter the list of regions to the specified cloud provider.
Set the maximum number (limit) of results to fetch per page.
Set the sort order (ascending or descending) for results.
When iterating through results, retrieve the page with the specified token.
OK
Bad Request
Unauthorized
Internal Server Error
GET /provisioning/v1/regions HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"default": true,
"foundation_tier_maintenance_window": "text",
"has_clusters": true,
"id": "text",
"is_available": true,
"name": "text",
"order": 1,
"provider": "text",
"region": "text"
}
]Retrieve a list of zones for specific region
The name of the region
Filter the list of zones by the specified cloud provider.
Set the maximum number (limit) of results to fetch per page.
Set the sort order (ascending or descending) for results.
When iterating through results, retrieve the page with the specified token.
OK
Bad Request
Unauthorized
Internal Server Error
GET /provisioning/v1/regions/{region_name}/zones HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"id": "text",
"name": "text",
"provider": "text",
"region_name": "text"
}
]Retrieve a list of available service types.
Set the maximum number (limit) of results to fetch per page.
Set the sort order (ascending or descending) for results.
When iterating through results, retrieve the page with the specified token.
OK
Bad Request
Unauthorized
Internal Server Error
GET /provisioning/v1/service-types HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"description": "text",
"display_name": "text",
"id": "text",
"name": "text",
"order": 1,
"short_description": "text"
}
]Retrieve a list of available node sizes.
Filter the list of node sizes to the specified hardware architecture.
Filter the list of node sizes to the specified service type.
Filter the list of node sizes to the specified cloud provider.
Filter the list of node sizes to the specified topology.
Filter the list of node sizes to the specified type. Either server or proxy.
Set the maximum number (limit) of results to fetch per page.
Set the sort order (ascending or descending) for results.
When iterating through results, retrieve the page with the specified token.
OK
Bad Request
Unauthorized
Internal Server Error
GET /provisioning/v1/sizes HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"architecture": "text",
"cpu": "text",
"created_on": "text",
"default_maxscale_size_name": "text",
"display_name": "text",
"id": "text",
"is_active": true,
"name": "text",
"provider": "text",
"ram": "text",
"service_type": "text",
"tier": "text",
"topology": "text",
"type": "text",
"updated_on": "text"
}
]Retrieve a list of available tiers and the topologies they support.
Set the maximum number (limit) of results to fetch per page.
Set the sort order (ascending or descending) for results.
When iterating through results, retrieve the page with the specified token.
OK
Bad Request
Unauthorized
Internal Server Error
GET /provisioning/v1/tiers HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"description": "text",
"display_name": "text",
"id": "text",
"is_active": true,
"name": "text",
"topologies": [
{
"database": "text",
"display_name": "text",
"id": "text",
"name": "text",
"order": 1,
"service_type": "text",
"storage_engine": "text"
}
]
}
]Retrieve a list of available topologies for the specified service type.
The service type whose topologies will be retrieved.
Whether to returns legacy topologies only.
Set the maximum number (limit) of results to fetch per page.
Set the sort order (ascending or descending) for results.
When iterating through results, retrieve the page with the specified token.
OK
Bad Request
Unauthorized
Internal Server Error
GET /provisioning/v1/topologies HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"database": "text",
"display_name": "text",
"id": "text",
"name": "text",
"order": 1,
"service_type": "text",
"storage_engine": "text"
}
]Retrieve a list of available node options for the specified topology.
The topology whose node options will be retrieved.
Set the maximum number (limit) of results to fetch per page.
Set the sort order (ascending or descending) for results.
When iterating through results, retrieve the page with the specified token.
OK
Bad Request
Unauthorized
Internal Server Error
GET /provisioning/v1/topologies/{topology_name}/nodes HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"default_maxscale_nodes": 1,
"id": "text",
"maxscale_nodes": [
1
],
"nodes": [
1
],
"tier": "text",
"topology": "text"
}
]Retrieve a list of available options (features) for the specified topology.
The topology whose options will be retrieved.
Set the maximum number (limit) of results to fetch per page.
Set the sort order (ascending or descending) for results.
When iterating through results, retrieve the page with the specified token.
OK
Bad Request
Unauthorized
Internal Server Error
GET /provisioning/v1/topologies/{topology_name}/options HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
{
"nosql_available": true,
"scale_options": {
"cpu": {
"default": [
1
],
"range": [
1
]
}
}
}Retrieve a list of available storage sizes for the specified topology.
The topology whose storage sizes will be retrieved.
Set the maximum number (limit) of results to fetch per page.
Set the sort order (ascending or descending) for results.
When iterating through results, retrieve the page with the specified token.
OK
Bad Request
Unauthorized
Not Found
Internal Server Error
GET /provisioning/v1/topologies/{topology_name}/storage-sizes HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"id": "text",
"storage_sizes": [
1
],
"tier": "text",
"topology": "text"
}
]Retrieve a list of available software versions.
Set the maximum number (limit) of results to fetch per page.
Set the sort order (ascending or descending) for results.
When iterating through results, retrieve the page with the specified token.
Filter the list of versions to the specified topology.
OK
Bad Request
Unauthorized
Internal Server Error
GET /provisioning/v1/versions HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"default": true,
"display_name": "text",
"id": "text",
"is_major": true,
"name": "text",
"product": "text",
"release_date": "text",
"release_notes_url": "text",
"topology": "text",
"version": "text"
}
]Was this helpful?