> For the complete documentation index, see [llms.txt](https://docs.flashback.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flashback.tech/support-reference/platform-api-reference/storage-apis/node-information/get__node.md).

# get\_\_node

`GET /node`

*List Nodes*

Get all available Flashgate nodes. Returns a structured response with success status, data array, and total count.

#### Query Parameters

| Name           | Type   | Required | Description                                                                                  |
| -------------- | ------ | -------- | -------------------------------------------------------------------------------------------- |
| `nodeServices` | number | yes      | Filters nodes by service flag using a bitwise AND operation. If `0`, all nodes are returned. |

**Service Flags (`BridgeTypes.ServiceFlag`)**

The `nodeServices` parameter uses a bitwise flag mode to filter nodes based on their capabilities. The available flags defined in the enum are:

* `SERVICE_FLAG_NONE = 0` (Returns all nodes)
* `SERVICE_FLAG_STORAGE = 1`
* `SERVICE_FLAG_AILLM = 2`
* `SERVICE_FLAG_CHAT = 4`

To query for multiple services at once, combine them using the bitwise OR (`|`) operator.

**Example:** For example, if you want to list all storage and aillm nodes, you must pass: `?nodeServices=BridgeTypes.ServiceFlag.SERVICE_FLAG_STORAGE | SERVICE_FLAG_AILLM` *(Note: In raw HTTP requests, this evaluates to the integer `3`)*

#### TypeScript Client Library

```typescript
// Using the Flashgate TypeScript client
import { FlashgateClient, BridgeTypes } from '@flashgate/client';

const client = new FlashgateClient({
  accessToken: 'your-access-token'
});

// Get all storage and AI LLM nodes
try {
  const result = await client.nodes.list({
    nodeServices: BridgeTypes.ServiceFlag.SERVICE_FLAG_STORAGE | BridgeTypes.ServiceFlag.SERVICE_FLAG_AILLM
  });
  console.log('Available nodes:', result);
} catch (error) {
  console.error('Failed to retrieve nodes:', error);
}
```

#### Code Samples

{% tabs %}
{% tab title="Shell" %}

```shell
# You can also use wget
curl -X GET https://backend.flashback.tech/node?nodeServices=3 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'
```

{% endtab %}

{% tab title="HTTP" %}

```http
GET https://backend.flashback.tech/node?nodeServices=3 HTTP/1.1
Host: localhost:3000
Accept: application/json
```

{% endtab %}

{% tab title="JavaScript" %}

```javascript
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://backend.flashback.tech/node?nodeServices=3',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
```

{% endtab %}

{% tab title="Ruby" %}

```ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://backend.flashback.tech/node?nodeServices=3',
  params: {
  }, headers: headers

p JSON.parse(result)
```

{% endtab %}

{% tab title="Python" %}

```python
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://backend.flashback.tech/node?nodeServices=3', headers = headers)

print(r.json())
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://backend.flashback.tech/node?nodeServices=3', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
```

{% endtab %}

{% tab title="Java" %}

```java
URL obj = new URL("https://backend.flashback.tech/node?nodeServices=3");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
```

{% endtab %}

{% tab title="Go" %}

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://backend.flashback.tech/node?nodeServices=3", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
```

{% endtab %}
{% endtabs %}

> Example responses

> 200 Response

```json
{
  "success": true,
  "data": [
    {
      "nodeServices": 3,
      "url": "string",
      "ip": "string",
      "region": "string",
      "version": "string",
      "status": "string",
      "lastUpdated": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 1
}
```

#### Responses <a href="#get__node-responses" id="get__node-responses"></a>

| Status | Meaning                                                 | Description                  | Schema |
| ------ | ------------------------------------------------------- | ---------------------------- | ------ |
| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Nodes retrieved successfully | Inline |

#### Response Schema <a href="#get__node-responseschema" id="get__node-responseschema"></a>

Status Code **200**

| Name      | Type        | Required | Restrictions | Description                             |
| --------- | ----------- | -------- | ------------ | --------------------------------------- |
| » success | boolean     | false    | none         | Indicates if the request was successful |
| » data    | \[NodeInfo] | false    | none         | Array of available nodes                |
| » total   | number      | false    | none         | Total number of nodes returned          |

**NodeInfo Object**

| Name           | Type              | Required | Restrictions | Description                          |
| -------------- | ----------------- | -------- | ------------ | ------------------------------------ |
| » nodeServices | number            | false    | none         | Service capability flags of the node |
| » url          | string            | false    | none         | Endpoint URL of the node             |
| » ip           | string            | false    | none         | IP address of the node               |
| » region       | string            | false    | none         | Geographic region of the node        |
| » version      | string            | false    | none         | Version of the node software         |
| » status       | string            | false    | none         | Current status of the node           |
| » lastUpdated  | string(date-time) | false    | none         | Last update timestamp                |


---

# 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.flashback.tech/support-reference/platform-api-reference/storage-apis/node-information/get__node.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.
