Skip to main content
POST
Set Telemetry Key Active

Authorizations

X-EntityToken
string
header
required

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Body

application/json
Active
boolean
required

Whether to set the key to active (true) or deactivated (false).

KeyName
string
required

The name of the key to update.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Entity
object

The optional entity to perform this action on. Defaults to the currently logged in entity.

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Last modified on October 1, 2026