It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Get ECE telemetry config Templates - Deployments »

› › › ›

Set ECE telemetry config

edit

Set ECE telemetry config

edit

Sets whether to enable ECE telemetry.

Request

edit

PUT /api/v1/phone-home/config

Request body

edit

(TelemetryConfigRequest) (required) The desired ECE telemetry configuration

Responses

edit

200

(TelemetryConfig) Telemetry configuration updated successfully

403

(BasicFailedReply) 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

(BasicFailedReply) 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

(BasicFailedReply) 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

(BasicFailedReply) 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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit

curl -XPUT https://{{hostname}}/api/v1/phone-home/config \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "enabled" : true
}
'

« Get ECE telemetry config Templates - Deployments »