Apache Superset

Generated superset CLI and agent Skill for the Apache Superset analytics and BI API.

$ superset search "list dashboards" --json

CLI binaries 6 platform builds

Skill Included in CLI

Source refs 1 pinned inputs

Smoke intent list dashboards

01 Schema superset commands schema --json

02 Catalog superset commands --json

03 Search superset search "list dashboards" --json

Recipe structure

Files

10 files

builds/superset.json json

{
  "schema_version": 1,
  "recipe": "superset",
  "cli_name": "superset",
  "generated_at": "2026-08-21T06:47:37.591Z",
  "lathe_version": "lathe v0.5.2 (none, unknown)",
  "gate": {
    "verdict": "GO",
    "generated_at": "2026-08-21T06:47:37.591Z",
    "lathe_version": "lathe v0.5.2 (none, unknown)",
    "command_count": 276,
    "group_count": 38,
    "skill_included": true,
    "warnings": [
      "G9",
      "W2",
      "W4"
    ]
  },
  "source_refs": [
    {
      "name": "superset",
      "display_name": "superset",
      "backend": "openapi3",
      "repo_url": "https://github.com/apache/superset.git",
      "pinned_tag": "3bdf134aaa2f3cc34739964f7c276506949f0653",
      "files": [
        "docs/static/resources/openapi.json"
      ]
    }
  ],
  "outputs": {
    "catalog": null,
    "skill": "skills/superset",
    "cli_artifacts": [
      {
        "os": "darwin",
        "arch": "arm64",
        "format": "tar.gz",
        "binary": "superset",
        "path": "downloads/superset-darwin-arm64.tar.gz",
        "size": 3718088,
        "sha256": "sha256:04469e1540e8f91d50bb1424e5788997c813e9b2acce24ba364dc6efe9e6e15f"
      },
      {
        "os": "darwin",
        "arch": "amd64",
        "format": "tar.gz",
        "binary": "superset",
        "path": "downloads/superset-darwin-amd64.tar.gz",
        "size": 4010295,
        "sha256": "sha256:a6635b2dd41e12b359df95fb760b59e7b58eb48a4b498a56255dc638ba0ff1c7"
      },
      {
        "os": "linux",
        "arch": "amd64",
        "format": "tar.gz",
        "binary": "superset",
        "path": "downloads/superset-linux-amd64.tar.gz",
        "size": 3944166,
        "sha256": "sha256:d5ae9bc476c7c9e09f8403071824d7c53c7b5014bb4fe83a1ea5d03056a5aebf"
      },
      {
        "os": "linux",
        "arch": "arm64",
        "format": "tar.gz",
        "binary": "superset",
        "path": "downloads/superset-linux-arm64.tar.gz",
        "size": 3577759,
        "sha256": "sha256:ad3addd53347936035f7d885b09dd87bf866f3d984838b89a25ed29675e2349c"
      },
      {
        "os": "windows",
        "arch": "amd64",
        "format": "tar.gz",
        "binary": "superset.exe",
        "path": "downloads/superset-windows-amd64.tar.gz",
        "size": 4064595,
        "sha256": "sha256:05920cef393437be89548f4aacacc667ee25801c0191e904b671d23ed7c60193"
      },
      {
        "os": "windows",
        "arch": "arm64",
        "format": "tar.gz",
        "binary": "superset.exe",
        "path": "downloads/superset-windows-arm64.tar.gz",
        "size": 3639071,
        "sha256": "sha256:44362f6ffd3aab44c0019655ab86e9b5624255b8afb89629656eaaee60941372"
      }
    ]
  }
}

recipes/superset/README.md markdown

# Apache Superset

This recipe generates the `superset` CLI and agent Skill for the
[Apache Superset](https://github.com/apache/superset) analytics and BI API.

It keeps only the reproducible Lathe inputs: the OpenAPI spec is pinned from the
Superset repository, and generated code is not the source of truth.

## Module

- `superset`: dashboards, charts, datasets, databases, queries, reports,
  security, and other Superset API operations (276 commands across 28 groups).

## Auth

Superset uses JWT bearer tokens. Obtain an access token from
`POST /api/v1/security/login`, then:

```sh
superset auth login --hostname <superset-host>
```

`auth status` validates the token against `GET /api/v1/me/`:

```sh
superset auth status --hostname <superset-host>
```

## Install the Skill

The recipe enables the bundled Agent Skill (`skill.bundle` in `cli.yaml`):

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

## Agent workflow

```sh
superset commands schema --json
superset commands --json
superset search "list dashboards" --json
superset commands show superset dashboards get-api-v1dashboard --json
```

Search results are discovery only. Inspect command details before execution.

## Source inputs

The recipe pins the Superset OpenAPI spec from:

```text
https://github.com/apache/superset.git   docs/static/resources/openapi.json
```

Bump `pinned_tag` in `specs/sources.yaml` when upgrading the Superset API
version.

recipes/superset/cli.yaml yaml

cli:
  name: superset
  short: "Command-line tool for the Apache Superset analytics and BI API"

skill:
  bundle: true

auth:
  validate:
    method: GET
    path: /api/v1/me/
    display:
      username_field: result.username
      fallback_field: result.email

recipes/superset/lathe.yaml yaml

name: superset
display_name: Apache Superset
cli_name: superset
category: analytics
homepage: https://github.com/apache/superset
description: Generated superset CLI and agent Skill for the Apache Superset analytics and BI API.
maintainers:
  - github: samzong
auth:
  type: bearer
  notes: >-
    Requires a Superset JWT access token. Obtain one from
    POST /api/v1/security/login, then run
    `superset auth login --hostname <superset-host>` and verify with
    `superset auth status` (validates against GET /api/v1/me/).
smoke:
  intent: list dashboards
  expect: get-dashboard

recipes/superset/specs/sources.yaml yaml

sources:
  superset:
    display_name: superset
    repo_url: https://github.com/apache/superset.git
    # pinned to master HEAD as of 2026-07-24 (OpenAPI info.version v1); bump when upgrading
    pinned_tag: 3bdf134aaa2f3cc34739964f7c276506949f0653
    backend: openapi3
    openapi3:
      files:
        - docs/static/resources/openapi.json

skills/superset/.lathe-skill text

generated by lathe codegen; safe to remove and regenerate

skills/superset/SKILL.md markdown

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

# superset CLI

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

## Workflow

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

## General Commands

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

## Maintenance Commands

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

## References

- Read `references/catalog.md` for the command discovery protocol and catalog field meanings.
- Read `references/modules/superset.md` for the `superset` 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/superset/agents/openai.yaml yaml

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

skills/superset/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 `superset search "<intent>" --json` to find candidate commands. Use `--limit` to control result count. Treat search output as candidates only.

## Full Catalog

Run `superset 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 `$SUPERSET_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 `superset 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 `superset 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 `superset auth status --hostname <host>` before execution. Use `http.default_hostname` when present unless the user provides `--hostname` or `$SUPERSET_HOST`; if no matching host is logged in, stop and ask the user to authenticate.

skills/superset/references/modules/superset.md markdown

# Module `superset`

## Source

- Backend: `openapi3`
- Repository: https://github.com/apache/superset.git
- Pinned tag: `3bdf134aaa2f3cc34739964f7c276506949f0653`
- Files: `docs/static/resources/openapi.json`
- Resolved SHA: `3bdf134aaa2f3cc34739964f7c276506949f0653`

## Advanced Data Type

### `superset superset advanced get-advanced-data-type-convert`

- Summary: Return an AdvancedDataTypeResponse
- HTTP: `GET /api/v1/advanced_data_type/convert`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `valid_filter_operators`; response media `application/json`

### `superset superset advanced get-advanced-data-type-types`

- Summary: Return a list of available advanced data types
- HTTP: `GET /api/v1/advanced_data_type/types`
- Auth: required
- Body: none
- Flags: none
- Output: list path `result`; response media `application/json`

## Annotation Layers

### `superset superset annotation delete-annotation-layer`

- Summary: Delete multiple annotation layers in a bulk operation
- HTTP: `DELETE /api/v1/annotation_layer/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: response media `application/json`

### `superset superset annotation delete-annotation-layer-pk`

- Summary: Delete annotation layer (annotation-layer-pk)
- HTTP: `DELETE /api/v1/annotation_layer/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The annotation layer pk for this annotation
- Output: response media `application/json`

### `superset superset annotation delete-annotation-layer-pk-annotation`

- Summary: Bulk delete annotation layers
- HTTP: `DELETE /api/v1/annotation_layer/{pk}/annotation/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The annotation layer pk for this annotation
  - `--q` (query): q
- Output: response media `application/json`

### `superset superset annotation delete-annotation-layer-pk-annotation-annotation-id`

- Summary: Delete annotation layer (annotation-layer-pk-annotation-annotation-id)
- HTTP: `DELETE /api/v1/annotation_layer/{pk}/annotation/{annotation_id}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The annotation layer pk for this annotation
  - `--annotation_id` (path, required): The annotation pk for this annotation
- Output: response media `application/json`

### `superset superset annotation get-annotation-layer`

- Summary: Get a list of annotation layers (annotation-layer)
- HTTP: `GET /api/v1/annotation_layer/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset annotation get-annotation-layer-info`

- Summary: Get metadata information about this API resource (annotation-layer--info)
- HTTP: `GET /api/v1/annotation_layer/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset annotation get-annotation-layer-pk`

- Summary: Get an annotation layer (annotation-layer-pk)
- HTTP: `GET /api/v1/annotation_layer/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: list path `show_columns`; response media `application/json`

### `superset superset annotation get-annotation-layer-pk-annotation`

- Summary: Get a list of annotation layers (annotation-layer-pk-annotation)
- HTTP: `GET /api/v1/annotation_layer/{pk}/annotation/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The annotation layer id for this annotation
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset annotation get-annotation-layer-pk-annotation-annotation-id`

- Summary: Get an annotation layer (annotation-layer-pk-annotation-annotation-id)
- HTTP: `GET /api/v1/annotation_layer/{pk}/annotation/{annotation_id}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The annotation layer pk for this annotation
  - `--annotation_id` (path, required): The annotation pk
  - `--q` (query): q
- Output: response media `application/json`

### `superset superset annotation get-annotation-layer-related-column-name`

- Summary: Get related fields data (annotation-layer-related-column-name)
- HTTP: `GET /api/v1/annotation_layer/related/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`, `value`; response media `application/json`

### `superset superset annotation post-annotation-layer`

- Summary: Create an annotation layer (annotation-layer)
- HTTP: `POST /api/v1/annotation_layer/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset annotation post-annotation-layer-pk-annotation`

- Summary: Create an annotation layer (annotation-layer-pk-annotation)
- HTTP: `POST /api/v1/annotation_layer/{pk}/annotation/`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): The annotation layer pk for this annotation

