Skip to main content

Manage APIs

Use Manage APIs to build and test the HTTP endpoints that your workflows call. You collect endpoints into groupings. Each grouping holds a base URL and the defaults its endpoints share, such as authentication and headers.

To open the screen, go to ManageIT → Manage Sources, then select Manage ▾ → Manage APIs. To go back, select Back to Manage Sources.

Before you start​

Execute sends requests through your account's collector. Set up and connect a collector first. See Configure collector.

The screen​

  • On the left, API Collections lists your groupings. Each grouping shows its base URL and how many endpoints it holds. Expand a grouping to see its endpoints, each with its HTTP method.
  • On the right, the request builder shows the endpoint you selected, with the Response below it.

To find a grouping or endpoint, type in the Search groupings and endpoints... box. To change the order, select the sort button and choose Default, Name A-Z, Name Z-A, Date (Oldest) or Date (Newest).

Create a grouping​

  1. Select Add grouping (the + button beside API Collections). The Create Endpoint Grouping drawer opens.
  2. Under Basic Information, enter a Name (up to 100 characters) and a Description (up to 300 characters).
  3. Under URL Configuration, enter the Base URL, for example https://api.example.com. You can also enter a Default Path (optional) and choose a Default HTTP Method: GET, POST, PUT, PATCH or DELETE.
  4. Under Authentication, choose an Auth Type and fill in its fields:
    • No Auth: no fields.
    • Bearer Token: Token.
    • Basic Auth: Username and Password.
    • API Key: Key Name, for example X-API-Key, and Key Value.
  5. Optionally, add Default Headers and Default Query Parameters. Select Add Header or Add Param to add a row.
  6. Under Settings, set the Default Timeout (seconds), from 1 to 300. It starts at 30. You can also add Tags, separated by commas.
  7. Leave Enabled selected to use the grouping.
  8. Select Create.

The new grouping opens in the list. To leave without saving, select Cancel, press Escape or select Close drawer.

Add an endpoint​

  1. In API Collections, expand the grouping and select Add Endpoint. You can also open the grouping's Grouping actions menu and select Add Endpoint. The request builder shows New Endpoint.
  2. Choose the HTTP method.
  3. Enter the path after the grouping's base URL, for example /users or /orders/{id}. The {{baseUrl}} label in front of the path stands for the grouping's base URL and default path. Hold the pointer over it to see them.
  4. Enter an Endpoint Name, using letters and numbers only, for example GetUsers. You can also add a Description.
  5. Set up the request on the tabs:
    • Params: Query Parameters. Select Add Parameter to add a row.
    • Authorization: choose a Type. Inherit from parent uses the grouping's authentication. You can also choose No Auth, Basic Auth, Bearer Token or API Key.
    • Headers: Request Headers. Select Add Header to add a row. The tab shows how many headers are set.
    • Body: type the request body, for example JSON or XML.
  6. Leave Enabled selected to use the endpoint.
  7. Select Save.

Rows the endpoint inherits from its grouping appear in the Params and Headers tabs and can't be removed there. To leave a row out of a request, clear its checkbox. To remove a row you added, select Remove row.

Test a request​

  1. Select an endpoint, or set up a new one.
  2. Select Execute. The button shows Executing… while the request runs.

You don't need to save first. Execute sends the request as it's set up on screen.

The Response shows the status, how long the request took in ms, and the size of the response. The status reads, for example, 200 Success, 301 Redirect, 404 Failed or 500 Error. Unknown means the request didn't get a reply from the server at all. Select Copy to copy the response body.

Edit a grouping or endpoint​

  • To edit a grouping, open its Grouping actions menu and select Edit Grouping. Make your changes in Edit Endpoint Grouping, then select Update.
  • To edit an endpoint, select it in API Collections, make your changes, then select Update.

Delete a grouping or endpoint​

  • To delete a grouping, open its Grouping actions menu and select Delete Grouping. In the Delete Grouping dialog, select Delete. All the grouping's endpoints are removed with it.
  • To delete an endpoint, select Delete endpoint beside it in the list, or at the bottom of the request builder. In the Delete Endpoint dialog, select Delete.

Select Cancel to keep the grouping or endpoint.

What happens next​

To chain your endpoints into steps that run on a schedule, select Go to Workflows. See Manage workflows.

Troubleshooting​

ProblemWhat to do
Name is required, Description is required or Base URL is requiredFill in the field in the grouping drawer, then select Create or Update again.
Endpoint name is requiredEnter an Endpoint Name before you save.
Only letters and numbers allowedRemove spaces and symbols from the Endpoint Name.
The Response shows Unknown or Execution failed:Check that your collector is connected on Configure collector, and that the base URL is correct.
No endpoint groupings yet. Click + to create one.You haven't created a grouping yet. See Create a grouping.
No matching groupings or endpoints found.Clear or change the search.