Get Destination

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

Retrieves an export destination by id. Its credentials come back masked — fifteen asterisks followed by the last six characters of the stored value — so you can tell which key is in use without the key itself being returned.

GET/v2/export-destinations/{exportDestinationId}

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

200

{
  "success": true,
  "data": {
    "id": "<EXPORT-DESTINATION-ID>",
    "name": "Nightly S3 exports",
    "type": "S3",
    "bucket": "acme-llm-exports",
    "region": "us-east-1",
    "accessKeyId": "***************XAMPLE",
    "secretAccessKey": "***************PLEKEY",
    "pathPrefix": "confident-ai/",
    "enabled": true,
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-20T08:15: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

exportDestinationIdstringRequired
The id of the export destination.

Response

Get Destination succeeded.

successboolean
Indicates if the request was successful.
dataobject
A storage destination export schedules upload to, with its credentials masked. Confident AI returns the last six characters of each credential so you can tell which one is stored, never the credential itself.
Show 11 propertiesHide 11 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.
- regionstring
  The region the bucket lives in.
- accessKeyIdstring
  The stored access key id, masked: fifteen asterisks followed by its last six characters. The real key id is never returned. Send this value back on an update to leave the stored key id alone, or omit the field entirely.
- secretAccessKeystring
  The stored secret access key, masked: fifteen asterisks followed by its last six characters. The real secret is never returned. Send this value back on an update to leave the stored secret alone, or omit the field entirely.
- pathPrefixstring | null
  The folder inside the bucket exports are written under, always ending in a slash, or null when they are written to the root of the bucket.
- enabledboolean
  Whether export schedules may upload to this destination.
- createdAtstring
  The timestamp when the destination was created.
- updatedAtstring
  The timestamp when the destination was last updated.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI