Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.elementum.io/llms.txt

Use this file to discover all available pages before exploring further.

In addition to data warehouses, Elementum can create a CloudLink to an external REST API. The primary use case for an API CloudLink is populating API-powered dropdowns—it stores the base URL and credentials in one place so dropdown fields and API Elements can call the API without re-entering connection details. If you’re new to CloudLink, start with the CloudLink Overview for the underlying concepts and security model.
Before creating an API CloudLink, review Populate Dropdown Fields from External APIs to confirm this is the right setup for your use case and to see how the CloudLink is consumed downstream.
AI services are not supported on API CloudLinks. AI Services (LLMs, embeddings, Snowflake Cortex, etc.) require a CloudLink configured against a supported data warehouse such as Snowflake. If you need AI services, set up a Snowflake CloudLink instead.

​
Prerequisites

Before creating an API CloudLink, gather:
  • Admin access to your Elementum organization (required to manage CloudLinks)
  • Base URL of the external API (for example, https://api.example.com/v1)
  • Authentication details for the API, depending on the method:
    • Basic — username and password
    • Bearer Token — a static API token
    • OAuth 2.0 — token URL, client ID, and client secret
  • Network reachability — confirm the API is reachable from the public internet. Elementum sends API requests server-side from its platform infrastructure.
1

Open the CloudLinks page

In Elementum, open Settings icon Organization Settings and select CloudLinks.
2

Start a new CloudLink

Click + CloudLink in the upper right. In the Create New CloudLink dialog, select API.
3

Enter connection details

Fill out the API connection form:
FieldDescription
NameA descriptive name for the connection (for example, Acme CRM or Internal Pricing API). This is how the CloudLink appears in pickers across Elementum.
Base URLThe root URL of the API. Endpoint paths configured later (on Elements or dropdown fields) are appended to this base URL. Use https:// for production APIs.
AuthenticationThe method used to authenticate requests. See API authentication methods below.
4

Configure authentication

Select an authentication method from the dropdown and provide the required credentials. The fields displayed change based on the method you choose.
5

Save the connection

Click Save. The new API CloudLink appears on the CloudLinks page and can be selected when configuring API Elements or API-powered dropdown fields.

​
API authentication methods

Choose the method supported by the external API:
MethodRequired fieldsNotes
BasicUsername, PasswordSent as a Base64-encoded Authorization: Basic header. Use only over HTTPS.
Bearer TokenTokenSent as Authorization: Bearer <token> on every request.
OAuth 2.0Token URL, Client ID, Client Secret (optional Scope)Elementum runs the client credentials flow, caches the access token, and refreshes it automatically before expiration.
None—No authentication header is sent. Use only for public, unauthenticated endpoints.
Avoid Basic authentication over non-HTTPS endpoints. Credentials are stored encrypted at rest in Elementum and are not displayed again in the UI after they’re saved.

​
Edit or rotate API credentials

To update the URL or credentials on an existing API CloudLink:
  1. On the CloudLinks page, click Edit next to the API connection.
  2. Change the fields you need to update and click Save.
For credential rotation, update the credentials in the external system first, then update them on the CloudLink to keep requests flowing without an outage. After the API CloudLink is saved, use it to power dropdown fields. Continue with Populate Dropdown Fields from External APIs, which covers both options:
  • API Picklist field — A dropdown that calls the CloudLink’s endpoint directly and maps the response to options.
  • Dynamic Dropdown on an API Element — A dropdown backed by an API Element built on top of the CloudLink, suited for cases where the external data needs to participate in relationships, calculations, or reports.

​
Troubleshooting

IssueResolution
Save fails with an authentication errorConfirm the credentials work outside Elementum (for example, with curl or Postman). For OAuth 2.0, verify the token URL and that the client has access to the requested scope.
Requests time outConfirm the API is reachable from the public internet. If the API restricts inbound traffic, allow Elementum’s outbound IP addresses (see Elementum IP addresses).
Dropdown or Element returns no dataVerify the Base URL does not include a trailing endpoint path that conflicts with the path configured on the Element or dropdown. Endpoints are appended to the base URL.
Need to change the auth methodEdit the CloudLink and select a different Authentication option. The credential fields update to match the new method.

​
Next steps

API-powered dropdowns

Use this CloudLink to populate dropdown fields from external APIs.

CloudLink Overview

Review the CloudLink concept and security model.