API console

Use the API Console to try the CONNECT REST API without writing code. This console acts on your real data. Therefore, use caution when creating, updating, or deleting data.

Open the console using the side navigation. Select Developer Tools, then select API Console.

Send an API request

Send an API request by completing these basic steps.

1. Complete the request form, choosing a Verb and URI path. Complete any additional request customizations using Query Parameters, Body, and Headers.

2. Choose Send Request.

   Tip: You can also press CTRL+ENTER to send the request.

Request form

Before sending an API request, complete the request form.

When sending a request, use the request form to choose:

• Method Verb.

• URI path for resources. As you type, autocomplete suggests available paths and resources.

• Query Parameters, if available for the method.

• Request Body, for write operations.

  For detailed documentation on the query parameters and body properties available for each path, consult the CONNECT API reference.

• Header options.

Response panel

Following your request, the Response panel displays. Body displays the JSON payload returned by the request. Details displays the URI path that the request was made to, the content type, and the resulting HTTP status.

• Use the Copy Response Body and Download Response Body to work with the response JSON in another context.

• To reopen a previous request, select the Session Request History and choose it from the list.

• To open or close the panel, select the API Response Panel .