Get ECE telemetry config

GET /phone-home/config

Returns whether ECE telemetry is enabled.

Responses

  • The current ECE telemetry configuration

    Hide response attribute Show response attribute object
    • enabled boolean Required

      Whether ECE telemetry is enabled

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

    Hide headers attribute Show headers attribute
    • 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

GET /phone-home/config
curl \
 -X GET https://{{hostname}}/api/v1/phone-home/config
Response examples (200)
{
  "enabled": true
}
Response examples (403)
# Headers
x-cloud-error-codes: root.unauthorized.rbac

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