Skip to content
Proud to collaborate with Microsoft for Startups

connection.validate ​

Validates an existing cloud provider connection by testing connectivity and updating its status in the database

Workflow for validating existing cloud provider connections.

States: initiated → loading → testing → updating → completed any → failed

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-connection
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—UUID of the organization that owns the connection
connection_uuiduuidYes—UUID of the connection to validate

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID echoed from input
connection_uuiduuidNo—Connection UUID echoed from input
provider_typestringNo—Provider type loaded from the row
connection_statusstringNo—Persisted connection status at load time (pending/active/error)
connection_namestringNo—Connection name loaded from the row
initiated_atstringNo—ISO-8601 timestamp when validation began
initiated_bystringNo—Actor that initiated validation
loaded_atstringNo—ISO-8601 timestamp when connection was loaded
test_passedbooleanNo—True after connectivity test passed
test_resultjsonNo—Provider connectivity test result
account_infojsonNo—Provider account metadata returned by test_connection
tested_atstringNo—ISO-8601 timestamp of connectivity test
new_statusstringNo—Status after update_status step
last_validated_atstringNo—ISO-8601 timestamp of last successful validation
validation_countintegerNo—Total validations performed on the row
updated_atstringNo—ISO-8601 timestamp of status update
completed_atstringNo—ISO-8601 timestamp of overall completion
validation_successbooleanNo—True when validation succeeded
failure_reasonstringNo—Failure reason on the failed branch
failure_typestringNo—Failure category
failed_actionstringNo—Action method that raised
failed_at_statestringNo—State the workflow was in when it failed
failed_atstringNo—ISO-8601 timestamp of failure
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name
failed_layerstringNo—Engine-stamped layer index (DAG path)
failed_stepstringNo—Engine-stamped step name (DAG path)

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—load_connectionValidation request received
loadingNoNo—test_connectionLoading connection from database
testingNoNo—update_statusTesting connection to cloud provider
updatingNoNo—completeUpdating connection status in database
completedNoYesYes—Validation completed
failedNoYesNo—Validation workflow failed

State Diagram ​

Transitions ​

FromActionToDescription
initiatedload_connectionloading—
loadingtest_connectiontesting—
testingupdate_statusupdating—
updatingcompletecompleted—
initiatedfailfailed—
loadingfailfailed—
testingfailfailed—
updatingfailfailed—

Business Errors ​

CodeMessage Template
CONNECTION_NOT_FOUNDConnection {connection_uuid} not found in organization
CONNECTION_DELETEDConnection {connection_uuid} has been deleted

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "connection.validate",
  "initial_data": {
    "organization_uuid": "value",
    "connection_uuid": "value"
  }
}