Test Connection for Instance
POST/api/veracore/integration-instances/:integration_instance/test-connection
Test the Veracore connection for an existing integration instance using its saved credentials. The endpoint attempts to request an access token from the Veracore API and reports whether authentication succeeded.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
No request body is required — the credentials stored on the instance are used.
Errors
404when the integration instance does not exist.422withdata.success = falseanddata.errorwhen Veracore rejects the saved credentials or the server cannot be reached.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.