Webinar | Beyond Keywords: AI Vector Search with LangChain and MariaDB Cloud
Watch Now
Download MariaDBContact Us

Services

List Services

get

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

Authorizations
Query parameters
page_sizeinteger · min: 1 · max: 100Optional

Set the maximum number (limit) of results to fetch per page.

page_orderstring · enumOptional

Set the sort order (ascending or descending) for results.

Possible values:
page_tokenstringOptional

When iterating through results, retrieve the page with the specified token.

Responses
200

OK

application/json
get
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
  }
]

Create a Service

post

Create (launch) a new service.

Authorizations
Body
analyticalbooleanOptional

Enable embedded analytical SQL support. Valid values: true or false. Defaults to false if not specified.

Example: true
architecturestring · enumOptional

The hardware architecture of the service.

Example: amd64Possible values:
availability_zonestringOptional

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.

Example: us-east-1a
custom_sslbooleanOptional
endpoint_allowed_accountsstring[]Optional

The 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".

endpoint_mechanismstring · enumOptional

The endpoint mechanism to use.

Possible values:
maintenance_windowstringOptional

The maintenance window. Applicable for the power tier customers only.

maxscale_nodesintegerOptional

Number of maxscale nodes.

Example: 2
maxscale_sizestringOptional

The instance size. Valid values are: sky-2x4, sky-2x8 etc. Not applicable for the Serverless Analytics topology. Only aplicable if maxscale_nodes > 0

Example: sky-2x8
namestringOptional

Name of the service.

Example: my-first-service
nodesintegerOptional

The number of nodes in the service. Not applicable for Enterprise Server Single Node and Serverless Analytics topologies.

Example: 1
nosql_enabledbooleanOptional

Whether to enable the NoSQL Protocol Module.

Example: true
private_linkall ofOptional

PrivateLink is the AWS PrivateLink configuration

private_service_connectall ofOptional

PrivateServiceConnect is the GCP Private Service Connect configuration

project_idstringOptional

The ID of the project to create the service in.

Example: b4ffd36d-20b2-4813-9939-635f66a21c5e
providerstring · enumOptional

The cloud provider for the service.

Example: awsPossible values:
regionstringOptional

The region where the service will be created. The region value should match with the region names used by the cloud provider.

Example: us-east-1
scale_optionsall ofOptional

ScaleOptions are the options for serverless scaling

service_typestring · enumOptional

The type of service to create.

Example: transactionalPossible values:
sizestringOptional

The instance size. Valid values are: sky-2x4, sky-2x8 etc. Not applicable for the Serverless Analytics topology.

Example: sky-2x8
ssl_enabledbooleanOptional

Whether to enable SSL. Valid values are: true or false

Example: true
storageintegerOptional

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

Example: 100
tenancystring · enumOptionalPossible values:
topologystring · enumOptional

The topology of the service. Valid values are: sa, csdw, es-replica, es-single and xpand.

Example: standalonePossible values:
versionstringOptional

The service software versions. Not applicable for the Serverless Analytics topology.

Example: 10.6.7-3-1
volume_iopsintegerOptional

The service storage IOPS. This is only applicable for AWS

Example: 100
volume_throughputintegerOptional

The service storage throughput. This is only applicable for GP3(AWS) volume type.

volume_typestring · enumOptional

The volume type. Valid values are: gp2 and io1. This is only applicable for AWS.

Example: gp2Possible values:
Responses
202

Accepted

application/json
post
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
}

Retrieve Service Info

get

Retrieve the information and status of the specified service.

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Responses
200

OK

application/json
get
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
}

Delete Service

delete

Delete the specified service and its associated data.

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Responses
200

OK

No content
delete
DELETE /provisioning/v1/services/{service_id} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Update Service Config

post

Update the configuration of the specified service.

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Body

Config for a service

config_idstringOptional
Responses
202

Accepted

application/json
post
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"
}

Remove a Custom Config from a Service

delete

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

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Responses
202

Accepted

application/json
delete
DELETE /provisioning/v1/services/{service_id}/config HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "config_id": "text"
}

Creates Service Endpoints

post

Creates Service Endpoints

Authorizations
Path parameters
service_idstringRequired

Identifier for a services

Body
namestringRequired
Responses
202

Accepted

application/json
post
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"
  }
]

Modifies Service Endpoints

patch

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

Authorizations
Path parameters
service_idstringRequired

Identifier for a services

Bodyobject[]
allowed_accountsstring[]Optional

AllowedAccounts is the list of cloud accounts (aws account ids or gcp projects) that are allowed to access the service

mechanismstringOptional

Mechanism is the endpoint mechanism to use. Valid values are: privateconnect or nlb

private_linkall ofOptional

PrivateLink is the AWS PrivateLink configuration

private_service_connectall ofOptional

PrivateServiceConnect is the GCP Private Service Connect configuration

Responses
200

OK

application/json
patch
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"
  }
]

Deletes Service Endpoints

