Create and manage APIs using API builder

You can start a new API from any of these locations:

If a published API is likely to return large result sets, you can turn on pagination to return results in pages instead of a single response. Pagination is available for APIs whose first lookup — the lookup that runs earliest in your API's flow — uses HTTP, Salesforce, or NetSuite as its source. If your API's first lookup uses a relational database or other source type, API builder blocks pagination at save with a validation error.

{
  "data": [...],
  "pagination": {
    "has_more": true,
    "next_cursor": "..."
  }
}

If a connection your API uses goes offline, the API can fail right away or wait for the connection to come back. The Immediate error for offline connections setting controls which one happens. The setting applies only to APIs built in API builder. Flows and other run types aren't affected.

• On — The API returns HTTP 500 immediately if any connection the API uses is offline, including connections on branches the current request doesn't run.
• Off — When a request reaches a step that uses an offline connection, the API waits and checks the connection every 60 seconds. The request continues if the connection comes back online before the API times out.

New APIs have the setting turned on. Existing APIs may have it turned off, so check the setting on any API that should fail fast. You can change it on any API.

How long the API waits

When the setting is off, an API waits for an offline connection until the API's timeout runs out. By default, the timeout is your account's Organization-wide API timeout limit (Account → Company → API builder), which is 120 seconds unless an account owner or administrator changes it. To use a different timeout for one API, enter a value from 0 to 120 seconds in that API's Override timeout field. The override takes precedence over the organization-wide limit, and it can be longer or shorter.

Change the setting

1. Go to Resources → APIs → API builder, and then select your API.
2. In your API, open API settings and go to the Advanced section.
3. Check Immediate error for offline connections to turn the setting on, or clear it to turn it off.
4. Select Save.

Choose the right setting

• Turn the setting on when callers need a fast, predictable response, such as a storefront or partner system that can fail over to another path or retry later.
• Leave the setting off if callers should wait out a short outage. The wait never runs longer than the API timeout.
• Remove connections your API no longer uses. With the setting on, an offline connection on an unused branch still fails every request.

If requests fail because a connection is offline, see Troubleshoot offline connection failures in Troubleshoot APIs.

The APIs list shows every API you've created in API builder. You see this list on the APIs page (Build > APIs) and on an integration's API builder tab. It includes these details:

You can clone an API for versioning, testing, repurposing, or promotion to a new environment.

To clone an API:

After an API is deleted, it's placed in the Recycle bin and purged according to your organization's data retention period.

If the API has been pushed to the API Management console, deleting it may affect existing API consumers relying on it. You must update the API and the OpenAPI specification in the API Management console.

To delete an API from the API builder list view:

To delete an API from the API builder:

You can invoke an API using a third-party tool, such as Postman, with cURL and an API token. You never need to include any form of authentication in custom headers. All APIs created in the Celigo platform automatically include token authentication and require an API token to be invoked externally. You can use other authentication methods, such as JWT or OAuth 2.0, with API Management, but you must manually update the OpenAPI schema in the API Management console.

To copy your invoke URL:

To generate an API token, see Create and manage API and Personal Access tokens. You can create a custom API token that only applies to specific APIs or a token that has full access to your Celigo platform account.

The following limits and requirements apply to requests and responses: