For more information about API Checks in general, see our API Check article.
When creating or editing an API Check, it is important to be able to do a dry-run of the configuration before saving.
You can run the test from any location using the selector next to the test button.
While running the test, you cannot make any changes. You can view the results placeholder at any time by double-clicking, dragging, or using the resize button on the blue status bar.
After the test is complete, the status bar will indicate if the test passed or failed by turning green or red. If there was an error running the test, the bar will turn yellow. If re-running the test continues to produce an error with a yellow bar, contact firstname.lastname@example.org.
To see the results of the test, double-click, drag, or click the resize button. You can page through each step to verify the results. The failing step’s results will automatically be selected for debugging.
The API Check must be valid before a test check can be run. If a required field is missing, the form must be corrected before test check will run.