Connections
Validate Connection State
This endpoint validates the current state of a given connection. This will perform different checks based on the connection auth type. For basic and apiKey auth types, the presence of required fields is checked. For connectors that implement OAuth2, this operation forces the refresh flow for an access token regardless of its expiry.
Note:
- Do not include any credentials in the request body. This operation does not persist changes, but only triggers the validation of connection state.
- If a refresh token flow was performed and successful, the new access token will then be used for subsequent API requests.
post/vault/connections/{unified_api}/{service_id}/validate
Path parameters
service_idstring required
Service ID of the resource to return
unified_apistring required
Unified API
Headers
x-apideck-consumer-idstring required
ID of the consumer which you want to get or push data from
x-apideck-app-idstring required
The ID of your Unify application
Request body
object required
Response
Connection access token refreshed
Example response
{
"status_code": 200,
"status": "OK",
"data": {
"id": "crm+salesforce",
"state": "authorized"
}
}