# List promote paths

URL: https://docs.hanzo.ai/docs/openapi/o11y/get-o11y-logs-promote-paths

> Lists the log body paths already promoted or indexed, with the indexes each carries.

`GET /v1/o11y/logs/promote_paths`

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

|               |                                                   |
| ------------- | ------------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/o11y/logs/promote_paths` |
| **Method**    | `GET`                                             |
| **Operation** | `get_o11y_logs_promote_paths`                     |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`            |

Lists the log body paths already promoted or indexed, with the
indexes each carries.

Callers need the viewer role; the runtime's own gate enforces it.

## Request

`GET /v1/o11y/logs/promote_paths` takes no parameters and no body — the credential is the whole request.

## Response

| Status    | Body                    | Meaning           |
| --------- | ----------------------- | ----------------- |
| `200`     | o11y.O11yLogPromotedOut | ok                |
| `202`     | Approval                | held for approval |
| `default` | problem-details         | refused           |

`200` body — 8 fields.

| Field                            | In   | Type                        | Always | Description                                                                      |
| -------------------------------- | ---- | --------------------------- | ------ | -------------------------------------------------------------------------------- |
| `data`                           | body | o11y.O11yLogPromotePath\[]  | —      | Data holds the paths.                                                            |
| `data[].indexes`                 | body | o11y.O11yLogPromoteIndex\[] | —      | Indexes are the indexes to put on the path.                                      |
| `data[].indexes[].fieldDataType` | body | string                      | —      | FieldDataType is the path's data type, e.g. string, number, bool.                |
| `data[].indexes[].granularity`   | body | integer (int64)             | —      | Granularity is the index granularity in rows.                                    |
| `data[].indexes[].type`          | body | string                      | —      | Type is the index type, e.g. minmax, set(N), bloom\_filter(P).                   |
| `data[].path`                    | body | string                      | —      | Path is the body path, e.g. body.user.id on the way in; listed without the body. |
| `data[].promote`                 | body | boolean                     | —      | Promote lifts the path into its own column when true.                            |
| `status`                         | body | string                      | —      | Status is "success".                                                             |

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

## Examples

**CLI**

```bash
hanzo o11y logs promote_paths get
```

**SDK**

**.ts**

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

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

**.py**

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

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

**.go**

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

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

**.rs**

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

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

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

**.java**

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

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

var result = new O11yApi(client).getO11yLogsPromotePaths();
```

**HTTP**

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

**MCP**

MCP reaches **o11y** through the `o11y` tool, which names its 307 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_o11y_autocomplete_aggregate_attributes"
         }
       }
     }'
```

---

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