/o/configs

Endpoint

/o/configs

Overview

Returns the current global configuration set visible to the dashboard, excluding internal services namespace.

Authentication

Countly API supports three authentication methods:

1. API Key (parameter): api_key=YOUR_API_KEY
2. Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
3. Auth Token (header): countly-token: YOUR_AUTH_TOKEN

Permissions

• Required permission: App Admin.

Request Parameters

Parameter	Type	Required	Description
api_key	String	Yes (or use auth_token)	API key for authentication.
auth_token	String	No	Auth token as query parameter or countly-token header.
app_id	String	Yes	Target app ID required by app-admin validation.

Response

Success Response

{
  "api": {
    "country_data": true,
    "city_data": true
  },
  "frontend": {
    "session_timeout": 30
  },
  "drill": {
    "record_meta": true
  }
}

Response Fields

Field	Type	Description
(root)	Object	Raw object containing visible configuration namespaces.
{namespace}	Object	Namespace-level effective configuration.
{namespace}.{setting}	Varies	Effective setting value.

Error Responses

400 Bad Request

{
  "result": "No app_id provided"
}

400 Bad Request

{
  "result": "Missing parameter \"api_key\" or \"auth_token\""
}

400 Bad Request

{
  "result": "Token not valid"
}

401 Unauthorized

{
  "result": "User does not exist"
}

401 Unauthorized

{
  "result": "User does not have right"
}

401 Unauthorized

{
  "result": "User is locked"
}

401 Unauthorized

{
  "result": "Token is invalid"
}

Behavior/Processing

• Validates app-admin access.
• Loads current global configuration set from server runtime.
• Returns full configuration payload as a JSON object.
• Removes services from the response before returning data.

Database Collections

Collection	Used for	Data touched by this endpoint
countly.members	App-admin validation	Reads authenticated user and app-admin permissions.
countly.apps	App scope validation	Validates provided app_id during app-admin checks.
countly.plugins	Stores global feature/config namespace data	Reads _id: "plugins" document to build effective response payload.

Examples

Read global configuration for an app-admin context

/o/configs?api_key=YOUR_API_KEY&app_id=YOUR_APP_ID

Limitations

• app_id is required for this endpoint's permission validator.
• Internal/hidden namespaces are not returned.

Related Endpoints

• Features - Global Config Update
• Features - User Config Update

Last Updated

2026-02-17