Config

List Custom Configs

get

Retrieve a list of custom configurations (Configuration Manager) available to the user/team.

Authorizations

BearerAuth

X-API-KeystringRequired

Query parameters

page_sizeinteger · min: 1 · max: 100Optional

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

page_orderstring · enumOptional

The sort order (ascending or descending) for results.

Possible values:

page_tokenstringOptional

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

include_defaultbooleanOptional

include_default

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/provisioning/v1/configs

HTTPcURLJavaScriptPython

GET /provisioning/v1/configs HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "created_by": "text",
    "created_date": 1,
    "id": "text",
    "name": "text",
    "public": true,
    "services": [
      "text"
    ],
    "topology_id": "text",
    "updated_by": "text",
    "updated_date": 1,
    "version_id": "text"
  }
]

Create Custom Config

post

Create a custom configuration (Configuration Manager) available to the user/team.

Authorizations

BearerAuth

X-API-KeystringRequired

Body

application/json

namestringOptional

topology_idstringOptional

version_idstringOptional

Responses

202

Accepted

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

/provisioning/v1/configs

HTTPcURLJavaScriptPython

POST /provisioning/v1/configs HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "name": "text",
  "topology_id": "text",
  "version_id": "text"
}

{
  "created_by": "text",
  "created_date": 1,
  "id": "text",
  "name": "text",
  "public": true,
  "services": [
    "text"
  ],
  "topology_id": "text",
  "updated_by": "text",
  "updated_date": 1,
  "version_id": "text"
}

Read Custom Config

get

Retrieve a custom configuration (Configuration Manager) and its values.

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

config_idstringRequired

Config ID

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

get

/provisioning/v1/configs/{config_id}

HTTPcURLJavaScriptPython

GET /provisioning/v1/configs/{config_id} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "created_by": "text",
  "created_date": 1,
  "id": "text",
  "name": "text",
  "public": true,
  "services": [
    "text"
  ],
  "topology_id": "text",
  "updated_by": "text",
  "updated_date": 1,
  "version_id": "text"
}

Delete Custom Config

delete

Delete the specified custom configuration (Configuration Manager) and its associated data.

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

config_idstringRequired

Config ID

Responses

200

OK

No content

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

/provisioning/v1/configs/{config_id}

HTTPcURLJavaScriptPython

DELETE /provisioning/v1/configs/{config_id} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Update a config

patch

Update the name of a custom configuration

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

config_idstringRequired

Config ID

Body

application/json

namestringOptional

Responses

204

No Content

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

patch

/provisioning/v1/configs/{config_id}

HTTPcURLJavaScriptPython

PATCH /provisioning/v1/configs/{config_id} 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

Get Config Values

get

Retrieve the selected values for the given configuration ID.

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

config_idstringRequired

Config ID

Responses

202

Accepted

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/provisioning/v1/configs/{config_id}/values

HTTPcURLJavaScriptPython

GET /provisioning/v1/configs/{config_id}/values HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "config_key_id": "text",
    "selected_values": [
      "text"
    ]
  }
]

Batch Update Config Values

put

Set the selected values for a configuration.

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

config_idstringRequired

Config ID

Bodyobject[]

application/json

config_key_idstringOptional

selected_valuesstring[]Optional

Responses

202

Accepted

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

put

/provisioning/v1/configs/{config_id}/values

HTTPcURLJavaScriptPython

PUT /provisioning/v1/configs/{config_id}/values HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 53

[
  {
    "config_key_id": "text",
    "selected_values": [
      "text"
    ]
  }
]

[
  {
    "config_key_id": "text",
    "selected_values": [
      "text"
    ]
  }
]

Set Config Value

post

Set a configuration variables value by variable name.

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

config_idstringRequired

Config ID

variable_namestringRequired

Variable name

Body

application/json

valuestringOptional

Responses

204

No Content

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/provisioning/v1/configs/{config_id}/values/{variable_name}

HTTPcURLJavaScriptPython

POST /provisioning/v1/configs/{config_id}/values/{variable_name} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "value": "text"
}

No content

Unset Config Value

delete

Unset a configuration variables value by variable name.

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

config_idstringRequired

Config ID

variable_namestringRequired

Variable name

Responses

204

No Content

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

delete

/provisioning/v1/configs/{config_id}/values/{variable_name}

HTTPcURLJavaScriptPython

DELETE /provisioning/v1/configs/{config_id}/values/{variable_name} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Read Topology Configuration Manager Parameters

get

Retrieve a list of available configuration parameters and values (Configuration Manager) for the specified topology.

Authorizations

BearerAuth

X-API-KeystringRequired

Path parameters

topology_namestringRequired

The topology whose configuration parameters and values will be retrieved.

Query parameters

versionstringOptional

Version of MariaDB to filter on.

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

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/provisioning/v1/topologies/{topology_name}/configs

HTTPcURLJavaScriptPython

GET /provisioning/v1/topologies/{topology_name}/configs HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "allowed_values": [
      "text"
    ],
    "component": "server",
    "config_section": "text",
    "default_value": [
      "text"
    ],
    "documentation_url": "text",
    "flags": 1,
    "id": "text",
    "maximum_value": "text",
    "minimum_value": "text",
    "multiselect": true,
    "name": "text",
    "readonly": true,
    "requires_restart": true,
    "tags": [
      "text"
    ]
  }
]