> For the complete documentation index, see [llms.txt](https://documentation.astera.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.astera.com/astera-data-stack-v8/api-flows/api-consumption/consume/using-rest-client-outside-of-the-scope-of-the-project.md).

# Using REST Client Outside of the Scope of the Project

The REST Client object in Astera can be used outside the scope of a project, such as in a dataflow. The REST API Browser is dependent upon the project, which is why when using REST Client outside the project’s scope, we have to make each request manually.

To use the REST Client object in a dataflow, follow the steps below:

1. Drag and drop the *RESTConnection* object onto the dataflow designer.

![](/files/X37Oe87pADvVEjqKyoni)

2. Right-click on the header of *RESTConnection* object and select *Properties*.

The *REST Connection* window will open where you can specify the *Base URL* of the API using which you can establish your REST Client’s connection. Specify the *Security Type,* if your API requires authentication, otherwise click *OK*.

In this scenario, we are using Petstore’s open API definition. So, we do not need any authentication.

![](/files/6yrPiXEa9N3CzXKMB7U0)

3. Right-click on the header of the REST Client object and select *Properties*. The *REST API Client* screen will open where you will have to specify the following:
   * *Shared Connection –* the shared action using which you want to establish your REST Client’s connection

### **REST Request**

* *HTTP Method –* the HTTP request which you want to make
* *Resource –* the resource of the API which you want to make a GET request from
* *Content Type* – JSON, by default. If there comes a type which is not supported, a popup notification will appear to prompt the the content type is not supported. Click ok, then the new content type starts appearing in the properties

![](/files/lO8hnrXKSf3YObeDUAHH)

1. Click *Next*. A *Parameters* screen will appear where you will have to specify the following:
   * *Name* – the name of your parameter
   * *Parameter Location* – the parameter type such as Query, URI, and Header. In this example, we are using a *Query* parameter.
   * *Data Type* – specify the data type of your parameter
   * *Default Value* - the parameter’s value for which you want to make a GET request. In this case, it is “available.”

![](/files/evrLyhDvDbk9Qm1WBbIa)

2. Click *Next*. A *REST Client Output Layout* screen will open where we will *Select Generate the Layout by Running Request* to build the response layout. Then click *Ok*.

![](/files/DrXPN86RbljOeZtkUFsv)

3. Now right-click on the header of the REST Client object and select *Preview Output*.

Your request has successfully been executed as you can see that *HTTPStatusCode* is 200 which means that the REST Client has successfully carried out GET request for the “available” status.

![](/files/SamMaqdjjqKNOkJFIidP)

This concludes working with REST Client object outside the scope of the project in Astera.

![](/files/J7YyUBSXocQWhHqD2oh0)


---

# 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://documentation.astera.com/astera-data-stack-v8/api-flows/api-consumption/consume/using-rest-client-outside-of-the-scope-of-the-project.md?ask=<question>&goal=<endgoal>
```

`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.