### `superset superset annotation put-annotation-layer-pk`

- Summary: Update an annotation layer (annotation-layer-pk)
- HTTP: `PUT /api/v1/annotation_layer/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): The annotation layer pk for this annotation
- Output: response media `application/json`

### `superset superset annotation put-annotation-layer-pk-annotation-annotation-id`

- Summary: Update an annotation layer (annotation-layer-pk-annotation-annotation-id)
- HTTP: `PUT /api/v1/annotation_layer/{pk}/annotation/{annotation_id}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): The annotation layer pk for this annotation
  - `--annotation_id` (path, required): The annotation pk for this annotation
- Output: response media `application/json`

## AsyncEventsRestApi

### `superset superset asynceventsrestapi get-async-event`

- Summary: Read off of the Redis events stream
- HTTP: `GET /api/v1/async_event/`
- Auth: required
- Body: none
- Flags:
  - `--last_id` (query): Last ID received by the client
- Output: list path `result`; response media `application/json`

## Available Domains

### `superset superset available get-available-domains`

- Summary: Get all available domains
- HTTP: `GET /api/v1/available_domains/`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

## CSS Templates

### `superset superset css delete-css-template`

- Summary: Bulk delete CSS templates
- HTTP: `DELETE /api/v1/css_template/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: response media `application/json`

### `superset superset css delete-css-template-pk`

- Summary: Delete a CSS template
- HTTP: `DELETE /api/v1/css_template/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset css get-css-template`

- Summary: Get a list of CSS templates
- HTTP: `GET /api/v1/css_template/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset css get-css-template-info`

- Summary: Get metadata information about this API resource (css-template--info)
- HTTP: `GET /api/v1/css_template/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset css get-css-template-pk`

- Summary: Get a CSS template
- HTTP: `GET /api/v1/css_template/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: list path `show_columns`; response media `application/json`

### `superset superset css get-css-template-related-column-name`

- Summary: Get related fields data (css-template-related-column-name)
- HTTP: `GET /api/v1/css_template/related/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`, `value`; response media `application/json`

### `superset superset css post-css-template`

- Summary: Create a CSS template
- HTTP: `POST /api/v1/css_template/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset css put-css-template-pk`

- Summary: Update a CSS template
- HTTP: `PUT /api/v1/css_template/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

## CacheRestApi

### `superset superset cacherestapi post-cachekey-invalidate`

- Summary: Invalidate cache records and remove the database records
- HTTP: `POST /api/v1/cachekey/invalidate`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

## Charts

### `superset superset charts delete-chart`

- Summary: Bulk delete charts
- HTTP: `DELETE /api/v1/chart/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: response media `application/json`

### `superset superset charts delete-chart-pk`

- Summary: Delete a chart
- HTTP: `DELETE /api/v1/chart/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset charts delete-chart-pk-favorites`

- Summary: Remove the chart from the user favorite list
- HTTP: `DELETE /api/v1/chart/{pk}/favorites/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset charts get-chart`

- Summary: Get a list of charts
- HTTP: `GET /api/v1/chart/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset charts get-chart-data-cache-key`

- Summary: Return payload data response for the given query (chart-data-cache-key)
- HTTP: `GET /api/v1/chart/data/{cache_key}`
- Auth: required
- Body: none
- Flags:
  - `--cache_key` (path, required): cache_key
- Output: list path `result`; columns `cache_key`, `cache_timeout`, `cached_dttm`, `detected_currency`, `error`, `from_dttm`; response media `application/json`

### `superset superset charts get-chart-export`

- Summary: Download multiple charts as YAML files
- HTTP: `GET /api/v1/chart/export/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: response media `application/zip`

### `superset superset charts get-chart-favorite-status`

- Summary: Check favorited charts for current user
- HTTP: `GET /api/v1/chart/favorite_status/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `result`; columns `id`, `value`; response media `application/json`

### `superset superset charts get-chart-id-or-uuid`

- Summary: Get a chart detail information
- HTTP: `GET /api/v1/chart/{id_or_uuid}`
- Auth: required
- Body: none
- Flags:
  - `--id_or_uuid` (path, required): Either the id of the chart, or its uuid
- Output: response media `application/json`

### `superset superset charts get-chart-info`

- Summary: Get metadata information about this API resource (chart--info)
- HTTP: `GET /api/v1/chart/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset charts get-chart-pk-cache-screenshot`

- Summary: Compute and cache a screenshot (chart-pk-cache-screenshot)
- HTTP: `GET /api/v1/chart/{pk}/cache_screenshot/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: response media `application/json`

### `superset superset charts get-chart-pk-data`

- Summary: Return payload data response for a chart
- HTTP: `GET /api/v1/chart/{pk}/data/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The chart ID
  - `--format` (query): The format in which the data should be returned
  - `--type` (query): The type in which the data should be returned
  - `--force` (query): Should the queries be forced to load from the source
- Output: list path `result`; columns `cache_key`, `cache_timeout`, `cached_dttm`, `detected_currency`, `error`, `from_dttm`; response media `application/json`

### `superset superset charts get-chart-pk-screenshot-digest`

- Summary: Get a computed screenshot from cache (chart-pk-screenshot-digest)
- HTTP: `GET /api/v1/chart/{pk}/screenshot/{digest}/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--digest` (path, required): digest
- Output: response media `image/*`

### `superset superset charts get-chart-pk-thumbnail-digest`

- Summary: Get chart thumbnail
- HTTP: `GET /api/v1/chart/{pk}/thumbnail/{digest}/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--digest` (path, required): A hex digest that makes this chart unique
- Output: response media `image/*`

### `superset superset charts get-chart-related-column-name`

- Summary: Get related fields data (chart-related-column-name)
- HTTP: `GET /api/v1/chart/related/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`, `value`; response media `application/json`

