Create Config

curl --request POST \
  --url http://localhost:8000/api/v1/config_definition/{config_definition_key}/config/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config_key": "qreate",
  "data": {
    "setting_object": {
      "first_key": "value",
      "second_key": 1
    },
    "setting_string": "value"
  }
}
'

import requests

url = "http://localhost:8000/api/v1/config_definition/{config_definition_key}/config/"

payload = {
    "config_key": "qreate",
    "data": {
        "setting_object": {
            "first_key": "value",
            "second_key": 1
        },
        "setting_string": "value"
    }
}
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_key: 'qreate',
    data: {setting_object: {first_key: 'value', second_key: 1}, setting_string: 'value'}
  })
};

fetch('http://localhost:8000/api/v1/config_definition/{config_definition_key}/config/', 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/{config_definition_key}/config/",
  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_key' => 'qreate',
    'data' => [
        'setting_object' => [
                'first_key' => 'value',
                'second_key' => 1
        ],
        'setting_string' => 'value'
    ]
  ]),
  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/{config_definition_key}/config/"

	payload := strings.NewReader("{\n  \"config_key\": \"qreate\",\n  \"data\": {\n    \"setting_object\": {\n      \"first_key\": \"value\",\n      \"second_key\": 1\n    },\n    \"setting_string\": \"value\"\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/{config_definition_key}/config/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config_key\": \"qreate\",\n  \"data\": {\n    \"setting_object\": {\n      \"first_key\": \"value\",\n      \"second_key\": 1\n    },\n    \"setting_string\": \"value\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8000/api/v1/config_definition/{config_definition_key}/config/")

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_key\": \"qreate\",\n  \"data\": {\n    \"setting_object\": {\n      \"first_key\": \"value\",\n      \"second_key\": 1\n    },\n    \"setting_string\": \"value\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {},
  "status": "SUCCESS",
  "message": "<string>",
  "errors": "<unknown>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

api

config_definition

{config_definition_key}

config

Create Config

curl --request POST \
  --url http://localhost:8000/api/v1/config_definition/{config_definition_key}/config/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config_key": "qreate",
  "data": {
    "setting_object": {
      "first_key": "value",
      "second_key": 1
    },
    "setting_string": "value"
  }
}
'

import requests

url = "http://localhost:8000/api/v1/config_definition/{config_definition_key}/config/"

payload = {
    "config_key": "qreate",
    "data": {
        "setting_object": {
            "first_key": "value",
            "second_key": 1
        },
        "setting_string": "value"
    }
}
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_key: 'qreate',
    data: {setting_object: {first_key: 'value', second_key: 1}, setting_string: 'value'}
  })
};

fetch('http://localhost:8000/api/v1/config_definition/{config_definition_key}/config/', 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/{config_definition_key}/config/",
  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_key' => 'qreate',
    'data' => [
        'setting_object' => [
                'first_key' => 'value',
                'second_key' => 1
        ],
        'setting_string' => 'value'
    ]
  ]),
  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/{config_definition_key}/config/"

	payload := strings.NewReader("{\n  \"config_key\": \"qreate\",\n  \"data\": {\n    \"setting_object\": {\n      \"first_key\": \"value\",\n      \"second_key\": 1\n    },\n    \"setting_string\": \"value\"\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/{config_definition_key}/config/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config_key\": \"qreate\",\n  \"data\": {\n    \"setting_object\": {\n      \"first_key\": \"value\",\n      \"second_key\": 1\n    },\n    \"setting_string\": \"value\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8000/api/v1/config_definition/{config_definition_key}/config/")

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_key\": \"qreate\",\n  \"data\": {\n    \"setting_object\": {\n      \"first_key\": \"value\",\n      \"second_key\": 1\n    },\n    \"setting_string\": \"value\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {},
  "status": "SUCCESS",
  "message": "<string>",
  "errors": "<unknown>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

config_definition_key

string

required

Body

application/json

Represents the configuration.

data

Data · object

required

The data for the configuration.

config_key

string

required

The unique identifier for the config.

Response

Successful Response

Represents the response for creating a configuration.

data

Data · object

required

status

enum<string>

default:SUCCESS

The status of the response.

Available options:

SUCCESS,

FAILURE

message

string | null

The message for the response.

errors

any | null

The errors for the response.

List Configs Get Config

API Documentation

Config Definition

Config

API Reference

Create Config

Authorizations

Path Parameters

Body

Response