TelemetrySettingsDto

TelemetrySettingsDto
TelemetrySettingsDto

Telemetry settings. The CA bundle is returned only as a fingerprint; the client secret is never returned.

JSON Example
{
    "shareAdditionalData": false,
    "endpoint": "string",
    "proxyUrl": "string",
    "caBundleFingerprint": "string",
    "retentionDays": 0,
    "installationId": "string",
    "secretConfigured": false,
    "operatorDisabled": false,
    "disclosureAcknowledgedAt": "string"
}
boolean
shareAdditionalData
Required  

Whether the additional tier is included in reports generated from now on

endpoint
Required  

Upload endpoint selection

  • production: The Broadcom production endpoint; the default of a release build
  • staging: The Broadcom staging endpoint; the default of a build that is not a release build
  • custom: An https URL from configuration (vtp.telemetry.custom-url) without user info, query or fragment; refused in a release build
Enumeration: production, staging, custom
string
proxyUrl
Optional

Optional proxy URL without userinfo

string
caBundleFingerprint
Optional

SHA-256 fingerprint of the custom CA bundle, when one is set

integer As int32 As int32
retentionDays
Required  
Constraints: minimum: 90 maximum: 365

Days reports are kept, 90 to 365

string
installationId
Required  

Stable installation id (UUID)

boolean
secretConfigured
Required  

Whether the product credential was delivered to the appliance

boolean
operatorDisabled
Required  

Whether the support-only operator kill switch is set. Read-only.

string As date-time As date-time
disclosureAcknowledgedAt
Optional

When an administrator acknowledged the disclosure notice, if ever