### `superset superset charts post-chart`

- Summary: Create a new chart
- HTTP: `POST /api/v1/chart/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset charts post-chart-data`

- Summary: Return payload data response for the given query (chart-data)
- HTTP: `POST /api/v1/chart/data`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: list path `result`; columns `cache_key`, `cache_timeout`, `cached_dttm`, `detected_currency`, `error`, `from_dttm`; response media `application/json`

### `superset superset charts post-chart-import`

- Summary: Import chart(s) with associated datasets and databases
- HTTP: `POST /api/v1/chart/import/`
- Auth: required
- Body: required; media type `multipart/form-data`
- Flags: none
- Output: response media `application/json`

### `superset superset charts post-chart-pk-favorites`

- Summary: Mark the chart as favorite for the current user
- HTTP: `POST /api/v1/chart/{pk}/favorites/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset charts put-chart-pk`

- Summary: Update a chart
- HTTP: `PUT /api/v1/chart/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset charts put-chart-warm-up-cache`

- Summary: Warm up the cache for the chart
- HTTP: `PUT /api/v1/chart/warm_up_cache`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: list path `result`; columns `chart_id`, `viz_error`, `viz_status`; response media `application/json`

## Current User

### `superset superset current get-me`

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

### `superset superset current get-me-roles`

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

### `superset superset current put-me`

- Summary: Update the current user
- HTTP: `PUT /api/v1/me/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: response media `application/json`

## Dashboard Filter State

### `superset superset dashboard delete-dashboard-pk-filter-state-key`

- Summary: Delete a dashboard's filter state value
- HTTP: `DELETE /api/v1/dashboard/{pk}/filter_state/{key}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--key` (path, required): The value key.
- Output: response media `application/json`

### `superset superset dashboard get-dashboard-pk-filter-state-key`

- Summary: Get a dashboard's filter state value
- HTTP: `GET /api/v1/dashboard/{pk}/filter_state/{key}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--key` (path, required): key
- Output: response media `application/json`

### `superset superset dashboard post-dashboard-pk-filter-state`

- Summary: Create a dashboard's filter state
- HTTP: `POST /api/v1/dashboard/{pk}/filter_state`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
  - `--tab_id` (query): tab_id

### `superset superset dashboard put-dashboard-pk-filter-state-key`

- Summary: Update a dashboard's filter state value
- HTTP: `PUT /api/v1/dashboard/{pk}/filter_state/{key}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
  - `--key` (path, required): key
  - `--tab_id` (query): tab_id
- Output: response media `application/json`

## Dashboard Permanent Link

### `superset superset dashboard get-dashboard-permalink-key`

- Summary: Get dashboard's permanent link state
- HTTP: `GET /api/v1/dashboard/permalink/{key}`
- Auth: required
- Body: none
- Flags:
  - `--key` (path, required): key
- Output: response media `application/json`

### `superset superset dashboard post-dashboard-pk-permalink`

- Summary: Create a new dashboard's permanent link
- HTTP: `POST /api/v1/dashboard/{pk}/permalink`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk

## Dashboards

### `superset superset dashboards delete-dashboard`

- Summary: Bulk delete dashboards
- HTTP: `DELETE /api/v1/dashboard/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: response media `application/json`

### `superset superset dashboards delete-dashboard-id-or-slug-embedded`

- Summary: Delete a dashboard's embedded configuration
- HTTP: `DELETE /api/v1/dashboard/{id_or_slug}/embedded`
- Auth: required
- Body: none
- Flags:
  - `--id_or_slug` (path, required): The dashboard id or slug
- Output: response media `application/json`

### `superset superset dashboards delete-dashboard-pk`

- Summary: Delete a dashboard
- HTTP: `DELETE /api/v1/dashboard/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset dashboards delete-dashboard-pk-favorites`

- Summary: Remove the dashboard from the user favorite list
- HTTP: `DELETE /api/v1/dashboard/{pk}/favorites/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset dashboards get-dashboard`

- Summary: Get a list of dashboards
- HTTP: `GET /api/v1/dashboard/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset dashboards get-dashboard-export`

- Summary: Download multiple dashboards as YAML files
- HTTP: `GET /api/v1/dashboard/export/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: response media `text/plain`

### `superset superset dashboards get-dashboard-favorite-status`

- Summary: Check favorited dashboards for current user
- HTTP: `GET /api/v1/dashboard/favorite_status/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `result`; columns `id`, `value`; response media `application/json`

### `superset superset dashboards get-dashboard-id-or-slug`

- Summary: Get a dashboard detail information
- HTTP: `GET /api/v1/dashboard/{id_or_slug}`
- Auth: required
- Body: none
- Flags:
  - `--id_or_slug` (path, required): Either the id of the dashboard, or its slug
- Output: response media `application/json`

### `superset superset dashboards get-dashboard-id-or-slug-charts`

- Summary: Get a dashboard's chart definitions.
- HTTP: `GET /api/v1/dashboard/{id_or_slug}/charts`
- Auth: required
- Body: none
- Flags:
  - `--id_or_slug` (path, required): id_or_slug
- Output: list path `result`; columns `id`, `cache_timeout`, `certification_details`, `certified_by`, `changed_on`, `description`; response media `application/json`

### `superset superset dashboards get-dashboard-id-or-slug-datasets`

- Summary: Get dashboard's datasets
- HTTP: `GET /api/v1/dashboard/{id_or_slug}/datasets`
- Auth: required
- Body: none
- Flags:
  - `--id_or_slug` (path, required): Either the id of the dashboard, or its slug
- Output: list path `result`; columns `name`, `type`, `id`, `uid`, `always_filter_main_dttm`, `cache_timeout`; response media `application/json`

### `superset superset dashboards get-dashboard-id-or-slug-embedded`

- Summary: Get the dashboard's embedded configuration
- HTTP: `GET /api/v1/dashboard/{id_or_slug}/embedded`
- Auth: required
- Body: none
- Flags:
  - `--id_or_slug` (path, required): The dashboard id or slug
- Output: response media `application/json`

### `superset superset dashboards get-dashboard-id-or-slug-tabs`

- Summary: Get dashboard's tabs
- HTTP: `GET /api/v1/dashboard/{id_or_slug}/tabs`
- Auth: required
- Body: none
- Flags:
  - `--id_or_slug` (path, required): Either the id of the dashboard, or its slug
- Output: response media `application/json`

### `superset superset dashboards get-dashboard-info`

- Summary: Get metadata information about this API resource (dashboard--info)
- HTTP: `GET /api/v1/dashboard/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset dashboards get-dashboard-pk-export-as-example`

- Summary: Export dashboard as example bundle
- HTTP: `GET /api/v1/dashboard/{pk}/export_as_example/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The dashboard id
  - `--export_data` (query, default `true`): Whether to include Parquet data files
  - `--sample_rows` (query): Limit data export to this many rows per dataset
- Output: response media `application/zip`

### `superset superset dashboards get-dashboard-pk-screenshot-digest`

- Summary: Get a computed screenshot from cache (dashboard-pk-screenshot-digest)
- HTTP: `GET /api/v1/dashboard/{pk}/screenshot/{digest}/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--digest` (path, required): digest
  - `--download_format` (query, one of: png|pdf): download_format
- Output: response media `image/*`

### `superset superset dashboards get-dashboard-pk-thumbnail-digest`

- Summary: Get dashboard's thumbnail
- HTTP: `GET /api/v1/dashboard/{pk}/thumbnail/{digest}/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--digest` (path, required): A hex digest that makes this dashboard unique
- Output: response media `image/*`

### `superset superset dashboards get-dashboard-related-column-name`

- Summary: Get related fields data (dashboard-related-column-name)
- HTTP: `GET /api/v1/dashboard/related/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`, `value`; response media `application/json`

### `superset superset dashboards post-dashboard`

- Summary: Create a new dashboard
- HTTP: `POST /api/v1/dashboard/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset dashboards post-dashboard-id-or-slug-copy`

- Summary: Create a copy of an existing dashboard
- HTTP: `POST /api/v1/dashboard/{id_or_slug}/copy/`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--id_or_slug` (path, required): The dashboard id or slug
- Output: response media `application/json`

### `superset superset dashboards post-dashboard-id-or-slug-embedded`

- Summary: Set a dashboard's embedded configuration
- HTTP: `POST /api/v1/dashboard/{id_or_slug}/embedded`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--id_or_slug` (path, required): The dashboard id or slug
- Output: response media `application/json`

