Skip to main content

SDK - Enforcement Update

Endpoint

/i/sdk-config/update-enforcement

Overview

Updates SDK enforcement overrides for an app.

Authentication

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

Permissions

Requires sdk Update permission.

Request Parameters

ParameterTypeRequiredDescription
api_keyStringYes (or use auth_token)API key for authentication.
auth_tokenStringNoAuth token as query parameter or countly-token header.
app_idStringYesApp id.
enforcementString (JSON Object) or ObjectYesEnforcement object to save.

Examples

Update enforcement overrides

/i/sdk-config/update-enforcement?api_key=YOUR_API_KEY&app_id=6991c75b024cb89cdc04efd2&enforcement={"tracking":false,"crt":false,"eqs":100}

Response

Success Response

{
"result": "Success"
}

Response Fields

FieldTypeDescription
resultStringSuccess when enforcement is saved.

Error Responses

  • 400
{
"result": "Missing parameter \"app_id\""
}
  • 400
{
"result": "Error parsing enforcement"
}
  • 400
{
"result": "Wrong enforcement format"
}
  • 500
{
"result": "Error saving enforcement to database"
}

Behavior

  • Parses enforcement when provided as JSON string.
  • Removes unknown keys and persists only valid SDK option keys.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly_out.sdk_enforcementEnforcement storageUpserts app enforcement as { _id: app_id, enforcement: ... }.