Skip to main content

Enable or disable a data analyzer

POST 
/api/v1/orgs/{orgId}/devices/{deviceId}/analyzers/{analyzerId}:{action}

Set the enabled or disabled state of the specified analyzer.

Valid actions are enable and disable. Command execution is tracked for audit purposes.

An analyzer with two or more input data streams needs a Data Assembly, which is provisioned in the background after this call returns. A 204 therefore confirms the state change, not that the analyzer has begun producing.

Responses

  • 204 No Content: Action executed successfully.
  • 400 Bad Request: orgId or analyzerId is not a valid identifier, or action is neither enable nor disable.
  • 401 Unauthorized: Missing or invalid authentication token.
  • 403 Forbidden: The caller is not permitted to access this organization or device.
  • 404 Not Found: Analyzer or device not found.
  • 409 Conflict: Analyzer is already in the requested state.
  • 500 Internal Server Error: An upstream service (device management, data streams, or Data Assembly) was unreachable or failed.

Security

  • This API requires authentication.

Request​

Responses​

No Content