For Developers
Validate Source
GET https://ed.link/api/v2/teams/:team_id/sources/:source_id/validate
Validates source credentials and network reachability against the upstream provider API (e.g. testing Canvas or Blackbaud API keys).
Permissions
Requires the sources.update system permission.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
:team_id | UUID | Yes | The ID of the team. |
:source_id | UUID | Yes | The ID of the source. |
Sample Request
const response = await axios.get(
`https://ed.link/api/v2/teams/${team_id}/sources/${source_id}/validate`,
{
headers: {
authorization: `Bearer ${user_session_token}`
}
}
);
Sample Response
{
"$data": {
"valid": true,
"checked_at": "2024-06-21T12:00:00.000Z",
"provider_message": "Connection established successfully."
}
}
