Create Config Definition
curl --request POST \
--url http://localhost:8000/api/v1/config_definition/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"config_definition_key": "app_config",
"indexes": [
"setting_object.first_key"
],
"json_schema": {
"properties": {
"setting_string": {
"type": "string"
},
"setting_object": {
"properties": {
"first_key": {
"type": "string"
},
"second_key": {
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"setting_string",
"setting_object"
],
"type": "object"
}
}
'import requests
url = "http://localhost:8000/api/v1/config_definition/"
payload = {
"config_definition_key": "app_config",
"indexes": ["setting_object.first_key"],
"json_schema": {
"properties": {
"setting_string": { "type": "string" },
"setting_object": {
"properties": {
"first_key": { "type": "string" },
"second_key": { "type": "integer" }
},
"type": "object"
}
},
"required": ["setting_string", "setting_object"],
"type": "object"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
config_definition_key: 'app_config',
indexes: ['setting_object.first_key'],
json_schema: {
properties: {
setting_string: {type: 'string'},
setting_object: {
properties: {first_key: {type: 'string'}, second_key: {type: 'integer'}},
type: 'object'
}
},
required: ['setting_string', 'setting_object'],
type: 'object'
}
})
};
fetch('http://localhost:8000/api/v1/config_definition/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/api/v1/config_definition/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'config_definition_key' => 'app_config',
'indexes' => [
'setting_object.first_key'
],
'json_schema' => [
'properties' => [
'setting_string' => [
'type' => 'string'
],
'setting_object' => [
'properties' => [
'first_key' => [
'type' => 'string'
],
'second_key' => [
'type' => 'integer'
]
],
'type' => 'object'
]
],
'required' => [
'setting_string',
'setting_object'
],
'type' => 'object'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8000/api/v1/config_definition/"
payload := strings.NewReader("{\n \"config_definition_key\": \"app_config\",\n \"indexes\": [\n \"setting_object.first_key\"\n ],\n \"json_schema\": {\n \"properties\": {\n \"setting_string\": {\n \"type\": \"string\"\n },\n \"setting_object\": {\n \"properties\": {\n \"first_key\": {\n \"type\": \"string\"\n },\n \"second_key\": {\n \"type\": \"integer\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"setting_string\",\n \"setting_object\"\n ],\n \"type\": \"object\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8000/api/v1/config_definition/")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"config_definition_key\": \"app_config\",\n \"indexes\": [\n \"setting_object.first_key\"\n ],\n \"json_schema\": {\n \"properties\": {\n \"setting_string\": {\n \"type\": \"string\"\n },\n \"setting_object\": {\n \"properties\": {\n \"first_key\": {\n \"type\": \"string\"\n },\n \"second_key\": {\n \"type\": \"integer\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"setting_string\",\n \"setting_object\"\n ],\n \"type\": \"object\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/api/v1/config_definition/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config_definition_key\": \"app_config\",\n \"indexes\": [\n \"setting_object.first_key\"\n ],\n \"json_schema\": {\n \"properties\": {\n \"setting_string\": {\n \"type\": \"string\"\n },\n \"setting_object\": {\n \"properties\": {\n \"first_key\": {\n \"type\": \"string\"\n },\n \"second_key\": {\n \"type\": \"integer\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"setting_string\",\n \"setting_object\"\n ],\n \"type\": \"object\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"config_definition_key": "app_config",
"indexes": [
"setting_object.first_key"
],
"json_schema": {
"properties": {
"setting_string": {
"type": "string"
},
"setting_object": {
"properties": {
"first_key": {
"type": "string"
},
"second_key": {
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"setting_string",
"setting_object"
],
"type": "object"
}
},
"status": "SUCCESS",
"message": "<string>",
"errors": "<unknown>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Config Definition
Create Config Definition
POST
/
api
/
v1
/
config_definition
/
Create Config Definition
curl --request POST \
--url http://localhost:8000/api/v1/config_definition/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"config_definition_key": "app_config",
"indexes": [
"setting_object.first_key"
],
"json_schema": {
"properties": {
"setting_string": {
"type": "string"
},
"setting_object": {
"properties": {
"first_key": {
"type": "string"
},
"second_key": {
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"setting_string",
"setting_object"
],
"type": "object"
}
}
'import requests
url = "http://localhost:8000/api/v1/config_definition/"
payload = {
"config_definition_key": "app_config",
"indexes": ["setting_object.first_key"],
"json_schema": {
"properties": {
"setting_string": { "type": "string" },
"setting_object": {
"properties": {
"first_key": { "type": "string" },
"second_key": { "type": "integer" }
},
"type": "object"
}
},
"required": ["setting_string", "setting_object"],
"type": "object"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
config_definition_key: 'app_config',
indexes: ['setting_object.first_key'],
json_schema: {
properties: {
setting_string: {type: 'string'},
setting_object: {
properties: {first_key: {type: 'string'}, second_key: {type: 'integer'}},
type: 'object'
}
},
required: ['setting_string', 'setting_object'],
type: 'object'
}
})
};
fetch('http://localhost:8000/api/v1/config_definition/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/api/v1/config_definition/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'config_definition_key' => 'app_config',
'indexes' => [
'setting_object.first_key'
],
'json_schema' => [
'properties' => [
'setting_string' => [
'type' => 'string'
],
'setting_object' => [
'properties' => [
'first_key' => [
'type' => 'string'
],
'second_key' => [
'type' => 'integer'
]
],
'type' => 'object'
]
],
'required' => [
'setting_string',
'setting_object'
],
'type' => 'object'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8000/api/v1/config_definition/"
payload := strings.NewReader("{\n \"config_definition_key\": \"app_config\",\n \"indexes\": [\n \"setting_object.first_key\"\n ],\n \"json_schema\": {\n \"properties\": {\n \"setting_string\": {\n \"type\": \"string\"\n },\n \"setting_object\": {\n \"properties\": {\n \"first_key\": {\n \"type\": \"string\"\n },\n \"second_key\": {\n \"type\": \"integer\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"setting_string\",\n \"setting_object\"\n ],\n \"type\": \"object\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8000/api/v1/config_definition/")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"config_definition_key\": \"app_config\",\n \"indexes\": [\n \"setting_object.first_key\"\n ],\n \"json_schema\": {\n \"properties\": {\n \"setting_string\": {\n \"type\": \"string\"\n },\n \"setting_object\": {\n \"properties\": {\n \"first_key\": {\n \"type\": \"string\"\n },\n \"second_key\": {\n \"type\": \"integer\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"setting_string\",\n \"setting_object\"\n ],\n \"type\": \"object\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/api/v1/config_definition/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config_definition_key\": \"app_config\",\n \"indexes\": [\n \"setting_object.first_key\"\n ],\n \"json_schema\": {\n \"properties\": {\n \"setting_string\": {\n \"type\": \"string\"\n },\n \"setting_object\": {\n \"properties\": {\n \"first_key\": {\n \"type\": \"string\"\n },\n \"second_key\": {\n \"type\": \"integer\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"setting_string\",\n \"setting_object\"\n ],\n \"type\": \"object\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"config_definition_key": "app_config",
"indexes": [
"setting_object.first_key"
],
"json_schema": {
"properties": {
"setting_string": {
"type": "string"
},
"setting_object": {
"properties": {
"first_key": {
"type": "string"
},
"second_key": {
"type": "integer"
}
},
"type": "object"
}
},
"required": [
"setting_string",
"setting_object"
],
"type": "object"
}
},
"status": "SUCCESS",
"message": "<string>",
"errors": "<unknown>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Represents a new configuration definition to be created in the internal table.
Response
Successful Response
Represents the response for the create configuration definition request.
Represents a new configuration definition to be created in the internal table.
Show child attributes
Show child attributes
Example:
{
"config_definition_key": "app_config",
"indexes": ["setting_object.first_key"],
"json_schema": {
"properties": {
"setting_string": { "type": "string" },
"setting_object": {
"properties": {
"first_key": { "type": "string" },
"second_key": { "type": "integer" }
},
"type": "object"
}
},
"required": ["setting_string", "setting_object"],
"type": "object"
}
}
The status of the response.
Available options:
SUCCESS, FAILURE The message for the response.
The errors for the response.
⌘I