Skip to content
API Reference/
/
Set Platform Configuratio...

ibl-data-manager (4.84.1-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server
https://docs.ibl.ai/_mock/apis/ibl/
https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

analytics

Operations

career

Operations

catalog

Operations

core

Operations

List Platform Configurations

Request

Get all configuration values for a platform with proper type casting.

Security
PlatformApiKeyAuthentication
Query
platform_keystringnon-emptyrequired

Platform key to get/set configurations for

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/core/platform/configurations/?platform_key=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
platform_keystringread-onlyrequired
configurationsobjectread-onlyrequired

Dictionary of configuration key-value pairs with proper type casting

configurations.​property name*anyadditional property
countintegerread-onlyrequired

Number of configurations returned

]
Response
application/json
[
  {
    "platform_key": "string",
    "configurations": { … },
    "count": 0
  }
]

Set Platform Configurations

Request

Set or update multiple platform configuration values.Values will be automatically normalized for storage and cast appropriately on retrieval.

Security
PlatformApiKeyAuthentication
Body
required
platform_keystringwrite-onlyrequired

Platform key to set configurations for

configurationsArray of objects(ConfigurationItem)required

List of configurations to set

configurations[].​keystring<= 255 charactersrequired

Configuration key

configurations[].​valueanyrequired

Configuration value stored as JSON

configurations[].​descriptionstring

Optional description for the configuration

Default ""
configurations[].​is_publicboolean

If True, this configuration will be visible to platform members

Default false
curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/core/platform/configurations/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "platform_key": "string",
    "configurations": [
      {
        "key": "string",
        "value": null,
        "description": "",
        "is_public": false
      }
    ]
  }'

Responses

Bodyapplication/json
platform_keystringread-onlyrequired
resultsArray of objectsread-onlyrequired

Results for each configuration item

results[].​property name*anyadditional property
total_setintegerread-onlyrequired

Total number of configurations set

Response
application/json
{
  "platform_key": "string",
  "results": [
    { … }
  ],
  "total_set": 0
}

core_platform_configurations_available_settings_retrieve

Request

Get all available settings that can be configured with current platform values

Security
PlatformApiKeyAuthentication
curl -i -X GET \
  https://docs.ibl.ai/_mock/apis/ibl/api/core/platform/configurations/available-settings/ \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
platform_keystringread-onlyrequired
configurationsobjectread-onlyrequired

Dictionary of configuration key-value pairs with proper type casting

configurations.​property name*anyadditional property
countintegerread-onlyrequired

Number of configurations returned

Response
application/json
{
  "platform_key": "string",
  "configurations": {
    "property1": null,
    "property2": null
  },
  "count": 0
}

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com