Test Storage Connection
Perform a credential test against the external provider.
Validates that connection credentials are still valid and the provider is accessible. Result is logged in audit trail.
Use Cases:
- Validate credentials before using in sync operations
- Diagnose connection issues
- Refresh credentials after expiration
Example:
curl -X POST "http://localhost:8000/v1/organizations/connections/conn_abc123/test" \
-H "Authorization: Bearer YOUR_API_KEY"
Documentation Index
Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Headers
Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.
"Bearer YOUR_MIXPEEK_API_KEY"
Path Parameters
Connection identifier - either connection ID (conn_...) or name. The system will automatically resolve names to IDs.
"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.
Whether the connection test succeeded. True: Credentials are valid and connection is accessible. False: Authentication failed, network error, or permissions denied.
true
false
Human-readable message describing the test result. Success: 'Connection test succeeded' or similar. Failure: Error message explaining what went wrong.
"Connection test succeeded"
"Authentication failed: Invalid credentials"
"Permission denied: Unable to access shared drive"
OPTIONAL. Additional diagnostic information about the test result. May include error details, provider-specific information, or success metadata. Format varies by provider.
{
"provider_response": "...",
"result": "success"
}