List all configurations

GET

/api/admin/config

const url = 'https://example.com/api/admin/config';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url https://example.com/api/admin/config \
  --header 'Authorization: Bearer <token>'

Retrieves all repository configurations

Authorizations

bearerAuth

Responses

200

Configurations retrieved successfully

application/json

object

count

Total number of repositories

number

items

required

Array of repositories

Array<object>

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

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