Get Config Definition

curl --request GET \
  --url http://localhost:8000/api/v1/config_definition/{config_definition_key} \
  --header 'Authorization: <api-key>'

import requests

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

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('http://localhost:8000/api/v1/config_definition/{config_definition_key}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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>"
    }
  ]
}

GET

api

config_definition

{config_definition_key}

Get Config Definition

curl --request GET \
  --url http://localhost:8000/api/v1/config_definition/{config_definition_key} \
  --header 'Authorization: <api-key>'

import requests

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

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('http://localhost:8000/api/v1/config_definition/{config_definition_key}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

Authorization

string

header

required

Path Parameters

config_definition_key

string

required

Response

Successful Response

Represents the response for getting a configuration definition.

data

ConfigDefinitionRetrievable · object

required

Represents the configuration definition with the key.

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"
  }
}

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.

Create Config Definition Update Config Definition

API Documentation

Config Definition

Config

API Reference

Get Config Definition

Authorizations

Path Parameters

Response