### `superset superset dashboards post-dashboard-import`

- Summary: Import dashboard(s) with associated charts/datasets/databases
- HTTP: `POST /api/v1/dashboard/import/`
- Auth: required
- Body: required; media type `multipart/form-data`
- Flags: none
- Output: response media `application/json`

### `superset superset dashboards post-dashboard-pk-cache-dashboard-screenshot`

- Summary: Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)
- HTTP: `POST /api/v1/dashboard/{pk}/cache_dashboard_screenshot/`
- Auth: required
- Body: optional; media type `application/json`
- Flags:
  - `--pk` (path, required): pk

### `superset superset dashboards post-dashboard-pk-favorites`

- Summary: Mark the dashboard as favorite for the current user
- HTTP: `POST /api/v1/dashboard/{pk}/favorites/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset dashboards put-dashboard-pk`

- Summary: Update a dashboard
- HTTP: `PUT /api/v1/dashboard/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset dashboards put-dashboard-pk-chart-customizations`

- Summary: Update chart customizations configuration for a dashboard.
- HTTP: `PUT /api/v1/dashboard/{pk}/chart_customizations`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset dashboards put-dashboard-pk-colors`

- Summary: Update colors configuration for a dashboard.
- HTTP: `PUT /api/v1/dashboard/{pk}/colors`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
  - `--mark_updated` (query): mark_updated
- Output: response media `application/json`

### `superset superset dashboards put-dashboard-pk-filters`

- Summary: Update native filters configuration for a dashboard.
- HTTP: `PUT /api/v1/dashboard/{pk}/filters`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset dashboards update-dashboard-by-id-or-slug-embedded`

- Summary: Update dashboard by id_or_slug embedded
- HTTP: `PUT /api/v1/dashboard/{id_or_slug}/embedded`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--id_or_slug` (path, required): The dashboard id or slug
- Output: response media `application/json`

## Database

### `superset superset database delete-database-pk`

- Summary: Delete a database
- HTTP: `DELETE /api/v1/database/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset database get-database`

- Summary: Get a list of databases
- HTTP: `GET /api/v1/database/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset database get-database-available`

- Summary: Get names of databases currently available
- HTTP: `GET /api/v1/database/available/`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `superset superset database get-database-export`

- Summary: Download database(s) and associated dataset(s) as a zip file
- HTTP: `GET /api/v1/database/export/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: response media `application/zip`

### `superset superset database get-database-info`

- Summary: Get metadata information about this API resource (database--info)
- HTTP: `GET /api/v1/database/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset database get-database-oauth2`

- Summary: Receive personal access tokens from OAuth2
- HTTP: `GET /api/v1/database/oauth2/`
- Auth: required
- Body: none
- Flags:
  - `--state` (query): state
  - `--code` (query): code
  - `--scope` (query): scope
  - `--error` (query): error
- Output: response media `text/html`

### `superset superset database get-database-pk`

- Summary: Get a database
- HTTP: `GET /api/v1/database/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The database id
- Output: response media `application/json`

### `superset superset database get-database-pk-catalogs`

- Summary: Get all catalogs from a database
- HTTP: `GET /api/v1/database/{pk}/catalogs/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The database id
  - `--q` (query): q
- Output: list path `result`; response media `application/json`

### `superset superset database get-database-pk-connection`

- Summary: Get a database connection info
- HTTP: `GET /api/v1/database/{pk}/connection`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The database id
- Output: response media `application/json`

### `superset superset database get-database-pk-function-names`

- Summary: Get function names supported by a database
- HTTP: `GET /api/v1/database/{pk}/function_names/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: list path `function_names`; response media `application/json`

### `superset superset database get-database-pk-related-objects`

- Summary: Get charts and dashboards count associated to a database
- HTTP: `GET /api/v1/database/{pk}/related_objects/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset database get-database-pk-schemas`

- Summary: Get all schemas from a database
- HTTP: `GET /api/v1/database/{pk}/schemas/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The database id
  - `--q` (query): q
- Output: list path `result`; response media `application/json`

### `superset superset database get-database-pk-schemas-access-for-file-upload`

- Summary: The list of the database schemas where to upload information
- HTTP: `GET /api/v1/database/{pk}/schemas_access_for_file_upload/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: list path `schemas`; response media `application/json`

### `superset superset database get-database-pk-select-star-table-name`

- Summary: Get database select star for table (database-pk-select-star-table-name)
- HTTP: `GET /api/v1/database/{pk}/select_star/{table_name}/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The database id
  - `--table_name` (path, required): Table name
  - `--schema_name` (path, required): Table schema
- Output: response media `application/json`

### `superset superset database get-database-pk-select-star-table-name-schema-name`

- Summary: Get database select star for table (database-pk-select-star-table-name-schema-name)
- HTTP: `GET /api/v1/database/{pk}/select_star/{table_name}/{schema_name}/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The database id
  - `--table_name` (path, required): Table name
  - `--schema_name` (path, required): Table schema
- Output: response media `application/json`

### `superset superset database get-database-pk-table-extra-table-name-schema-name`

- Summary: Get table extra metadata (database-pk-table-extra-table-name-schema-name)
- HTTP: `GET /api/v1/database/{pk}/table_extra/{table_name}/{schema_name}/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The database id
  - `--table_name` (path, required): Table name
  - `--schema_name` (path, required): Table schema
- Output: response media `application/json`

### `superset superset database get-database-pk-table-metadata`

- Summary: Get table metadata
- HTTP: `GET /api/v1/database/{pk}/table_metadata/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The database id
  - `--name` (query, required): Table name
  - `--schema` (query): Optional table schema, if not passed default schema will be used
  - `--catalog` (query): Optional table catalog, if not passed default catalog will be used
- Output: response media `application/json`

### `superset superset database get-database-pk-table-metadata-extra`

- Summary: Get table extra metadata (database-pk-table-metadata-extra)
- HTTP: `GET /api/v1/database/{pk}/table_metadata/extra/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The database id
  - `--name` (query, required): Table name
  - `--schema` (query): Optional table schema, if not passed the schema configured in the database will be used
  - `--catalog` (query): Optional table catalog, if not passed the catalog configured in the database will be used
- Output: response media `application/json`

### `superset superset database get-database-pk-table-table-name-schema-name`

- Summary: Get database table metadata
- HTTP: `GET /api/v1/database/{pk}/table/{table_name}/{schema_name}/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The database id
  - `--table_name` (path, required): Table name
  - `--schema_name` (path, required): Table schema
- Output: list path `columns`; columns `name`, `type`, `duplicates_constraint`, `longType`; response media `application/json`

### `superset superset database get-database-pk-tables`

- Summary: Get a list of tables for given database
- HTTP: `GET /api/v1/database/{pk}/tables/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The database id
  - `--q` (query): q
- Output: list path `result`; columns `type`, `value`; response media `application/json`

### `superset superset database get-database-related-column-name`

- Summary: Get related fields data (database-related-column-name)
- HTTP: `GET /api/v1/database/related/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`, `value`; response media `application/json`

### `superset superset database post-database`

- Summary: Create a new database
- HTTP: `POST /api/v1/database/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset database post-database-import`

- Summary: Import database(s) with associated datasets
- HTTP: `POST /api/v1/database/import/`
- Auth: required
- Body: required; media type `multipart/form-data`
- Flags: none
- Output: response media `application/json`

### `superset superset database post-database-pk-sync-permissions`

- Summary: Re-sync all permissions for a database connection
- HTTP: `POST /api/v1/database/{pk}/sync_permissions/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The database connection ID
- Output: response media `application/json`

### `superset superset database post-database-pk-upload`

- Summary: Upload a file to a database table
- HTTP: `POST /api/v1/database/{pk}/upload/`
- Auth: required
- Body: required; media type `multipart/form-data`
- Flags:
  - `--pk` (path, required): pk

### `superset superset database post-database-pk-validate-sql`

- Summary: Validate arbitrary SQL
- HTTP: `POST /api/v1/database/{pk}/validate_sql/`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
- Output: list path `result`; columns `end_column`, `line_number`, `message`, `start_column`; response media `application/json`

### `superset superset database post-database-test-connection`

- Summary: Test a database connection
- HTTP: `POST /api/v1/database/test_connection/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `superset superset database post-database-upload-metadata`

