Set ECE telemetry config

PUT /phone-home/config

Sets whether to enable ECE telemetry.

Body Required

The desired ECE telemetry configuration

enabled boolean Required

Whether to enable ECE telemetry

Responses

200

Telemetry configuration updated successfully
Hide response attribute Show response attribute object
- enabled boolean Required
  
  Whether ECE telemetry is enabled
403

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

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

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 \
 -X PUT https://{{hostname}}/api/v1/phone-home/config \
 -d '{"enabled":true}'

Request examples

{
  "enabled": true
}

Response examples (200)

{
  "enabled": true
}

Response examples (403)

# Headers
x-cloud-error-codes: root.unauthorized.rbac

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Response examples (409)

# Headers
x-cloud-error-codes: telemetry.already_exists

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Response examples (500)

# Headers
x-cloud-error-codes: telemetry.request_execution_failed

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}