Contact Us 1-800-596-4880

Testing APIs Using an API Instance

The API Console enables you to test an API using an API instance as a server. API instances let you interact with a server by sending requests and getting responses with actual data.

Before You Begin

You must have an API specification with at least one endpoint and one method in it.

Test an API Using an Instance

  1. On the Home or the APIs page, select a REST API.

  2. Select the API specification tab.

  3. In the Specification pane, click a method like get.

  4. In the Try it pane, select an instance URL from the Select Server options.

  5. Enter any query parameters you want to test.

  6. Click Send to send data to the API.

  7. Verify the returned responses from the API.