Troubleshoot a Connection Test

Connection tests can time out or throw errors. This may be due to incorrect credentials or parameters, orchestrator problems, vendor issues, or other causes. In the event a connection test does not pass, try the following suggestions to troubleshoot the connection.

Troubleshoot an Error

If your test results in an error status, you will see a red dot next to the connection. Click the ellipses ... menu and select View, then open the Test Status tab and click on a test to expand the test details.

In the test status details, you will find a log with details on the error encountered. In most cases, the issue is either (1) a connectivity issue or (2) a permissions issue.

If you are unable to remediate the error using information from the logs, reach out to our support team.

Connectivity Issues

Connectivity issues are caused by network connectivity problems between your Orchestrator and the connection target. These issues can usually be quickly diagnosed. Look for a connection timeout or failed to reach target host error message. If your Orchestrator is attempting to reach another server in your network, consult your network administrator to identify the connectivity issue. In most cases, connectivity errors are due to networking constraints.

It is also possible that your connection test failed due to an unresponsive Orchestrator. You may see an error message like, No response from orchestrator. Check orchestrator health to troubleshoot. Test will resume after response from orchestrator. If so, find the orchestrator under “Settings” and make sure the orchestrator you’ve assigned to this connection to is running properly.

If your orchestrator is down or has problems, contact the Rapid7 support team.

Permissions Issues

Permissions issues are typically caused by invalid credentials or credentials lacking necessary permissions. Permissions issues may result in a 404 (forbidden) error, an invalid credentials error, a failed to authenticate error, or a similar error log entry. Review the connection test logs and try to remediate the problem with the information provided in the error messages. For example, if you see the message API key incorrect length, keys are 64 characters, edit your connection’s configurations to correct the API key length.

Edit a Connection

To fix a permissions issue, you will likely need to edit the connection. Switch from the Test Status to the Details tab to view your connection configuration, then click the Edit button. Update connection configurations as needed then click Save. A new connection test will start automatically. Switch back to the Details tab to view the results of the new connection test.

Edit a Credential

While in the Edit Connection view, open the Credentials dropdown, find the credential used by the connection, and click the edit pencil button. Re-enter the credential, then click Save. You may need to rerun the connection test by selecting Retry Test from the connection’s ... menu on the Connections page.