Config
Retrieve a list of custom configurations (Configuration Manager) available to the user/team.
The maximum number (limit) of results to fetch per page.
The sort order (ascending or descending) for results.
When iterating through results, retrieve the page with the specified token.
include_default
OK
Bad Request
Unauthorized
Internal Server Error
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 a custom configuration (Configuration Manager) available to the user/team.
Accepted
Bad Request
Unauthorized
Internal Server Error
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"
}Retrieve a custom configuration (Configuration Manager) and its values.
Config ID
OK
Bad Request
Unauthorized
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 the specified custom configuration (Configuration Manager) and its associated data.
Config ID
OK
No content
Bad Request
Unauthorized
Not Found
Internal Server Error
DELETE /provisioning/v1/configs/{config_id} HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*
No content
Update the name of a custom configuration
Config ID
No Content
No content
Bad Request
Unauthorized
Not Found
Internal Server Error
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
Retrieve the selected values for the given configuration ID.
Config ID
Accepted
Bad Request
Unauthorized
Not Found
Internal Server Error
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"
]
}
]Set the selected values for a configuration.
Config ID
Accepted
Bad Request
Unauthorized
Not Found
Internal Server Error
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 a configuration variables value by variable name.
Config ID
Variable name
No Content
No content
Bad Request
Unauthorized
Not Found
Internal Server Error
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 a configuration variables value by variable name.
Config ID
Variable name
No Content
No content
Bad Request
Unauthorized
Not Found
Internal Server Error
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
Retrieve a list of available configuration parameters and values (Configuration Manager) for the specified topology.
The topology whose configuration parameters and values will be retrieved.
Version of MariaDB to filter on.
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}/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"
]
}
]Was this helpful?