Edit an OpenTelemetry Collector Exporter

Edit online

Edit an OpenTelemetry Collector Exporter.

Request

Edit online

Security

Edit online
Table 1. Roles capable of executing the Edit an OpenTelemetry Collector Exporter API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin    

HTTP method

Edit online

POST /managerapi/json/1.0/editOpenTelemetryCollectorExporter.adm HTTP/1.1 Host:{manager.dsnet} id={id}&name={name}&pipelines={metrics|traces}&metricsEndpoint={metricsEndpoint}&tracesEndpoint={tracesEndpoint}&authenticated={true|false}

Curl method

Edit online
curl -u {admin}:{password}  -k  
'https://{manager.dsnet}/manager/api/json/1.0/editOpenTelemetryCollectorExporter.adm'
-d 'id={id}
  &name={name}
  &pipelines={metrics|traces}
  &metricsEndpoint={metricsEndpoint}
  &tracesEndpoint={tracesEndpoint}
  &authenticated={true|false}'

Parameters

Edit online
Table 2. Request parameters for Create OpenTelemetry Collector Exporter (editOpenTelemetryCollectorExporter) API method
Parameter Type Usage Default Description
id Long Required  

The id of the exporter.
name String Optional  

The name of the exporter.
pipelines List Required  

The telemetry pipelines the exporter is associated with.
endpoint String if type=prometheusremotewrite  

The endpoint to which metrics will be pushed when using prometheusremotewrite.
metricsEndpoint String if type=otlphttp  

The endpoint to which metrics will be exported. Required if type is otlphttp and the metrics pipeline is selected.
tracesEndpoint String if type=otlphttp  

The endpoint to which traces will be exported. Required if type is otlphttp and the traces pipeline is selected.
headers Map Optional  

Additional headers that will included in every request made by the exporter.
secretHeaders String Optional  

Additional secret headers that will included in every request made by the exporter.
authenticated Boolean Required  

Indicates if the exporter should be authenticated.
authScheme String If authenticated=true  

Specifies the authentication scheme of the exporter.
username String If authScheme=basic  

The username to use with basic authentication.
password String if authScheme=basic  

The password to use with basic authentication.
token String if authScheme=token  

The token to use with token authentication.
clientId String if authScheme=oauth2  

The exporter's client id.
clientSecret String if authScheme=oauth2  

The exporter's client secret.
tokenEndpoint String if authScheme=oauth2  

The OAuth2 token endpoint", notes = "If a port is not specified, 443 will be used.
scopes List if authScheme=oauth2  

Scopes are not often used with the client credentials grant flow.
tokenEndpointParameters Map if authScheme=oauth2  

Additional parameters sent to the token endpoint.