Helpful endpoints when troubleshooting connect

You may find the following endpoints helpful when attempting to troubleshoot Connect issues.

Health endpoints

The Health endpoints require no Connect API token and will simply return a 200 or 204 response (depending on the HTTP verb used) if Connect exists at the requested URL and is running. You can use this endpoint to confirm whether an instance of Connect exists and whether it's currently running at the expected location without having to worry about authentication.

Identity endpoint

The Identity endpoint returns metadata on the client associated with the provided Connect API token. You can use this endpoint to confirm that a given Connect API token is valid and is associated with the expected sales channel. Client metadata can also be useful when finding requests made from a certain client in downstream application logs.

Version endpoint

The Version endpoint returns the version of Connect that’s currently installed. You can use this endpoint as a quick reference to determine what the installed version of any given Connect instance is, or to confirm that an upgrade has completed successfully.

Features endpoint

The Features endpoint provides a list of Connect features that have dependencies on certain versions of downstream applications, and whether these features are enabled. If a given feature is not working in your environment, you can use this endpoint to see if the feature should be available, and what versions of downstream applications are required for the feature to work.