Test Connection with Credentials
POST/api/veracore/integration-instances/test-connection
Test a set of Veracore credentials before saving an integration instance. The endpoint attempts to request an access token from the Veracore API using the supplied credentials and reports whether authentication succeeded.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
No integration instance is created or modified — the credentials are used only for the live authentication attempt.
Use this during initial setup. To test the credentials already saved on an existing instance, use the instance-scoped test-connection endpoint instead.
Errors
422when a required field is missing.422withdata.success = falseanddata.errorwhen Veracore rejects the credentials or the server cannot be reached.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 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.
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.