/o/plugins-check

Endpoint

/o/plugins-check

Overview

Returns the current global feature-operation status marker derived from the plugins collection.

Authentication

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

Permissions

• Required permission: Global 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.

Examples

Check current feature-operation status

/o/plugins-check?api_key=YOUR_API_KEY

Response

Success Response

{
  "result": "completed"
}

Alternative successful status responses:

{
  "result": "busy"
}

{
  "result": "failed"
}

Response Fields

Field	Type	Description
result	String	Global status marker: completed, busy, or failed.

Error Responses

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

Behavior Modes

Mode	Trigger	Processing Path	Response Shape
Failed	_id: "failed" marker exists, or marker-query error	Returns failed marker result.	Wrapped object: { "result": "failed" }
Busy	No failed marker and _id: "busy" exists	Returns busy marker result.	Wrapped object: { "result": "busy" }
Completed	No failed marker and no busy marker	Returns completed marker result.	Wrapped object: { "result": "completed" }

Limitations

• Status is global and not per-feature.
• Endpoint always reports marker state only; it does not include progress details.

Related Endpoints

• Features - Feature State Update
• Features - Feature List

Implementation details

Database Collections

Collection	Used for	Data touched by this endpoint
countly.members	Global-admin validation	Reads authenticated user and global-admin status.
countly.plugins	Stores global operation marker documents	Reads marker documents with _id values failed and busy.