- Summary: Upload a file and returns file metadata
- HTTP: `POST /api/v1/database/upload_metadata/`
- Auth: required
- Body: required; media type `multipart/form-data`
- Flags: none
- Output: response media `application/json`

### `superset superset database post-database-validate-parameters`

- Summary: Validate database connection parameters
- HTTP: `POST /api/v1/database/validate_parameters/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `superset superset database put-database-pk`

- Summary: Change a database
- HTTP: `PUT /api/v1/database/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

## Datasets

### `superset superset datasets delete-dataset`

- Summary: Bulk delete datasets
- HTTP: `DELETE /api/v1/dataset/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: response media `application/json`

### `superset superset datasets delete-dataset-pk`

- Summary: Delete a dataset
- HTTP: `DELETE /api/v1/dataset/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset datasets delete-dataset-pk-column-column-id`

- Summary: Delete a dataset column
- HTTP: `DELETE /api/v1/dataset/{pk}/column/{column_id}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The dataset pk for this column
  - `--column_id` (path, required): The column id for this dataset
- Output: response media `application/json`

### `superset superset datasets delete-dataset-pk-metric-metric-id`

- Summary: Delete a dataset metric
- HTTP: `DELETE /api/v1/dataset/{pk}/metric/{metric_id}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The dataset pk for this column
  - `--metric_id` (path, required): The metric id for this dataset
- Output: response media `application/json`

### `superset superset datasets get-dataset`

- Summary: Get a list of datasets
- HTTP: `GET /api/v1/dataset/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset datasets get-dataset-distinct-column-name`

- Summary: Get distinct values from field data (dataset-distinct-column-name)
- HTTP: `GET /api/v1/dataset/distinct/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`; response media `application/json`

### `superset superset datasets get-dataset-export`

- Summary: Download multiple datasets as YAML files
- HTTP: `GET /api/v1/dataset/export/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: response media `text/plain`

### `superset superset datasets get-dataset-id-or-uuid`

- Summary: Get a dataset
- HTTP: `GET /api/v1/dataset/{id_or_uuid}`
- Auth: required
- Body: none
- Flags:
  - `--id_or_uuid` (path, required): Either the id of the dataset, or its uuid
  - `--q` (query): q
  - `--include_rendered_sql` (query): Should Jinja macros from sql, metrics and columns be rendered and included in the response
- Output: response media `application/json`

### `superset superset datasets get-dataset-id-or-uuid-related-objects`

- Summary: Get charts and dashboards count associated to a dataset
- HTTP: `GET /api/v1/dataset/{id_or_uuid}/related_objects`
- Auth: required
- Body: none
- Flags:
  - `--id_or_uuid` (path, required): id_or_uuid
- Output: response media `application/json`

### `superset superset datasets get-dataset-info`

- Summary: Get metadata information about this API resource (dataset--info)
- HTTP: `GET /api/v1/dataset/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset datasets get-dataset-pk-drill-info`

- Summary: Get dataset drill info
- HTTP: `GET /api/v1/dataset/{pk}/drill_info/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The dataset ID
- Output: response media `application/json`

### `superset superset datasets get-dataset-related-column-name`

- Summary: Get related fields data (dataset-related-column-name)
- HTTP: `GET /api/v1/dataset/related/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`, `value`; response media `application/json`

### `superset superset datasets post-dataset`

- Summary: Create a new dataset
- HTTP: `POST /api/v1/dataset/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset datasets post-dataset-duplicate`

- Summary: Duplicate a dataset
- HTTP: `POST /api/v1/dataset/duplicate`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset datasets post-dataset-get-or-create`

- Summary: Retrieve a table by name, or create it if it does not exist
- HTTP: `POST /api/v1/dataset/get_or_create/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `superset superset datasets post-dataset-import`

- Summary: Import dataset(s) with associated databases
- HTTP: `POST /api/v1/dataset/import/`
- Auth: required
- Body: required; media type `multipart/form-data`
- Flags: none
- Output: response media `application/json`

### `superset superset datasets put-dataset-pk`

- Summary: Update a dataset
- HTTP: `PUT /api/v1/dataset/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
  - `--override_columns` (query): override_columns
- Output: response media `application/json`

### `superset superset datasets put-dataset-pk-refresh`

- Summary: Refresh and update columns of a dataset
- HTTP: `PUT /api/v1/dataset/{pk}/refresh`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset datasets put-dataset-warm-up-cache`

- Summary: Warm up the cache for each chart powered by the given table
- HTTP: `PUT /api/v1/dataset/warm_up_cache`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: list path `result`; columns `chart_id`, `viz_error`, `viz_status`; response media `application/json`

## Datasources

### `superset superset datasources get-datasource-datasource-type-datasource-id-column-column-name-values`

- Summary: Get possible values for a datasource column
- HTTP: `GET /api/v1/datasource/{datasource_type}/{datasource_id}/column/{column_name}/values/`
- Auth: required
- Body: none
- Flags:
  - `--datasource_type` (path, required): The type of datasource
  - `--datasource_id` (path, required): The id of the datasource
  - `--column_name` (path, required): The name of the column to get values for
- Output: list path `result`; response media `application/json`

### `superset superset datasources post-datasource-datasource-type-datasource-id-validate-expression`

- Summary: Validate a SQL expression against a datasource
- HTTP: `POST /api/v1/datasource/{datasource_type}/{datasource_id}/validate_expression/`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--datasource_type` (path, required): The type of datasource
  - `--datasource_id` (path, required): The id of the datasource
- Output: list path `result`; response media `application/json`

## Embedded Dashboard

### `superset superset embedded get-embedded-dashboard-uuid`

- Summary: Get a report schedule log (embedded-dashboard-uuid)
- HTTP: `GET /api/v1/embedded_dashboard/{uuid}`
- Auth: required
- Body: none
- Flags:
  - `--uuid` (path, required): The embedded configuration uuid
  - `--ui-config` (query): The ui config of embedded dashboard (optional).
  - `--show_filters` (query): Show filters (optional).
  - `--expand_filters` (query): Expand filters (optional).
  - `--native_filters_key` (query): Native filters key to apply filters. (optional).
  - `--permalink_key` (query): Permalink key to apply filters. (optional).
- Output: response media `application/json`

## Explore

### `superset superset explore get-explore`

- Summary: Assemble Explore related information in a single endpoint
- HTTP: `GET /api/v1/explore/`
- Auth: required
- Body: none
- Flags:
  - `--form_data_key` (query): form_data_key
  - `--permalink_key` (query): permalink_key
  - `--slice_id` (query): slice_id
  - `--datasource_id` (query): datasource_id
  - `--datasource_type` (query): datasource_type
- Output: response media `application/json`

## Explore Form Data

### `superset superset explore delete-explore-form-data-key`

- Summary: Delete a form_data
- HTTP: `DELETE /api/v1/explore/form_data/{key}`
- Auth: required
- Body: none
- Flags:
  - `--key` (path, required): The form_data key.
- Output: response media `application/json`

### `superset superset explore get-explore-form-data-key`

- Summary: Get a form_data
- HTTP: `GET /api/v1/explore/form_data/{key}`
- Auth: required
- Body: none
- Flags:
  - `--key` (path, required): key
- Output: response media `application/json`

### `superset superset explore post-explore-form-data`

- Summary: Create a new form_data
- HTTP: `POST /api/v1/explore/form_data`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--tab_id` (query): tab_id

### `superset superset explore put-explore-form-data-key`

- Summary: Update an existing form_data
- HTTP: `PUT /api/v1/explore/form_data/{key}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--key` (path, required): key
  - `--tab_id` (query): tab_id
- Output: response media `application/json`

## Explore Permanent Link

### `superset superset explore get-explore-permalink-key`

- Summary: Get chart's permanent link state
- HTTP: `GET /api/v1/explore/permalink/{key}`
- Auth: required
- Body: none
- Flags:
  - `--key` (path, required): key
- Output: response media `application/json`

### `superset superset explore post-explore-permalink`

- Summary: Create a new permanent link (explore-permalink)
- HTTP: `POST /api/v1/explore/permalink`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

## Import/export

### `superset superset import/export get-assets-export`

- Summary: Export all assets
- HTTP: `GET /api/v1/assets/export/`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/zip`

