Test Instance Connection
POST/api/magento1/instances/:integrationInstance/test-connection
Re-test the stored credentials of an existing Magento 1 integration instance. The stored API key is resolved server-side (it is never returned to clients), the same three-step probe runs as for unsaved credentials, and the verdict is persisted onto the instance — subsequent instance reads reflect it in connection_status, connection_checked_at, and connection_error.
A failed probe returns HTTP 422 and still carries the per-check breakdown plus a message naming the Magento Admin screen to fix.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
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
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.