List Connectors

GEThttps://api.confident-ai.com/v2/forwarding-connectors

Lists the forwarding connectors in your Confident AI project one page at a time, newest first. Each connector is returned as a summary; retrieve one by id for its headers, environments and delivery history.

GET/v2/forwarding-connectors

curl -X GET "https://api.confident-ai.com/v2/forwarding-connectors" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "forwardingConnectors": [
      {
        "id": "<FORWARDING-CONNECTOR-ID>",
        "name": "Acme OTLP collector",
        "endpoint": "https://otlp.acme-observability.com/v1/traces",
        "enabled": true
      }
    ],
    "totalForwardingConnectors": 2,
    "page": 1,
    "pageSize": 25
  },
  "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.

Query parameters

pageintegerdefault: 1
The page to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of results per page, at most 100. Defaults to 25.

Response

List Connectors succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of forwarding connectors, with the total across all pages.
Show 4 propertiesHide 4 properties
- forwardingConnectorslist of objects
  The forwarding connectors for the current page, newest first.
  Show 4 propertiesHide 4 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.
  - enabledboolean
    Whether the connector is currently forwarding traces.
- totalForwardingConnectorsinteger
  The total number of forwarding connectors in this project.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of forwarding connectors per page.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI