Update Connector

PUThttps://api.confident-ai.com/v2/forwarding-connectors/{forwardingConnectorId}

Updates a forwarding connector and returns it. Every field you omit is left as stored, which is how you change one setting without knowing the header values. When you do send headers, the list replaces all stored headers, so resend the ones you want to keep: a value left masked keeps the stored credential, and a plaintext value replaces it.

PUT/v2/forwarding-connectors/{forwardingConnectorId}

curl -X PUT "https://api.confident-ai.com/v2/forwarding-connectors/{forwardingConnectorId}" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme OTLP collector",
  "endpoint": "https://otlp.acme-observability.com/v1/traces",
  "headers": [
    {
      "key": "Authorization",
      "value": "Bearer sk-live-a1b2c3"
    }
  ],
  "environments": [
    "production"
  ],
  "enabled": true
}'

200

{
  "success": true,
  "data": {
    "id": "<FORWARDING-CONNECTOR-ID>",
    "name": "Acme OTLP collector",
    "endpoint": "https://otlp.acme-observability.com/v1/traces",
    "headers": [
      {
        "key": "Authorization",
        "value": "***************a1b2c3"
      }
    ],
    "environments": [
      "production"
    ],
    "enabled": true,
    "lastForwardedAt": "2025-01-15T10:30:00.000Z",
    "lastError": null,
    "successCount": 1284,
    "failureCount": 3,
    "createdAt": "2025-01-01T09:00:00.000Z",
    "updatedAt": "2025-01-15T10:29:00.000Z"
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/project-settings/exports",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

forwardingConnectorIdstringRequired
The id of the forwarding connector.

Request body

namestring
The name of the connector.
endpointstring
The HTTPS URL of the OTLP/HTTP collector that receives the forwarded traces. It must resolve to a public address; private and loopback addresses are rejected.
headerslist of objects
The complete set of HTTP headers to send with every forwarded batch, alongside the Content-Type: application/x-protobuf header Confident AI sets. Omit this field to leave the stored headers untouched. When you do send it, the list replaces all stored headers, so resend every header you want to keep — including the ones whose values you read back masked, which are kept as stored.
Show 2 propertiesHide 2 properties
- keystringRequired
  The name of the HTTP header to send.
- valuestringRequired
  The value of the header. Send a plaintext value to set or replace it, or send back the masked value you read to keep the stored one. A masked value that matches no stored header of the same name is dropped, because the original cannot be recovered from a mask.
environmentslist of enums
The environments whose traces this connector forwards. An empty list forwards traces from every environment. Omit this field to leave the stored environments unchanged.
Show 4 enum valuesHide 4 enum values
- production
- development
- staging
- testing
enabledboolean
Whether the connector forwards traces. Defaults to true on create; omit it on an update to leave it unchanged.

Response

Update Connector succeeded.

successboolean
Indicates if the request was successful.
dataobject
A destination Confident AI forwards your traces to over OTLP/HTTP, with its delivery history. Header values are always masked.
Show 12 propertiesHide 12 properties
- idstring
  The id of the connector, generated by Confident AI.
- namestring
  The name of the connector.
- endpointstring
  The OTLP/HTTP collector the connector forwards traces to.
- headerslist of objects
  The HTTP headers sent with every forwarded batch, with every value masked. To change one, resend the whole list with the new value in place and the other values left masked; to leave them all alone, omit headers from the update entirely.
  Show 2 propertiesHide 2 properties
  - keystring
    The name of the HTTP header, returned exactly as stored.
  - valuestring
    The masked value of the header: fifteen asterisks followed by the last six characters of the stored value. The stored value itself is never returned. Send this masked value back on an update to keep the header unchanged.
- environmentslist of enums
  The environments whose traces this connector forwards. An empty list forwards traces from every environment.
  Show 4 enum valuesHide 4 enum values
  - production
  - development
  - staging
  - testing
- enabledboolean
  Whether the connector is currently forwarding traces.
- lastForwardedAtstring | null
  When this connector last delivered a batch, or null when it never has.
- lastErrorstring | null
  The error from the most recent failed delivery, or null when the last delivery succeeded.
- successCountinteger
  How many batches this connector has delivered successfully.
- failureCountinteger
  How many batches this connector has failed to deliver.
- createdAtstring
  When the connector was created.
- updatedAtstring
  When the connector was last changed.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI