Update Destination

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

Updates an export destination and returns it with its credentials masked. Omit a credential to leave the stored one alone; resending the masked value a read returned does the same, so a destination you read and send straight back keeps working.

PUT/v2/export-destinations/{exportDestinationId}

curl -X PUT "https://api.confident-ai.com/v2/export-destinations/{exportDestinationId}" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Nightly S3 exports",
  "type": "S3",
  "bucket": "acme-llm-exports",
  "region": "us-east-1",
  "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
  "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
  "pathPrefix": "confident-ai/",
  "enabled": true
}'

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.

Request body

namestring
The name of the destination, as it appears in your project.
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
A new access key id for the bucket. Omit it to leave the stored key id untouched. Sending back the masked value a read returned leaves it untouched too, so a destination you read and send straight back keeps working.
secretAccessKeystring
A new secret access key for the bucket. Omit it to leave the stored secret untouched. Sending back the masked value a read returned leaves it untouched too; the mask is never written into storage.
pathPrefixstring | null
A folder inside the bucket to write exports under. A leading slash is stripped and a trailing one added, so /confident-ai is stored as confident-ai/. Send null to clear it and write to the root of the bucket; an empty string is ignored.
enabledboolean
Whether export schedules may upload to this destination. Set it to false to stop uploads without deleting the destination.

Response

Update 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