Create PlatformConfiguration
curl --request POST \
--url https://platform.kodexa.ai/api/platform-configurations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"aboutMarkdown": "<string>",
"changeLogArticleId": "<string>",
"cornerIcon": "<string>",
"platformDashboardRefs": "<string>",
"runBackgroundServices": true,
"settings": null,
"stylesheet": "<string>",
"welcomeMarkdown": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/platform-configurations"
payload = {
"aboutMarkdown": "<string>",
"changeLogArticleId": "<string>",
"cornerIcon": "<string>",
"platformDashboardRefs": "<string>",
"runBackgroundServices": True,
"settings": None,
"stylesheet": "<string>",
"welcomeMarkdown": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
aboutMarkdown: '<string>',
changeLogArticleId: '<string>',
cornerIcon: '<string>',
platformDashboardRefs: '<string>',
runBackgroundServices: true,
settings: null,
stylesheet: '<string>',
welcomeMarkdown: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/platform-configurations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.kodexa.ai/api/platform-configurations",
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([
'aboutMarkdown' => '<string>',
'changeLogArticleId' => '<string>',
'cornerIcon' => '<string>',
'platformDashboardRefs' => '<string>',
'runBackgroundServices' => true,
'settings' => null,
'stylesheet' => '<string>',
'welcomeMarkdown' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.kodexa.ai/api/platform-configurations"
payload := strings.NewReader("{\n \"aboutMarkdown\": \"<string>\",\n \"changeLogArticleId\": \"<string>\",\n \"cornerIcon\": \"<string>\",\n \"platformDashboardRefs\": \"<string>\",\n \"runBackgroundServices\": true,\n \"settings\": null,\n \"stylesheet\": \"<string>\",\n \"welcomeMarkdown\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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("https://platform.kodexa.ai/api/platform-configurations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"aboutMarkdown\": \"<string>\",\n \"changeLogArticleId\": \"<string>\",\n \"cornerIcon\": \"<string>\",\n \"platformDashboardRefs\": \"<string>\",\n \"runBackgroundServices\": true,\n \"settings\": null,\n \"stylesheet\": \"<string>\",\n \"welcomeMarkdown\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/platform-configurations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"aboutMarkdown\": \"<string>\",\n \"changeLogArticleId\": \"<string>\",\n \"cornerIcon\": \"<string>\",\n \"platformDashboardRefs\": \"<string>\",\n \"runBackgroundServices\": true,\n \"settings\": null,\n \"stylesheet\": \"<string>\",\n \"welcomeMarkdown\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"aboutMarkdown": "<string>",
"changeLogArticleId": "<string>",
"changeSequence": 123,
"cornerIcon": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"platformDashboardRefs": "<string>",
"runBackgroundServices": true,
"settings": null,
"stylesheet": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"welcomeMarkdown": "<string>"
}Platform Configuration
Create PlatformConfiguration
Creates a new PlatformConfiguration. Platform configurations store platform-wide settings and feature flags.
POST
/
api
/
platform-configurations
Create PlatformConfiguration
curl --request POST \
--url https://platform.kodexa.ai/api/platform-configurations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"aboutMarkdown": "<string>",
"changeLogArticleId": "<string>",
"cornerIcon": "<string>",
"platformDashboardRefs": "<string>",
"runBackgroundServices": true,
"settings": null,
"stylesheet": "<string>",
"welcomeMarkdown": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/platform-configurations"
payload = {
"aboutMarkdown": "<string>",
"changeLogArticleId": "<string>",
"cornerIcon": "<string>",
"platformDashboardRefs": "<string>",
"runBackgroundServices": True,
"settings": None,
"stylesheet": "<string>",
"welcomeMarkdown": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
aboutMarkdown: '<string>',
changeLogArticleId: '<string>',
cornerIcon: '<string>',
platformDashboardRefs: '<string>',
runBackgroundServices: true,
settings: null,
stylesheet: '<string>',
welcomeMarkdown: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/platform-configurations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.kodexa.ai/api/platform-configurations",
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([
'aboutMarkdown' => '<string>',
'changeLogArticleId' => '<string>',
'cornerIcon' => '<string>',
'platformDashboardRefs' => '<string>',
'runBackgroundServices' => true,
'settings' => null,
'stylesheet' => '<string>',
'welcomeMarkdown' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.kodexa.ai/api/platform-configurations"
payload := strings.NewReader("{\n \"aboutMarkdown\": \"<string>\",\n \"changeLogArticleId\": \"<string>\",\n \"cornerIcon\": \"<string>\",\n \"platformDashboardRefs\": \"<string>\",\n \"runBackgroundServices\": true,\n \"settings\": null,\n \"stylesheet\": \"<string>\",\n \"welcomeMarkdown\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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("https://platform.kodexa.ai/api/platform-configurations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"aboutMarkdown\": \"<string>\",\n \"changeLogArticleId\": \"<string>\",\n \"cornerIcon\": \"<string>\",\n \"platformDashboardRefs\": \"<string>\",\n \"runBackgroundServices\": true,\n \"settings\": null,\n \"stylesheet\": \"<string>\",\n \"welcomeMarkdown\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/platform-configurations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"aboutMarkdown\": \"<string>\",\n \"changeLogArticleId\": \"<string>\",\n \"cornerIcon\": \"<string>\",\n \"platformDashboardRefs\": \"<string>\",\n \"runBackgroundServices\": true,\n \"settings\": null,\n \"stylesheet\": \"<string>\",\n \"welcomeMarkdown\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"aboutMarkdown": "<string>",
"changeLogArticleId": "<string>",
"changeSequence": 123,
"cornerIcon": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"platformDashboardRefs": "<string>",
"runBackgroundServices": true,
"settings": null,
"stylesheet": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"welcomeMarkdown": "<string>"
}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Body
application/json
Response
Created PlatformConfiguration
Platform configuration stores platform-wide settings and feature flags.