Set ECE telemetry config
editSet ECE telemetry config
editSets whether to enable ECE telemetry.
Request
editPUT /api/v1/phone-home/config
Request body
edit(TelemetryConfigRequest) (required) The desired ECE telemetry configuration
Responses
edit-
200 -
Telemetry configuration updated successfully
-
403 -
User must have Platform level permissions. (code:
root.unauthorized.rbac)Headers
-
x-cloud-error-codes(string; allowed values: [root.unauthorized.rbac]) - The error codes associated with the response
-
-
409 -
The telemetry configuration did not exist so there was an attempt to create one. Another request resulted in the creation of a telemetry configuration before this request completed, resulting in the failure of this request to create a configuration. Please retry. (code:
telemetry.already_exists)Headers
-
x-cloud-error-codes(string; allowed values: [telemetry.already_exists]) - The error codes associated with the response
-
-
449 -
Elevated permissions are required. (code:
root.unauthorized.rbac.elevated_permissions_required)Headers
-
x-cloud-error-codes(string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]) - The error codes associated with the response
-
-
500 -
Failed to set the configuration due to an internal server error. (code:
telemetry.request_execution_failed)Headers
-
x-cloud-error-codes(string; allowed values: [telemetry.request_execution_failed]) - The error codes associated with the response
-
Request example
editcurl -XPUT https://{{hostname}}/api/v1/phone-home/config \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
"enabled" : true
}
'