Services
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
Unauthorized
GET /provisioning/v1/services HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"analytics": true,
"architecture": "text",
"assigned_on": 1,
"availability_zone": "text",
"config_id": "text",
"created_by": "text",
"created_on": 1,
"custom_ssl": true,
"data_center": "text",
"domains": [
"text"
],
"endpoints": [
{
"allow_list": [
{
"comment": "text",
"ip": "text"
}
],
"allowed_accounts": [
"text"
],
"endpoint_service": "text",
"fqdn": "text",
"ips": [
"text"
],
"mechanism": "text",
"name": "text",
"ports": [
{
"name": "readwrite",
"port": 5001,
"purpose": "text"
}
],
"private_link": {
"accounts": [
{
"alias": "text",
"id": "text"
}
]
},
"private_service_connect": {
"projects": [
{
"alias": "text",
"id": "text"
}
]
},
"visibility": "text"
}
],
"errors": [
"text"
],
"fqdn": "text",
"id": "text",
"is_active": true,
"maintenance_window": "text",
"maxscale_nodes": 1,
"maxscale_size": "text",
"name": "text",
"nodes": 1,
"nosql_enabled": true,
"outbound_ips": [
"text"
],
"primary_host": "text",
"project_id": "text",
"provider": "text",
"region": "text",
"replication_enabled": true,
"scale_options": {
"max_compute": 1,
"min_compute": 1,
"suspend_enabled": false
},
"service_type": "text",
"size": "text",
"ssl_enabled": true,
"status": "pending_create",
"storage_volume": {
"iops": 1,
"size": 1,
"throughput": 1,
"volume_type": "text"
},
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tenancy": "text",
"tier": "text",
"topology": "text",
"updated_by": "text",
"updated_on": 1,
"upgrades": {
"kubernetes_upgrade_deadline": "text",
"kubernetes_upgrade_in_progress": true,
"kubernetes_upgrade_status": "available"
},
"version": "text",
"volume_modified_on": 1
}
]Enable embedded analytical SQL support. Valid values: true or false. Defaults to false if not specified.
trueThe hardware architecture of the service.
amd64Possible values: 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.
us-east-1aThe list of cloud accounts (AWS account IDs or GCP projects) that are allowed to access the service. The "endpoint_allowed_accounts" attributes is required when the "endpoint_mechanism" is set to "privateconnect".
The endpoint mechanism to use.
The maintenance window. Applicable for the power tier customers only.
Number of maxscale nodes.
2The instance size. Valid values are: sky-2x4, sky-2x8 etc. Not applicable for the Serverless Analytics topology. Only applicable if maxscale_nodes > 0
sky-2x8Name of the service.
my-first-serviceThe number of nodes in the service. Not applicable for Enterprise Server Single Node and Serverless Analytics topologies.
1Whether to enable the NoSQL Protocol Module.
trueThe ID of the project to create the service in.
b4ffd36d-20b2-4813-9939-635f66a21c5eThe cloud provider for the service.
awsPossible values: The region where the service will be created. The region value should match with the region names used by the cloud provider.
us-east-1The type of service to create.
transactionalPossible values: The instance size. Valid values are: sky-2x4, sky-2x8 etc. Not applicable for the Serverless Analytics topology.
sky-2x8Whether to enable SSL. Valid values are: true or false
trueThe 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
100The topology of the service. Valid values are: sa, csdw, es-replica, es-single and xpand.
standalonePossible values: The service software versions. Not applicable for the Serverless Analytics topology.
10.6.7-3-1The service storage IOPS. This is only applicable for AWS
100The service storage throughput. This is only applicable for GP3(AWS) volume type.
The volume type. Valid values are: gp2 and io1. This is only applicable for AWS.
gp2Possible values: Accepted
ServiceResponse
Bad Request
Unauthorized
Payment Required
Internal Server Error
POST /provisioning/v1/services HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1050
{
"allow_list": [
{
"comment": "text",
"ip": "text"
}
],
"analytical": true,
"architecture": "amd64",
"availability_zone": "us-east-1a",
"custom_image_versions": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"custom_ssl": true,
"endpoint_allowed_accounts": [
"text"
],
"endpoint_mechanism": "nlb",
"endpoints": [
{
"name": "text",
"ports": [
{
"name": "readwrite",
"port": 5001
}
]
}
],
"maintenance_window": "text",
"maxscale_nodes": 2,
"maxscale_size": "sky-2x8",
"name": "my-first-service",
"nodes": 1,
"nosql_enabled": true,
"ports": [
{
"name": "readwrite",
"port": 5001
}
],
"private_link": {
"accounts": [
{
"alias": "text",
"id": "text"
}
]
},
"private_service_connect": {
"projects": [
{
"alias": "text",
"id": "text"
}
]
},
"project_id": "b4ffd36d-20b2-4813-9939-635f66a21c5e",
"provider": "aws",
"region": "us-east-1",
"scale_options": {
"max_compute": 1,
"min_compute": 1,
"suspend_enabled": false
},
"service_type": "transactional",
"size": "sky-2x8",
"ssl_enabled": true,
"storage": 100,
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tenancy": "shared",
"topology": "standalone",
"version": "10.6.7-3-1",
"volume_iops": 100,
"volume_throughput": 1,
"volume_type": "gp2"
}{
"analytics": true,
"architecture": "text",
"assigned_on": 1,
"availability_zone": "text",
"config_id": "text",
"created_by": "text",
"created_on": 1,
"custom_ssl": true,
"data_center": "text",
"domains": [
"text"
],
"endpoints": [
{
"allow_list": [
{
"comment": "text",
"ip": "text"
}
],
"allowed_accounts": [
"text"
],
"endpoint_service": "text",
"fqdn": "text",
"ips": [
"text"
],
"mechanism": "text",
"name": "text",
"ports": [
{
"name": "readwrite",
"port": 5001,
"purpose": "text"
}
],
"private_link": {
"accounts": [
{
"alias": "text",
"id": "text"
}
]
},
"private_service_connect": {
"projects": [
{
"alias": "text",
"id": "text"
}
]
},
"visibility": "text"
}
],
"errors": [
"text"
],
"fqdn": "text",
"id": "text",
"is_active": true,
"maintenance_window": "text",
"maxscale_nodes": 1,
"maxscale_size": "text",
"name": "text",
"nodes": 1,
"nosql_enabled": true,
"outbound_ips": [
"text"
],
"primary_host": "text",
"project_id": "text",
"provider": "text",
"region": "text",
"replication_enabled": true,
"scale_options": {
"max_compute": 1,
"min_compute": 1,
"suspend_enabled": false
},
"service_type": "text",
"size": "text",
"ssl_enabled": true,
"status": "pending_create",
"storage_volume": {
"iops": 1,
"size": 1,
"throughput": 1,
"volume_type": "text"
},
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tenancy": "text",
"tier": "text",
"topology": "text",
"updated_by": "text",
"updated_on": 1,
"upgrades": {
"kubernetes_upgrade_deadline": "text",
"kubernetes_upgrade_in_progress": true,
"kubernetes_upgrade_status": "available"
},
"version": "text",
"volume_modified_on": 1
}The ID for the service.
OK
ServiceResponse
Bad Request
Unauthorized
Not Found
Internal Server Error
GET /provisioning/v1/services/{service_id} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
{
"analytics": true,
"architecture": "text",
"assigned_on": 1,
"availability_zone": "text",
"config_id": "text",
"created_by": "text",
"created_on": 1,
"custom_ssl": true,
"data_center": "text",
"domains": [
"text"
],
"endpoints": [
{
"allow_list": [
{
"comment": "text",
"ip": "text"
}
],
"allowed_accounts": [
"text"
],
"endpoint_service": "text",
"fqdn": "text",
"ips": [
"text"
],
"mechanism": "text",
"name": "text",
"ports": [
{
"name": "readwrite",
"port": 5001,
"purpose": "text"
}
],
"private_link": {
"accounts": [
{
"alias": "text",
"id": "text"
}
]
},
"private_service_connect": {
"projects": [
{
"alias": "text",
"id": "text"
}
]
},
"visibility": "text"
}
],
"errors": [
"text"
],
"fqdn": "text",
"id": "text",
"is_active": true,
"maintenance_window": "text",
"maxscale_nodes": 1,
"maxscale_size": "text",
"name": "text",
"nodes": 1,
"nosql_enabled": true,
"outbound_ips": [
"text"
],
"primary_host": "text",
"project_id": "text",
"provider": "text",
"region": "text",
"replication_enabled": true,
"scale_options": {
"max_compute": 1,
"min_compute": 1,
"suspend_enabled": false
},
"service_type": "text",
"size": "text",
"ssl_enabled": true,
"status": "pending_create",
"storage_volume": {
"iops": 1,
"size": 1,
"throughput": 1,
"volume_type": "text"
},
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tenancy": "text",
"tier": "text",
"topology": "text",
"updated_by": "text",
"updated_on": 1,
"upgrades": {
"kubernetes_upgrade_deadline": "text",
"kubernetes_upgrade_in_progress": true,
"kubernetes_upgrade_status": "available"
},
"version": "text",
"volume_modified_on": 1
}The ID for the service.
OK
No content
Bad Request
Unauthorized
Not Found
Internal Server Error
DELETE /provisioning/v1/services/{service_id} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
No content
The ID for the service.
Config for a service
Accepted
Config for a service
Bad Request
Unauthorized
Not Found
Internal Server Error
POST /provisioning/v1/services/{service_id}/config HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"config_id": "text"
}{
"config_id": "text"
}The ID for the service.
Accepted
Config for a service
Bad Request
Unauthorized
Not Found
Internal Server Error
DELETE /provisioning/v1/services/{service_id}/config HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
{
"config_id": "text"
}Identifier for a services
Accepted
Bad Request
Unauthorized
Not Found
Internal Server Error
POST /provisioning/v1/services/{service_id}/endpoints HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 58
{
"name": "text",
"ports": [
{
"name": "readwrite",
"port": 5001
}
]
}[
{
"allow_list": [
{
"comment": "text",
"ip": "text"
}
],
"allowed_accounts": [
"text"
],
"endpoint_service": "text",
"fqdn": "text",
"ips": [
"text"
],
"mechanism": "text",
"name": "text",
"ports": [
{
"name": "readwrite",
"port": 5001,
"purpose": "text"
}
],
"private_link": {
"accounts": [
{
"alias": "text",
"id": "text"
}
]
},
"private_service_connect": {
"projects": [
{
"alias": "text",
"id": "text"
}
]
},
"visibility": "text"
}
]Identifier for a services
AllowedAccounts is the list of cloud accounts (aws account ids or gcp projects) that are allowed to access the service
Mechanism is the endpoint mechanism to use. Valid values are: privateconnect or nlb
OK
Bad Request
Unauthorized
Not Found
Internal Server Error
PATCH /provisioning/v1/services/{service_id}/endpoints HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 179
[
{
"allowed_accounts": [
"text"
],
"mechanism": "text",
"private_link": {
"accounts": [
{
"alias": "text",
"id": "text"
}
]
},
"private_service_connect": {
"projects": [
{
"alias": "text",
"id": "text"
}
]
}
}
][
{
"allow_list": [
{
"comment": "text",
"ip": "text"
}
],
"allowed_accounts": [
"text"
],
"endpoint_service": "text",
"fqdn": "text",
"ips": [
"text"
],
"mechanism": "text",
"name": "text",
"ports": [
{
"name": "readwrite",
"port": 5001,
"purpose": "text"
}
],
"private_link": {
"accounts": [
{
"alias": "text",
"id": "text"
}
]
},
"private_service_connect": {
"projects": [
{
"alias": "text",
"id": "text"
}
]
},
"visibility": "text"
}
]Identifier for a services
Endpoint name
Accepted
Bad Request
Unauthorized
Not Found
Internal Server Error
DELETE /provisioning/v1/services/{service_id}/endpoints/{name} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"allow_list": [
{
"comment": "text",
"ip": "text"
}
],
"allowed_accounts": [
"text"
],
"endpoint_service": "text",
"fqdn": "text",
"ips": [
"text"
],
"mechanism": "text",
"name": "text",
"ports": [
{
"name": "readwrite",
"port": 5001,
"purpose": "text"
}
],
"private_link": {
"accounts": [
{
"alias": "text",
"id": "text"
}
]
},
"private_service_connect": {
"projects": [
{
"alias": "text",
"id": "text"
}
]
},
"visibility": "text"
}
]The ID for the service.
Update the number of nodes for a service
3OK
Update the number of nodes for a service
3Bad Request
Unauthorized
Not Found
Internal Server Error
POST /provisioning/v1/services/{service_id}/nodes HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 11
{
"nodes": 3
}{
"nodes": 3
}The ID for the service.
Start/Stop Service
OK
No content
Bad Request
Unauthorized
Not Found
Internal Server Error
POST /provisioning/v1/services/{service_id}/power HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"is_active": true
}No content
The ID for the service.
OK
Services of user or team
Bad Request
Unauthorized
Not Found
Internal Server Error
GET /provisioning/v1/services/{service_id}/replicas HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"analytics": true,
"architecture": "text",
"assigned_on": 1,
"availability_zone": "text",
"config_id": "text",
"created_by": "text",
"created_on": 1,
"custom_ssl": true,
"data_center": "text",
"domains": [
"text"
],
"endpoints": [
{
"allow_list": [
{
"comment": "text",
"ip": "text"
}
],
"allowed_accounts": [
"text"
],
"endpoint_service": "text",
"fqdn": "text",
"ips": [
"text"
],
"mechanism": "text",
"name": "text",
"ports": [
{
"name": "readwrite",
"port": 5001,
"purpose": "text"
}
],
"private_link": {
"accounts": [
{
"alias": "text",
"id": "text"
}
]
},
"private_service_connect": {
"projects": [
{
"alias": "text",
"id": "text"
}
]
},
"visibility": "text"
}
],
"errors": [
"text"
],
"fqdn": "text",
"id": "text",
"is_active": true,
"maintenance_window": "text",
"maxscale_nodes": 1,
"maxscale_size": "text",
"name": "text",
"nodes": 1,
"nosql_enabled": true,
"outbound_ips": [
"text"
],
"primary_host": "text",
"project_id": "text",
"provider": "text",
"region": "text",
"replication_enabled": true,
"scale_options": {
"max_compute": 1,
"min_compute": 1,
"suspend_enabled": false
},
"service_type": "text",
"size": "text",
"ssl_enabled": true,
"status": "pending_create",
"storage_volume": {
"iops": 1,
"size": 1,
"throughput": 1,
"volume_type": "text"
},
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tenancy": "text",
"tier": "text",
"topology": "text",
"updated_by": "text",
"updated_on": 1,
"upgrades": {
"kubernetes_upgrade_deadline": "text",
"kubernetes_upgrade_in_progress": true,
"kubernetes_upgrade_status": "available"
},
"version": "text",
"volume_modified_on": 1
}
]The ID for the service.
Enable replication for a service
db12345678bi-directionalPossible values: Accepted
Enable replication for a service
db12345678bi-directionalPossible values: Bad Request
Unauthorized
Not Found
Internal Server Error
POST /provisioning/v1/services/{service_id}/replication HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"primary_host": "db12345678",
"replication_type": "bi-directional"
}{
"primary_host": "db12345678",
"replication_type": "bi-directional"
}The ID for the service.
OK
No content
Bad Request
Unauthorized
Not Found
Internal Server Error
DELETE /provisioning/v1/services/{service_id}/replication HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
No content
The ID for the service.
Enable serverless suspension. Valid values: true or false. Defaults to true if not specified.
No Content
No content
Bad Request
Unauthorized
Not Found
Internal Server Error
PUT /provisioning/v1/services/{service_id}/scale_options HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 57
{
"max_compute": 1,
"min_compute": 1,
"suspend_enabled": false
}No content
The ID for the service.
OK
IP Address that has been added to the services network allowlist.
Deprecated: This should be removed in future release. Use allow_list instead.
["142.251.46.142"]primaryBad Request
Unauthorized
Not Found
Internal Server Error
GET /provisioning/v1/services/{service_id}/security/allowlist HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
[
{
"allowList": [
"142.251.46.142"
],
"allow_list": [
{
"comment": "text",
"ip": "text"
}
],
"name": "primary"
}
]The ID for the service.
142.251.46.142/32OK
IP Address that has been added to the services network allowlist.
Deprecated: This should be removed in future release. Use allow_list instead.
["142.251.46.142"]primaryBad Request
Unauthorized
Internal Server Error
POST /provisioning/v1/services/{service_id}/security/allowlist HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"ip_address": "142.251.46.142/32"
}[
{
"allowList": [
"142.251.46.142"
],
"allow_list": [
{
"comment": "text",
"ip": "text"
}
],
"name": "primary"
}
]The ID for the service.
OK
IP Address that has been added to the services network allowlist.
Deprecated: This should be removed in future release. Use allow_list instead.
["142.251.46.142"]primaryBad Request
Unauthorized
Internal Server Error
PUT /provisioning/v1/services/{service_id}/security/allowlist HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 32
[
{
"comment": "text",
"ip": "text"
}
][
{
"allowList": [
"142.251.46.142"
],
"allow_list": [
{
"comment": "text",
"ip": "text"
}
],
"name": "primary"
}
]The ID for the service.
142.251.46.142/32OK
IP Address that has been added to the services network allowlist.
Deprecated: This should be removed in future release. Use allow_list instead.
["142.251.46.142"]primaryBad Request
Unauthorized
Internal Server Error
DELETE /provisioning/v1/services/{service_id}/security/allowlist HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"ip_address": "142.251.46.142/32"
}[
{
"allowList": [
"142.251.46.142"
],
"allow_list": [
{
"comment": "text",
"ip": "text"
}
],
"name": "primary"
}
]The ID for the service.
OK
Bad Request
Unauthorized
Not Found
Internal Server Error
GET /provisioning/v1/services/{service_id}/security/credentials HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
{
"host": "text",
"password": "text",
"username": "text"
}The ID for the service.
Request to identify if an ip is whitelisted
OK
Response if an ip is whitelisted
Bad Request
POST /provisioning/v1/services/{service_id}/security/is-ip-allowed HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"ip_address": "text"
}{
"ip_address": "text",
"is_allowed": true
}The ID for the service.
trueOK
ServiceResponse
Bad Request
Unauthorized
Not Found
Internal Server Error
PATCH /provisioning/v1/services/{service_id}/security/ssl HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"ssl_enabled": true
}{
"analytics": true,
"architecture": "text",
"assigned_on": 1,
"availability_zone": "text",
"config_id": "text",
"created_by": "text",
"created_on": 1,
"custom_ssl": true,
"data_center": "text",
"domains": [
"text"
],
"endpoints": [
{
"allow_list": [
{
"comment": "text",
"ip": "text"
}
],
"allowed_accounts": [
"text"
],
"endpoint_service": "text",
"fqdn": "text",
"ips": [
"text"
],
"mechanism": "text",
"name": "text",
"ports": [
{
"name": "readwrite",
"port": 5001,
"purpose": "text"
}
],
"private_link": {
"accounts": [
{
"alias": "text",
"id": "text"
}
]
},
"private_service_connect": {
"projects": [
{
"alias": "text",
"id": "text"
}
]
},
"visibility": "text"
}
],
"errors": [
"text"
],
"fqdn": "text",
"id": "text",
"is_active": true,
"maintenance_window": "text",
"maxscale_nodes": 1,
"maxscale_size": "text",
"name": "text",
"nodes": 1,
"nosql_enabled": true,
"outbound_ips": [
"text"
],
"primary_host": "text",
"project_id": "text",
"provider": "text",
"region": "text",
"replication_enabled": true,
"scale_options": {
"max_compute": 1,
"min_compute": 1,
"suspend_enabled": false
},
"service_type": "text",
"size": "text",
"ssl_enabled": true,
"status": "pending_create",
"storage_volume": {
"iops": 1,
"size": 1,
"throughput": 1,
"volume_type": "text"
},
"tags": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tenancy": "text",
"tier": "text",
"topology": "text",
"updated_by": "text",
"updated_on": 1,
"upgrades": {
"kubernetes_upgrade_deadline": "text",
"kubernetes_upgrade_in_progress": true,
"kubernetes_upgrade_status": "available"
},
"version": "text",
"volume_modified_on": 1
}The ID for the service.
Nodes size for a service
sky-2x8Accepted
Nodes size for a service
sky-2x8Bad Request
Unauthorized
Not Found
Internal Server Error
POST /provisioning/v1/services/{service_id}/size HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"size": "sky-2x8"
}{
"size": "sky-2x8"
}The ID for the service.
OK
No content
Bad Request
Unauthorized
Not Found
Internal Server Error
POST /provisioning/v1/services/{service_id}/start HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
No content
The ID for the service.
OK
No content
Bad Request
Unauthorized
Not Found
Internal Server Error
POST /provisioning/v1/services/{service_id}/stop HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
No content
The ID for the service.
Storage size and IOPS (AWS only) that is set for the service
Total Input/output operations of the volume Minimum / Maximum IOPs depend on the size of the disk and volume type. This property should only be set on AWS gp3 volume types. The Valid range is 3000 to 16000 IOPS.
5000Size in GBs
10Throughput in MB/s. This property should only be set on AWS services with gp3 volume typee. The Valid range is 125 MiB/s to 1,000 MiB/s.
125Accepted
Storage size and IOPS (AWS only) that is set for the service
Total Input/output operations of the volume Minimum / Maximum IOPs depend on the size of the disk and volume type. This property should only be set on AWS gp3 volume types. The Valid range is 3000 to 16000 IOPS.
5000Size in GBs
10Throughput in MB/s. This property should only be set on AWS services with gp3 volume typee. The Valid range is 125 MiB/s to 1,000 MiB/s.
125Bad Request
Unauthorized
Not Found
Too Early
Internal Server Error
PATCH /provisioning/v1/services/{service_id}/storage HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"iops": 5000,
"size": 10,
"throughput": 125
}{
"iops": 5000,
"size": 10,
"throughput": 125
}The ID for the service.
Storage size and IOPS (AWS only) that is set for the service
Total Input/output operations of the volume Minimum / Maximum IOPs depend on the size of the disk and volume type. This property should only be set on AWS gp3 volume types. The Valid range is 3000 to 16000 IOPS.
5000Size in GBs
10Throughput in MB/s. This property should only be set on AWS services with gp3 volume typee. The Valid range is 125 MiB/s to 1,000 MiB/s.
125Accepted
Storage size and IOPS (AWS only) that is set for the service
Total Input/output operations of the volume Minimum / Maximum IOPs depend on the size of the disk and volume type. This property should only be set on AWS gp3 volume types. The Valid range is 3000 to 16000 IOPS.
5000Size in GBs
10Throughput in MB/s. This property should only be set on AWS services with gp3 volume typee. The Valid range is 125 MiB/s to 1,000 MiB/s.
125Bad Request
Unauthorized
Not Found
Too Early
Internal Server Error
PATCH /provisioning/v1/services/{service_id}/storage/iops HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"iops": 5000,
"size": 10,
"throughput": 125
}{
"iops": 5000,
"size": 10,
"throughput": 125
}The ID for the service.
Storage size and IOPS (AWS only) that is set for the service
Total Input/output operations of the volume Minimum / Maximum IOPs depend on the size of the disk and volume type. This property should only be set on AWS gp3 volume types. The Valid range is 3000 to 16000 IOPS.
5000Size in GBs
10Throughput in MB/s. This property should only be set on AWS services with gp3 volume typee. The Valid range is 125 MiB/s to 1,000 MiB/s.
125Accepted
Storage size and IOPS (AWS only) that is set for the service
Total Input/output operations of the volume Minimum / Maximum IOPs depend on the size of the disk and volume type. This property should only be set on AWS gp3 volume types. The Valid range is 3000 to 16000 IOPS.
5000Size in GBs
10Throughput in MB/s. This property should only be set on AWS services with gp3 volume typee. The Valid range is 125 MiB/s to 1,000 MiB/s.
125Bad Request
Unauthorized
Not Found
Internal Server Error
PATCH /provisioning/v1/services/{service_id}/storage/size HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"iops": 5000,
"size": 10,
"throughput": 125
}{
"iops": 5000,
"size": 10,
"throughput": 125
}The ID for the service.
Tags to be set for the service
No Content
No content
Bad Request
Unauthorized
Not Found
Internal Server Error
PATCH /provisioning/v1/services/{service_id}/tags HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"tags": {
"name": "new-service-name"
}
}No content
Last updated
Was this helpful?