### `superset superset import/export post-assets-import`

- Summary: Import multiple assets
- HTTP: `POST /api/v1/assets/import/`
- Auth: required
- Body: required; media type `multipart/form-data`
- Flags: none
- Output: response media `application/json`

## LogRestApi

### `superset superset logrestapi create-log`

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

### `superset superset logrestapi get-log`

- Summary: Get a list of logs
- HTTP: `GET /api/v1/log/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset logrestapi get-log-pk`

- Summary: Get a log detail information
- HTTP: `GET /api/v1/log/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: list path `show_columns`; response media `application/json`

### `superset superset logrestapi get-log-recent-activity`

- Summary: Get recent activity data for a user
- HTTP: `GET /api/v1/log/recent_activity/`
- Auth: required
- Body: none
- Flags:
  - `--user_id` (path, required): The id of the user
  - `--q` (query): q
- Output: list path `result`; columns `action`, `item_title`, `item_type`, `item_url`, `time`, `time_delta_humanized`; response media `application/json`

## Menu

### `superset superset menu get-menu`

- Summary: Get menu
- HTTP: `GET /api/v1/menu/`
- Auth: required
- Body: none
- Flags: none
- Output: list path `result`; response media `application/json`

## OpenApi

### `superset superset openapi get-api-by-version-openapi`

- Summary: Get api by version openapi
- HTTP: `GET /api/{version}/_openapi`
- Auth: required
- Body: none
- Flags:
  - `--version` (path, required): version
- Output: response media `application/json`

## Queries

### `superset superset queries delete-saved-query`

- Summary: Bulk delete saved queries
- HTTP: `DELETE /api/v1/saved_query/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: response media `application/json`

### `superset superset queries delete-saved-query-pk`

- Summary: Delete a saved query
- HTTP: `DELETE /api/v1/saved_query/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset queries get-query`

- Summary: Get a list of queries
- HTTP: `GET /api/v1/query/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset queries get-query-distinct-column-name`

- Summary: Get distinct values from field data (query-distinct-column-name)
- HTTP: `GET /api/v1/query/distinct/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`; response media `application/json`

### `superset superset queries get-query-pk`

- Summary: Get query detail information
- HTTP: `GET /api/v1/query/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: list path `show_columns`; response media `application/json`

### `superset superset queries get-query-related-column-name`

- Summary: Get related fields data (query-related-column-name)
- HTTP: `GET /api/v1/query/related/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`, `value`; response media `application/json`

### `superset superset queries get-query-updated-since`

- Summary: Get a list of queries that changed after last_updated_ms
- HTTP: `GET /api/v1/query/updated_since`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `result`; columns `id`, `changed_on`, `client_id`, `end_result_backend_time`, `end_time`, `error_message`; response media `application/json`

### `superset superset queries get-saved-query`

- Summary: Get a list of saved queries
- HTTP: `GET /api/v1/saved_query/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset queries get-saved-query-distinct-column-name`

- Summary: Get distinct values from field data (saved-query-distinct-column-name)
- HTTP: `GET /api/v1/saved_query/distinct/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`; response media `application/json`

### `superset superset queries get-saved-query-export`

- Summary: Download multiple saved queries as YAML files
- HTTP: `GET /api/v1/saved_query/export/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: response media `application/zip`

### `superset superset queries get-saved-query-info`

- Summary: Get metadata information about this API resource (saved-query--info)
- HTTP: `GET /api/v1/saved_query/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset queries get-saved-query-pk`

- Summary: Get a saved query
- HTTP: `GET /api/v1/saved_query/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: list path `show_columns`; response media `application/json`

### `superset superset queries get-saved-query-related-column-name`

- Summary: Get related fields data (saved-query-related-column-name)
- HTTP: `GET /api/v1/saved_query/related/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`, `value`; response media `application/json`

### `superset superset queries post-query-stop`

- Summary: Manually stop a query with client_id
- HTTP: `POST /api/v1/query/stop`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `superset superset queries post-saved-query`

- Summary: Create a saved query
- HTTP: `POST /api/v1/saved_query/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset queries post-saved-query-import`

- Summary: Import saved queries with associated databases
- HTTP: `POST /api/v1/saved_query/import/`
- Auth: required
- Body: required; media type `multipart/form-data`
- Flags: none
- Output: response media `application/json`

### `superset superset queries put-saved-query-pk`

- Summary: Update a saved query
- HTTP: `PUT /api/v1/saved_query/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

## Report Schedules

### `superset superset report delete-report`

- Summary: Bulk delete report schedules
- HTTP: `DELETE /api/v1/report/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: response media `application/json`

### `superset superset report delete-report-pk`

- Summary: Delete a report schedule
- HTTP: `DELETE /api/v1/report/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The report schedule pk
- Output: response media `application/json`

### `superset superset report get-report`

- Summary: Get a list of report schedules
- HTTP: `GET /api/v1/report/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset report get-report-info`

- Summary: Get metadata information about this API resource (report--info)
- HTTP: `GET /api/v1/report/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset report get-report-pk`

- Summary: Get a report schedule
- HTTP: `GET /api/v1/report/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: list path `show_columns`; response media `application/json`

### `superset superset report get-report-pk-log`

- Summary: Get a list of report schedule logs
- HTTP: `GET /api/v1/report/{pk}/log/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The report schedule id for these logs
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset report get-report-pk-log-log-id`

- Summary: Get a report schedule log (report-pk-log-log-id)
- HTTP: `GET /api/v1/report/{pk}/log/{log_id}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The report schedule pk for log
  - `--log_id` (path, required): The log pk
  - `--q` (query): q
- Output: response media `application/json`

### `superset superset report get-report-related-column-name`

- Summary: Get related fields data (report-related-column-name)
- HTTP: `GET /api/v1/report/related/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`, `value`; response media `application/json`

### `superset superset report get-report-slack-channels`

- Summary: Get slack channels
- HTTP: `GET /api/v1/report/slack_channels/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `result`; response media `application/json`

### `superset superset report post-report`

- Summary: Create a report schedule
- HTTP: `POST /api/v1/report/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset report put-report-pk`

- Summary: Update a report schedule
- HTTP: `PUT /api/v1/report/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): The Report Schedule pk
- Output: response media `application/json`

## Row Level Security

### `superset superset row delete-rowlevelsecurity`

- Summary: Bulk delete RLS rules
- HTTP: `DELETE /api/v1/rowlevelsecurity/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: response media `application/json`

### `superset superset row delete-rowlevelsecurity-pk`

- Summary: Delete an RLS
- HTTP: `DELETE /api/v1/rowlevelsecurity/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset row get-rowlevelsecurity`

- Summary: Get a list of RLS
- HTTP: `GET /api/v1/rowlevelsecurity/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset row get-rowlevelsecurity-info`

- Summary: Get metadata information about this API resource (rowlevelsecurity--info)
- HTTP: `GET /api/v1/rowlevelsecurity/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset row get-rowlevelsecurity-pk`

- Summary: Get an RLS
- HTTP: `GET /api/v1/rowlevelsecurity/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: list path `show_columns`; response media `application/json`

### `superset superset row get-rowlevelsecurity-related-column-name`

- Summary: Get related fields data (rowlevelsecurity-related-column-name)
- HTTP: `GET /api/v1/rowlevelsecurity/related/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`, `value`; response media `application/json`

### `superset superset row post-rowlevelsecurity`

- Summary: Create a new RLS rule
- HTTP: `POST /api/v1/rowlevelsecurity/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset row put-rowlevelsecurity-pk`

- Summary: Update an RLS rule
- HTTP: `PUT /api/v1/rowlevelsecurity/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): The Rule pk
- Output: response media `application/json`

## SQL Lab

### `superset superset sql get-sqllab`

- Summary: Get the bootstrap data for SqlLab page
- HTTP: `GET /api/v1/sqllab/`
- Auth: required
- Body: none
- Flags: none
- Output: list path `tab_state_ids`; response media `application/json`

### `superset superset sql get-sqllab-export-client-id`

- Summary: Export the SQL query results to a CSV
- HTTP: `GET /api/v1/sqllab/export/{client_id}/`
- Auth: required
- Body: none
- Flags:
  - `--client_id` (path, required): The SQL query result identifier
- Output: response media `text/csv`

### `superset superset sql get-sqllab-results`

- Summary: Get the result of a SQL query execution
- HTTP: `GET /api/v1/sqllab/results/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `data`; response media `application/json`

