Update a configuration

POST

/api/admin/config/{id}

const url = 'https://example.com/api/admin/config/example';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"TYPES":"Article,Page,Asset","SECURITY":{"contributors":["example"],"maintainers":["example"],"viewers":["example"]},"IS_PUBLIC":false,"ENABLE_GRAPHQL":true,"GENERATE_EMBEDDINGS":false,"CACHE_INDEX_FIELDS":["example"],"ai":{"default_settings":{"CONTEXT_DOCUMENT_NUMBER":"example","RELEVANT_DOCUMENT_RETURN_FIELDS":["example"],"HISTORY_RECENT_NUMBER":"example","HISTORY_RELEVANT_NUMBER":"example","EMBED_CHUNK_SIZE":"example","EMBED_CHUNK_OVERLAP":"example"}},"CUSTOM_FIELDS":{"additionalProperty":"example"},"SYNONYMS":{"additionalProperty":"example"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/admin/config/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "TYPES": "Article,Page,Asset", "SECURITY": { "contributors": [ "example" ], "maintainers": [ "example" ], "viewers": [ "example" ] }, "IS_PUBLIC": false, "ENABLE_GRAPHQL": true, "GENERATE_EMBEDDINGS": false, "CACHE_INDEX_FIELDS": [ "example" ], "ai": { "default_settings": { "CONTEXT_DOCUMENT_NUMBER": "example", "RELEVANT_DOCUMENT_RETURN_FIELDS": [ "example" ], "HISTORY_RECENT_NUMBER": "example", "HISTORY_RELEVANT_NUMBER": "example", "EMBED_CHUNK_SIZE": "example", "EMBED_CHUNK_OVERLAP": "example" } }, "CUSTOM_FIELDS": { "additionalProperty": "example" }, "SYNONYMS": { "additionalProperty": "example" } }'

Updates an existing repository configuration

Authorizations

bearerAuth

Parameters

Path Parameters

required

Configuration ID

string

Request Body

application/json

object

TYPES

Comma-separated list of content types

string

Example

Article,Page,Asset

SECURITY

Security configuration

object

contributors

Contributor roles/users

Array<string>

maintainers

Maintainer roles/users

Array<string>

viewers

Viewer roles/users

Array<string>

IS_PUBLIC

Whether repository allows public access to published content

boolean

Example

false

ENABLE_GRAPHQL

Whether GraphQL API is enabled

boolean

Example

true

GENERATE_EMBEDDINGS

Whether to generate AI embeddings for content

boolean

Example

false

CACHE_INDEX_FIELDS

Additional fields to index for search

Array<string>

AI/embedding settings

object

default_settings

object

CONTEXT_DOCUMENT_NUMBER

string

RELEVANT_DOCUMENT_RETURN_FIELDS

Array<string>

HISTORY_RECENT_NUMBER

string

HISTORY_RELEVANT_NUMBER

string

EMBED_CHUNK_SIZE

string

EMBED_CHUNK_OVERLAP

string

CUSTOM_FIELDS

Custom field mappings

object

key

additional properties

SYNONYMS

Search synonyms configuration

object

key

additional properties

Responses

200

Configuration updated successfully

application/json

object

required

Repository ID

string

CACHE_ROOT

required

Repository namespace/name used as Redis key prefix

string

TYPES

Comma-separated list of content types

string

SECURITY

Repository security configuration

object

contributors

Contributor roles/users

Array<string>

maintainers

Maintainer roles/users

Array<string>

viewers

Viewer roles/users

Array<string>

storage

Storage configuration

object

bucketName

Storage bucket name

string

provider

Storage provider (e.g., oci, s3, azure)

string

IS_PUBLIC

Whether repository allows public access

boolean

ENABLE_GRAPHQL

Whether GraphQL API is enabled

boolean

GENERATE_EMBEDDINGS

Whether to generate AI embeddings

boolean

CACHE_INDEX_FIELDS

Additional fields to index

Array<string>

AI/embedding settings

object

default_settings

object

CONTEXT_DOCUMENT_NUMBER

Number of context documents for AI

string

RELEVANT_DOCUMENT_RETURN_FIELDS

Fields to return for relevant documents

Array<string>

HISTORY_RECENT_NUMBER

Number of recent history items

string

HISTORY_RELEVANT_NUMBER

Number of relevant history items

string

EMBED_CHUNK_SIZE

Chunk size for embeddings

string

EMBED_CHUNK_OVERLAP

Chunk overlap for embeddings

string

CUSTOM_FIELDS

Custom field mappings

object

key

additional properties

SYNONYMS

Search synonyms configuration

object

key

additional properties

OCE_BASE_URL

Oracle Content URL (legacy)

string

AZURE_BASE_URL

Azure base URL (legacy)

string

IDCS_URL

IDCS URL for auth (legacy)

string

AUTH_SCOPE

OAuth scope (legacy)

string

Example

{
  "id": "repo-123",
  "CACHE_ROOT": "my-repository",
  "TYPES": "Article,Page,Asset",
  "IS_PUBLIC": false,
  "ENABLE_GRAPHQL": true,
  "GENERATE_EMBEDDINGS": false
}