Skip to content

Test a datasource connection

POST
/v1/admin/datasources/{id}/test-connection
curl --request POST \
--url https://localhost:8080/v1/admin/datasources/example/test-connection \
--header 'Authorization: <Authorization>'

Runs a synchronous connectivity check for a single datasource and returns the result immediately, instead of waiting for the next scheduled health probe sweep

id
required
string

Datasource ID

OK

Media typeapplication/json
object
data
object
datasource_id
string
datasource_name
string
datasource_type
string
error_message
string
last_checked
string
last_success
string
status
string
Allowed values: healthy failing pending
success
boolean

Example

{
"data": {
"status": "healthy"
}
}

Unauthorized

Media typeapplication/json
object
error
string
message
string
success
boolean

Example

{
"error": "",
"message": "Success",
"success": true
}

Forbidden

Media typeapplication/json
object
error
string
message
string
success
boolean

Example

{
"error": "",
"message": "Success",
"success": true
}

Not Found

Media typeapplication/json
object
error
string
message
string
success
boolean

Example

{
"error": "",
"message": "Success",
"success": true
}

Internal Server Error

Media typeapplication/json
object
error
string
message
string
success
boolean

Example

{
"error": "",
"message": "Success",
"success": true
}

Service Unavailable

Media typeapplication/json
object
error
string
message
string
success
boolean

Example

{
"error": "",
"message": "Success",
"success": true
}