### `superset superset sql post-sqllab-estimate`

- Summary: Estimate the SQL query execution cost
- HTTP: `POST /api/v1/sqllab/estimate/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `superset superset sql post-sqllab-execute`

- Summary: Execute a SQL query
- HTTP: `POST /api/v1/sqllab/execute/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: list path `data`; response media `application/json`

### `superset superset sql post-sqllab-export-streaming`

- Summary: Export SQL query results to CSV with streaming
- HTTP: `POST /api/v1/sqllab/export_streaming/`
- Auth: required
- Body: required; media type `application/x-www-form-urlencoded`
- Flags: none
- Output: response media `text/csv`

### `superset superset sql post-sqllab-format-sql`

- Summary: Format SQL code
- HTTP: `POST /api/v1/sqllab/format_sql/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: response media `application/json`

## SQL Lab Permanent Link

### `superset superset sql get-sqllab-permalink-key`

- Summary: Get permanent link state for SQLLab editor.
- HTTP: `GET /api/v1/sqllab/permalink/{key}`
- Auth: required
- Body: none
- Flags:
  - `--key` (path, required): key
- Output: response media `application/json`

### `superset superset sql post-sqllab-permalink`

- Summary: Create a new permanent link (sqllab-permalink)
- HTTP: `POST /api/v1/sqllab/permalink`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

## Security

### `superset superset security create-security-login`

- Summary: Create security login
- HTTP: `POST /api/v1/security/login`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `superset superset security create-security-refresh`

- Summary: Create security refresh
- HTTP: `POST /api/v1/security/refresh`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `superset superset security get-security-csrf-token`

- Summary: Get the CSRF token
- HTTP: `GET /api/v1/security/csrf_token/`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `superset superset security post-security-guest-token`

- Summary: Get a guest token
- HTTP: `POST /api/v1/security/guest_token/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: response media `application/json`

## Security Groups

### `superset superset security create-security-groups`

- Summary: Create security groups
- HTTP: `POST /api/v1/security/groups/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset security delete-security-groups-by-pk`

- Summary: Delete security groups by pk
- HTTP: `DELETE /api/v1/security/groups/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset security get-security-groups`

- Summary: Get security groups
- HTTP: `GET /api/v1/security/groups/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset security get-security-groups-by-pk`

- Summary: Get security groups by pk
- HTTP: `GET /api/v1/security/groups/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: list path `show_columns`; response media `application/json`

### `superset superset security get-security-groups-info`

- Summary: Get security groups info
- HTTP: `GET /api/v1/security/groups/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset security update-security-groups-by-pk`

- Summary: Update security groups by pk
- HTTP: `PUT /api/v1/security/groups/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

## Security Permissions

### `superset superset security get-security-permissions`

- Summary: Get security permissions
- HTTP: `GET /api/v1/security/permissions/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset security get-security-permissions-by-pk`

- Summary: Get security permissions by pk
- HTTP: `GET /api/v1/security/permissions/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: list path `show_columns`; response media `application/json`

### `superset superset security get-security-permissions-info`

- Summary: Get security permissions info
- HTTP: `GET /api/v1/security/permissions/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

## Security Permissions on Resources (View Menus)

### `superset superset security create-security-permissions-resources`

- Summary: Create security permissions resources
- HTTP: `POST /api/v1/security/permissions-resources/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset security delete-security-permissions-resources-by-pk`

- Summary: Delete security permissions resources by pk
- HTTP: `DELETE /api/v1/security/permissions-resources/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset security get-security-permissions-resources`

- Summary: Get security permissions resources
- HTTP: `GET /api/v1/security/permissions-resources/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset security get-security-permissions-resources-by-pk`

- Summary: Get security permissions resources by pk
- HTTP: `GET /api/v1/security/permissions-resources/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: list path `show_columns`; response media `application/json`

### `superset superset security get-security-permissions-resources-info`

- Summary: Get security permissions resources info
- HTTP: `GET /api/v1/security/permissions-resources/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset security update-security-permissions-resources-by-pk`

- Summary: Update security permissions resources by pk
- HTTP: `PUT /api/v1/security/permissions-resources/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

## Security Resources (View Menus)

### `superset superset security create-security-resources`

- Summary: Create security resources
- HTTP: `POST /api/v1/security/resources/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset security delete-security-resources-by-pk`

- Summary: Delete security resources by pk
- HTTP: `DELETE /api/v1/security/resources/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset security get-security-resources`

- Summary: Get security resources
- HTTP: `GET /api/v1/security/resources/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset security get-security-resources-by-pk`

- Summary: Get security resources by pk
- HTTP: `GET /api/v1/security/resources/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: list path `show_columns`; response media `application/json`

### `superset superset security get-security-resources-info`

- Summary: Get security resources info
- HTTP: `GET /api/v1/security/resources/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset security update-security-resources-by-pk`

- Summary: Update security resources by pk
- HTTP: `PUT /api/v1/security/resources/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

## Security Roles

### `superset superset security create-security-roles`

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

### `superset superset security create-security-roles-by-role-id-permissions`

- Summary: Create security roles by role_id permissions
- HTTP: `POST /api/v1/security/roles/{role_id}/permissions`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--role_id` (path, required): role_id
- Output: response media `application/json`

### `superset superset security delete-security-roles-by-pk`

- Summary: Delete security roles by pk
- HTTP: `DELETE /api/v1/security/roles/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset security get-security-roles`

- Summary: Get security roles
- HTTP: `GET /api/v1/security/roles/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset security get-security-roles-by-pk`

- Summary: Get security roles by pk
- HTTP: `GET /api/v1/security/roles/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: list path `show_columns`; response media `application/json`

### `superset superset security get-security-roles-by-role-id-permissions`

- Summary: Get security roles by role_id permissions
- HTTP: `GET /api/v1/security/roles/{role_id}/permissions/`
- Auth: required
- Body: none
- Flags:
  - `--role_id` (path, required): role_id
- Output: list path `result`; columns `id`, `permission_name`, `view_menu_name`; response media `application/json`

### `superset superset security get-security-roles-info`

- Summary: Get security roles info
- HTTP: `GET /api/v1/security/roles/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset security get-security-roles-search`

- Summary: List roles
- HTTP: `GET /api/v1/security/roles/search/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset security update-security-roles-by-pk`

- Summary: Update security roles by pk
- HTTP: `PUT /api/v1/security/roles/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset security update-security-roles-by-role-id-groups`

- Summary: Update security roles by role_id groups
- HTTP: `PUT /api/v1/security/roles/{role_id}/groups`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--role_id` (path, required): role_id
- Output: response media `application/json`

### `superset superset security update-security-roles-by-role-id-users`

- Summary: Update security roles by role_id users
- HTTP: `PUT /api/v1/security/roles/{role_id}/users`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--role_id` (path, required): role_id
- Output: response media `application/json`

## Security Users

### `superset superset security create-security-users`

- Summary: Create security users
- HTTP: `POST /api/v1/security/users/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset security delete-security-users-by-pk`

- Summary: Delete security users by pk
- HTTP: `DELETE /api/v1/security/users/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset security get-security-users`

- Summary: Get security users
- HTTP: `GET /api/v1/security/users/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset security get-security-users-by-pk`

- Summary: Get security users by pk
- HTTP: `GET /api/v1/security/users/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: list path `show_columns`; response media `application/json`

### `superset superset security get-security-users-info`

- Summary: Get security users info
- HTTP: `GET /api/v1/security/users/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset security update-security-users-by-pk`

- Summary: Update security users by pk
- HTTP: `PUT /api/v1/security/users/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

## Tags

### `superset superset tags create-tag-by-pk-favorites`

- Summary: Create tag by pk favorites
- HTTP: `POST /api/v1/tag/{pk}/favorites/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset tags delete-tag`

