ycli datalens¶

Yandex DataLens: workbooks, connections, datasets, charts, dashboards.

Usage:

$ ycli datalens [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• auth: Check that the token works for datalens.
• tenant: The DataLens instance.
• collections: DataLens collections.
• workbooks: DataLens workbooks.
• entrylocks: Locks on DataLens entries.
• sparkclusters: Spark clusters of DataLens (an...
• htmlpages: DataLens HTML pages.
• members: DataLens members.
• entries: DataLens entries.
• permissions: DataLens permissions.
• connections: DataLens connections.
• datasets: DataLens datasets.
• charts: DataLens charts.
• dashboards: DataLens dashboards.
• reports: DataLens reports.
• workbookexports: Exports of a DataLens workbook.
• workbookimports: Imports of a DataLens workbook.
• embeds: DataLens embeds.
• embeddingsecrets: DataLens keys for embedding.
• sharedentries: DataLens shared entries: connections and...
• audit: DataLens audit.
• sqlqueries: DataLens saved SQL queries (experimental...
• licensing: Licences (seats) of the DataLens instance.
• cloudenvironments: DataLens cloud environments (experimental...
• cloudenvironmentstorage: The storage bucket of a DataLens cloud...
• restcatalogs: DataLens REST catalogs (experimental in...
• lakehouseoperations: DataLens Lakehouse operations...
• trinoclusters: DataLens Trino clusters (experimental in...
• sparkapplications: DataLens Spark applications (experimental...

ycli datalens auth¶

Check that the token works for datalens.

Usage:

$ ycli datalens auth [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• status: Probe datalens with its own read; exit 1...

ycli datalens auth status¶

Probe datalens with its own read; exit 1 when the token is rejected.

Usage:

$ ycli datalens auth status [OPTIONS]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens tenant¶

The DataLens instance.

Usage:

$ ycli datalens tenant [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• details-get: Print the DataLens instance the...

ycli datalens tenant details-get¶

Print the DataLens instance the credentials reach (a safe auth probe).

Usage:

$ ycli datalens tenant details-get [OPTIONS]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens collections¶

DataLens collections.

Usage:

$ ycli datalens collections [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print one collection.
• list-by-ids: Print the collections with these ids.
• content-list: List what a collection holds: collections,...
• breadcrumbs-list: List the collections from the root down to...
• permissions-get-root: Print what you may create in the root.
• access-bindings-list: List who has which role on a collection...
• create: Create a collection in --parent-id, or in...
• update: Change a collection's title or description.
• move: Move a collection into --parent-id, or...
• move-bulk: Move several collections into --parent-id,...
• delete: Delete a collection with everything it holds.
• delete-bulk: Delete several collections with everything...
• access-bindings-update: Give or take away roles on a collection;...

ycli datalens collections get¶

Print one collection.

Usage:

$ ycli datalens collections get [OPTIONS] COLLECTION_ID

Arguments:

• COLLECTION_ID: Collection id. [required]

Options:

• --include-permissions-info / --no-include-permissions-info: Also say what you may do with it.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens collections list-by-ids¶

Print the collections with these ids.

Usage:

$ ycli datalens collections list-by-ids [OPTIONS] COLLECTION_ID...

Arguments:

• COLLECTION_ID...: Collection ids. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens collections content-list¶

List what a collection holds: collections, workbooks and entries (auto-paginated).

Usage:

$ ycli datalens collections content-list [OPTIONS] [COLLECTION_ID]

Arguments:

• [COLLECTION_ID]: Collection id; the root when left out.

Options:

• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• --filter-string TEXT: Keep the items whose title has this.
• --order-field TEXT: What to sort by. Known values: title, createdAt, updatedAt.
• --order-direction TEXT: Sort direction. Known values: asc, desc.
• --only-my / --no-only-my: Keep only what you created.
• --mode TEXT: Which kinds of items to list. Known values: all, onlyCollections, onlyWorkbooks, onlyEntries.
• --include-permissions-info / --no-include-permissions-info: Also say what you may do with it.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens collections breadcrumbs-list¶

List the collections from the root down to this one.

Usage:

$ ycli datalens collections breadcrumbs-list [OPTIONS] COLLECTION_ID

Arguments:

• COLLECTION_ID: Collection id. [required]

Options:

• --include-permissions-info / --no-include-permissions-info: Also say what you may do with it.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens collections permissions-get-root¶

Print what you may create in the root.

Usage:

$ ycli datalens collections permissions-get-root [OPTIONS]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens collections access-bindings-list¶

List who has which role on a collection (auto-paginated).

Usage:

$ ycli datalens collections access-bindings-list [OPTIONS] COLLECTION_ID

Arguments:

• COLLECTION_ID: Collection id. [required]

Options:

• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• --get-inherited-bindings / --no-get-inherited-bindings: Also list the inherited roles.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens collections create¶

Create a collection in --parent-id, or in the root.

Usage:

$ ycli datalens collections create [OPTIONS]

Options:

• --title TEXT: Title of the collection. [required]
• --parent-id TEXT: The collection to put it in; the root when left out.
• --description TEXT: Description of the collection.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens collections update¶

Change a collection's title or description.

Usage:

$ ycli datalens collections update [OPTIONS] COLLECTION_ID

Arguments:

• COLLECTION_ID: Collection id. [required]

Options:

• --title TEXT: New title.
• --description TEXT: New description.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens collections move¶

Move a collection into --parent-id, or into the root.

Usage:

$ ycli datalens collections move [OPTIONS] COLLECTION_ID

Arguments:

• COLLECTION_ID: Collection id. [required]

Options:

• --parent-id TEXT: The collection to put it in; the root when left out.
• --title TEXT: New title to give it on the way.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens collections move-bulk¶

Move several collections into --parent-id, or into the root.

Usage:

$ ycli datalens collections move-bulk [OPTIONS] COLLECTION_ID...

Arguments:

• COLLECTION_ID...: Collection ids. [required]

Options:

• --parent-id TEXT: The collection to put it in; the root when left out.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens collections delete¶

Delete a collection with everything it holds.

Usage:

$ ycli datalens collections delete [OPTIONS] COLLECTION_ID

Arguments:

• COLLECTION_ID: Collection id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens collections delete-bulk¶

Delete several collections with everything they hold.

Usage:

$ ycli datalens collections delete-bulk [OPTIONS] COLLECTION_ID...

Arguments:

• COLLECTION_ID...: Collection ids. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens collections access-bindings-update¶

Give or take away roles on a collection; the roles not named stay as they are.

Grants access: asks before it is sent (--yes to skip).

Usage:

$ ycli datalens collections access-bindings-update [OPTIONS] COLLECTION_ID

Arguments:

• COLLECTION_ID: Collection id. [required]

Options:

• --delta TEXT: A role to add or remove, as a JSON object of the API docs: {"action": "ADD", "accessBinding": {"roleId": ..., "subject": {"id": ..., "type": ...}}} (repeatable). [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbooks¶

DataLens workbooks.

Usage:

$ ycli datalens workbooks [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print one workbook.
• list: List the workbooks of a collection...
• list-by-ids: Print the workbooks with these ids.
• access-bindings-list: List who has which role on a workbook...
• entries-list: List what a workbook holds: connections,...
• create: Create a workbook in --collection-id, or...
• update: Change a workbook's title or description.
• move: Move a workbook into --collection-id, or...
• move-bulk: Move several workbooks into...
• delete: Delete a workbook with everything it holds.
• delete-bulk: Delete several workbooks with everything...
• access-bindings-update: Give or take away roles on a workbook; the...

ycli datalens workbooks get¶

Print one workbook.

Usage:

$ ycli datalens workbooks get [OPTIONS] WORKBOOK_ID

Arguments:

• WORKBOOK_ID: Workbook id. [required]

Options:

• --include-permissions-info / --no-include-permissions-info: Also say what you may do with it.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbooks list¶

List the workbooks of a collection (auto-paginated).

Usage:

$ ycli datalens workbooks list [OPTIONS]

Options:

• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• --collection-id TEXT: Collection to list; the root when left out.
• --filter-string TEXT: Keep the titles that have this.
• --order-field TEXT: What to sort by. Known values: title, createdAt, updatedAt.
• --order-direction TEXT: Sort direction. Known values: asc, desc.
• --only-my / --no-only-my: Keep only what you created.
• --include-permissions-info / --no-include-permissions-info: Also say what you may do with it.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbooks list-by-ids¶

Print the workbooks with these ids.

Usage:

$ ycli datalens workbooks list-by-ids [OPTIONS] WORKBOOK_ID...

Arguments:

• WORKBOOK_ID...: Workbook ids. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbooks access-bindings-list¶

List who has which role on a workbook (auto-paginated).

Usage:

$ ycli datalens workbooks access-bindings-list [OPTIONS] WORKBOOK_ID

Arguments:

• WORKBOOK_ID: Workbook id. [required]

Options:

• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• --get-inherited-bindings / --no-get-inherited-bindings: Also list the inherited roles.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbooks entries-list¶

List what a workbook holds: connections, datasets, charts, dashboards (auto-paginated).

Usage:

$ ycli datalens workbooks entries-list [OPTIONS] WORKBOOK_ID

Arguments:

• WORKBOOK_ID: Workbook id. [required]

Options:

• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• --include-permissions-info / --no-include-permissions-info: Also say what you may do with it.
• --only-my / --no-only-my: Keep only what you created.
• --created-by TEXT: Keep only what this user created.
• --scope TEXT: Keep only this kind of entry (repeatable). Known values: dash, report, widget, dataset, folder, connection, compute, artifact, sql_query.
• --order-by TEXT: What to sort by, as a JSON object: {"field": "name", "direction": "asc"}.
• --filters TEXT: A filter, as a JSON object: {"name": "sales"}.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbooks create¶

Create a workbook in --collection-id, or in the root.

Usage:

$ ycli datalens workbooks create [OPTIONS]

Options:

• --title TEXT: Title of the workbook. [required]
• --collection-id TEXT: The collection to put it in; the root when left out.
• --description TEXT: Description of the workbook.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbooks update¶

Change a workbook's title or description.

Usage:

$ ycli datalens workbooks update [OPTIONS] WORKBOOK_ID

Arguments:

• WORKBOOK_ID: Workbook id. [required]

Options:

• --title TEXT: New title.
• --description TEXT: New description.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbooks move¶

Move a workbook into --collection-id, or into the root.

Usage:

$ ycli datalens workbooks move [OPTIONS] WORKBOOK_ID

Arguments:

• WORKBOOK_ID: Workbook id. [required]

Options:

• --collection-id TEXT: The collection to put it in; the root when left out.
• --title TEXT: New title to give it on the way.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbooks move-bulk¶

Move several workbooks into --collection-id, or into the root.

Usage:

$ ycli datalens workbooks move-bulk [OPTIONS] WORKBOOK_ID...

Arguments:

• WORKBOOK_ID...: Workbook ids. [required]

Options:

• --collection-id TEXT: The collection to put it in; the root when left out.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbooks delete¶

Delete a workbook with everything it holds.

Usage:

$ ycli datalens workbooks delete [OPTIONS] WORKBOOK_ID

Arguments:

• WORKBOOK_ID: Workbook id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbooks delete-bulk¶

Delete several workbooks with everything they hold.

Usage:

$ ycli datalens workbooks delete-bulk [OPTIONS] WORKBOOK_ID...

Arguments:

• WORKBOOK_ID...: Workbook ids. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbooks access-bindings-update¶

Give or take away roles on a workbook; the roles not named stay as they are.

Grants access: asks before it is sent (--yes to skip).

Usage:

$ ycli datalens workbooks access-bindings-update [OPTIONS] WORKBOOK_ID

Arguments:

• WORKBOOK_ID: Workbook id. [required]

Options:

• --delta TEXT: A role to add or remove, as a JSON object of the API docs: {"action": "ADD", "accessBinding": {"roleId": ..., "subject": {"id": ..., "type": ...}}} (repeatable). [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens entrylocks¶

Locks on DataLens entries.

Usage:

$ ycli datalens entrylocks [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• create: Lock an entry for editing; keep the token...
• extend: Hold a lock longer.
• delete: Release a lock; an entry that is not...

ycli datalens entrylocks create¶

Lock an entry for editing; keep the token the reply holds, releasing the lock takes it.

--data is required; -F adds a field it does not name (-F 'data[force]=true'). An entry that is already locked answers 423 with who holds the lock and until when.

Usage:

$ ycli datalens entrylocks create [OPTIONS] ENTRY_ID

Arguments:

• ENTRY_ID: Entry id. [required]

Options:

• --data TEXT: The terms of the lock, as a JSON object: {"duration": 300000, "force": false} (the duration in milliseconds). [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens entrylocks extend¶

Hold a lock longer.

Usage:

$ ycli datalens entrylocks extend [OPTIONS] ENTRY_ID

Arguments:

• ENTRY_ID: Entry id. [required]

Options:

• --data TEXT: The lock and its new terms, as a JSON object: {"lockToken": "...", "duration": 600000}. [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens entrylocks delete¶

Release a lock; an entry that is not locked answers 404.

Usage:

$ ycli datalens entrylocks delete [OPTIONS] ENTRY_ID

Arguments:

• ENTRY_ID: Entry id. [required]

Options:

• --params TEXT: Which lock to release, as a JSON object: {"lockToken": "..."}, or {"force": true} for a lock held by another. [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens sparkclusters¶

Spark clusters of DataLens (an experimental API; not measured, a cluster is paid for).

Usage:

$ ycli datalens sparkclusters [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List the Spark clusters (auto-paginated).
• get: Print one Spark cluster: its settings,...
• create: Create a Spark cluster, which is paid for...
• delete: Delete a Spark cluster; prints the...
• start: Start a stopped Spark cluster, which is...
• stop: Stop a running Spark cluster; prints the...
• resource-presets-list: List the sizes an instance of a Spark...
• resource-presets-get: Print one resource preset: its cores and...

ycli datalens sparkclusters list¶

List the Spark clusters (auto-paginated).

Usage:

$ ycli datalens sparkclusters list [OPTIONS]

Options:

• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• --collection-id TEXT: Keep the clusters of one collection.
• --filter TEXT: A filter expression of the API (repeatable).
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens sparkclusters get¶

Print one Spark cluster: its settings, health and status.

Usage:

$ ycli datalens sparkclusters get [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Spark cluster id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens sparkclusters create¶

Create a Spark cluster, which is paid for while it runs; prints the operation.

The collection, the cloud environment, the name and config are required, from the flags or --body-file. lakehouseoperations get <operation_id> says how the operation ended.

Usage:

$ ycli datalens sparkclusters create [OPTIONS]

Options:

• --collection-id TEXT: The collection to create it in.
• --cloud-environment-id TEXT: The cloud environment the cluster runs in.
• --name TEXT: The cluster's name.
• --config TEXT: The Spark version and the pools of the driver and executors, as a JSON object; --body-file gives it under config.
• --description TEXT: A description of the cluster.
• --labels TEXT: Labels, as a JSON object: {"team": "bi"}.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens sparkclusters delete¶

Delete a Spark cluster; prints the operation that deletes it.

Usage:

$ ycli datalens sparkclusters delete [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Spark cluster id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens sparkclusters start¶

Start a stopped Spark cluster, which is paid for while it runs; prints the operation.

Usage:

$ ycli datalens sparkclusters start [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Spark cluster id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens sparkclusters stop¶

Stop a running Spark cluster; prints the operation.

Usage:

$ ycli datalens sparkclusters stop [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Spark cluster id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens sparkclusters resource-presets-list¶

List the sizes an instance of a Spark cluster can take (auto-paginated).

Usage:

$ ycli datalens sparkclusters resource-presets-list [OPTIONS]

Options:

• --cloud-environment-id TEXT: The cloud environment the presets are for. [required]
• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens sparkclusters resource-presets-get¶

Print one resource preset: its cores and its memory.

Usage:

$ ycli datalens sparkclusters resource-presets-get [OPTIONS] RESOURCE_PRESET_ID

Arguments:

• RESOURCE_PRESET_ID: Resource preset id. [required]

Options:

• --cloud-environment-id TEXT: The cloud environment the presets are for. [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens htmlpages¶

DataLens HTML pages.

Usage:

$ ycli datalens htmlpages [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print one HTML page: where it lies and its...
• create: Create an HTML page; content is...
• update: Save new HTML (--content), or make a...
• delete: Delete an HTML page.
• preview-url-get: Print a temporary signed link that shows...

ycli datalens htmlpages get¶

Print one HTML page: where it lies and its revisions (its HTML is not in the reply).

Usage:

$ ycli datalens htmlpages get [OPTIONS] ENTRY_ID

Arguments:

• ENTRY_ID: Entry id. [required]

Options:

• --rev-id TEXT: One revision, as it is; give it or --branch, not both.
• --branch TEXT: The version to read when no revision is named: saved or published. Known values: saved, published.
• --include-permissions / --no-include-permissions: Also say what you may do with the page.
• --include-favorite / --no-include-favorite: Also say whether the page is a favourite.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens htmlpages create¶

Create an HTML page; content is required, from --content or --body-file.

Creating publishes: the new page is saved and published at once. A draft comes with the first update --mode save.

Usage:

$ ycli datalens htmlpages create [OPTIONS]

Options:

• --content TEXT: The HTML of the page; --body-file gives it under content.
• --annotation TEXT: A description of the page, as JSON: {"description": "…"}.
• --key TEXT: The page's key, in a folder.
• --workbook-id TEXT: The workbook to create the page in.
• --name TEXT: The page's name.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens htmlpages update¶

Save new HTML (--content), or make a revision the current one (--rev-id with --mode).

Give one of the two, not both. With --rev-id, --mode publish shows that revision to everyone and --mode save copies it as the current draft.

Usage:

$ ycli datalens htmlpages update [OPTIONS] ENTRY_ID

Arguments:

• ENTRY_ID: Entry id. [required]

Options:

• --mode TEXT: Keep it as a draft, or show it to everyone. Known values: save, publish.
• --content TEXT: The HTML of the page; --body-file gives it under content.
• --rev-id TEXT: A revision to make current, in place of new content.
• --annotation TEXT: A description of the page, as JSON: {"description": "…"}.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens htmlpages delete¶

Delete an HTML page.

Usage:

$ ycli datalens htmlpages delete [OPTIONS] ENTRY_ID

Arguments:

• ENTRY_ID: Entry id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens htmlpages preview-url-get¶

Print a temporary signed link that shows the page.

Usage:

$ ycli datalens htmlpages preview-url-get [OPTIONS] ENTRY_ID

Arguments:

• ENTRY_ID: Entry id. [required]

Options:

• --branch TEXT: The version to read when no revision is named: saved or published. Known values: saved, published.
• --rev-id TEXT: One revision, as it is; give it or --branch, not both.
• --lang TEXT: Language of the preview. Known values: en, ru.
• --theme TEXT: Theme of the preview. Known values: light, dark, light-hc, dark-hc, system.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens members¶

DataLens members.

Usage:

$ ycli datalens members [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List the users, groups and service...

ycli datalens members list¶

List the users, groups and service accounts a role can be given to (auto-paginated).

Usage:

$ ycli datalens members list [OPTIONS]

Options:

• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• --language TEXT: Language of the names. Known values: en, ru.
• --search TEXT: Keep the names or addresses that have this.
• --tab-id TEXT: Keep one kind of subject. Known values: SUBJECT_TYPE_UNSPECIFIED, USER_ACCOUNT, GROUP, INVITEE, SERVICE_ACCOUNT, _system.
• --filter TEXT: A filter expression of the API.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens entries¶

DataLens entries.

Usage:

$ ycli datalens entries [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: Find entries across the organization...
• relations-list: List what entries use, or what uses them...
• permissions-get: Print what you may do with each entry; a...
• revisions-list: List the revisions of an entry...
• rename: Give an entry another name.

ycli datalens entries list¶

Find entries across the organization (auto-paginated); give --scope, --scopes or --id.

Usage:

$ ycli datalens entries list [OPTIONS]

Options:

• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• --id TEXT: Keep the entry with this id (repeatable).
• --scope TEXT: Keep one kind of entry. Known values: dash, report, widget, dataset, folder, connection, compute, artifact, sql_query.
• --scopes TEXT: Keep this kind of entry (repeatable). Known values: dash, report, widget, dataset, folder, connection, compute, artifact, sql_query.
• --type TEXT: Keep this type of entry (repeatable).
• --created-by TEXT: Keep what this user created (repeatable).
• --order-by TEXT: What to sort by, as a JSON object: {"field": "name", "direction": "asc"}.
• --exclude-locked / --no-exclude-locked: Leave out what you may not read.
• --include-links / --no-include-links: Also say what each is linked to.
• --filters TEXT: A filter, as a JSON object: {"name": "sales"}.
• --include-permissions-info / --no-include-permissions-info: Also say what you may do with it.
• --ignore-workbook-entries / --no-ignore-workbook-entries: Leave out the entries of workbooks.
• --ignore-shared-entries / --no-ignore-shared-entries: Leave out the shared entries.
• --include-data / --no-include-data: Also give the content of each.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens entries relations-list¶

List what entries use, or what uses them (auto-paginated).

Usage:

$ ycli datalens entries relations-list [OPTIONS] ENTRY_ID...

Arguments:

• ENTRY_ID...: Entry ids. [required]

Options:

• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• --link-direction TEXT: from: what they use; to: what uses them.
• --include-permissions-info / --no-include-permissions-info: Also say what you may do with it.
• --scope TEXT: Keep one kind of related entry. Known values: dash, report, widget, dataset, folder, connection, compute, artifact, sql_query.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens entries permissions-get¶

Print what you may do with each entry; a missing one answers error: NOT_FOUND.

Usage:

$ ycli datalens entries permissions-get [OPTIONS] ENTRY_ID...

Arguments:

• ENTRY_ID...: Entry ids. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens entries revisions-list¶

List the revisions of an entry (auto-paginated).

Usage:

$ ycli datalens entries revisions-list [OPTIONS] ENTRY_ID

Arguments:

• ENTRY_ID: Entry id. [required]

Options:

• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• --rev-id TEXT: Keep this revision (repeatable).
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens entries rename¶

Give an entry another name.

Usage:

$ ycli datalens entries rename [OPTIONS] ENTRY_ID

Arguments:

• ENTRY_ID: Entry id. [required]

Options:

• --name TEXT: The new name. [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens permissions¶

DataLens permissions.

Usage:

$ ycli datalens permissions [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get-bulk: Print what you may do with many entries,...

ycli datalens permissions get-bulk¶

Print what you may do with many entries, workbooks and collections at once.

An object that does not exist answers error: NOT_FOUND under its id.

Usage:

$ ycli datalens permissions get-bulk [OPTIONS]

Options:

• --entry-id TEXT: An entry id (repeatable).
• --workbook-id TEXT: A workbook id (repeatable).
• --collection-id TEXT: A collection id (repeatable).
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens connections¶

DataLens connections.

Usage:

$ ycli datalens connections [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print one connection; its kind comes in...
• create: Create a connection from --body-file (JSON...
• update: Change the fields given of a connection;...
• delete: Delete a connection; the datasets on it...

ycli datalens connections get¶

Print one connection; its kind comes in db_type, its password or token never.

Usage:

$ ycli datalens connections get [OPTIONS] CONNECTION_ID

Arguments:

• CONNECTION_ID: Connection id. [required]

Options:

• --workbook-id TEXT: The workbook the connection lies in.
• --binded-dataset-id TEXT: A dataset bound to it, to read it through.
• --rev-id TEXT: The revision to read; the current by default.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens connections create¶

Create a connection from --body-file (JSON or YAML) and -F over it.

The body is the connection itself: type says which kind it is and which fields it takes (ycli datalens connections create --body-file conn.yaml --dry-run shows what would go).

Usage:

$ ycli datalens connections create [OPTIONS]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Give a password or a token from a file outside the repository, mode 600: in --body-file, or as one field with -F password=@FILE. Typed on a command line it stays in the shell history. Write the file of one field with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret. --dry-run prints a secret as ***.

ycli datalens connections update¶

Change the fields given of a connection; the others stay as they are.

Usage:

$ ycli datalens connections update [OPTIONS] CONNECTION_ID

Arguments:

• CONNECTION_ID: Connection id. [required]

Options:

• --data TEXT: The fields to change, as a JSON object: {"host": "db2.example.net"}. --body-file and -F give them under data (-F 'data[port]=8443').
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Give a password or a token from a file outside the repository, mode 600: in --body-file, or as one field with -F password=@FILE. Typed on a command line it stays in the shell history. Write the file of one field with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret. --dry-run prints a secret as ***.

ycli datalens connections delete¶

Delete a connection; the datasets on it lose their source.

The API has no way to bring it back, and a chart that reads through it keeps naming its id (measured).

The interface lists what was deleted under Service settings, Deleted objects, with a Restore button (measured: the entry appears there; restoring was not tried).

Usage:

$ ycli datalens connections delete [OPTIONS] CONNECTION_ID

Arguments:

• CONNECTION_ID: Connection id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens datasets¶

DataLens datasets.

Usage:

$ ycli datalens datasets [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print one dataset: its sources, their...
• create: Create a dataset; with no source and no...
• update: Save a dataset as given: read it, change...
• delete: Delete a dataset; the charts built on it...
• validate: Check a dataset, or changes to it, without...
• data-get: Print rows of a dataset: the columns asked...

ycli datalens datasets get¶

Print one dataset: its sources, their joins and its fields with their guids.

Usage:

$ ycli datalens datasets get [OPTIONS] DATASET_ID

Arguments:

• DATASET_ID: Dataset id. [required]

Options:

• --workbook-id TEXT: The workbook the dataset lies in.
• --rev-id TEXT: The revision to read; the current by default.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens datasets create¶

Create a dataset; with no source and no field it is empty, to be filled by update.

Usage:

$ ycli datalens datasets create [OPTIONS]

Options:

• --dataset TEXT: What the dataset holds, as a JSON object; --body-file gives it under dataset. An empty one is valid: {"sources": [], "result_schema": []}.
• --collection-id TEXT: The collection to create it in.
• --created-via TEXT: How it is created: user or workbook_copy.
• --dir-path TEXT: The folder to create it in (old placement model).
• --name TEXT: The dataset's name.
• --options TEXT: What the editor may do with it, as a JSON object.
• --preview / --no-preview: Whether it is a preview.
• --published-id TEXT: The published revision.
• --rev-id TEXT: The revision.
• --saved-id TEXT: The saved revision.
• --workbook-id TEXT: The workbook to create it in.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens datasets update¶

Save a dataset as given: read it, change what it holds, send it back whole.

The reply holds the content and the revisions; its id is null (measured).

Usage:

$ ycli datalens datasets update [OPTIONS] DATASET_ID

Arguments:

• DATASET_ID: Dataset id. [required]

Options:

• --data TEXT: What to save, as a JSON object: {"dataset": {...}, "mode": "save"}. --body-file gives it under data.
• --workbook-id TEXT: The workbook the dataset lies in.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens datasets delete¶

Delete a dataset; the charts built on it lose their data.

The API has no way to bring it back, and a chart built on it keeps naming its id (measured).

The interface lists what was deleted under Service settings, Deleted objects, with a Restore button (measured: the entry appears there; restoring was not tried).

Usage:

$ ycli datalens datasets delete [OPTIONS] DATASET_ID

Arguments:

• DATASET_ID: Dataset id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens datasets validate¶

Check a dataset, or changes to it, without saving anything.

Usage:

$ ycli datalens datasets validate [OPTIONS] DATASET_ID

Arguments:

• DATASET_ID: Dataset id. [required]

Options:

• --workbook-id TEXT: The workbook the dataset lies in.
• --binded-dataset-id TEXT: A dataset bound to this one.
• --data TEXT: What to check, as a JSON object: {"dataset": {...}, "updates": [...]}. --body-file gives it under data.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens datasets data-get¶

Print rows of a dataset: the columns asked for, one page per call.

Usage:

$ ycli datalens datasets data-get [OPTIONS] DATASET_ID

Arguments:

• DATASET_ID: Dataset id. [required]

Options:

• --columns TEXT: The guid of a field to return, as get lists them (repeatable). [required]
• --workbook-id TEXT: The workbook the dataset lies in.
• --filters TEXT: A filter, as a JSON object: {"guid": "...", "operation": "eq", "values": ["x"]} (repeatable).
• --params TEXT: A value of a parameter, as a JSON object: {"guid": "...", "value": 1} (repeatable).
• --sort TEXT: A sorting rule, as a JSON object: {"guid": "...", "direction": "asc"} (repeatable).
• --limit INTEGER: The most rows to return; 100 by default.
• --offset INTEGER: How many rows to skip; above zero it needs --sort.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens charts¶

DataLens charts.

Usage:

$ ycli datalens charts [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• data-get: Print the data a saved chart shows, as...
• wizard: Charts built in the wizard.
• ql: QL charts.
• editor: Charts written in the editor.

ycli datalens charts data-get¶

Print the data a saved chart shows, as tables; a pivot table is not supported.

A chart of the editor with no source did not answer within the client's wait: the command ends with a timeout after about two minutes (measured, twice).

Usage:

$ ycli datalens charts data-get [OPTIONS] CHART_ID

Arguments:

• CHART_ID: Chart id. [required]

Options:

• --params TEXT: Values for the chart's parameters, as a JSON object: {"year": "2026", "city": ["Moscow", "Kazan"]}.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens charts wizard¶

Charts built in the wizard.

Usage:

$ ycli datalens charts wizard [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print one chart of the wizard: its...
• create: Create a chart of the wizard.
• update: Save a chart of the wizard as given: read...
• delete: Delete a chart of the wizard; dashboards...

ycli datalens charts wizard get¶

Print one chart of the wizard: its datasets and what it shows.

Usage:

$ ycli datalens charts wizard get [OPTIONS] CHART_ID

Arguments:

• CHART_ID: Chart id. [required]

Options:

• --workbook-id TEXT: The workbook the chart lies in.
• --rev-id TEXT: One revision to read, as it is; give it or --branch, not both.
• --include-permissions / --no-include-permissions: Also say what you may do with it.
• --include-links / --no-include-links: Also say what it is linked to.
• --include-favorite / --no-include-favorite: Also say whether it is a favourite.
• --branch TEXT: The version to read when no revision is named: saved or published. A save writes the saved one: read saved before you change a chart. Known values: saved, published.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens charts wizard create¶

Create a chart of the wizard.

--body-file (and -F) give the request itself: data, workbookId, name; a flag lies over them. data is required: the entry.data of a chart read with get.

Usage:

$ ycli datalens charts wizard create [OPTIONS]

Options:

• --data TEXT: What the chart holds, as a JSON object (the entry.data of a chart read with get); --body-file gives it under data.
• --annotation TEXT: A description, as a JSON object: {"description": "…"}.
• --key TEXT: The entry's key, in a folder.
• --workbook-id TEXT: The workbook to create it in.
• --name TEXT: The chart's name.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens charts wizard update¶

Save a chart of the wizard as given: read it, change it, send it back whole.

DataLens does not check a revision here: a save overwrites what was saved since you read it (measured).

data is required, from --data or under data of --body-file.

Usage:

$ ycli datalens charts wizard update [OPTIONS] CHART_ID

Arguments:

• CHART_ID: Chart id. [required]

Options:

• --mode TEXT: Keep the change as a draft, or publish it. Known values: save, publish. [required]
• --data TEXT: What the chart holds, as a JSON object; --body-file gives it under data.
• --annotation TEXT: A description, as a JSON object: {"description": "…"}.
• --rev-id TEXT: The revision the change is made on; DataLens does not check it (measured).
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens charts wizard delete¶

Delete a chart of the wizard; dashboards that show it lose it.

The API has no way to bring it back, and a dashboard that shows it keeps naming its id (measured).

The interface lists what was deleted under Service settings, Deleted objects, with a Restore button (measured: the entry appears there; restoring was not tried).

Usage:

$ ycli datalens charts wizard delete [OPTIONS] CHART_ID

Arguments:

• CHART_ID: Chart id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens charts ql¶

QL charts.

Usage:

$ ycli datalens charts ql [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print one QL chart: its keys come flat,...
• create: Create a QL chart; --body-file and -F give...
• update: Save a QL chart as given; data is...
• delete: Delete a QL chart; dashboards that show it...

ycli datalens charts ql get¶

Print one QL chart: its keys come flat, with no entry around them.

Usage:

$ ycli datalens charts ql get [OPTIONS] CHART_ID

Arguments:

• CHART_ID: Chart id. [required]

Options:

• --workbook-id TEXT: The workbook the chart lies in.
• --rev-id TEXT: One revision to read, as it is; give it or --branch, not both.
• --include-permissions / --no-include-permissions: Also say what you may do with it.
• --include-links / --no-include-links: Also say what it is linked to.
• --include-favorite / --no-include-favorite: Also say whether it is a favourite.
• --branch TEXT: The version to read when no revision is named: saved or published. A save writes the saved one: read saved before you change a chart. Known values: saved, published.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens charts ql create¶

Create a QL chart; --body-file and -F give the request itself, data is required.

Usage:

$ ycli datalens charts ql create [OPTIONS]

Options:

• --template TEXT: The template of the chart; the API takes only ql today. [required]
• --data TEXT: What the chart holds, as a JSON object (its query and how it is shown); --body-file gives it under data.
• --annotation TEXT: A description, as a JSON object: {"description": "…"}.
• --key TEXT: The entry's key, in a folder.
• --workbook-id TEXT: The workbook to create it in.
• --name TEXT: The chart's name.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens charts ql update¶

Save a QL chart as given; data is required, from --data or --body-file.

DataLens does not check a revision here: a save overwrites what was saved since you read it (measured).

Usage:

$ ycli datalens charts ql update [OPTIONS] ENTRY_ID

Arguments:

• ENTRY_ID: Chart id. [required]

Options:

• --template TEXT: The template of the chart; the API takes only ql today. [required]
• --mode TEXT: Keep the change as a draft, or publish it. Known values: save, publish. [required]
• --data TEXT: What the chart holds, as a JSON object (its query and how it is shown); --body-file gives it under data.
• --annotation TEXT: A description, as a JSON object: {"description": "…"}.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens charts ql delete¶

Delete a QL chart; dashboards that show it lose it.

Usage:

$ ycli datalens charts ql delete [OPTIONS] CHART_ID

Arguments:

• CHART_ID: Chart id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens charts editor¶

Charts written in the editor.

Usage:

$ ycli datalens charts editor [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print one chart of the editor: its kind...
• create: Create a chart of the editor from --entry...
• update: Save a chart of the editor as given;...
• delete: Delete a chart of the editor; dashboards...

ycli datalens charts editor get¶

Print one chart of the editor: its kind and its code.

Usage:

$ ycli datalens charts editor get [OPTIONS] CHART_ID

Arguments:

• CHART_ID: Chart id. [required]

Options:

• --workbook-id TEXT: The workbook the chart lies in.
• --rev-id TEXT: One revision to read, as it is; give it or --branch, not both.
• --include-permissions / --no-include-permissions: Also say what you may do with it.
• --include-links / --no-include-links: Also say what it is linked to.
• --include-favorite / --no-include-favorite: Also say whether it is a favourite.
• --branch TEXT: The version to read when no revision is named: saved or published. A save writes the saved one: read saved before you change a chart. Known values: saved, published.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens charts editor create¶

Create a chart of the editor from --entry or --body-file.

Usage:

$ ycli datalens charts editor create [OPTIONS]

Options:

• --entry TEXT: The chart, as a JSON object; type says which kind it is. --body-file gives it under entry.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens charts editor update¶

Save a chart of the editor as given; entryId in the entry says which.

DataLens does not check a revision here: a save overwrites what was saved since you read it (measured).

Usage:

$ ycli datalens charts editor update [OPTIONS]

Options:

• --mode TEXT: Keep the change as a draft, or publish it. Known values: save, publish. [required]
• --entry TEXT: The chart, as a JSON object; type says which kind it is. --body-file gives it under entry.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens charts editor delete¶

Delete a chart of the editor; dashboards that show it lose it.

Usage:

$ ycli datalens charts editor delete [OPTIONS] CHART_ID

Arguments:

• CHART_ID: Chart id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens dashboards¶

DataLens dashboards.

Usage:

$ ycli datalens dashboards [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print one dashboard: its tabs and what...
• create: Create a dashboard from --entry or...
• update: Save a dashboard as given; entryId in...
• delete: Delete a dashboard.

ycli datalens dashboards get¶

Print one dashboard: its tabs and what stands on them.

A real dashboard is large (100 KB and more): redirect the output to a file to work with it.

Usage:

$ ycli datalens dashboards get [OPTIONS] DASHBOARD_ID

Arguments:

• DASHBOARD_ID: Dashboard id. [required]

Options:

• --rev-id TEXT: One revision to read, as it is; give it or --branch, not both.
• --include-permissions / --no-include-permissions: Also say what you may do with the dashboard.
• --include-links / --no-include-links: Also say what the dashboard is linked to.
• --include-favorite / --no-include-favorite: Also say whether the dashboard is a favourite.
• --branch TEXT: The version to read when no revision is named: saved or published. A save writes the saved one: read saved before you change a dashboard. Known values: saved, published.
• --workbook-id TEXT: The workbook the dashboard lies in.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens dashboards create¶

Create a dashboard from --entry or --body-file.

entry.meta must be an object, {} when empty: without it DataLens answers 400 entry.meta: expected record, received undefined.

Usage:

$ ycli datalens dashboards create [OPTIONS]

Options:

• --entry TEXT: The dashboard, as a JSON object; --body-file gives it under entry.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens dashboards update¶

Save a dashboard as given; entryId in the entry says which.

DataLens does not check a revision here: a save overwrites what was saved since you read it (measured).

Usage:

$ ycli datalens dashboards update [OPTIONS]

Options:

• --mode TEXT: Keep the dashboard as a draft, or publish it. Known values: save, publish. [required]
• --entry TEXT: The dashboard, as a JSON object; --body-file gives it under entry.
• --lock-token TEXT: The token of the lock held on it, when it is locked.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens dashboards delete¶

Delete a dashboard.

Usage:

$ ycli datalens dashboards delete [OPTIONS] DASHBOARD_ID

Arguments:

• DASHBOARD_ID: Dashboard id. [required]

Options:

• --lock-token TEXT: The token of the lock held on it, when it is locked.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens reports¶

DataLens reports.

Usage:

$ ycli datalens reports [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print one report: its slides and what...
• create: Create a report; the API keeps no layout...
• update: Save a report; it LOSES the layout of...
• delete: Delete a report.

ycli datalens reports get¶

Print one report: its slides and what stands on them.

A report has no branch in the API: the read answers the saved version (measured).

Usage:

$ ycli datalens reports get [OPTIONS] ENTRY_ID

Arguments:

• ENTRY_ID: Report id. [required]

Options:

• --rev-id TEXT: The revision of the report to read; the current one.
• --include-permissions / --no-include-permissions: Also say what you may do with the report.
• --include-favorite / --no-include-favorite: Also say whether the report is a favourite.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens reports create¶

Create a report; the API keeps no layout of slide elements and drops some settings.

Measured: a copy made from a report read with get loses where its elements stood. data (with at least one slide) and meta are required.

Usage:

$ ycli datalens reports create [OPTIONS]

Options:

• --data TEXT: What the report holds, as a JSON object (the entry.data of a report read with get); --body-file gives it under data.
• --meta TEXT: Metadata of the entry, as a JSON object or null; the API requires it.
• --annotation TEXT: A description of the report, as JSON: {"description": "…"}.
• --include-permissions / --no-include-permissions: Also say what you may do with the new report.
• --key TEXT: The report's key, in a folder.
• --workbook-id TEXT: The workbook to create the report in.
• --name TEXT: The report's name.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens reports update¶

Save a report; it LOSES the layout of its slide elements and some settings.

DataLens does not check a revision here: a save overwrites what was saved since you read it (measured).

Measured: DataLens drops them on a save through the API, without a word. Do not save a report that exists unless that loss is fine. Otherwise: read it, change it, send it back whole.

Usage:

$ ycli datalens reports update [OPTIONS] ENTRY_ID

Arguments:

• ENTRY_ID: Report id. [required]

Options:

• --mode TEXT: Keep the report as a draft, or publish it. Known values: save, publish. [required]
• --data TEXT: What the report holds, as a JSON object (the entry.data of a report read with get); --body-file gives it under data.
• --meta TEXT: Metadata of the entry, as a JSON object or null; the API requires it.
• --rev-id TEXT: The revision of the report to change; DataLens does not check it (measured).
• --annotation TEXT: A description of the report, as JSON: {"description": "…"}.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens reports delete¶

Delete a report.

Usage:

$ ycli datalens reports delete [OPTIONS] ENTRY_ID

Arguments:

• ENTRY_ID: Report id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbookexports¶

Exports of a DataLens workbook.

Usage:

$ ycli datalens workbookexports [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• start: Export a workbook (async): prints the...
• status-get: Print how far an export is: pending,...
• result-get: Print the exported workbook; its data is...
• cancel: Stop an export: its status becomes error,...

ycli datalens workbookexports start¶

Export a workbook (async): prints the export's final status, or with --no-wait its id.

workbookexports result-get EXPORT_ID then prints the exported workbook.

Usage:

$ ycli datalens workbookexports start [OPTIONS] WORKBOOK_ID

Arguments:

• WORKBOOK_ID: Workbook id. [required]

Options:

• --wait / --no-wait: Poll to a terminal status before printing. [default: wait]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbookexports status-get¶

Print how far an export is: pending, success or error, with its notifications.

Usage:

$ ycli datalens workbookexports status-get [OPTIONS] EXPORT_ID

Arguments:

• EXPORT_ID: Export id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbookexports result-get¶

Print the exported workbook; its data is what workbookimports start takes.

An export that is not over, or was cancelled, answers 409. The document is large: write it to a file. It holds no password or token of a connection.

Usage:

$ ycli datalens workbookexports result-get [OPTIONS] EXPORT_ID

Arguments:

• EXPORT_ID: Export id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbookexports cancel¶

Stop an export: its status becomes error, with WORKBOOK_EXPORT_CANCELLED.

An export that is over stays as it ended, and the command answers the same.

Usage:

$ ycli datalens workbookexports cancel [OPTIONS] EXPORT_ID

Arguments:

• EXPORT_ID: Export id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbookimports¶

Imports of a DataLens workbook.

Usage:

$ ycli datalens workbookimports [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• start: Make a workbook from an export (async):...
• status-get: Print how far an import is: pending,...

ycli datalens workbookimports start¶

Make a workbook from an export (async): prints the import's final status.

With --no-wait it prints the ids of the import and of the workbook at once. The connections of the new workbook come without their secrets: give them again with connections update.

ycli datalens workbookexports result-get EXPORT_ID | jq '{data}' > export.json writes the file --body-file takes here.

Usage:

$ ycli datalens workbookimports start [OPTIONS]

Options:

• --data TEXT: The data of an export's result, as a JSON object; --body-file gives it under data.
• --title TEXT: The title of the new workbook.
• --collection-id TEXT: The collection to make it in; the root if not.
• --description TEXT: The description of the new workbook.
• --wait / --no-wait: Poll to a terminal status before printing. [default: wait]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens workbookimports status-get¶

Print how far an import is: pending, success or error, with its notifications.

Usage:

$ ycli datalens workbookimports status-get [OPTIONS] IMPORT_ID

Arguments:

• IMPORT_ID: Import id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens embeds¶

DataLens embeds.

Usage:

$ ycli datalens embeds [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List the embeds of an entry.
• create: Embed an entry; the title, the key, the...
• update: Save an embed as given: the API takes it...
• delete: Delete an embed; its links stop working.

ycli datalens embeds list¶

List the embeds of an entry.

Usage:

$ ycli datalens embeds list [OPTIONS] ENTRY_ID

Arguments:

• ENTRY_ID: Entry id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens embeds create¶

Embed an entry; the title, the key, the entry, the mode and the settings are required.

Grants access: asks before it is sent (--yes to skip).

Usage:

$ ycli datalens embeds create [OPTIONS]

Options:

• --title TEXT: The name of the embed.
• --embedding-secret-id TEXT: The key for embedding that signs its links.
• --entry-id TEXT: The entry to embed.
• --public-params-mode / --no-public-params-mode: Whether the default mode of parameters is on.
• --settings TEXT: The settings, as a JSON object: {"enableExport": true}, or {}.
• --deps-ids TEXT: An entry the embedded one depends on (repeatable).
• --unsigned-params TEXT: A parameter a link may carry unsigned (repeatable).
• --private-params TEXT: A parameter that goes signed, in the token (repeatable).
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens embeds update¶

Save an embed as given: the API takes it whole, so name everything that is to stay.

Grants access: asks before it is sent (--yes to skip).

Usage:

$ ycli datalens embeds update [OPTIONS] EMBED_ID

Arguments:

• EMBED_ID: Embed id. [required]

Options:

• --title TEXT: The name of the embed.
• --embedding-secret-id TEXT: The key for embedding that signs its links.
• --public-params-mode / --no-public-params-mode: Whether the default mode of parameters is on.
• --settings TEXT: The settings, as a JSON object: {"enableExport": true}, or {}.
• --deps-ids TEXT: An entry the embedded one depends on (repeatable).
• --unsigned-params TEXT: A parameter a link may carry unsigned (repeatable).
• --private-params TEXT: A parameter that goes signed, in the token (repeatable).
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens embeds delete¶

Delete an embed; its links stop working.

Usage:

$ ycli datalens embeds delete [OPTIONS] EMBED_ID

Arguments:

• EMBED_ID: Embed id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens embeddingsecrets¶

DataLens keys for embedding.

Usage:

$ ycli datalens embeddingsecrets [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print one key for embedding: its name and...
• list: List the keys for embedding of a workbook,...
• create: Make a key for embedding; prints its id...
• delete: Delete a key for embedding.

ycli datalens embeddingsecrets get¶

Print one key for embedding: its name and workbook, never its private key.

Usage:

$ ycli datalens embeddingsecrets get [OPTIONS] EMBEDDING_SECRET_ID

Arguments:

• EMBEDDING_SECRET_ID: Id of the key for embedding. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens embeddingsecrets list¶

List the keys for embedding of a workbook, without their private keys.

Usage:

$ ycli datalens embeddingsecrets list [OPTIONS] WORKBOOK_ID

Arguments:

• WORKBOOK_ID: Workbook id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens embeddingsecrets create¶

Make a key for embedding; prints its id and its private key.

The private key is given once: get and list do not return it. Keep it at once, in a file nobody else reads: ycli -o json datalens embeddingsecrets create … > secret.json.

Grants access: asks before it is sent (--yes to skip).

Usage:

$ ycli datalens embeddingsecrets create [OPTIONS]

Options:

• --title TEXT: The name of the key. [required]
• --workbook-id TEXT: The workbook the key belongs to. [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens embeddingsecrets delete¶

Delete a key for embedding.

Usage:

$ ycli datalens embeddingsecrets delete [OPTIONS] EMBEDDING_SECRET_ID

Arguments:

• EMBEDDING_SECRET_ID: Id of the key for embedding. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens sharedentries¶

DataLens shared entries: connections and datasets that lie in a collection.

Usage:

$ ycli datalens sharedentries [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• access-bindings-list: List who has which role on a shared entry...
• access-bindings-update: Give or take away roles on a shared entry;...

ycli datalens sharedentries access-bindings-list¶

List who has which role on a shared entry (auto-paginated).

Usage:

$ ycli datalens sharedentries access-bindings-list [OPTIONS] ENTRY_ID

Arguments:

• ENTRY_ID: Entry id. [required]

Options:

• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• --get-inherited-bindings / --no-get-inherited-bindings: Also list the inherited roles.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens sharedentries access-bindings-update¶

Give or take away roles on a shared entry; the roles not named stay as they are.

Grants access: asks before it is sent (--yes to skip).

Usage:

$ ycli datalens sharedentries access-bindings-update [OPTIONS] ENTRY_ID

Arguments:

• ENTRY_ID: Entry id. [required]

Options:

• --delta TEXT: A role to add or remove, as a JSON object of the API docs: {"action": "ADD", "accessBinding": {"roleId": ..., "subject": {"id": ..., "type": ...}}} (repeatable). [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens audit¶

DataLens audit.

Usage:

$ ycli datalens audit [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• entries-updates-list: List the entries changed in a period,...
• entry-permissions-get: Print what one user may do with each...

ycli datalens audit entries-updates-list¶

List the entries changed in a period, deleted ones too (auto-paginated).

Usage:

$ ycli datalens audit entries-updates-list [OPTIONS]

Options:

• --from TEXT: The start of the period: an ISO-8601 time with its zone. [required]
• --to TEXT: The end of the period.
• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens audit entry-permissions-get¶

Print what one user may do with each entry: execute, read, edit, admin.

Usage:

$ ycli datalens audit entry-permissions-get [OPTIONS] ENTRY_ID...

Arguments:

• ENTRY_ID...: Entry ids. [required]

Options:

• --user-id TEXT: The user's id, as createdBy of an entry gives it. [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens sqlqueries¶

DataLens saved SQL queries (experimental in the API).

Usage:

$ ycli datalens sqlqueries [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print one saved SQL query: its text, its...
• create: Save a SQL query in a workbook.
• update: Save a SQL query anew; the connection and...
• delete: Delete a saved SQL query.
• run: Run a saved SQL query on its connection; a...

ycli datalens sqlqueries get¶

Print one saved SQL query: its text, its connection and its parameters.

Usage:

$ ycli datalens sqlqueries get [OPTIONS] SQL_QUERY_ID

Arguments:

• SQL_QUERY_ID: SQL query id. [required]

Options:

• --rev-id TEXT: The revision to read; the current if not.
• --include-permissions / --no-include-permissions: Also say what you may do with the query.
• --include-favorite / --no-include-favorite: Also say whether the query is a favourite.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API and written from its document: not measured. An organization whose SQL editor is off answers 403 SQL_EDITOR_NOT_ALLOWED.

ycli datalens sqlqueries create¶

Save a SQL query in a workbook.

The workbook, the name, the connection and the text are required.

Usage:

$ ycli datalens sqlqueries create [OPTIONS]

Options:

• --workbook-id TEXT: The workbook to keep it in.
• --name TEXT: The query's name in the workbook.
• --connection-id TEXT: The connection it runs over: PostgreSQL, ClickHouse, MySQL, Greenplum or Trino.
• --query TEXT: The text of the query.
• --description TEXT: A description.
• --params TEXT: The parameters the text takes, as a JSON array: [{"name": "since", "type": "date", "defaultValue": "2026-01-01"}].
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API and written from its document: not measured. An organization whose SQL editor is off answers 403 SQL_EDITOR_NOT_ALLOWED.

ycli datalens sqlqueries update¶

Save a SQL query anew; the connection and the text are required every time.

Usage:

$ ycli datalens sqlqueries update [OPTIONS] SQL_QUERY_ID

Arguments:

• SQL_QUERY_ID: SQL query id. [required]

Options:

• --connection-id TEXT: The connection it runs over: PostgreSQL, ClickHouse, MySQL, Greenplum or Trino.
• --query TEXT: The text of the query.
• --description TEXT: A description.
• --params TEXT: The parameters the text takes, as a JSON array: [{"name": "since", "type": "date", "defaultValue": "2026-01-01"}].
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API and written from its document: not measured. An organization whose SQL editor is off answers 403 SQL_EDITOR_NOT_ALLOWED.

ycli datalens sqlqueries delete¶

Delete a saved SQL query.

Usage:

$ ycli datalens sqlqueries delete [OPTIONS] SQL_QUERY_ID

Arguments:

• SQL_QUERY_ID: SQL query id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API and written from its document: not measured. An organization whose SQL editor is off answers 403 SQL_EDITOR_NOT_ALLOWED.

ycli datalens sqlqueries run¶

Run a saved SQL query on its connection; a text that changes data changes it.

Usage:

$ ycli datalens sqlqueries run [OPTIONS] SQL_QUERY_ID

Arguments:

• SQL_QUERY_ID: SQL query id. [required]

Options:

• --params TEXT: The values of the parameters, as a JSON object: {"since": "2026-10-01"}. A parameter left out takes its default.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API and written from its document: not measured. An organization whose SQL editor is off answers 403 SQL_EDITOR_NOT_ALLOWED.

ycli datalens licensing¶

Licences (seats) of the DataLens instance.

Usage:

$ ycli datalens licensing [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• licenses-list: List the licences of the instance: whose,...
• licenses-assign: Give each of these users a licence.
• limit-get: Print how many licences the instance may...
• limit-set: Set how many licences the instance may hold.

ycli datalens licensing licenses-list¶

List the licences of the instance: whose, of which type, active or not (auto-paginated).

Usage:

$ ycli datalens licensing licenses-list [OPTIONS]

Options:

• --user-ids TEXT: Only the licences of this user (repeatable).
• --status TEXT: Only licences in this state. Known values: active, expired, expiring.
• --sort-by TEXT: The field to sort by. Known values: createdAt, updatedAt.
• --order TEXT: The order of the sort. Known values: asc, desc.
• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens licensing licenses-assign¶

Give each of these users a licence.

Grants access: asks before it is sent (--yes to skip).

Usage:

$ ycli datalens licensing licenses-assign [OPTIONS] USER_ID...

Arguments:

• USER_ID...: User ids. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

A licence is a seat DataLens bills for. Written from the DataLens document and never called: not measured.

ycli datalens licensing limit-get¶

Print how many licences the instance may hold, now and next, and how many are active.

Usage:

$ ycli datalens licensing limit-get [OPTIONS]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens licensing limit-set¶

Set how many licences the instance may hold.

Usage:

$ ycli datalens licensing limit-set [OPTIONS] VALUE

Arguments:

• VALUE: The most licences the instance may hold. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

A licence is a seat DataLens bills for. Written from the DataLens document and never called: not measured.

ycli datalens cloudenvironments¶

DataLens cloud environments (experimental in the API).

Usage:

$ ycli datalens cloudenvironments [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List the cloud environments (auto-paginated).
• get: Print one cloud environment; an id nothing...
• create: Make a cloud environment; prints the...
• update: Change the fields given of a cloud...
• delete: Delete a cloud environment; prints the...

ycli datalens cloudenvironments list¶

List the cloud environments (auto-paginated).

Usage:

$ ycli datalens cloudenvironments list [OPTIONS]

Options:

• --filter TEXT: A condition, all must hold: status="READY", name="…", cloud_id="…", created_by_id="…" (repeatable).
• --include-permissions / --no-include-permissions: Also say what you may do with the environment.
• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens cloudenvironments get¶

Print one cloud environment; an id nothing knows answers 403, not 404.

Usage:

$ ycli datalens cloudenvironments get [OPTIONS] ID

Arguments:

• ID: Id of the cloud environment. [required]

Options:

• --include-permissions / --no-include-permissions: Also say what you may do with the environment.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens cloudenvironments create¶

Make a cloud environment; prints the operation that makes it.

Usage:

$ ycli datalens cloudenvironments create [OPTIONS]

Options:

• --name TEXT: The environment's name. [required]
• --cloud-id TEXT: The cloud to make it in. [required]
• --subnet-id TEXT: The subnet it uses. [required]
• --description TEXT: A description.
• --security-group-ids TEXT: A security group it uses (repeatable).
• --storage TEXT: The settings of its storage bucket, as a JSON object: {"maxSize": "0"} (bytes; zero is unlimited).
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API. It creates or changes resources in a cloud, which may be billed: written from the document and never called, not measured.

ycli datalens cloudenvironments update¶

Change the fields given of a cloud environment; prints the operation.

Usage:

$ ycli datalens cloudenvironments update [OPTIONS] ID

Arguments:

• ID: Id of the cloud environment. [required]

Options:

• --name TEXT: A new name.
• --description TEXT: A new description; empty clears it.
• --security-group-ids TEXT: A security group it uses (repeatable).
• --storage TEXT: The settings of its storage bucket, as a JSON object: {"maxSize": "0"} (bytes; zero is unlimited).
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API. It creates or changes resources in a cloud, which may be billed: written from the document and never called, not measured.

ycli datalens cloudenvironments delete¶

Delete a cloud environment; prints the operation that deletes it.

Usage:

$ ycli datalens cloudenvironments delete [OPTIONS] ID

Arguments:

• ID: Id of the cloud environment. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API. It creates or changes resources in a cloud, which may be billed: written from the document and never called, not measured.

ycli datalens cloudenvironmentstorage¶

The storage bucket of a DataLens cloud environment (experimental in the API).

Usage:

$ ycli datalens cloudenvironmentstorage [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• bucket-objects-list: List the paths of the objects in the...
• bucket-object-metadata-get: Print the size of an object and when it...
• bucket-download-url-create: Print a signed link to read one object; it...
• bucket-upload-url-create: Print a signed link to put one object; it...

ycli datalens cloudenvironmentstorage bucket-objects-list¶

List the paths of the objects in the bucket (auto-paginated).

Usage:

$ ycli datalens cloudenvironmentstorage bucket-objects-list [OPTIONS] CLOUD_ENVIRONMENT_ID

Arguments:

• CLOUD_ENVIRONMENT_ID: Id of the cloud environment. [required]

Options:

• --prefix TEXT: Only the paths that start with this.
• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API and written from its document: not measured. An environment nothing knows answers 403 Permission denied.

ycli datalens cloudenvironmentstorage bucket-object-metadata-get¶

Print the size of an object and when it last changed.

Usage:

$ ycli datalens cloudenvironmentstorage bucket-object-metadata-get [OPTIONS] CLOUD_ENVIRONMENT_ID

Arguments:

• CLOUD_ENVIRONMENT_ID: Id of the cloud environment. [required]

Options:

• --path TEXT: The path of the object in the bucket. [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API and written from its document: not measured. An environment nothing knows answers 403 Permission denied.

ycli datalens cloudenvironmentstorage bucket-download-url-create¶

Print a signed link to read one object; it works for whoever holds it.

Usage:

$ ycli datalens cloudenvironmentstorage bucket-download-url-create [OPTIONS] CLOUD_ENVIRONMENT_ID

Arguments:

• CLOUD_ENVIRONMENT_ID: Id of the cloud environment. [required]

Options:

• --path TEXT: The path of the object in the bucket. [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API and written from its document: not measured. An environment nothing knows answers 403 Permission denied.

ycli datalens cloudenvironmentstorage bucket-upload-url-create¶

Print a signed link to put one object; it works for whoever holds it.

Usage:

$ ycli datalens cloudenvironmentstorage bucket-upload-url-create [OPTIONS] CLOUD_ENVIRONMENT_ID

Arguments:

• CLOUD_ENVIRONMENT_ID: Id of the cloud environment. [required]

Options:

• --path TEXT: The path of the object in the bucket. [required]
• --size TEXT: The size of the object in bytes. [required]
• --content-md5 TEXT: The MD5 digest of the content, base64-encoded. [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API and written from its document: not measured. An environment nothing knows answers 403 Permission denied.

ycli datalens restcatalogs¶

DataLens REST catalogs (experimental in the API).

Usage:

$ ycli datalens restcatalogs [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List the REST catalogs (auto-paginated).
• create: Make a REST catalog; prints the operation...

ycli datalens restcatalogs list¶

List the REST catalogs (auto-paginated).

Usage:

$ ycli datalens restcatalogs list [OPTIONS]

Options:

• --cloud-environment-id TEXT: Only the catalogs of this cloud environment.
• --filter TEXT: A condition such as name="…" (repeatable).
• --sort-by TEXT: The field to sort by. Known values: name, createdAt, updatedAt.
• --reverse-order / --no-reverse-order: Sort the other way round.
• --include-permissions / --no-include-permissions: Also say what you may do with each catalog.
• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens restcatalogs create¶

Make a REST catalog; prints the operation that makes it.

Usage:

$ ycli datalens restcatalogs create [OPTIONS]

Options:

• --cloud-environment-id TEXT: The cloud environment to make it in. [required]
• --name TEXT: The catalog's name. [required]
• --bucket-settings TEXT: The settings of its bucket, as a JSON object: {"storageClass": "STANDARD", "maxSize": "1073741824"}, or {}. [required]
• --description TEXT: A description.
• --labels TEXT: Labels, as a JSON object: {"team": "analytics"}.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API. It creates a bucket in a cloud, which may be billed: written from the document and never called, not measured.

ycli datalens lakehouseoperations¶

DataLens Lakehouse operations (experimental in the API).

Usage:

$ ycli datalens lakehouseoperations [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print how far an operation is: done or...

ycli datalens lakehouseoperations get¶

Print how far an operation is: done or not, its error or its response.

Usage:

$ ycli datalens lakehouseoperations get [OPTIONS] OPERATION_ID

Arguments:

• OPERATION_ID: Operation id. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API and written from its document: not measured. An id nothing knows answers 403 Permission denied.

ycli datalens trinoclusters¶

DataLens Trino clusters (experimental in the API).

Usage:

$ ycli datalens trinoclusters [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List the Trino clusters (auto-paginated).
• get: Print one Trino cluster: its...
• create: Make a Trino cluster; prints the operation...
• delete: Delete a Trino cluster; prints the...
• start: Start a stopped Trino cluster; prints the...
• stop: Stop a running Trino cluster; prints the...
• catalog-create: Attach a REST catalog to a Trino cluster;...
• catalog-delete: Detach a REST catalog from a Trino...
• resource-presets-list: List the sizes a cluster's machines may...
• resource-preset-get: Print one size of a cluster's machines:...

ycli datalens trinoclusters list¶

List the Trino clusters (auto-paginated).

Usage:

$ ycli datalens trinoclusters list [OPTIONS]

Options:

• --filter TEXT: A condition the clusters must meet (repeatable).
• --collection-id TEXT: Only the clusters of this collection.
• --catalog-id TEXT: Only the clusters this REST catalog is attached to.
• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

ycli datalens trinoclusters get¶

Print one Trino cluster: its configuration, health, status and coordinator.

Usage:

$ ycli datalens trinoclusters get [OPTIONS] ID

Arguments:

• ID: Id of the Trino cluster. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API and written from its document: not measured. An id nothing knows answers 403 Permission denied, not 404.

ycli datalens trinoclusters create¶

Make a Trino cluster; prints the operation that makes it.

Usage:

$ ycli datalens trinoclusters create [OPTIONS]

Options:

• --collection-id TEXT: The DataLens collection to make it in. [required]
• --cloud-environment-id TEXT: The cloud environment to make it in. [required]
• --name TEXT: The cluster's name. [required]
• --worker-config TEXT: The workers, as a JSON object: {"resources": {"resourcePresetId": "…"}, "scalePolicy": {"autoScale": {"minCount": "1", "maxCount": "4"}}}. [required]
• --description TEXT: A description.
• --labels TEXT: Labels, as a JSON object: {"team": "analytics"}.
• --catalogs-config TEXT: A REST catalog to attach, as a JSON object: {"catalogId": "…"} (repeatable).
• --trino-version TEXT: The version of Trino; the service's own if not.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API. A cluster is cloud resources, billed while it runs: written from the document and never called, not measured.

ycli datalens trinoclusters delete¶

Delete a Trino cluster; prints the operation that deletes it.

Usage:

$ ycli datalens trinoclusters delete [OPTIONS] ID

Arguments:

• ID: Id of the Trino cluster. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API. A cluster is cloud resources, billed while it runs: written from the document and never called, not measured.

ycli datalens trinoclusters start¶

Start a stopped Trino cluster; prints the operation that starts it.

Usage:

$ ycli datalens trinoclusters start [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Id of the Trino cluster. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API. A cluster is cloud resources, billed while it runs: written from the document and never called, not measured.

ycli datalens trinoclusters stop¶

Stop a running Trino cluster; prints the operation that stops it.

Usage:

$ ycli datalens trinoclusters stop [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Id of the Trino cluster. [required]

Options:

• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API. A cluster is cloud resources, billed while it runs: written from the document and never called, not measured.

ycli datalens trinoclusters catalog-create¶

Attach a REST catalog to a Trino cluster; prints the operation.

Usage:

$ ycli datalens trinoclusters catalog-create [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Id of the Trino cluster. [required]

Options:

• --catalog TEXT: The REST catalog to attach, as a JSON object: {"catalogId": "…"}. [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API. A cluster is cloud resources, billed while it runs: written from the document and never called, not measured.

ycli datalens trinoclusters catalog-delete¶

Detach a REST catalog from a Trino cluster; the catalog itself stays.

Usage:

$ ycli datalens trinoclusters catalog-delete [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Id of the Trino cluster. [required]

Options:

• --catalog-id TEXT: The id of the REST catalog to detach. [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API. A cluster is cloud resources, billed while it runs: written from the document and never called, not measured.

ycli datalens trinoclusters resource-presets-list¶

List the sizes a cluster's machines may have in a cloud environment.

Usage:

$ ycli datalens trinoclusters resource-presets-list [OPTIONS] CLOUD_ENVIRONMENT_ID

Arguments:

• CLOUD_ENVIRONMENT_ID: Id of the cloud environment. [required]

Options:

• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API and written from its document: not measured. An id nothing knows answers 403 Permission denied, not 404.

ycli datalens trinoclusters resource-preset-get¶

Print one size of a cluster's machines: its cores and its memory.

Usage:

$ ycli datalens trinoclusters resource-preset-get [OPTIONS] RESOURCE_PRESET_ID

Arguments:

• RESOURCE_PRESET_ID: Id of the resource preset. [required]

Options:

• --cloud-environment-id TEXT: The cloud environment the presets are of. [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API and written from its document: not measured. An id nothing knows answers 403 Permission denied, not 404.

ycli datalens sparkapplications¶

DataLens Spark applications (experimental in the API).

Usage:

$ ycli datalens sparkapplications [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List the applications of a Spark cluster...
• get: Print one Spark application: its status,...
• create: Make a Spark application on a cluster;...
• cancel: Stop a Spark application; prints the...
• log-list: Print one fragment of an application's...

ycli datalens sparkapplications list¶

List the applications of a Spark cluster (auto-paginated).

Usage:

$ ycli datalens sparkapplications list [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Id of the Spark cluster. [required]

Options:

• --filter TEXT: A condition, all must hold: name="…", created_by="…", application_type="…", catalog_id="…" (repeatable).
• --limit INTEGER RANGE: Max items to fetch (default: the configured cap). [x>=1]
• --all: Fetch everything, ignoring the cap.
• --next TOKEN: Go on from where an earlier run stopped, with the token it printed: the token carries its listing; give what is required again, and nothing else but the limit.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API and written from its document: not measured. A cluster nothing knows answers 403 Permission denied, not 404.

ycli datalens sparkapplications get¶

Print one Spark application: its status, its times and what it runs.

Usage:

$ ycli datalens sparkapplications get [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Id of the Spark cluster. [required]

Options:

• --application-id TEXT: Id of the Spark application. [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API and written from its document: not measured. A cluster nothing knows answers 403 Permission denied, not 404.

ycli datalens sparkapplications create¶

Make a Spark application on a cluster; prints the operation that makes it.

Give exactly one of the three kinds. --body-file and -F give the request itself (pysparkApplication, catalogs, name); a flag wins over them.

Usage:

$ ycli datalens sparkapplications create [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Id of the Spark cluster. [required]

Options:

• --name TEXT: The application's name.
• --catalogs TEXT: A REST catalog to attach, as a JSON object: {"catalogId": "…"} (repeatable).
• --spark-application TEXT: An application in a JAR, as a JSON object: {"mainJarFileUri": "…", "mainClass": "…", "args": ["…"]}.
• --pyspark-application TEXT: An application in a Python file, as a JSON object: {"mainPythonFileUri": "…", "args": ["…"]}.
• --spark-connect-application TEXT: A Spark Connect application, as a JSON object: {"properties": {"…": "…"}}.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API, written from its document and never called: not measured.

ycli datalens sparkapplications cancel¶

Stop a Spark application; prints the operation that cancels it.

Usage:

$ ycli datalens sparkapplications cancel [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Id of the Spark cluster. [required]

Options:

• --application-id TEXT: Id of the Spark application. [required]
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API, written from its document and never called: not measured.

ycli datalens sparkapplications log-list¶

Print one fragment of an application's log, and the token of the next.

Usage:

$ ycli datalens sparkapplications log-list [OPTIONS] CLUSTER_ID

Arguments:

• CLUSTER_ID: Id of the Spark cluster. [required]

Options:

• --application-id TEXT: Id of the Spark application. [required]
• --page-size INTEGER: The most characters the fragment may hold.
• --page-token TEXT: The token of the fragment to read; the first if not.
• -o, --format [auto|json|yaml|pretty|csv|markdown|ndjson|name]: Output format (auto = pretty on a TTY, JSON when piped).
• -y, --yes: Do not ask before an operation that deletes data or grants access.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown. A secret in the body (a password, a token) is printed as ***.
• --profile NAME: Use the credentials saved as this profile (YCLI_PROFILE); the environment's and .env's are then not read. ycli auth profiles lists them.
• -F, --field TEXT: Set any field of the request body: key=value, key[sub]=value for a nested one (JSON-coerced; repeatable). key=@FILE (@- for stdin) gives the file's text as it is; a string that starts with @ goes in JSON quotes ('text="@ivan"'). A flag of the command wins over it. Objects merge; a list replaces the one below it. Give a secret from a file, not typed here: a command line stays in the shell history. Write that file with no line break at its end (printf %s 'secret' > file), or the break goes out with the secret.
• --body-file FILE: A JSON object (YAML in a .yaml / .yml file) laid under the request body: -F and the command's flags win over it. Objects merge; a list is replaced, not added to. YAML guesses types (no, 1.10): quote a value meant as text.
• --help: Show this message and exit.

Experimental in the DataLens API and written from its document: not measured. A cluster nothing knows answers 403 Permission denied, not 404.