Test Instance Connection
POST/api/magento2/integration-instances/:magento2IntegrationInstance/test-connection
Probe an EXISTING instance's STORED credentials against the Magento 2 REST API. Backs the live Connection Status chip on the settings Connection tab — the frontend never sees the raw access token, so the server re-uses what's persisted in connection_settings. No request body.
Returns 200 with data.connected = true when the token authenticates, or 422 with data.connected = false and an actionable message when Magento rejects it (invalid/expired token, missing resource scopes, or unreachable host).
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.