SigNoz

Generated SigNoz CLI and agent Skill for dashboards, alerts, traces, logs, and metrics.

$ signoz search "list dashboards" --json

CLI binaries 6 platform builds

Skill Included in CLI

Source refs 1 pinned inputs

Smoke intent list dashboards

01 Schema signoz commands schema --json

02 Catalog signoz commands --json

03 Search signoz search "list dashboards" --json

Recipe structure

Files

10 files

builds/signoz.json json

{
  "schema_version": 1,
  "recipe": "signoz",
  "cli_name": "signoz",
  "generated_at": "2026-08-21T06:47:11.083Z",
  "lathe_version": "lathe v0.5.2 (none, unknown)",
  "gate": {
    "verdict": "GO",
    "generated_at": "2026-08-21T06:47:11.083Z",
    "lathe_version": "lathe v0.5.2 (none, unknown)",
    "command_count": 213,
    "group_count": 29,
    "skill_included": true,
    "warnings": [
      "W2"
    ]
  },
  "source_refs": [
    {
      "name": "signoz",
      "display_name": "signoz",
      "backend": "openapi3",
      "repo_url": "https://github.com/SigNoz/signoz",
      "pinned_tag": "e728942fec39378a2afcec67af7b92124ba24c2d",
      "files": [
        "docs/api/openapi.yml"
      ]
    }
  ],
  "outputs": {
    "catalog": null,
    "skill": "skills/signoz",
    "cli_artifacts": [
      {
        "os": "darwin",
        "arch": "arm64",
        "format": "tar.gz",
        "binary": "signoz",
        "path": "downloads/signoz-darwin-arm64.tar.gz",
        "size": 3816461,
        "sha256": "sha256:f3dd95355710b1a2716505d97550f2129ad0715226a2d68da1f9be78edf60f11"
      },
      {
        "os": "darwin",
        "arch": "amd64",
        "format": "tar.gz",
        "binary": "signoz",
        "path": "downloads/signoz-darwin-amd64.tar.gz",
        "size": 4181983,
        "sha256": "sha256:742b2c67eb50369d59a94b325f80f5378f4cce1d08650adf3eb3efcbc33053a8"
      },
      {
        "os": "linux",
        "arch": "amd64",
        "format": "tar.gz",
        "binary": "signoz",
        "path": "downloads/signoz-linux-amd64.tar.gz",
        "size": 4115999,
        "sha256": "sha256:3ab87340d942bbd8af3989e9babcb7982ab09b66e4ddea14e5aeb59139bb9c67"
      },
      {
        "os": "linux",
        "arch": "arm64",
        "format": "tar.gz",
        "binary": "signoz",
        "path": "downloads/signoz-linux-arm64.tar.gz",
        "size": 3674322,
        "sha256": "sha256:fede015a12283b79dc9bc8967ed5dbce979169f5476292a3c34c58cd236dae91"
      },
      {
        "os": "windows",
        "arch": "amd64",
        "format": "tar.gz",
        "binary": "signoz.exe",
        "path": "downloads/signoz-windows-amd64.tar.gz",
        "size": 4234552,
        "sha256": "sha256:0f81f93a5f452b0c7cf44c462549ea5da4ccbc0496394305a592208ece083e8c"
      },
      {
        "os": "windows",
        "arch": "arm64",
        "format": "tar.gz",
        "binary": "signoz.exe",
        "path": "downloads/signoz-windows-arm64.tar.gz",
        "size": 3734682,
        "sha256": "sha256:4d7bc0a38446352540fce75099e4b73bcf2cd8dc4d05536040819204595e70fb"
      }
    ]
  }
}

recipes/signoz/README.md markdown

# SigNoz

