> For the complete documentation index, see [llms.txt](https://docs.heisenware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.heisenware.com/~/changes/Q625pQNc0nXqVGPtyjAY/building-apps/integration/protocol-connectors/http-rest.md). # HTTP/REST To integrate data from HTTP/REST servers exposed to the internet, you can establish a connection with a REST API. To start, navigate to `Protocol Connectors` in the functions panel and unfold `HTTP/REST`. {% hint style="info" %} To integrate a server from a local network, you need to deploy an HTTP/REST [edge connector](/~/changes/Q625pQNc0nXqVGPtyjAY/building-apps/integration/edge-connector.md) first. Afterward, you can use the same functions described in this article. {% endhint %} ## REST API instance If a REST API is to be integrated and your app needs to repeatedly access this API using different types of requests or resources, it is recommended to create an instance for this connection to avoid re-entering the URL every time. ### Create a REST API connection With the `create` function, you can add a fixed REST API connection instance and use all the [RESTful server request functions](#restful-server-requests) below. Do so by using and configuring the create function. Remember to name your instance in the yellow naming box.

The connection instance will appear in the functions panel. After that, you can use the functions from inside the instance from under `Protocol Connectors -> HTTP/REST -> {instance name}` by dragging them onto the board.

Example of `GET` usage with pre-existing REST instance

### Delete a REST API connection To remove a REST API connection, use the `delete` function by inserting the name of the instance into the yellow box and triggering the function.

## RESTful server requests The [HTTP/REST protocol](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) functions are used to connect to an existing HTTP server with RESTful requests. All these functions are also available within a connection instance, specifically created for a connected REST API. ### Do a GET request With the `get` function, you can do a simple HTTP `GET` request to a server. Parameters can either be added at the end of the URL in the first input box or as an object in the second input box. The output is a JSON object with the HTTP header information removed.

The same GET request, but using the parameter input box

### Do a DELETE request Using the `delete` function, you can remove a resource from a server. Enter the URL of the resource you wish to delete in the input box and execute the function. `DELETE` requests typically don't include parameters. The output is the HTTP response in full, including header information.

Removing a resource with a DELETE request

### Do a HEAD request With the `head` function, you can do a [`HEAD`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD) request to a server, e.g. to get the content length of a GET request, without actually getting the content. Follow the same syntax as in the [`GET`](#do-a-get-request) example.

HEAD request with same URL as in the GET example

### Do an OPTIONS request With the `options` function, you can request which HTTP requests you are allowed to do on a specific resource. The allowed requests are listed under `headers -> allow` in the output.

### Do a POST request With the `post` function, you can invoke a `POST` request for updating an existing resource on a server or adding a subsidiary resource to an existing one. POST is not defined as idempotent, meaning that the same request sent multiple times may have different results. * Insert the URL, including the server path, into the first input box. * Drag your data into the second input box. {% hint style="info" %} You can also drag and drop files from the file manager on the bottom left into the second input field. {% endhint %}

Creating a new sub-resource with a POST request

### Do a PUT request With the `put` function, you can invoke a `PUT` request for replacing an existing resource on a server or adding a new resource at a new path. PUT is defined as idempotent, meaning that the same request sent multiple times should have the same result, provided the server has implemented PUT correctly.

Replacing an existing resource with a PUT request

### Do a PATCH request The `patch` function creates a [`PATCH`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH) request, with which you can modify a resource on a server. PATCH requests are often omitted in the implementation of the server. You may check if it is supported with the [`options`](#do-an-options-request) function.

Modifying an existing resource with a PATCH request

--- # 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.heisenware.com/~/changes/Q625pQNc0nXqVGPtyjAY/building-apps/integration/protocol-connectors/http-rest.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.