Test Instance Connection
POST/api/pinnacle/instances/:instance/test-connection
Re-tests a saved instance with its stored credentials (token grant + Tracking API key probe). A newly granted token is cached on the instance. No request body.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Returns 200 with ok=true on success, or 422 with a code (invalid_credentials, invalid_tracking_key, rate_limited, maintenance, unreachable, api_error) and field-keyed errors.
Authentication: requires a Bearer token (Personal Access 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
Response Headers
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.