Set ECE telemetry config

PUT /phone-home/config
Basic auth Api key

Sets whether to enable ECE telemetry.

application/json

Body Required

The desired ECE telemetry configuration

  • enabled boolean Required

    Whether to enable ECE telemetry

Responses

  • 200 application/json

    Telemetry configuration updated successfully

    Hide response attribute Show response attribute object
    • enabled boolean Required

      Whether ECE telemetry is enabled
  • 403 application/json

    User must have Platform level permissions. (code: root.unauthorized.rbac)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is root.unauthorized.rbac.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
  • 409 application/json

    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)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is telemetry.already_exists.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
  • 500 application/json

    Failed to set the configuration due to an internal server error. (code: telemetry.request_execution_failed)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is telemetry.request_execution_failed.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
PUT /phone-home/config 
curl \
 --request PUT 'https://{{hostname}}/api/v1/phone-home/config' \
 --user "username:password" \
 --header "Content-Type: application/json" \
 --data '{"enabled":true}'