Skip to main content

Validate Storage Integration (V2)

This operation validates whether the supplied storage credential can access the target bucket or container without creating an integration record.

POST/v2/storageIntegrations/validate
Connection Endpoint

The base URL for this API is in the following format:

https://api.cloud.zilliz.com

📘Notes

The endpoints on the control plane currently supports up to 20 requests per second per user per endpoint.

shell
export BASE_URL="https://api.cloud.zilliz.com"
Parameters
Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges.

Example Value: Bearer {{TOKEN}}
Request Bodyapplication/json
projectIdstringrequired

The ID of the project.

regionIdstringrequired

The ID of the region. The server uses this field to derive the cloud provider.

bucketNamestringrequired

The bucket, container, or storage name to validate.

externalCredobject

Provider-specific credential fields.

roleArnstring

The AWS IAM role ARN or Alibaba Cloud RAM role ARN.

externalIdstring

The external ID for AWS or Alibaba Cloud role assumption.

accountNamestring

The Azure storage account name.

clientIdstring

The Azure federated identity client ID.

tenantIdstring

The Azure tenant ID.

gcpProjectIdstring

The customer GCP project ID.

serviceAccountEmailstring

The customer-created GCP service account email that grants bucket access.

AWS S3bash
export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/storageIntegrations/validate" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx",
    "regionId": "aws-us-west-2",
    "bucketName": "my-bucket",
    "externalCred": {
        "roleArn": "arn:aws:iam::123456789012:role/zilliz-bucket-role",
        "externalId": "zilliz-external-AbCdEf12345678"
    }
}'
Responses200 OK - application/json

Returns the validation result.

A success response.

codeinteger<int32>

Response code.

Example Value: 0
dataobject

Returns the validation result.

successboolean

Whether the credential can access the target storage.

messagestring

The failure reason when validation fails. This field is empty when validation succeeds.

A failure response.

codeinteger

Response code.

Example Value: 1800
messagestring

Error message.

Example Value: User hasn't authenticated
Successjson
{
    "code": 0,
    "data": {
        "success": true,
        "message": ""
    }
}
Ctrl I