This recipe generates the `signoz` CLI and agent Skill for
[SigNoz](https://github.com/SigNoz/signoz) dashboards, alerts, traces, logs,
metrics, and related observability APIs.

## API and authentication

Create a SigNoz API key and use the `SigNoz-Api-Key` header:

```sh
signoz auth login --hostname <host> --auth-type apikey
signoz auth status --hostname <host>
```

Enter `SigNoz-Api-Key` when the login command asks for the header name.

## Install the Skill

```sh
signoz skill install --scope user --agent codex --yes
```

## Agent workflow

```sh
signoz commands --json
signoz search "list dashboards" --json
```

Use the returned command path with `signoz commands show` before execution.
Bump the pin in `specs/sources.yaml` when upgrading the SigNoz API.

recipes/signoz/cli.yaml yaml

cli:
  name: signoz
  short: "Command-line tool for the SigNoz observability platform"

skill:
  bundle: true

auth:
  validate:
    method: GET
    path: /api/v2/dashboards
    display:
      username_field: status
      fallback_field: status

recipes/signoz/lathe.yaml yaml

name: signoz
display_name: SigNoz
cli_name: signoz
category: observability
homepage: https://github.com/SigNoz/signoz
description: Generated SigNoz CLI and agent Skill for dashboards, alerts, traces, logs, and metrics.
maintainers:
  - github: samzong
auth:
  type: custom
  notes: >-
    Requires a SigNoz API key in the SigNoz-Api-Key header. Run
    `signoz auth login --hostname <host> --auth-type apikey`, enter that header
    name, then verify with `signoz auth status`.
smoke:
  intent: list dashboards
  expect: list-dashboards-for-user-v2

recipes/signoz/specs/sources.yaml yaml

sources:
  signoz:
    default_hostname: localhost:8080
    repo_url: https://github.com/SigNoz/signoz
    # pinned to main HEAD as of 2026-07-26; bump when upgrading
    pinned_tag: e728942fec39378a2afcec67af7b92124ba24c2d
    backend: openapi3
    openapi3:
      files:
        - docs/api/openapi.yml

skills/signoz/.lathe-skill text

generated by lathe codegen; safe to remove and regenerate

skills/signoz/SKILL.md markdown

---
name: signoz
description: >
  Use when operating the signoz generated CLI. Discover commands, inspect parameters,
  check auth state, and execute API operations safely.
---

# signoz CLI

Use this skill when a user asks you to operate `signoz`, inspect its API commands, or find the right generated command for an API task.

## Workflow

1. Search for candidates with `signoz search "<intent>" --json`; use `--limit` when needed. Search is only candidate discovery.
2. Inspect the exact command with `signoz commands show <path...> --json` before executing an unfamiliar command.
3. If the command detail has `auth.required=true`, run `signoz auth status --hostname <host>` before execution. Use `http.default_hostname` when present unless the user provides `--hostname` or `$SIGNOZ_HOST`.
4. Execute only after flags, body, auth, HTTP path, and output hints are clear from `commands show`.

## General Commands

- `signoz commands --json`: full generated command catalog.
- `signoz commands --include-hidden --json`: include hidden generated commands.
- `signoz commands show <path...> --json`: source of truth for one command.
- `signoz commands schema --json`: catalog schema version for parser compatibility.
- `signoz search "<intent>" --json`: ranked candidate commands.

## Maintenance Commands

- `signoz --version` or `signoz -v`: print CLI build version.

## References

- Read `references/catalog.md` for the command discovery protocol and catalog field meanings.
- Read `references/modules/signoz.md` for the `signoz` module command index.

## Rules

- Do not guess flags or request body shape from command names.
- Do not execute directly from search results; confirm with `commands show` first.
- Prefer `-o json` for machine-readable command output unless the user asks for human-readable output.
- Use `--file`, `--set`, or `--set-str` for JSON request bodies according to `commands show` body requirements.
- For sensitive flags, prefer safe modes from `flags[].input_modes`: `--<flag>-env`, `--<flag>-file`, or `--<flag>-stdin`.

skills/signoz/agents/openai.yaml yaml

interface:
  display_name: "signoz CLI"
  short_description: "Use the signoz generated CLI"
  default_prompt: "Use $signoz to find and run the right signoz command."

skills/signoz/references/catalog.md markdown

# Catalog Protocol

Use the runtime catalog as the source of truth. Generated references are a fast index; command execution details come from the CLI itself.

## Search

Run `signoz search "<intent>" --json` to find candidate commands. Use `--limit` to control result count. Treat search output as candidates only.

## Full Catalog

Run `signoz commands --json` to inspect the generated command catalog. Use `--include-hidden` only when hidden commands are relevant.

Key fields:

- `path`: command path to pass to `commands show` or execute after the CLI name.
- `shortcuts`: root-level commands that execute the same operation with preset flag values.
- `http`: HTTP method and path template.
- `http.default_hostname`: optional source-level host selected after explicit `--hostname` and `$SIGNOZ_HOST`; when present it is used before the single-host fallback from `hosts.yml`.
- `flags`: CLI flags, parameter location, type, required state, defaults, enum values, format, input modes, and help.
- `body`: request body requirement and media type.
- `auth`: whether auth is required and which scopes are declared.
- `examples`: runnable examples with optional body shape, output hints, and follow-up commands.
- `output`: list path, default columns, response media type, pagination, and streaming hints.
- `notes`, `prerequisites`, and `known_errors`: overlay-provided operation context that is not inferred from the API spec.

## Command Detail

Run `signoz commands show <path...> --json` before executing an unfamiliar command. This is the source of truth for flags, body, auth, HTTP path, and output hints.

## Schema

Run `signoz commands schema --json` to read the catalog schema version before parsing catalog JSON with durable tooling.

## Sensitive Flags

When a flag entry has `input_modes`, prefer safe modes over putting secrets directly in shell arguments.

- `flag`: pass the direct `--<flag>` value; keep this for compatibility or non-secret values.
- `env`: pass `--<flag>-env NAME` to read the value from an environment variable.
- `file`: pass `--<flag>-file path` to read the value from a file.
- `stdin`: pass `--<flag>-stdin` to read the value from stdin.
- Use only one input mode for the same flag.

## Request Bodies

- `--file path`: read a JSON body from a file.
- `--file -`: read a JSON body from stdin.
- `--set key.path=value`: build JSON with type inference for booleans, null, integers, and floats.
- `--set-str key.path=value`: build JSON while forcing the value to remain a string.

## Output

Use `-o json` for machine-readable command output. Other supported formats are `table`, `yaml`, and `raw`.

## Auth

If command detail returns `auth.required=true`, run `signoz auth status --hostname <host>` before execution. Use `http.default_hostname` when present unless the user provides `--hostname` or `$SIGNOZ_HOST`; if no matching host is logged in, stop and ask the user to authenticate.

skills/signoz/references/modules/signoz.md markdown

# Module `signoz`

## Source

- Backend: `openapi3`
- Default hostname: `localhost:8080`
- Repository: https://github.com/SigNoz/signoz
- Pinned tag: `e728942fec39378a2afcec67af7b92124ba24c2d`
- Files: `docs/api/openapi.yml`
- Resolved SHA: `e728942fec39378a2afcec67af7b92124ba24c2d`

## alerts

### `signoz alerts get-alerts`

- Summary: Get alerts
- HTTP: `GET /api/v1/alerts`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags: none
- Output: list path `data`; columns `endsAt`, `fingerprint`, `generatorURL`, `startsAt`; response media `application/json`

## authdomains

### `signoz authdomains create-auth-domain`

- Summary: Create auth domain
- HTTP: `POST /api/v1/domains`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags: none

### `signoz authdomains delete-auth-domain`

- Summary: Delete auth domain
- HTTP: `DELETE /api/v1/domains/{id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz authdomains get-auth-domain`

- Summary: Get auth domain by ID
- HTTP: `GET /api/v1/domains/{id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz authdomains list-auth-domains`

- Summary: List all auth domains
- HTTP: `GET /api/v1/domains`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags: none
- Output: list path `data`; columns `name`, `id`, `createdAt`, `orgId`, `updatedAt`; response media `application/json`

### `signoz authdomains update-auth-domain`

- Summary: Update auth domain
- HTTP: `PUT /api/v1/domains/{id}`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id

## authz

### `signoz authz authz-check`

- Summary: Check permissions
- HTTP: `POST /api/v1/authz/check`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: list path `data`; columns `authorized`, `relation`; response media `application/json`

## channels

### `signoz channels create-channel`

- Summary: Create notification channel
- HTTP: `POST /api/v1/channels`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags: none

### `signoz channels delete-channel-by-id`

- Summary: Delete notification channel
- HTTP: `DELETE /api/v1/channels/{id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz channels get-channel-by-id`

- Summary: Get notification channel by ID
- HTTP: `GET /api/v1/channels/{id}`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz channels list-channels`

- Summary: List notification channels
- HTTP: `GET /api/v1/channels`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags: none
- Output: list path `data`; columns `name`, `type`, `id`, `createdAt`, `data`, `orgId`; response media `application/json`

### `signoz channels test-channel`

- Summary: Test notification channel
- HTTP: `POST /api/v1/channels/test`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags: none

### `signoz channels test-channel-deprecated`

- Summary: Test notification channel (deprecated)
- HTTP: `POST /api/v1/testChannel`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags: none

### `signoz channels update-channel-by-id`

- Summary: Update notification channel
- HTTP: `PUT /api/v1/channels/{id}`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id

## cloudintegration

### `signoz cloudintegration agent-check-in`

- Summary: Agent check-in
- HTTP: `POST /api/v1/cloud_integrations/{cloud_provider}/accounts/check_in`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags:
  - `--cloud_provider` (path, required): cloud_provider
- Output: response media `application/json`

### `signoz cloudintegration agent-check-in-deprecated`

- Summary: Agent check-in
- HTTP: `POST /api/v1/cloud-integrations/{cloud_provider}/agent-check-in`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags:
  - `--cloud_provider` (path, required): cloud_provider
- Output: response media `application/json`

### `signoz cloudintegration create-account`

- Summary: Create account
- HTTP: `POST /api/v1/cloud_integrations/{cloud_provider}/accounts`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags:
  - `--cloud_provider` (path, required): cloud_provider

### `signoz cloudintegration disconnect-account`

- Summary: Disconnect account
- HTTP: `DELETE /api/v1/cloud_integrations/{cloud_provider}/accounts/{id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--cloud_provider` (path, required): cloud_provider
  - `--id` (path, required): id

### `signoz cloudintegration get-account`

- Summary: Get account
- HTTP: `GET /api/v1/cloud_integrations/{cloud_provider}/accounts/{id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--cloud_provider` (path, required): cloud_provider
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz cloudintegration get-account-service`

- Summary: Get service for account
- HTTP: `GET /api/v1/cloud_integrations/{cloud_provider}/accounts/{id}/services/{service_id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--cloud_provider` (path, required): cloud_provider
  - `--id` (path, required): id
  - `--service_id` (path, required): service_id
- Output: response media `application/json`

### `signoz cloudintegration get-connection-credentials`

- Summary: Get connection credentials
- HTTP: `GET /api/v1/cloud_integrations/{cloud_provider}/credentials`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--cloud_provider` (path, required): cloud_provider
- Output: response media `application/json`

### `signoz cloudintegration get-service`

- Summary: Get service
- HTTP: `GET /api/v1/cloud_integrations/{cloud_provider}/services/{service_id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--cloud_integration_id` (query): cloud_integration_id
  - `--cloud_provider` (path, required): cloud_provider
  - `--service_id` (path, required): service_id
- Output: response media `application/json`

### `signoz cloudintegration list-account-services-metadata`

- Summary: List account services metadata
- HTTP: `GET /api/v1/cloud_integrations/{cloud_provider}/accounts/{id}/services`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--cloud_provider` (path, required): cloud_provider
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz cloudintegration list-accounts`

- Summary: List accounts
- HTTP: `GET /api/v1/cloud_integrations/{cloud_provider}/accounts`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--cloud_provider` (path, required): cloud_provider
- Output: response media `application/json`

### `signoz cloudintegration list-services-metadata`

- Summary: List services metadata
- HTTP: `GET /api/v1/cloud_integrations/{cloud_provider}/services`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--cloud_integration_id` (query): cloud_integration_id
  - `--cloud_provider` (path, required): cloud_provider
- Output: response media `application/json`

### `signoz cloudintegration update-account`

- Summary: Update account
- HTTP: `PUT /api/v1/cloud_integrations/{cloud_provider}/accounts/{id}`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags:
  - `--cloud_provider` (path, required): cloud_provider
  - `--id` (path, required): id

### `signoz cloudintegration update-service`

- Summary: Update service
- HTTP: `PUT /api/v1/cloud_integrations/{cloud_provider}/accounts/{id}/services/{service_id}`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags:
  - `--cloud_provider` (path, required): cloud_provider
  - `--id` (path, required): id
  - `--service_id` (path, required): service_id

## dashboard

### `signoz dashboard clone-dashboard-v2`

- Summary: Clone dashboard (v2)
- HTTP: `POST /api/v2/dashboards/{id}/clone`
- Auth: required; scopes: `EDITOR`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz dashboard create-dashboard-v2`

- Summary: Create dashboard (v2)
- HTTP: `POST /api/v2/dashboards`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags: none

### `signoz dashboard create-dashboard-view`

- Summary: Create dashboard saved view
- HTTP: `POST /api/v2/dashboard_views`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags: none

### `signoz dashboard create-public-dashboard`

- Summary: Create public dashboard
- HTTP: `POST /api/v1/dashboards/{id}/public`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id

### `signoz dashboard delete-dashboard-v2`

- Summary: Delete dashboard (v2)
- HTTP: `DELETE /api/v2/dashboards/{id}`
- Auth: required; scopes: `EDITOR`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz dashboard delete-dashboard-view`

- Summary: Delete dashboard saved view
- HTTP: `DELETE /api/v2/dashboard_views/{id}`
- Auth: required; scopes: `EDITOR`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz dashboard delete-public-dashboard`

- Summary: Delete public dashboard
- HTTP: `DELETE /api/v1/dashboards/{id}/public`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz dashboard get-dashboard-v2`

- Summary: Get dashboard (v2)
- HTTP: `GET /api/v2/dashboards/{id}`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz dashboard get-public-dashboard`

- Summary: Get public dashboard
- HTTP: `GET /api/v1/dashboards/{id}/public`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz dashboard get-public-dashboard-data`

- Summary: Get public dashboard data
- HTTP: `GET /api/v1/public/dashboards/{id}`
- Auth: required; scopes: `public-dashboard:read`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz dashboard get-public-dashboard-data-v2`

- Summary: Get public dashboard data (v2)
- HTTP: `GET /api/v2/public/dashboards/{id}`
- Auth: required; scopes: `public-dashboard:read`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz dashboard get-public-dashboard-panel-query-range-v2`

- Summary: Get query range result (v2)
- HTTP: `GET /api/v2/public/dashboards/{id}/panels/{key}/query_range`
- Auth: required; scopes: `public-dashboard:read`
- Body: none
- Flags:
  - `--start-time` (query): startTime
  - `--end-time` (query): endTime
  - `--id` (path, required): id
  - `--key` (path, required): key
- Output: response media `application/json`

### `signoz dashboard get-public-dashboard-widget-query-range`

- Summary: Get query range result
- HTTP: `GET /api/v1/public/dashboards/{id}/widgets/{idx}/query_range`
- Auth: required; scopes: `public-dashboard:read`
- Body: none
- Flags:
  - `--id` (path, required): id
  - `--idx` (path, required): idx
- Output: response media `application/json`

### `signoz dashboard list-dashboard-views`

- Summary: List dashboard saved views
- HTTP: `GET /api/v2/dashboard_views`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags: none
- Output: response media `application/json`

### `signoz dashboard list-dashboards-for-user-v2`

- Summary: List dashboards for the current user (v2)
- HTTP: `GET /api/v2/users/me/dashboards`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--query` (query): query
  - `--sort` (query): sort
  - `--order` (query): order
  - `--limit` (query): limit
  - `--offset` (query): offset
- Output: response media `application/json`; pagination `offset`

### `signoz dashboard list-dashboards-v2`

- Summary: List dashboards (v2)
- HTTP: `GET /api/v2/dashboards`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--query` (query): query
  - `--sort` (query): sort
  - `--order` (query): order
  - `--limit` (query): limit
  - `--offset` (query): offset
- Output: response media `application/json`; pagination `offset`

### `signoz dashboard lock-dashboard-v2`

- Summary: Lock dashboard (v2)
- HTTP: `PUT /api/v2/dashboards/{id}/lock`
- Auth: required; scopes: `EDITOR`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz dashboard patch-dashboard-v2`

- Summary: Patch dashboard (v2)
- HTTP: `PATCH /api/v2/dashboards/{id}`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz dashboard pin-dashboard-v2`

- Summary: Pin a dashboard for the current user (v2)
- HTTP: `PUT /api/v2/users/me/dashboards/{id}/pins`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz dashboard unlock-dashboard-v2`

- Summary: Unlock dashboard (v2)
- HTTP: `DELETE /api/v2/dashboards/{id}/lock`
- Auth: required; scopes: `EDITOR`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz dashboard unpin-dashboard-v2`

- Summary: Unpin a dashboard for the current user (v2)
- HTTP: `DELETE /api/v2/users/me/dashboards/{id}/pins`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz dashboard update-dashboard-v2`

- Summary: Update dashboard (v2)
- HTTP: `PUT /api/v2/dashboards/{id}`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz dashboard update-dashboard-view`

- Summary: Update dashboard saved view
- HTTP: `PUT /api/v2/dashboard_views/{id}`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz dashboard update-public-dashboard`

- Summary: Update public dashboard
- HTTP: `PUT /api/v1/dashboards/{id}/public`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id

## downtimeschedules

### `signoz downtimeschedules create-downtime-schedule`

- Summary: Create downtime schedule
- HTTP: `POST /api/v1/downtime_schedules`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags: none

### `signoz downtimeschedules delete-downtime-schedule-by-id`

- Summary: Delete downtime schedule
- HTTP: `DELETE /api/v1/downtime_schedules/{id}`
- Auth: required; scopes: `EDITOR`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz downtimeschedules get-downtime-schedule-by-id`

- Summary: Get downtime schedule by ID
- HTTP: `GET /api/v1/downtime_schedules/{id}`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz downtimeschedules list-downtime-schedules`

- Summary: List downtime schedules
- HTTP: `GET /api/v1/downtime_schedules`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--active` (query): active
  - `--recurring` (query): recurring
- Output: list path `data`; columns `name`, `kind`, `id`, `createdAt`, `createdBy`, `description`; response media `application/json`

### `signoz downtimeschedules update-downtime-schedule-by-id`

- Summary: Update downtime schedule
- HTTP: `PUT /api/v1/downtime_schedules/{id}`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id

## features

### `signoz features get-features`

- Summary: Get features
- HTTP: `GET /api/v2/features`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags: none
- Output: list path `data`; columns `name`, `kind`, `defaultVariant`, `description`, `resolvedValue`, `stage`; response media `application/json`

## fields

### `signoz fields get-fields-keys`

- Summary: Get field keys
- HTTP: `GET /api/v1/fields/keys`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--signal` (query): signal
  - `--source` (query): source
  - `--limit` (query): limit
  - `--start-unix-milli` (query, int64): startUnixMilli
  - `--end-unix-milli` (query, int64): endUnixMilli
  - `--field-context` (query): fieldContext
  - `--field-data-type` (query): fieldDataType
  - `--metric-name` (query): metricName
  - `--metric-namespace` (query): metricNamespace
  - `--search-text` (query): searchText
- Output: response media `application/json`; pagination `cursor`

### `signoz fields get-fields-values`

- Summary: Get field values
- HTTP: `GET /api/v1/fields/values`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--signal` (query): signal
  - `--source` (query): source
  - `--limit` (query): limit
  - `--start-unix-milli` (query, int64): startUnixMilli
  - `--end-unix-milli` (query, int64): endUnixMilli
  - `--field-context` (query): fieldContext
  - `--field-data-type` (query): fieldDataType
  - `--metric-name` (query): metricName
  - `--metric-namespace` (query): metricNamespace
  - `--search-text` (query): searchText
  - `--name` (query): name
  - `--existing-query` (query): existingQuery
- Output: response media `application/json`; pagination `cursor`

## gateway

### `signoz gateway create-ingestion-key`

- Summary: Create ingestion key for workspace
- HTTP: `POST /api/v2/gateway/ingestion_keys`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags: none

### `signoz gateway create-ingestion-key-limit`

- Summary: Create limit for the ingestion key
- HTTP: `POST /api/v2/gateway/ingestion_keys/{keyId}/limits`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags:
  - `--key-id` (path, required): keyId

### `signoz gateway delete-ingestion-key`

- Summary: Delete ingestion key for workspace
- HTTP: `DELETE /api/v2/gateway/ingestion_keys/{keyId}`
- Auth: required; scopes: `EDITOR`
- Body: none
- Flags:
  - `--key-id` (path, required): keyId

### `signoz gateway delete-ingestion-key-limit`

- Summary: Delete limit for the ingestion key
- HTTP: `DELETE /api/v2/gateway/ingestion_keys/limits/{limitId}`
- Auth: required; scopes: `EDITOR`
- Body: none
- Flags:
  - `--limit-id` (path, required): limitId

### `signoz gateway get-ingestion-keys`

- Summary: Get ingestion keys for workspace
- HTTP: `GET /api/v2/gateway/ingestion_keys`
- Auth: required; scopes: `EDITOR`
- Body: none
- Flags:
  - `--page` (query): page
  - `--per_page` (query): per_page
- Output: response media `application/json`; pagination `offset`

### `signoz gateway search-ingestion-keys`

- Summary: Search ingestion keys for workspace
- HTTP: `GET /api/v2/gateway/ingestion_keys/search`
- Auth: required; scopes: `EDITOR`
- Body: none
- Flags:
  - `--name` (query, required): name
  - `--page` (query): page
  - `--per_page` (query): per_page
- Output: response media `application/json`; pagination `offset`

### `signoz gateway update-ingestion-key`

- Summary: Update ingestion key for workspace
- HTTP: `PATCH /api/v2/gateway/ingestion_keys/{keyId}`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags:
  - `--key-id` (path, required): keyId

### `signoz gateway update-ingestion-key-limit`

- Summary: Update limit for the ingestion key
- HTTP: `PATCH /api/v2/gateway/ingestion_keys/limits/{limitId}`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags:
  - `--limit-id` (path, required): limitId

## global

### `signoz global get-global-config`

- Summary: Get global config
- HTTP: `GET /api/v1/global/config`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

## health

### `signoz health healthz`

- Summary: Health check
- HTTP: `GET /api/v2/healthz`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `signoz health livez`

- Summary: Liveness check
- HTTP: `GET /api/v2/livez`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `signoz health readyz`

- Summary: Readiness check
- HTTP: `GET /api/v2/readyz`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

## inframonitoring

### `signoz inframonitoring get-checks`

- Summary: Run Infra Monitoring Setup Checks
- HTTP: `GET /api/v2/infra_monitoring/checks`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--type` (query, required): type
- Output: response media `application/json`

### `signoz inframonitoring list-clusters`

- Summary: List Clusters for Infra Monitoring
- HTTP: `POST /api/v2/infra_monitoring/clusters`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz inframonitoring list-containers`

- Summary: List Kubernetes Containers for Infra Monitoring
- HTTP: `POST /api/v2/infra_monitoring/kube_containers`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz inframonitoring list-daemon-sets`

- Summary: List DaemonSets for Infra Monitoring
- HTTP: `POST /api/v2/infra_monitoring/daemonsets`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz inframonitoring list-deployments`

- Summary: List Deployments for Infra Monitoring
- HTTP: `POST /api/v2/infra_monitoring/deployments`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz inframonitoring list-hosts`

- Summary: List Hosts for Infra Monitoring
- HTTP: `POST /api/v2/infra_monitoring/hosts`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz inframonitoring list-jobs`

- Summary: List Jobs for Infra Monitoring
- HTTP: `POST /api/v2/infra_monitoring/jobs`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz inframonitoring list-namespaces`

- Summary: List Namespaces for Infra Monitoring
- HTTP: `POST /api/v2/infra_monitoring/namespaces`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz inframonitoring list-nodes`

- Summary: List Nodes for Infra Monitoring
- HTTP: `POST /api/v2/infra_monitoring/nodes`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz inframonitoring list-pods`

- Summary: List Pods for Infra Monitoring
- HTTP: `POST /api/v2/infra_monitoring/pods`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz inframonitoring list-stateful-sets`

- Summary: List StatefulSets for Infra Monitoring
- HTTP: `POST /api/v2/infra_monitoring/statefulsets`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz inframonitoring list-volumes`

- Summary: List Volumes for Infra Monitoring
- HTTP: `POST /api/v2/infra_monitoring/pvcs`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

## llmpricingrules

### `signoz llmpricingrules create-or-update-llm-pricing-rules`

- Summary: Create or update pricing rules
- HTTP: `PUT /api/v1/llm_pricing_rules`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags: none

### `signoz llmpricingrules delete-llm-pricing-rule`

- Summary: Delete a pricing rule
- HTTP: `DELETE /api/v1/llm_pricing_rules/{id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz llmpricingrules get-llm-pricing-rule`

- Summary: Get a pricing rule
- HTTP: `GET /api/v1/llm_pricing_rules/{id}`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz llmpricingrules list-llm-pricing-rules`

- Summary: List pricing rules
- HTTP: `GET /api/v1/llm_pricing_rules`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--offset` (query): offset
  - `--limit` (query): limit
  - `--q` (query): q
  - `--is-override` (query): isOverride
- Output: response media `application/json`; pagination `offset`

### `signoz llmpricingrules list-unmapped-llm-models`

- Summary: List unmapped models
- HTTP: `GET /api/v1/llm_pricing_rules/unmapped_models`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags: none
- Output: response media `application/json`

## logs

### `signoz logs handle-export-raw-data-post`

- Summary: Export raw data
- HTTP: `POST /api/v1/export_raw_data`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags:
  - `--format` (query, default `csv`, one of: csv|jsonl): The output format for the export.

### `signoz logs handle-promote-and-index-paths`

- Summary: Promote and index paths
- HTTP: `POST /api/v1/logs/promote_paths`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags: none

### `signoz logs list-promoted-and-indexed-paths`

- Summary: Promote and index paths
- HTTP: `GET /api/v1/logs/promote_paths`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags: none
- Output: list path `data`; columns `path`, `promote`; response media `application/json`

## metrics

### `signoz metrics create-metric-reduction-rule`

- Summary: Create a metric reduction rule
- HTTP: `POST /api/v2/metric_reduction_rules`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags: none

### `signoz metrics delete-metric-reduction-rule-by-id`

- Summary: Delete a metric reduction rule by id
- HTTP: `DELETE /api/v2/metric_reduction_rules/{id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz metrics get-metric-alerts`

- Summary: Get metric alerts
- HTTP: `GET /api/v2/metrics/alerts`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--metric-name` (query, required): The name of the metric. May contain slashes (e.g. cloud-provider metrics like run.googleapis.com/request_latencies).
- Output: response media `application/json`

### `signoz metrics get-metric-attributes`

- Summary: Get metric attributes
- HTTP: `GET /api/v2/metrics/attributes`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--metric-name` (query, required): The name of the metric. May contain slashes (e.g. cloud-provider metrics like run.googleapis.com/request_latencies).
  - `--start` (query): Start of the time range as a Unix timestamp in milliseconds.
  - `--end` (query): End of the time range as a Unix timestamp in milliseconds.
- Output: response media `application/json`

### `signoz metrics get-metric-dashboards`

- Summary: Get metric dashboards
- HTTP: `GET /api/v2/metrics/dashboards`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--metric-name` (query, required): The name of the metric. May contain slashes (e.g. cloud-provider metrics like run.googleapis.com/request_latencies).
- Output: response media `application/json`

### `signoz metrics get-metric-dashboards-v2`

- Summary: Get metric dashboards (v2)
- HTTP: `GET /api/v3/metrics/dashboards`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--metric-name` (query, required): The name of the metric. May contain slashes (e.g. cloud-provider metrics like run.googleapis.com/request_latencies).
- Output: response media `application/json`

### `signoz metrics get-metric-highlights`

- Summary: Get metric highlights
- HTTP: `GET /api/v2/metrics/highlights`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--metric-name` (query, required): The name of the metric. May contain slashes (e.g. cloud-provider metrics like run.googleapis.com/request_latencies).
- Output: response media `application/json`

### `signoz metrics get-metric-metadata`

- Summary: Get metric metadata
- HTTP: `GET /api/v2/metrics/metadata`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--metric-name` (query, required): The name of the metric. May contain slashes (e.g. cloud-provider metrics like run.googleapis.com/request_latencies).
- Output: response media `application/json`

### `signoz metrics get-metric-reduction-rule-by-id`

- Summary: Get a metric reduction rule by id
- HTTP: `GET /api/v2/metric_reduction_rules/{id}`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz metrics get-metric-reduction-rule-stats`

- Summary: Metric reduction stats
- HTTP: `GET /api/v2/metric_reduction_rules/stats`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags: none
- Output: response media `application/json`

### `signoz metrics get-metric-reduction-rule-timeseries`

- Summary: Metric reduction volume over time
- HTTP: `GET /api/v2/metric_reduction_rules/timeseries`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags: none
- Output: response media `application/json`

### `signoz metrics get-metrics-onboarding-status`

- Summary: Check if non-SigNoz metrics have been received
- HTTP: `GET /api/v2/metrics/onboarding`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags: none
- Output: response media `application/json`

### `signoz metrics get-metrics-stats`

- Summary: Get metrics statistics
- HTTP: `POST /api/v2/metrics/stats`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz metrics get-metrics-treemap`

- Summary: Get metrics treemap
- HTTP: `POST /api/v2/metrics/treemap`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz metrics inspect-metrics`

- Summary: Inspect raw metric data points
- HTTP: `POST /api/v2/metrics/inspect`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz metrics list-metric-reduction-rules`

- Summary: List metric reduction rules
- HTTP: `GET /api/v2/metric_reduction_rules`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--order-by` (query): orderBy
  - `--order` (query): order
  - `--search` (query): search
  - `--metric-name` (query): metricName
  - `--offset` (query): offset
  - `--limit` (query): limit
- Output: response media `application/json`; pagination `offset`

### `signoz metrics list-metrics`

- Summary: List metric names
- HTTP: `GET /api/v2/metrics`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--start` (query): start
  - `--end` (query): end
  - `--limit` (query): limit
  - `--search-text` (query): searchText
  - `--source` (query): source
- Output: response media `application/json`; pagination `cursor`

### `signoz metrics preview-metric-reduction-rule`

- Summary: Preview a metric reduction rule
- HTTP: `POST /api/v2/metric_reduction_rules/preview`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz metrics update-metric-metadata`

- Summary: Update metric metadata
- HTTP: `POST /api/v2/metrics/metadata`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags: none

### `signoz metrics update-metric-reduction-rule-by-id`

- Summary: Update a metric reduction rule by id
- HTTP: `PUT /api/v2/metric_reduction_rules/{id}`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

## orgs

### `signoz orgs get-my-organization`

- Summary: Get my organization
- HTTP: `GET /api/v2/orgs/me`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags: none
- Output: response media `application/json`

### `signoz orgs update-my-organization`

- Summary: Update my organization
- HTTP: `PUT /api/v2/orgs/me`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags: none

## preferences

### `signoz preferences get-org-preference`

- Summary: Get org preference
- HTTP: `GET /api/v1/org/preferences/{name}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--name` (path, required): name
- Output: response media `application/json`

### `signoz preferences get-user-preference`

- Summary: Get user preference
- HTTP: `GET /api/v1/user/preferences/{name}`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--name` (path, required): name
- Output: response media `application/json`

### `signoz preferences list-org-preferences`

- Summary: List org preferences
- HTTP: `GET /api/v1/org/preferences`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags: none
- Output: list path `data`; columns `name`, `description`, `valueType`; response media `application/json`

### `signoz preferences list-user-preferences`

- Summary: List user preferences
- HTTP: `GET /api/v1/user/preferences`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags: none
- Output: list path `data`; columns `name`, `description`, `valueType`; response media `application/json`

### `signoz preferences update-org-preference`

- Summary: Update org preference
- HTTP: `PUT /api/v1/org/preferences/{name}`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags:
  - `--name` (path, required): name

### `signoz preferences update-user-preference`

- Summary: Update user preference
- HTTP: `PUT /api/v1/user/preferences/{name}`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags:
  - `--name` (path, required): name

## querier

### `signoz querier query-range-preview-v5`

- Summary: Query range preview
- HTTP: `POST /api/v5/query_range/preview`
- Auth: required; scopes: `audit-logs:read`, `logs:read`, `meter-metrics:read`, `metrics:read`, `traces:read`
- Body: optional; media type `application/json`
- Flags:
  - `--verbose` (query): verbose
- Output: response media `application/json`

### `signoz querier query-range-v5`

- Summary: Query range
- HTTP: `POST /api/v5/query_range`
- Auth: required; scopes: `audit-logs:read`, `logs:read`, `meter-metrics:read`, `metrics:read`, `traces:read`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz querier replace-variables`

- Summary: Replace variables
- HTTP: `POST /api/v5/substitute_vars`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

## role

### `signoz role create-role`

- Summary: Create role
- HTTP: `POST /api/v1/roles`
- Auth: required; scopes: `role:create`
- Body: optional; media type `application/json`
- Flags: none

### `signoz role delete-role`

- Summary: Delete role
- HTTP: `DELETE /api/v1/roles/{id}`
- Auth: required; scopes: `role:delete`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz role get-role`

- Summary: Get role
- HTTP: `GET /api/v1/roles/{id}`
- Auth: required; scopes: `role:read`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz role list-roles`

- Summary: List roles
- HTTP: `GET /api/v1/roles`
- Auth: required; scopes: `role:list`
- Body: none
- Flags: none
- Output: list path `data`; columns `name`, `type`, `id`, `createdAt`, `description`, `orgId`; response media `application/json`

### `signoz role update-role`

- Summary: Update role
- HTTP: `PUT /api/v1/roles/{id}`
- Auth: required; scopes: `role:update`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id

## routepolicies

### `signoz routepolicies create-route-policy`

- Summary: Create route policy
- HTTP: `POST /api/v1/route_policies`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags: none

### `signoz routepolicies delete-route-policy-by-id`

- Summary: Delete route policy
- HTTP: `DELETE /api/v1/route_policies/{id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz routepolicies get-all-route-policies`

- Summary: List route policies
- HTTP: `GET /api/v1/route_policies`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags: none
- Output: list path `data`; columns `name`, `kind`, `id`, `createdAt`, `createdBy`, `description`; response media `application/json`

### `signoz routepolicies get-route-policy-by-id`

- Summary: Get route policy by ID
- HTTP: `GET /api/v1/route_policies/{id}`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz routepolicies update-route-policy`

- Summary: Update route policy
- HTTP: `PUT /api/v1/route_policies/{id}`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

## rules

### `signoz rules create-rule`

- Summary: Create alert rule
- HTTP: `POST /api/v2/rules`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags: none

### `signoz rules delete-rule-by-id`

- Summary: Delete alert rule
- HTTP: `DELETE /api/v2/rules/{id}`
- Auth: required; scopes: `EDITOR`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz rules get-rule-by-id`

- Summary: Get alert rule by ID
- HTTP: `GET /api/v2/rules/{id}`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz rules get-rule-history-filter-keys`

- Summary: Get rule history filter keys
- HTTP: `GET /api/v2/rules/{id}/history/filter_keys`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--signal` (query): signal
  - `--source` (query): source
  - `--limit` (query): limit
  - `--start-unix-milli` (query, int64): startUnixMilli
  - `--end-unix-milli` (query, int64): endUnixMilli
  - `--field-context` (query): fieldContext
  - `--field-data-type` (query): fieldDataType
  - `--metric-name` (query): metricName
  - `--metric-namespace` (query): metricNamespace
  - `--search-text` (query): searchText
  - `--id` (path, required): id
- Output: response media `application/json`; pagination `cursor`

### `signoz rules get-rule-history-filter-values`

- Summary: Get rule history filter values
- HTTP: `GET /api/v2/rules/{id}/history/filter_values`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--signal` (query): signal
  - `--source` (query): source
  - `--limit` (query): limit
  - `--start-unix-milli` (query, int64): startUnixMilli
  - `--end-unix-milli` (query, int64): endUnixMilli
  - `--field-context` (query): fieldContext
  - `--field-data-type` (query): fieldDataType
  - `--metric-name` (query): metricName
  - `--metric-namespace` (query): metricNamespace
  - `--search-text` (query): searchText
  - `--name` (query): name
  - `--existing-query` (query): existingQuery
  - `--id` (path, required): id
- Output: response media `application/json`; pagination `cursor`

### `signoz rules get-rule-history-overall-status`

- Summary: Get rule overall status timeline
- HTTP: `GET /api/v2/rules/{id}/history/overall_status`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--start` (query, required, int64): start
  - `--end` (query, required, int64): end
  - `--id` (path, required): id
- Output: list path `data`; columns `end`, `start`, `state`; response media `application/json`

### `signoz rules get-rule-history-stats`

- Summary: Get rule history stats
- HTTP: `GET /api/v2/rules/{id}/history/stats`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--start` (query, required, int64): start
  - `--end` (query, required, int64): end
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz rules get-rule-history-timeline`

- Summary: Get rule history timeline
- HTTP: `GET /api/v2/rules/{id}/history/timeline`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--start` (query, required, int64): start
  - `--end` (query, required, int64): end
  - `--state` (query): state
  - `--filter-expression` (query): filterExpression
  - `--limit` (query, int64): limit
  - `--order` (query): order
  - `--cursor` (query): cursor
  - `--id` (path, required): id
- Output: response media `application/json`; pagination `cursor`

### `signoz rules get-rule-history-top-contributors`

- Summary: Get top contributors to rule firing
- HTTP: `GET /api/v2/rules/{id}/history/top_contributors`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--start` (query, required, int64): start
  - `--end` (query, required, int64): end
  - `--id` (path, required): id
- Output: list path `data`; columns `count`, `fingerprint`, `relatedLogsLink`, `relatedTracesLink`; response media `application/json`

### `signoz rules list-rules`

- Summary: List alert rules
- HTTP: `GET /api/v2/rules`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags: none
- Output: list path `data`; columns `id`, `alert`, `alertType`, `createdAt`, `createdBy`, `description`; response media `application/json`

### `signoz rules patch-rule-by-id`

- Summary: Patch alert rule
- HTTP: `PATCH /api/v2/rules/{id}`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz rules test-rule`

- Summary: Test alert rule
- HTTP: `POST /api/v2/rules/test`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz rules update-rule-by-id`

- Summary: Update alert rule
- HTTP: `PUT /api/v2/rules/{id}`
- Auth: required; scopes: `EDITOR`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id

## serviceaccount

### `signoz serviceaccount create-service-account`

- Summary: Create service account
- HTTP: `POST /api/v1/service_accounts`
- Auth: required; scopes: `serviceaccount:create`
- Body: optional; media type `application/json`
- Flags: none

### `signoz serviceaccount create-service-account-key`

- Summary: Create a service account key
- HTTP: `POST /api/v1/service_accounts/{id}/keys`
- Auth: required; scopes: `factor-api-key:create`, `serviceaccount:attach`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id

### `signoz serviceaccount create-service-account-role`

- Summary: Create service account role
- HTTP: `POST /api/v1/service_account_roles`
- Auth: required; scopes: `role:attach`, `serviceaccount:attach`
- Body: optional; media type `application/json`
- Flags: none

### `signoz serviceaccount create-service-account-role-deprecated`

- Summary: Create service account role
- HTTP: `POST /api/v1/service_accounts/{id}/roles`
- Auth: required; scopes: `role:attach`, `serviceaccount:attach`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id

### `signoz serviceaccount delete-service-account`

- Summary: Deletes a service account
- HTTP: `DELETE /api/v1/service_accounts/{id}`
- Auth: required; scopes: `serviceaccount:delete`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz serviceaccount delete-service-account-role`

- Summary: Delete service account role
- HTTP: `DELETE /api/v1/service_account_roles/{id}`
- Auth: required; scopes: `role:detach`, `serviceaccount:detach`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz serviceaccount delete-service-account-role-deprecated`

- Summary: Delete service account role
- HTTP: `DELETE /api/v1/service_accounts/{id}/roles/{rid}`
- Auth: required; scopes: `role:detach`, `serviceaccount:detach`
- Body: none
- Flags:
  - `--id` (path, required): id
  - `--rid` (path, required): rid

### `signoz serviceaccount get-my-service-account`

- Summary: Gets my service account
- HTTP: `GET /api/v1/service_accounts/me`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `signoz serviceaccount get-service-account`

- Summary: Gets a service account
- HTTP: `GET /api/v1/service_accounts/{id}`
- Auth: required; scopes: `serviceaccount:read`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz serviceaccount get-service-account-role`

- Summary: Get service account role
- HTTP: `GET /api/v1/service_account_roles/{id}`
- Auth: required; scopes: `serviceaccount:read`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz serviceaccount get-service-account-roles`

- Summary: Gets service account roles
- HTTP: `GET /api/v1/service_accounts/{id}/roles`
- Auth: required; scopes: `serviceaccount:read`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: list path `data`; columns `name`, `type`, `id`, `createdAt`, `description`, `orgId`; response media `application/json`

### `signoz serviceaccount list-service-account-keys`

- Summary: List service account keys
- HTTP: `GET /api/v1/service_accounts/{id}/keys`
- Auth: required; scopes: `factor-api-key:list`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: list path `data`; columns `name`, `id`, `createdAt`, `expiresAt`, `lastObservedAt`, `serviceAccountId`; response media `application/json`

### `signoz serviceaccount list-service-accounts`

- Summary: List service accounts
- HTTP: `GET /api/v1/service_accounts`
- Auth: required; scopes: `serviceaccount:list`
- Body: none
- Flags: none
- Output: list path `data`; columns `name`, `id`, `createdAt`, `email`, `orgId`, `status`; response media `application/json`

### `signoz serviceaccount revoke-service-account-key`

- Summary: Revoke a service account key
- HTTP: `DELETE /api/v1/service_accounts/{id}/keys/{fid}`
- Auth: required; scopes: `factor-api-key:delete`, `serviceaccount:detach`
- Body: none
- Flags:
  - `--id` (path, required): id
  - `--fid` (path, required): fid

### `signoz serviceaccount update-my-service-account`

- Summary: Updates my service account
- HTTP: `PUT /api/v1/service_accounts/me`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none

### `signoz serviceaccount update-service-account`

- Summary: Updates a service account
- HTTP: `PUT /api/v1/service_accounts/{id}`
- Auth: required; scopes: `serviceaccount:update`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id

### `signoz serviceaccount update-service-account-key`

- Summary: Updates a service account key
- HTTP: `PUT /api/v1/service_accounts/{id}/keys/{fid}`
- Auth: required; scopes: `factor-api-key:update`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id
  - `--fid` (path, required): fid

## sessions

### `signoz sessions create-session-by-email-password`

- Summary: Create session by email and password
- HTTP: `POST /api/v2/sessions/email_password`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz sessions create-session-by-google-callback`

- Summary: Create session by google callback
- HTTP: `GET /api/v1/complete/google`
- Auth: required
- Body: none
- Flags: none

### `signoz sessions create-session-by-oidc-callback`

- Summary: Create session by oidc callback
- HTTP: `GET /api/v1/complete/oidc`
- Auth: required
- Body: none
- Flags: none

### `signoz sessions create-session-by-saml-callback`

- Summary: Create session by saml callback
- HTTP: `POST /api/v1/complete/saml`
- Auth: required
- Body: optional; media type `application/x-www-form-urlencoded`
- Flags:
  - `--relay-state` (query): RelayState
  - `--saml-response` (query): SAMLResponse

### `signoz sessions delete-session`

- Summary: Delete session
- HTTP: `DELETE /api/v2/sessions`
- Auth: required
- Body: none
- Flags: none

### `signoz sessions get-session-context`

- Summary: Get session context
- HTTP: `GET /api/v2/sessions/context`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `signoz sessions rotate-session`

- Summary: Rotate session
- HTTP: `POST /api/v2/sessions/rotate`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

## spanmapper

### `signoz spanmapper create-span-mapper`

- Summary: Create a span mapper
- HTTP: `POST /api/v1/span_mapper_groups/{groupId}/span_mappers`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags:
  - `--group-id` (path, required): groupId

### `signoz spanmapper create-span-mapper-group`

- Summary: Create a span attribute mapping group
- HTTP: `POST /api/v1/span_mapper_groups`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags: none

### `signoz spanmapper delete-span-mapper`

- Summary: Delete a span mapper
- HTTP: `DELETE /api/v1/span_mapper_groups/{groupId}/span_mappers/{mapperId}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--group-id` (path, required): groupId
  - `--mapper-id` (path, required): mapperId

### `signoz spanmapper delete-span-mapper-group`

- Summary: Delete a span attribute mapping group
- HTTP: `DELETE /api/v1/span_mapper_groups/{groupId}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--group-id` (path, required): groupId

### `signoz spanmapper list-span-mapper-groups`

- Summary: List span attribute mapping groups
- HTTP: `GET /api/v1/span_mapper_groups`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--enabled` (query): enabled
- Output: response media `application/json`

### `signoz spanmapper list-span-mappers`

- Summary: List span mappers for a group
- HTTP: `GET /api/v1/span_mapper_groups/{groupId}/span_mappers`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags:
  - `--group-id` (path, required): groupId
- Output: response media `application/json`

### `signoz spanmapper test-span-mappers`

- Summary: Test span mappers against sample spans
- HTTP: `POST /api/v1/span_mapper_groups/test`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `signoz spanmapper update-span-mapper`

- Summary: Update a span mapper
- HTTP: `PATCH /api/v1/span_mapper_groups/{groupId}/span_mappers/{mapperId}`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags:
  - `--group-id` (path, required): groupId
  - `--mapper-id` (path, required): mapperId

### `signoz spanmapper update-span-mapper-group`

- Summary: Update a span attribute mapping group
- HTTP: `PATCH /api/v1/span_mapper_groups/{groupId}`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags:
  - `--group-id` (path, required): groupId

## stats

### `signoz stats get-stats`

- Summary: Get stats
- HTTP: `GET /api/v1/stats`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags: none
- Output: response media `application/json`

## tracedetail

### `signoz tracedetail get-flamegraph`

- Summary: Get flamegraph view for a trace
- HTTP: `POST /api/v3/traces/{traceID}/flamegraph`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags:
  - `--trace-id` (path, required): traceID
- Output: response media `application/json`

### `signoz tracedetail get-trace-aggregations`

- Summary: Get aggregations for a trace
- HTTP: `POST /api/v1/traces/{traceID}/aggregations`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags:
  - `--trace-id` (path, required): traceID
- Output: response media `application/json`

### `signoz tracedetail get-waterfall-v4`

- Summary: Get waterfall view for a trace
- HTTP: `POST /api/v4/traces/{traceID}/waterfall`
- Auth: required; scopes: `VIEWER`
- Body: optional; media type `application/json`
- Flags:
  - `--trace-id` (path, required): traceID
- Output: response media `application/json`

## users

### `signoz users create-bulk-invite`

- Summary: Create bulk invite
- HTTP: `POST /api/v1/invite/bulk`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags: none

### `signoz users create-invite`

- Summary: Create invite
- HTTP: `POST /api/v1/invite`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags: none

### `signoz users create-reset-password-token`

- Summary: Create or regenerate reset password token for a user
- HTTP: `PUT /api/v2/users/{id}/reset_password_tokens`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz users create-user`

- Summary: Create user
- HTTP: `POST /api/v2/users`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags: none

### `signoz users create-user-role`

- Summary: Create user role
- HTTP: `POST /api/v2/user_roles`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags: none

### `signoz users delete-user`

- Summary: Delete user
- HTTP: `DELETE /api/v2/users/{id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz users delete-user-deprecated`

- Summary: Delete user
- HTTP: `DELETE /api/v1/user/{id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz users delete-user-role`

- Summary: Delete user role
- HTTP: `DELETE /api/v2/user_roles/{id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id

### `signoz users forgot-password`

- Summary: Forgot password
- HTTP: `POST /api/v2/factor_password/forgot`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none

### `signoz users get-my-user`

- Summary: Get my user v2
- HTTP: `GET /api/v2/users/me`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `signoz users get-my-user-deprecated`

- Summary: Get my user
- HTTP: `GET /api/v1/user/me`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `signoz users get-reset-password-token`

- Summary: Get reset password token for a user
- HTTP: `GET /api/v2/users/{id}/reset_password_tokens`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz users get-reset-password-token-deprecated`

- Summary: Get reset password token
- HTTP: `GET /api/v1/getResetPasswordToken/{id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz users get-roles-by-user-id`

- Summary: Get user roles
- HTTP: `GET /api/v2/users/{id}/roles`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: list path `data`; columns `name`, `type`, `id`, `createdAt`, `description`, `orgId`; response media `application/json`

### `signoz users get-user`

- Summary: Get user by user id
- HTTP: `GET /api/v2/users/{id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz users get-user-deprecated`

- Summary: Get user
- HTTP: `GET /api/v1/user/{id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz users get-user-role`

- Summary: Get user role
- HTTP: `GET /api/v2/user_roles/{id}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz users get-users-by-role-id`

- Summary: Get users by role id
- HTTP: `GET /api/v2/roles/{id}/users`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id
- Output: list path `data`; columns `id`, `createdAt`, `displayName`, `email`, `isRoot`, `orgId`; response media `application/json`

### `signoz users list-users`

- Summary: List users v2
- HTTP: `GET /api/v2/users`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags: none
- Output: list path `data`; columns `id`, `createdAt`, `displayName`, `email`, `isRoot`, `orgId`; response media `application/json`

### `signoz users list-users-deprecated`

- Summary: List users
- HTTP: `GET /api/v1/user`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags: none
- Output: list path `data`; columns `id`, `createdAt`, `displayName`, `email`, `isRoot`, `orgId`; response media `application/json`

### `signoz users remove-user-role-by-user-id-and-role-id`

- Summary: Remove a role from user
- HTTP: `DELETE /api/v2/users/{id}/roles/{roleId}`
- Auth: required; scopes: `ADMIN`
- Body: none
- Flags:
  - `--id` (path, required): id
  - `--role-id` (path, required): roleId

### `signoz users reset-password`

- Summary: Reset password
- HTTP: `POST /api/v1/resetPassword`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none

### `signoz users set-role-by-user-id`

- Summary: Set user roles
- HTTP: `POST /api/v2/users/{id}/roles`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id

### `signoz users update-my-password`

- Summary: Updates my password
- HTTP: `PUT /api/v2/users/me/factor_password`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags: none

### `signoz users update-my-user-v2`

- Summary: Update my user v2
- HTTP: `PUT /api/v2/users/me`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none

### `signoz users update-user`

- Summary: Update user v2
- HTTP: `PUT /api/v2/users/{id}`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id

### `signoz users update-user-deprecated`

- Summary: Update user
- HTTP: `PUT /api/v1/user/{id}`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags:
  - `--id` (path, required): id
- Output: response media `application/json`

### `signoz users verify-reset-password-token`

- Summary: Verify a reset password token
- HTTP: `POST /api/v2/reset_password_tokens/verify`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none

## zeus

### `signoz zeus get-hosts`

- Summary: Get host info from Zeus.
- HTTP: `GET /api/v2/zeus/hosts`
- Auth: required; scopes: `VIEWER`
- Body: none
- Flags: none
- Output: response media `application/json`

### `signoz zeus put-host`

- Summary: Put host in Zeus for a deployment.
- HTTP: `PUT /api/v2/zeus/hosts`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags: none

### `signoz zeus put-profile`

- Summary: Put profile in Zeus for a deployment.
- HTTP: `PUT /api/v2/zeus/profiles`
- Auth: required; scopes: `ADMIN`
- Body: optional; media type `application/json`
- Flags: none

SigNoz

This recipe generates the signoz CLI and agent Skill for SigNoz dashboards, alerts, traces, logs, metrics, and related observability APIs.

API and authentication

Create a SigNoz API key and use the SigNoz-Api-Key header:

signoz auth login --hostname <host> --auth-type apikey
signoz auth status --hostname <host>

Enter SigNoz-Api-Key when the login command asks for the header name.

Install the Skill

signoz skill install --scope user --agent codex --yes

Agent workflow

signoz commands --json
signoz search "list dashboards" --json

Use the returned command path with signoz commands show before execution. Bump the pin in specs/sources.yaml when upgrading the SigNoz API.