> For the complete documentation index, see [llms.txt](https://docs.lowcoder.cloud/lowcoder-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lowcoder.cloud/lowcoder-documentation/connect-your-data/data-sources-in-lowcoder/apis-as-datasource/rest-api.md). # REST API ## Connect REST API to Lowcoder Follow these steps to connect to REST APIs. 1. Click **Data Sources** on Lowcoder homepage. 2. Click **New Data Source** on the upper right. This permission is restricted to workspace admins and developers. 3. Select **APIs** > **REST API**. 4. Configure general settings. At a minimum, input **Name** and the base **URL** of the API to connect to. **Headers** and **Parameters** are optional. These are all common parameters that consist of URL query prefixes. 5. Configure **Authentication Type**. 6. Click **Save**. You can also connect to a new REST API data source when creating or editing queries in query library or query editor. ## Authentication type The default authentication type is **None**. Other options are **Basic** and **Digest**, which require configuration of **Username** and **Password**. If you need other customized authentication methods, contact our customer service on the [homepage](https://Lowcoder.dev). ## SSL Cert Verification In the advanced settings tab, you can configure SSL Cert Verification for your data sources. Three options are available: CA (Certificate Authority) Certificate, Self Signed Certificate, or Disabled. For security reasons, Lowcoder accepts APIs with CA certificates by default. For APIs without CA certificates, you can either select "Verify Self Signed Cert" and enter the self-signed certificate or disable the SSL Cert verification. Note that for self-signed certificate, the information should be provided in .[PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) (Privacy-Enhanced Mail) format. This certificate will be encrypted and stored securely in Lowcoder. ## Forward cookies If you are self-hosting Lowcoder in your own domain, you can make REST API requests with cookies to existing services under that domain. You can either toggle the option "Forward all cookies" or specify certain cookies to forward in the text box. This feature can be helpful in cases where you use cookies to share common context (like identity info in JWT format) across different services. ## Create a REST API query You can create REST API queries in two ways: * add a new data source and then create a query * create a query directly Note that without creating a new data source, the REST API data source is not stored in your **Data Sources** and thus cannot be accessed to build other queries. ### Create a query with a new data source Follow the steps to add a new REST API data source first and then create a query. 1. Connect REST API to access to. 2. In the query editor, click **+ New**. 3. Select the added API in **Data source**. 4. Enter URL, Headers, Parameters, and fill in other fields if needed. 5. Click ▶ **Run**. ### Create a REST API query with predefined data source Follow the steps to create a REST API query directly. 1. In the query editor, click **+ New**. 2. Select **REST Query** in Data Sources. Lowcoder offers this built-in plain data source so that you can quickly create REST API queries without adding a new data source first. 3. Enter URL, Query, Variables, Parameters, and fill in other fields if needed. 4. Click ▶ **Run**. ### Demo {% embed url="" %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.lowcoder.cloud/lowcoder-documentation/connect-your-data/data-sources-in-lowcoder/apis-as-datasource/rest-api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.