Organization Connections

Test Storage Connection

Changed on

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"
post/v1/organizations/connections/{connection_identifier}/test

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/organizations/connections/{connection_identifier}/test
  • Auth: HTTP bearer

Path parameters

connection_identifierstring required

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

Example:conn_abc123def456ghi

Response

Successful Response

successboolean required

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

messagestring required

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

detailsobject nullable

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

Example response

{
  "description": "Successful test",
  "details": {
    "result": "success"
  },
  "message": "Connection test succeeded",
  "success": true
}

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API