Articles in this section

Create and manage APIs using API builder

 

Create an API in API builder to define a request, add the steps that run your logic, and return a response. Creating the API sets its name, version, and integration, and opens the API builder canvas with a request and two responses ready to configure. For what the canvas contains, see API builder overview.

Prerequisites

You need the Manage permission on the integration or the Administrator role on the account. See Manage account and integration permissions.

Create an API

  1. Go to Build build-icon.png, and then select APIs.
  2. Select Create API.
  3. Under How would you like to build the API?, select API builder.
  4. Enter a Name for your API, such as "Get a chocolate".
  5. (Optional) Enter a Description.
  6. Enter the Version. The default is v1. The version is part of the API's URI: https://api.integrator.io/apis/<version>.
  7. Under Integration, select Create new integration or Add to existing integration.
  8. If you selected Add to existing integration, select the integration in Select integration.
  9. Select Save & next.

Create API panel with name, description, version, and integration.

The API opens in API builder with an API request, a Response picker, a Success response, and an Error response.

To create an API in JavaScript, see Create a JavaScript API.

Next steps

  1. Configure an API request using API builder.
  2. Configure an API response using API builder.
  3. Test and debug your API using API builder.
  4. Invoke an API and API limits.

To change the name, description, or version later, see Configure advanced API settings. To find, clone, or delete your APIs, see Manage APIs.

Manage APIs

Use the APIs page to find your APIs, check their status, and open, turn on or off, clone, move, or delete them. The page also lets you group the APIs in an integration. Row actions on the APIs page and actions inside API builder differ, so this article lists both.

Open the APIs page

Go to Build build-icon.png, and then select APIs. Select API builder. The page lists the APIs built in API builder. To see the APIs in one integration, open the integration and select APIs. The list there has the same columns and row actions.

APIs list in API builder.

APIs list columns

Column Description
Name/Description The API's name. Select the name to open the API in API builder. Select Description to read the API's description.
Integration The integration the API belongs to. Select the name to open the integration.
Version The API's version, which is part of its URI: https://api.integrator.io/apis/<version>.
HTTP method The HTTP method of the API's request.
Relative URI The path set in the API's request, relative to https://api.integrator.io/apis/<version>. Query parameters aren't shown.
Off / On Turns the API off or on. An API that's off doesn't accept requests.
Last updated The date and time the API was last changed.
Actions The actions for the API. See Row actions.

An API's endpoint URL is publicly reachable, but only callers with a valid API token can invoke it. In your account, two APIs that are on can't have the same endpoint URL.

Turning off an API stops it from accepting requests, which can affect the applications that call it.

Sort and filter the list

The list is sorted by Last updated, newest first. To sort by Name, Relative URI, or Last updated, select the column header. Select it again to reverse the order. To narrow the list, search by name, or filter by Integration, Off / On, or HTTP method.

To filter by HTTP method:

  1. In the HTTP method column header, select Filter filter-icon.png
  2. Select GET, POST, PUT, PATCH, or DELETE. The filter shows one method at a time.
  3. Select Apply.

To remove the filter, select Filter filter-icon.png, select Clear, and then select Apply. Your search, other filters, and sort stay in place.

Row actions

Select Actions elipses-button.png on an API's row to open its actions.

Action Description
Edit API Opens the API in API builder.
View request logs Opens the API's request logs. See View API request and execution logs in API builder.
View audit log Opens the API's audit log. See Audit logs.
Push to APIM or View in APIM API Management only. Pushes the API to your API Management console. An APIM label then appears next to the API. See Push your API to your API console.
Download OAS Downloads the OpenAPI specification (OAS) for the API. See Download the OpenAPI spec.
Download API Downloads the API's configuration so you can upload it to another environment or account.
Copy cURL Copies a cURL command that invokes the API. See Invoke an API and API limits.
Add to MCP server Adds the API to an MCP server so AI agents and external tools can use it. Select Create new MCP or Add to existing MCP, and then select Add to MCP server. See MCP servers.
Clone API Copies the API. See Clone an API.
Move to other integration Moves the API to a new or existing integration. See Move an API to another integration.
Used by Lists the resources that use this API, with each resource's Name and Type.
Delete API Sends the API to the Recycle bin. Available only when the API is off. See Delete and restore an API.

Actions in API builder

In API builder, select Actions elipses-button.png at the upper right to open the actions for the open API.

Action Description
Change log mode Sets how much request and response data the API stores. See View API request and execution logs in API builder.
Push to APIM API Management only. Works the same as the row action.
View request logs Opens the API's request logs.
Download OAS Downloads the OpenAPI specification for the API.
Copy Invoke URL Copies the API's invoke URL. See Invoke an API and API limits.
Disable API Turns the API off. The action then reads Enable API.
Clone API Copies the API. See Clone an API.
Delete API Sends the API to the Recycle bin. Available only when the API is off.

Turn an API on or off

To turn an API off or on, use Off / On in the list, or select Actions elipses-button.png > Disable API or Enable API in API builder.

Clone an API

Clone an API to version it, test changes, reuse it, or promote it to another environment.

  1. Select Actions elipses-button.png > Clone API on the API's row in the list, or in API builder. The Clone API page opens.
  2. Enter a unique Name.
  3. (Optional) Enter a Description.
  4. If your account has multiple environments, select the Environment to clone into. See Use multiple environments.
  5. Select the Integration to clone into.
  6. Enter the Version.
  7. Review the resources listed on the page. The API, its lookups, imports, branching, filters, and transformations are cloned.
  8. Select Clone API.

The clone opens in API builder. If it uses connections, review them on Connections.

Each combination of HTTP method, version, and relative URI must be unique within an environment. In the standard Sandbox and Production setup, the combination must be unique across both environments, because they share API tokens.

Move an API to another integration

  1. Select Actions elipses-button.png > Move to other integration on the API's row.
  2. Select Create new integration or Move to existing integration.
  3. If you selected Move to existing integration, select the integration in Select integration.
  4. Select Save & next.

Delete and restore an API

Deleting an API sends it to the Recycle bin. It is purged after 30 days or when your account's data retention period purges it. If you pushed the API to your API Management console, deleting it can affect the consumers that rely on it. Update the API and its OpenAPI specification in that console.

To delete an API:

  1. Turn the API off.
  2. Select Actions elipses-button.png > Delete API on the API's row, or in API builder.
  3. Confirm the deletion.

To restore an API:

  1. Go to Resources, and then select Recycle bin.
  2. On the API's row, select Actions elipses-button.png > Restore.

A restored API is switched on.

To remove an API permanently, select Actions elipses-button.png > Purge on its row in the Recycle bin.

Group APIs in an integration

API groups organize the APIs in an integration. Groups are available only in an integration.

To create a group:

  1. Open the integration and select APIs.
  2. Select Create > Create API group.
  3. Enter a Group name.
  4. (Optional) In APIs, select the APIs to add.
  5. Select Save.

The API groups panel lists your groups and an Unassigned group for APIs that aren't in a group. To create an API in a group, select the group, and then select Create > API. To change or delete a group, select it, and then select Edit API group or Delete API group. To add or remove APIs in a group, select Edit API group, and then change APIs. Deleting a group doesn't delete its APIs. They move to Unassigned.