List Config Definition

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

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

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 => "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/"

	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/")

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": {
    "results": [
      {
        "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"
        }
      }
    ],
    "meta": {
      "page": 123,
      "limit": 123,
      "total": 123
    }
  },
  "status": "SUCCESS",
  "message": "<string>",
  "errors": "<unknown>"
}

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

GET

api

config_definition

List Config Definition

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

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

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 => "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/"

	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/")

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": {
    "results": [
      {
        "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"
        }
      }
    ],
    "meta": {
      "page": 123,
      "limit": 123,
      "total": 123
    }
  },
  "status": "SUCCESS",
  "message": "<string>",
  "errors": "<unknown>"
}

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

Authorizations

Authorization

string

header

required

Query Parameters

page

integer

default:1

limit

integer

default:10

sort_by

string

default:modified_at

sort_order

string

default:desc

string

Response

Successful Response

Represents the response for listing configuration definitions.

data

ListData[ConfigDefinitionRetrievable] · object

required

Show child attributes

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.

Config Create Config Definition

API Documentation

Config Definition

Config

API Reference

List Config Definition

Authorizations

Query Parameters

Response