- Summary: Bulk delete tags
- HTTP: `DELETE /api/v1/tag/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: response media `application/json`

### `superset superset tags delete-tag-by-pk-favorites`

- Summary: Delete tag by pk favorites
- HTTP: `DELETE /api/v1/tag/{pk}/favorites/`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset tags delete-tag-object-type-object-id-tag`

- Summary: Delete a tagged object
- HTTP: `DELETE /api/v1/tag/{object_type}/{object_id}/{tag}/`
- Auth: required
- Body: none
- Flags:
  - `--tag` (path, required): tag
  - `--object_type` (path, required): object_type
  - `--object_id` (path, required): object_id
- Output: response media `application/json`

### `superset superset tags delete-tag-pk`

- Summary: Delete a tag
- HTTP: `DELETE /api/v1/tag/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset tags get-tag`

- Summary: Get a list of tags
- HTTP: `GET /api/v1/tag/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset tags get-tag-favorite-status`

- Summary: Get tag favorite status
- HTTP: `GET /api/v1/tag/favorite_status/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `result`; columns `id`, `value`; response media `application/json`

### `superset superset tags get-tag-get-objects`

- Summary: Get all objects associated with a tag
- HTTP: `GET /api/v1/tag/get_objects/`
- Auth: required
- Body: none
- Flags:
  - `--tag_id` (path, required): tag_id
- Output: list path `result`; columns `name`, `type`, `id`, `changed_on`, `creator`, `url`; response media `application/json`

### `superset superset tags get-tag-info`

- Summary: Get metadata information about tag API endpoints
- HTTP: `GET /api/v1/tag/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset tags get-tag-pk`

- Summary: Get a tag detail information
- HTTP: `GET /api/v1/tag/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: list path `show_columns`; response media `application/json`

### `superset superset tags get-tag-related-column-name`

- Summary: Get related fields data (tag-related-column-name)
- HTTP: `GET /api/v1/tag/related/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`, `value`; response media `application/json`

### `superset superset tags post-tag`

- Summary: Create a tag
- HTTP: `POST /api/v1/tag/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset tags post-tag-bulk-create`

- Summary: Bulk create tags and tagged objects
- HTTP: `POST /api/v1/tag/bulk_create`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `superset superset tags post-tag-object-type-object-id`

- Summary: Add tags to an object
- HTTP: `POST /api/v1/tag/{object_type}/{object_id}/`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--object_type` (path, required): object_type
  - `--object_id` (path, required): object_id

### `superset superset tags put-tag-pk`

- Summary: Update a tag
- HTTP: `PUT /api/v1/tag/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

## Themes

### `superset superset themes delete-theme`

- Summary: Bulk delete themes
- HTTP: `DELETE /api/v1/theme/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: response media `application/json`

### `superset superset themes delete-theme-pk`

- Summary: Delete a theme
- HTTP: `DELETE /api/v1/theme/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset themes delete-theme-unset-system-dark`

- Summary: Clear the system dark theme
- HTTP: `DELETE /api/v1/theme/unset_system_dark`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `superset superset themes delete-theme-unset-system-default`

- Summary: Clear the system default theme
- HTTP: `DELETE /api/v1/theme/unset_system_default`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `superset superset themes get-theme`

- Summary: Get a list of themes
- HTTP: `GET /api/v1/theme/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset themes get-theme-export`

- Summary: Download multiple themes as YAML files
- HTTP: `GET /api/v1/theme/export/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: response media `application/zip`

### `superset superset themes get-theme-info`

- Summary: Get metadata information about this API resource (theme--info)
- HTTP: `GET /api/v1/theme/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset themes get-theme-pk`

- Summary: Get a theme
- HTTP: `GET /api/v1/theme/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: list path `show_columns`; response media `application/json`

### `superset superset themes get-theme-related-column-name`

- Summary: Get related fields data (theme-related-column-name)
- HTTP: `GET /api/v1/theme/related/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`, `value`; response media `application/json`

### `superset superset themes post-theme`

- Summary: Create a theme
- HTTP: `POST /api/v1/theme/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset themes post-theme-import`

- Summary: Import themes from a ZIP file
- HTTP: `POST /api/v1/theme/import/`
- Auth: required
- Body: required; media type `multipart/form-data`
- Flags: none
- Output: response media `application/json`

### `superset superset themes put-theme-pk`

- Summary: Update a theme
- HTTP: `PUT /api/v1/theme/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset themes put-theme-pk-set-system-dark`

- Summary: Set a theme as the system dark theme
- HTTP: `PUT /api/v1/theme/{pk}/set_system_dark`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The theme id
- Output: response media `application/json`

### `superset superset themes put-theme-pk-set-system-default`

- Summary: Set a theme as the system default theme
- HTTP: `PUT /api/v1/theme/{pk}/set_system_default`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): The theme id
- Output: response media `application/json`

## User

### `superset superset user get-user-user-id-avatar-png`

- Summary: Get the user avatar
- HTTP: `GET /api/v1/user/{user_id}/avatar.png`
- Auth: required
- Body: none
- Flags:
  - `--user_id` (path, required): The ID of the user

## UserRegistrationsRestAPI

### `superset superset userregistrationsrestapi create-security-user-registrations`

- Summary: Create security user registrations
- HTTP: `POST /api/v1/security/user_registrations/`
- Auth: required
- Body: required; media type `application/json`
- Flags: none

### `superset superset userregistrationsrestapi delete-security-user-registrations-by-pk`

- Summary: Delete security user registrations by pk
- HTTP: `DELETE /api/v1/security/user_registrations/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

### `superset superset userregistrationsrestapi get-security-user-registrations`

- Summary: Get security user registrations
- HTTP: `GET /api/v1/security/user_registrations/`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `ids`; response media `application/json`

### `superset superset userregistrationsrestapi get-security-user-registrations-by-pk`

- Summary: Get security user registrations by pk
- HTTP: `GET /api/v1/security/user_registrations/{pk}`
- Auth: required
- Body: none
- Flags:
  - `--pk` (path, required): pk
  - `--q` (query): q
- Output: list path `show_columns`; response media `application/json`

### `superset superset userregistrationsrestapi get-security-user-registrations-distinct-column-name`

- Summary: Get distinct values from field data (security-user-registrations-distinct-column-name)
- HTTP: `GET /api/v1/security/user_registrations/distinct/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`; response media `application/json`

### `superset superset userregistrationsrestapi get-security-user-registrations-info`

- Summary: Get security user registrations info
- HTTP: `GET /api/v1/security/user_registrations/_info`
- Auth: required
- Body: none
- Flags:
  - `--q` (query): q
- Output: list path `permissions`; response media `application/json`

### `superset superset userregistrationsrestapi get-security-user-registrations-related-column-name`

- Summary: Get related fields data (security-user-registrations-related-column-name)
- HTTP: `GET /api/v1/security/user_registrations/related/{column_name}`
- Auth: required
- Body: none
- Flags:
  - `--column_name` (path, required): column_name
  - `--q` (query): q
- Output: list path `result`; columns `text`, `value`; response media `application/json`

### `superset superset userregistrationsrestapi update-security-user-registrations-by-pk`

- Summary: Update security user registrations by pk
- HTTP: `PUT /api/v1/security/user_registrations/{pk}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
  - `--pk` (path, required): pk
- Output: response media `application/json`

Apache Superset

This recipe generates the superset CLI and agent Skill for the Apache Superset analytics and BI API.

It keeps only the reproducible Lathe inputs: the OpenAPI spec is pinned from the Superset repository, and generated code is not the source of truth.

Module

superset: dashboards, charts, datasets, databases, queries, reports, security, and other Superset API operations (276 commands across 28 groups).

Auth

Superset uses JWT bearer tokens. Obtain an access token from POST /api/v1/security/login, then:

superset auth login --hostname <superset-host>

auth status validates the token against GET /api/v1/me/:

superset auth status --hostname <superset-host>

Install the Skill

The recipe enables the bundled Agent Skill (skill.bundle in cli.yaml):

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

Agent workflow

superset commands schema --json
superset commands --json
superset search "list dashboards" --json
superset commands show superset dashboards get-api-v1dashboard --json

Search results are discovery only. Inspect command details before execution.

Source inputs

The recipe pins the Superset OpenAPI spec from:

https://github.com/apache/superset.git   docs/static/resources/openapi.json

Bump pinned_tag in specs/sources.yaml when upgrading the Superset API version.