Organization API access

Use API in your organization's settings to enable API access, reveal its key, and configure permitted IP addresses for managing its environments.

For sending data into a project's flows, see Interfaces.

Open the API settings

1. Open the organization's Settings.
2. Select the API tab.

Opening the settings page in the interface requires the update organizations permission. Loading the settings and revealing the key also require view organization settings. Full Admins receive both permissions by default. See Roles and restrictions for general access information.

To reveal the key, confirm your own account password. Your account and the organization must be active.

Enable the organization API key

1. Turn on Enable API access.
2. Select Save changes at the bottom of the form.

Turning on the switch displays API configuration and Security restrictions. The key remains masked until you confirm your password. The switch changes the form immediately; selecting Save changes saves the access setting.

If API configuration displays URL rows, select Copy endpoint URL beside a URL to copy it. Successful copying displays Endpoint URL copied. The URL table is not displayed when no URLs are available.

Changing the access setting or the IP list preserves the existing API key.

Reveal the API key

The API key field is read-only and masked when you open the settings.

1. Select Show beside API key.
2. In Show API key?, enter your account password.
3. Select Show API key. The confirmation button is disabled while the password is empty or being checked.
4. After the key appears, select Copy to copy it. Successful copying displays API key copied.
5. Select Hide to mask the value again.

Saving settings successfully also masks a previously revealed key.

Configure allowed IP addresses

Use IP allowlist under Security restrictions to configure permitted source IP addresses. The settings editor accepts IPv4 addresses.

1. Enter one IPv4 address, such as 192.168.1.1, and press Enter or type a comma to add it to the list.
2. Add each additional address separately.
3. Review the entries. Each address must appear only once.
4. Select Save changes.

Invalid entries remain visible and highlighted. The page displays Enter a valid IP address. Invalid value: followed by the invalid value. Duplicate entries display IP addresses cannot be duplicated. Remove the affected entries and add the correct address once.

IPv6 addresses, wildcard addresses, and CIDR expressions are not accepted by this settings editor. While API access is enabled, invalid or duplicate entries prevent saving.

The field's help explains that an empty list allows requests from any IP address. To clear the configured list, remove all entries and select Save changes.

Disable organization API access

1. Open Settings > API for the organization.
2. Turn off Enable API access.
3. Select Save changes.

Turning off the switch hides API configuration and Security restrictions. Saving turns off the organization's API access setting and preserves its key.

To enable access again, turn on Enable API access and select Save changes.

Save changes and resolve errors

Save changes is disabled when the form has no unsaved changes, while settings are loading or saving, or when enabled API access has invalid or duplicate IP entries. While saving, the button displays Saving.... A successful save displays Changes saved.

Turning off Enable API access hides the IP list but does not clear it. Invalid IP addresses still prevent the changes from being saved. Turn access on again to remove or correct those entries, then choose the access setting you want and save.

Message or condition	What to check
Couldn't verify your password.	Confirm your own password, organization membership, and permission to view organization settings.
An invalid IP address is highlighted.	Remove it and add a valid IPv4 address.
IP addresses cannot be duplicated.	Remove repeated entries so each address appears once.
Couldn't save your changes.	Review the form and retry. Saving requires update organizations permission.