Skip to main content
POST
/
v1
/
organizations
/
connections
/
{connection_identifier}
/
test
Test Storage Connection
curl --request POST \
  --url https://api.mixpeek.com/v1/organizations/connections/{connection_identifier}/test \
  --header 'Authorization: Bearer <token>'
{
  "description": "Successful test",
  "details": {
    "result": "success"
  },
  "message": "Connection test succeeded",
  "success": true
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings.

Headers

​
Authorization
string
required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer sk_live_abc123def456"

"Bearer sk_test_xyz789"

Path Parameters

​
connection_identifier
string
required

Connection identifier - either connection ID (conn_...) or name. The system will automatically resolve names to IDs.

Examples:

"conn_abc123def456ghi"

"Marketing Google Drive"

Response

Successful Response

Response payload for connection test endpoint.

Returns the result of testing connection credentials against the external provider. Used to validate credentials before saving or to diagnose issues.

​
success
boolean
required

Whether the connection test succeeded. True: Credentials are valid and connection is accessible. False: Authentication failed, network error, or permissions denied.

Examples:

true

false

​
message
string
required

Human-readable message describing the test result. Success: 'Connection test succeeded' or similar. Failure: Error message explaining what went wrong.

Examples:

"Connection test succeeded"

"Authentication failed: Invalid credentials"

"Permission denied: Unable to access shared drive"

​
details
object | null

OPTIONAL. Additional diagnostic information about the test result. May include error details, provider-specific information, or success metadata. Format varies by provider.

Examples:
{
  "provider_response": "...",
  "result": "success"
}
{
  "error": "Invalid credentials",
  "error_code": "AUTH_FAILED"
}