List Destinations

GEThttps://api.confident-ai.com/v2/export-destinations

Lists the export destinations in your Confident AI project one page at a time, newest first. Each destination is returned without its credentials; retrieve one by id to see them in masked form.

GET/v2/export-destinations

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

200

{
  "success": true,
  "data": {
    "exportDestinations": [
      {
        "id": "<EXPORT-DESTINATION-ID>",
        "name": "Nightly S3 exports",
        "type": "S3",
        "bucket": "acme-llm-exports",
        "enabled": true
      }
    ],
    "totalExportDestinations": 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 Destinations succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of destinations, with the total across all pages.
Show 4 propertiesHide 4 properties
- exportDestinationslist of objects
  The destinations for the current page, newest first.
  Show 5 propertiesHide 5 properties
  - idstring
    The id of the destination, generated by Confident AI.
  - namestring
    The name of the destination.
  - typeenum
    The kind of storage exports are uploaded to. Only S3 is supported today, and any other member is rejected on create and update.
    Show 4 enum valuesHide 4 enum values
    S3
    GCS
    AZURE_BLOB
    SNOWFLAKE
  - bucketstring
    The name of the bucket exports are uploaded to.
  - enabledboolean
    Whether export schedules may upload to this destination.
- totalExportDestinationsinteger
  The total number of destinations in this project.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of destinations 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