delete

Deletes Service Endpoints

Authorizations
Path parameters
service_idstringRequired

Identifier for a services

namestringRequired

Endpoint name

Responses
202

Accepted

application/json
delete
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"
  }
]

Set Service Maintenance Window

post

Set the maintenance window the service.

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Body
namestringOptional
Responses
200

OK

No content
post
POST /provisioning/v1/services/{service_id}/maintenance-window HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
No content

Update Service Nodes

post

Update the number of nodes for the specified service.

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Body

Update the number of nodes for a service

nodesintegerOptionalExample: 3
Responses
200

OK

application/json
post
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
}
Deprecated

Set Service Power State

post

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

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Body

Start/Stop Service

is_activebooleanOptional
Responses
200

OK

No content
post
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

List Replicas for a Service

get

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

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Responses
200

OK

application/json
get
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
  }
]

Update Replication on a Service

post

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

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Body

Enable replication for a service

primary_hoststringOptionalExample: db12345678
replication_typestring · enumOptionalExample: bi-directionalPossible values:
Responses
202

Accepted

application/json
post
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"
}

Delete Replication on a Service

delete

Disables replication for a specified service.

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Responses
200

OK

No content
delete
DELETE /provisioning/v1/services/{service_id}/replication HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Update Service Scale Options

put

Updates the serverless instance's scale options.

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Body
max_computeintegerOptional
min_computeintegerOptional
suspend_enabledbooleanOptional

Enable serverless suspension. Valid values: true or false. Defaults to true if not specified.

Responses
204

No Content

No content
put
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

Read Allowed Addresses

get

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

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Responses
200

OK

application/json
get
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"
  }
]

Add Allowed Address

post

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

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Body
ip_addressstringOptionalExample: 142.251.46.142/32
Responses
200

OK

application/json
post
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"
  }
]

Update Allowed Address

put

Update the allowlist for the specified service.

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Bodyobject[]
commentstringOptional
ipstringOptional
Responses
200

OK

application/json
put
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"
  }
]

Remove Allowed Address

delete

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

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Body
ip_addressstringOptionalExample: 142.251.46.142/32
Responses
200

OK

application/json
delete
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"
  }
]

Retrieve Default Credentials

get

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

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Responses
200

OK

application/json
get
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"
}

Check an IP's Access

post

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

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Body

Request to identify if an ip is whitelisted

ip_addressstringOptional
Responses
200

OK

application/json
post
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
}

Set SSL for a Service

patch

Enables or disables SSL for the specified service

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Body
ssl_enabledbooleanOptionalExample: true
Responses
200

OK

application/json
patch
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
}

Update Service Size

post

Update the node size of the specified service.

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Body

Nodes size for a service

sizestringOptionalExample: sky-2x8
Responses
202

Accepted

application/json
post
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"
}

Starts a stopped service

post

Starts a stopped service

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Responses
200

OK

No content
post
POST /provisioning/v1/services/{service_id}/start HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Stops a running service

post

Stops a running service

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Responses
200

OK

No content
post
POST /provisioning/v1/services/{service_id}/stop HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Set Service Storage

patch

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

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Body

Storage size and IOPS (AWS only) that is set for the service

iopsinteger · int64 · min: 3000 · max: 16000Optional

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.

Example: 5000
sizeinteger · int64 · min: 1Optional

Size in GBs

Example: 10
throughputinteger · int64 · min: 125 · max: 1000Optional

Throughput 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.

Example: 125
Responses
202

Accepted

application/json
patch
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
}
Deprecated

Set Service Storage

patch

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

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Body

Storage size and IOPS (AWS only) that is set for the service

iopsinteger · int64 · min: 3000 · max: 16000Optional

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.

Example: 5000
sizeinteger · int64 · min: 1Optional

Size in GBs

Example: 10
throughputinteger · int64 · min: 125 · max: 1000Optional

Throughput 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.

Example: 125
Responses
202

Accepted

application/json
patch
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
}
Deprecated

Set Service Storage

patch

Sets the storage size of the specified service.

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Body

Storage size and IOPS (AWS only) that is set for the service

iopsinteger · int64 · min: 3000 · max: 16000Optional

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.

Example: 5000
sizeinteger · int64 · min: 1Optional

Size in GBs

Example: 10
throughputinteger · int64 · min: 125 · max: 1000Optional

Throughput 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.

Example: 125
Responses
202

Accepted

application/json
patch
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
}

Update Service Tags

patch

Update the service tags.

Authorizations
Path parameters
service_idstringRequired

The ID for the service.

Body

Tags to be set for the service

Responses
204

No Content

No content
patch
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

Upgrade Kubernetes Version

post

Upgrade Kubernetes Version

Authorizations
Path parameters
service_idstringRequired

service id

Responses
204

No Content

No content
post
POST /provisioning/v1/services/{service_id}/upgrade/kubernetes_version HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

No content
PreviousOfferingNextCopilot

Was this helpful?