# List nodes

URL: https://docs.hanzo.ai/docs/openapi/ai/get-ai-nodes

> List the caller's nodes.

`GET /v1/ai/nodes`

> [AI →](https://docs.hanzo.ai/docs/openapi/ai) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                        |
| ------------- | -------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/ai/nodes`     |
| **Method**    | `GET`                                  |
| **Operation** | `get_ai_nodes`                         |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY` |

List the caller's nodes.

## Request

`GET /v1/ai/nodes` takes no parameters and no body — the credential is the whole request.

## Response

| Status | Body | Meaning                                             |
| ------ | ---- | --------------------------------------------------- |
| `200`  |      | Envelope.                                           |
| `401`  | —    | No credential, or one this service does not accept. |
| `403`  | —    | A valid credential that may not do this.            |

`200` body — 53 fields.

| Field                               | In   | Type         | Always | Description                                             |
| ----------------------------------- | ---- | ------------ | ------ | ------------------------------------------------------- |
| `data`                              | body | any          | —      | The operation's own result.                             |
| `data2`                             | body | any          | —      | A second result the operation defines, when it has one. |
| `msg`                               | body | string       | yes    | Empty on success, the reason on failure.                |
| `status`                            | body | string       | yes    | One of `ok`, `error`.                                   |
| `data[].autoQuery`                  | body | boolean      | —      |                                                         |
| `data[].category`                   | body | string       | —      |                                                         |
| `data[].cpuSize`                    | body | string       | —      |                                                         |
| `data[].createdTime`                | body | string       | —      |                                                         |
| `data[].description`                | body | string       | —      |                                                         |
| `data[].displayName`                | body | string       | —      |                                                         |
| `data[].enableRemoteApp`            | body | boolean      | —      |                                                         |
| `data[].isPermanent`                | body | boolean      | —      |                                                         |
| `data[].language`                   | body | string       | —      |                                                         |
| `data[].machineName`                | body | string       | —      |                                                         |
| `data[].memSize`                    | body | string       | —      |                                                         |
| `data[].name`                       | body | string       | —      |                                                         |
| `data[].os`                         | body | string       | —      |                                                         |
| `data[].owner`                      | body | string       | —      |                                                         |
| `data[].patches`                    | body | Patch\[]     | —      |                                                         |
| `data[].patches[].category`         | body | string       | —      |                                                         |
| `data[].patches[].expectedStatus`   | body | string       | —      |                                                         |
| `data[].patches[].installTime`      | body | string       | —      |                                                         |
| `data[].patches[].message`          | body | string       | —      |                                                         |
| `data[].patches[].name`             | body | string       | —      |                                                         |
| `data[].patches[].size`             | body | string       | —      |                                                         |
| `data[].patches[].status`           | body | string       | —      |                                                         |
| `data[].patches[].title`            | body | string       | —      |                                                         |
| `data[].patches[].url`              | body | string       | —      |                                                         |
| `data[].privateIp`                  | body | string       | —      |                                                         |
| `data[].publicIp`                   | body | string       | —      |                                                         |
| `data[].remoteApps`                 | body | RemoteApp\[] | —      |                                                         |
| `data[].remoteApps[].no`            | body | integer      | —      |                                                         |
| `data[].remoteApps[].remoteAppArgs` | body | string       | —      |                                                         |
| `data[].remoteApps[].remoteAppDir`  | body | string       | —      |                                                         |
| `data[].remoteApps[].remoteAppName` | body | string       | —      |                                                         |
| `data[].remotePassword`             | body | string       | —      |                                                         |
| `data[].remotePort`                 | body | integer      | —      |                                                         |
| `data[].remoteProtocol`             | body | string       | —      |                                                         |
| `data[].remoteUsername`             | body | string       | —      |                                                         |
| `data[].services`                   | body | Service\[]   | —      |                                                         |
| `data[].services[].expectedStatus`  | body | string       | —      |                                                         |
| `data[].services[].message`         | body | string       | —      |                                                         |
| `data[].services[].name`            | body | string       | —      |                                                         |
| `data[].services[].no`              | body | integer      | —      |                                                         |
| `data[].services[].path`            | body | string       | —      |                                                         |
| `data[].services[].port`            | body | integer      | —      |                                                         |
| `data[].services[].processId`       | body | integer      | —      |                                                         |
| `data[].services[].status`          | body | string       | —      |                                                         |
| `data[].services[].subStatus`       | body | string       | —      |                                                         |
| `data[].size`                       | body | string       | —      |                                                         |
| `data[].tag`                        | body | string       | —      |                                                         |
| `data[].type`                       | body | string       | —      |                                                         |
| `data[].updatedTime`                | body | string       | —      |                                                         |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo ai nodes list
```

**SDK**

**.ts**

```ts
import { Configuration, AiApi } from 'hanzoai';

const api = new AiApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getAiNodes();
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import AiApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = AiApi(client).get_ai_nodes()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.AiAPI.GetAiNodes(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, ai_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = ai_api::get_ai_nodes(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.AiApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new AiApi(client).getAiNodes();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/ai/nodes \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

MCP declares no tool for **ai** — `tools/list` on `https://api.hanzo.ai/v1/mcp` names the products it does reach. Use HTTP or an SDK.

---

[AI API](https://docs.hanzo.ai/docs/openapi/ai) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)