Update Export Destination

(v2)

PUT

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/",
  "snowflakeConfig": {
    "account": "myorg-myaccount",
    "username": "CONFIDENT_EXPORTER",
    "role": "CONFIDENT_EXPORT_ROLE",
    "warehouse": "CONFIDENT_WH",
    "database": "ANALYTICS",
    "schema": "CONFIDENT",
    "privateKey": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASC...\n-----END PRIVATE KEY-----",
    "privateKeyPassphrase": "correct-horse-battery-staple"
  },
  "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/",
    "snowflakeConfig": {
      "account": "myorg-myaccount",
      "username": "CONFIDENT_EXPORTER",
      "role": "CONFIDENT_EXPORT_ROLE",
      "warehouse": "CONFIDENT_WH",
      "database": "ANALYTICS",
      "schema": "CONFIDENT",
      "privateKey": "***************Y-----",
      "privateKeyPassphrase": "***************"
    },
    "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
Where exports go. S3 uploads files to a bucket and SNOWFLAKE loads rows into tables; any other member is rejected on create. A destination's type can't be changed after it is created.
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.
snowflakeConfigobject
The Snowflake settings to change. Omitted fields keep their stored values.
Show 8 propertiesHide 8 properties
- accountstring
  The Snowflake account identifier, as <organization>-<account>. A full https://<account>.snowflakecomputing.com URL is accepted and trimmed to the identifier.
- usernamestring
  The Snowflake user Confident AI signs in as, ideally a TYPE = SERVICE user whose RSA_PUBLIC_KEY matches privateKey.
- rolestring
  The role loads run as. It needs USAGE on the warehouse, database and schema, and CREATE TABLE on the schema.
- warehousestring
  The warehouse that runs each load.
- databasestring
  The database the export tables live in.
- schemastring
  The schema Confident AI creates CONFIDENT_TRACES and CONFIDENT_ANNOTATIONS in.
- privateKeystring
  A new PEM private key. Omit it, or send back the masked value a read returned, to keep the stored key.
- privateKeyPassphrasestring | null
  A new passphrase for an encrypted private key. Omit it, or send back the masked value, to keep the stored one; send null to clear it.
enabledboolean
Whether export schedules may upload to this destination. Set it to false to stop uploads without deleting the destination.

Response

Update Export Destination succeeded.

successboolean
Indicates if the request was successful.
dataobject
A destination export schedules send exports 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 12 propertiesHide 12 properties
- idstring
  The id of the destination, generated by Confident AI.
- namestring
  The name of the destination.
- typeenum
  Where exports go. S3 uploads files to a bucket and SNOWFLAKE loads rows into tables; any other member is rejected on create. A destination's type can't be changed after it is created.
  Show 4 enum valuesHide 4 enum values
  - S3
  - GCS
  - AZURE_BLOB
  - SNOWFLAKE
- bucketstring | null
  The name of the bucket exports are uploaded to, or null for a SNOWFLAKE destination.
- regionstring | null
  The region the bucket lives in, or null for a SNOWFLAKE destination.
- accessKeyIdstring | null
  Null for a SNOWFLAKE destination. Otherwise 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 | null
  Null for a SNOWFLAKE destination. Otherwise 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 or the destination is SNOWFLAKE.
- snowflakeConfigobject | null
  A Snowflake destination's settings with the private key and passphrase masked.
  Show 8 propertiesHide 8 properties
  - accountstring
    The Snowflake account identifier, as <organization>-<account>. A full https://<account>.snowflakecomputing.com URL is accepted and trimmed to the identifier.
  - usernamestring
    The Snowflake user Confident AI signs in as, ideally a TYPE = SERVICE user whose RSA_PUBLIC_KEY matches privateKey.
  - rolestring
    The role loads run as. It needs USAGE on the warehouse, database and schema, and CREATE TABLE on the schema.
  - warehousestring
    The warehouse that runs each load.
  - databasestring
    The database the export tables live in.
  - schemastring
    The schema Confident AI creates CONFIDENT_TRACES and CONFIDENT_ANNOTATIONS in.
  - privateKeystring
    The stored private key, masked: fifteen asterisks followed by its last six characters. Send this value back on an update to keep the stored key.
  - privateKeyPassphrasestring | null
    The stored passphrase, fully masked as fifteen asterisks, or null when the key is unencrypted. Send it back on an update to keep the stored passphrase.
- 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