Credentials

Validate credentials

POST
Validate AWS or GCP credentials previously added to Coactive are configured properly

Request

This endpoint expects an object.
dataPath
stringRequired
The absolute path to the data in cloud storage to use to test access
credentialsId
stringOptional
The id of the credentials

Response

This endpoint returns an object
dataPath
string
The absolute path to the data in cloud storage to use to test access
success
boolean
True if data can be read at the specified data path using the credentials
credentialsId
stringOptional
The id of the credentials
detail
stringOptional
An explanation of the test failure
POST
1curl -X POST https://app.coactive.ai/api/v1/credentials/validate \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "dataPath": "s3://your-s3-bucket/prefix/to/use/",
6  "credentialsId": "382cc760-8e8e-4b97-abab-84438282cb9a"
7}'
200
Successful
1{
2  "dataPath": "s3://your-s3-bucket/prefix/to/use/",
3  "success": true,
4  "credentialsId": "382cc760-8e8e-4b97-abab-84438282cb9a",
5  "detail": "Unable to list objects under the provided prefix"
6}
Built with