Skip to main content

/o/apps/plugins

Endpoint​

/o/apps/plugins

Overview​

Return app-level plugin configuration either as a full plugin map or a single plugin entry.

Authentication​

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions​

  • Global admin permission is required.

Request Parameters​

ParameterTypeRequiredDescription
api_keyStringYes (or use auth_token)Dashboard API authentication key.
auth_tokenStringYes (or use api_key)Dashboard auth token.
app_idStringYesTarget app ID.
nameStringNoPlugin name filter.

Examples​

Example 1: Read all plugin configs​

/o/apps/plugins?api_key=YOUR_API_KEY&app_id=64b0ac10c2c3ce0012dd1001

Example 2: Read one plugin config​

/o/apps/plugins?api_key=YOUR_API_KEY&app_id=64b0ac10c2c3ce0012dd1001&name=push

Response​

Success Response​

Full map response:

{
  "plugins": {
    "push": {
      "gateway": "fcm"
    },
    "ab-testing": {
      "enabled": true
    }
  }
}

Single plugin response:

{
  "plugins": {
    "push": {
      "gateway": "fcm"
    }
  }
}

Response Fields​

FieldTypeDescription
pluginsObjectApp plugin configuration object.
plugins.[pluginName]ObjectConfiguration for each plugin key.

Error Responses​

Status Code: 400 Bad Request

{
  "result": "Error: Validation error details"
}

Status Code: 400 Bad Request

{
  "result": "Error getting app plugins:"
}

Behavior​

Behavior Modes​

ModeTriggerProcessing PathResponse Shape
Full config readname is missingReturns full app.plugins object for app.Raw object { plugins: {...} }
Single config readname exists and target plugin key existsReturns one plugin key/value under plugins.Raw object { plugins: { name: {...} } }
Name fallbackname provided but plugin key does not existFalls back to full app.plugins output.Raw object { plugins: {...} }

Limitations​

  • Route is restricted to global admins.
  • Unknown name value returns full plugin map rather than an empty object.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.membersAuthenticationReads caller identity for global-admin validation.
countly.appsPlugin config sourceReads app document and returns plugins object data.