API ReferencePlatform

Globals

The site’s configuration settings, read one key at a time or all together.

Prefix /cdna-api/globals GuideConfiguration and secrets per environment GuideGlobal Settings
Globals in Postman

About globals

Settings belong to a module and can differ per site. These routes return the value the platform resolves for the current site and user. A protected setting, and every setting of a restricted module, comes back as ***.

Scope Site and user

The value is the one that applies to the current site and the signed-in user.

Configuration and secrets per environment
Writes No

The API only reads settings; they are changed in the admin or per environment.

Global Settings

Read a setting#

GET /cdna-api/globals/config/{key}

Reads one setting for the current site and user. The value comes back as stored: a string, a number, a list or an object.

Access
Admin users and integrations, with an OAuth access token or an API key.
Returns
The value under data.value.

Parameters

keypathrequired
string
The setting’s key: the module name, a dot, then the setting’s path, such as Globals.i18n.dateFormat.

Example

Read a setting 
GET /cdna-api/globals/config/Globals.i18n.dateFormat HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Response 200 OK 
{
  "result": "success",
  "data": {
    "value": "d/m/Y"
  }
}
Open in Postman docs Real response from this documentation site

Read every setting#

GET /cdna-api/globals/config

Returns every public setting, grouped by module. It is slow: use it while developing, not in a live integration.

Access
Admin users and integrations, with an OAuth access token or an API key.
Returns
Every module’s public settings under data.value, keyed by module name.

Example

Read every setting 
GET /cdna-api/globals/config HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Open in Postman docs