PlayStream Events - Set Telemetry Key Active
Sets a telemetry key to the active or deactivated state.
POST https://titleId.playfabapi.com/Event/SetTelemetryKeyActiveRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-EntityToken | True |
string |
This API requires an Entity Session Token, available from the Entity GetEntityToken method. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| Active | True |
boolean |
Whether to set the key to active (true) or deactivated (false). |
| KeyName | True |
string |
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 |
The optional entity to perform this action on. Defaults to the currently logged in entity. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-EntityToken
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
|
Set |
|
|
Set |
|
|
Telemetry |
ApiErrorWrapper
The basic wrapper around every failed API response
| Name | Type | Description |
|---|---|---|
| code |
integer |
Numerical HTTP code |
| error |
string |
Playfab error code |
| errorCode |
integer |
Numerical PlayFab error code |
| errorDetails |
object |
Detailed description of individual issues with the request object |
| errorMessage |
string |
Description for the PlayFab errorCode |
| status |
string |
String HTTP code |
EntityKey
Combined entity type and ID structure which uniquely identifies a single entity.
| Name | Type | Description |
|---|---|---|
| Id |
string |
Unique ID of the entity. |
| Type |
string |
Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types |
SetTelemetryKeyActiveRequest
| Name | Type | Description |
|---|---|---|
| Active |
boolean |
Whether to set the key to active (true) or deactivated (false). |
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| Entity |
The optional entity to perform this action on. Defaults to the currently logged in entity. |
|
| KeyName |
string |
The name of the key to update. |
SetTelemetryKeyActiveResponse
| Name | Type | Description |
|---|---|---|
| KeyDetails |
The most current details about the telemetry key that was to be updated. |
|
| WasKeyUpdated |
boolean |
Indicates whether or not the key was updated. If false, the key was already in the desired state. |
TelemetryKeyDetails
| Name | Type | Description |
|---|---|---|
| CreateTime |
string |
When the key was created. |
| IsActive |
boolean |
Whether or not the key is currently active. Deactivated keys cannot be used for telemetry ingestion. |
| KeyValue |
string |
The key that can be distributed to clients for use during telemetry ingestion. |
| LastUpdateTime |
string |
When the key was last updated. |
| Name |
string |
The name of the key. Telemetry key names are unique within the scope of the title. |
Error Codes
| Name | Code |
|---|---|
| TelemetryKeyNotFound | 14200 |