Skip to main content

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.

Required scope: integrations:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

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​

OK

Response Headers
    Content-Type