Skip to main content
GET
/
api
/
platform-configurations
/
{id}
Get PlatformConfiguration by ID
curl --request GET \
  --url https://platform.kodexa.ai/api/platform-configurations/{id} \
  --header 'x-api-key: <api-key>'
{
  "aboutMarkdown": "<string>",
  "changeLogArticleId": "<string>",
  "changeSequence": 123,
  "cornerIcon": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "platformDashboardRefs": "<string>",
  "runBackgroundServices": true,
  "settings": {},
  "stylesheet": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "welcomeMarkdown": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

Response

The PlatformConfiguration

Platform configuration stores platform-wide settings and feature flags.

​
aboutMarkdown
string
​
changeLogArticleId
string
​
changeSequence
integer<int32>
​
cornerIcon
string
​
createdOn
string<date-time>
​
id
string
​
platformDashboardRefs
string
​
runBackgroundServices
boolean | null
​
settings
object
​
stylesheet
string
​
updatedOn
string<date-time>
​
uuid
string
​
welcomeMarkdown
string