Imported from albanistrefi/umbraco_CLI (
skills/cli/umbraco-document/SKILL.md). Install upstream withnpx skills add albanistrefi/umbraco_CLI --skill umbraco-document. Copyright stays with the author.
document
PREREQUISITE: Read
../umbraco-shared/SKILL.mdfor auth, global flags, and security rules.
umbraco document <command> [flags]Read Commands
| Command | Description |
|---|---|
document ancestors <id> |
Get ancestor documents |
document are-referenced |
Bulk check: which of these document IDs are referenced by something |
document audit-log <id> |
List the audit trail for a document (who did what, when) |
document bin children <id> |
List children of a trashed document item |
document bin list |
List document items at the recycle bin root |
document bin original-parent <id> |
Get the original parent of a trashed document item (the default restore target) |
document children <id> |
Get child documents (paginated; --skip/--take/--all) |
document domains get <id> |
Get the domains assigned to a document |
document get <id> |
Get a document by ID |
document grep <substring> |
Exhaustively scan document property values for an exact substring |
document public-access get <id> |
Get the public-access (member protection) rules on a document |
document publish-descendants-result <id> <task-id> |
Check the progress of an asynchronous publish-descendants run |
document referenced-descendants <id> |
List items that reference this document or any of its descendants |
document references <id> |
List items that reference this document (paginated; --skip/--take/--all) |
document root |
Get root documents (paginated; --skip/--take/--all) |
document search |
Search documents |
document urls <id> [<id>...] |
Get published document URLs |
document version get <version-id> |
Get a stored document version (the full payload as it was) |
document version list <document-id> |
List stored versions of a document (paginated; --skip/--take/--all) |
ancestors
umbraco document ancestors <id>are-referenced
umbraco document are-referenced| Flag | Type | Default | Description |
|---|---|---|---|
--ids |
string | — | Comma-separated document GUIDs to check (required) |
audit-log
umbraco document audit-log <id>GET /document/{id}/audit-log. Pass --params for orderDirection or sinceDate filters, e.g. --params '{"sinceDate":"2026-01-01T00:00:00Z"}'.
| Flag | Type | Default | Description |
|---|---|---|---|
--all |
bool | false | Walk every page until exhausted (auto-paginates with --take as the page size, default 500; combine with --skip to start partway through). Bounded by an internal 100k-item ceiling. |
--fields |
string | — | Limit response fields (comma-separated top-level keys) |
--first-n |
int | 0 | Return only the first N items from item collections |
--ids-only |
bool | false | Return only item IDs for item collections |
--params |
string | — | Query parameters as JSON |
--skip |
int | -1 | Skip count (passes through as ?skip=N; lets you walk past the server page size on large children/root collections) |
--summarize |
bool | false | Return only id/name/alias fields for item collections |
--take |
int | -1 | Take count (passes through as ?take=N; combine with --skip to page) |
bin children
umbraco document bin children <id>| Flag | Type | Default | Description |
|---|---|---|---|
--all |
bool | false | Walk every page until exhausted (auto-paginates with --take as the page size, default 500; combine with --skip to start partway through). Bounded by an internal 100k-item ceiling. |
--fields |
string | — | Limit response fields (comma-separated top-level keys) |
--first-n |
int | 0 | Return only the first N items from item collections |
--ids-only |
bool | false | Return only item IDs for item collections |
--params |
string | — | Query parameters as JSON |
--skip |
int | -1 | Skip count (passes through as ?skip=N; lets you walk past the server page size on large children/root collections) |
--summarize |
bool | false | Return only id/name/alias fields for item collections |
--take |
int | -1 | Take count (passes through as ?take=N; combine with --skip to page) |
bin list
umbraco document bin listGET /recycle-bin/document/root. Paginated; use 'bin children ' to descend into trashed subtrees.
| Flag | Type | Default | Description |
|---|---|---|---|
--all |
bool | false | Walk every page until exhausted (auto-paginates with --take as the page size, default 500; combine with --skip to start partway through). Bounded by an internal 100k-item ceiling. |
--fields |
string | — | Limit response fields (comma-separated top-level keys) |
--first-n |
int | 0 | Return only the first N items from item collections |
--ids-only |
bool | false | Return only item IDs for item collections |
--params |
string | — | Query parameters as JSON |
--skip |
int | -1 | Skip count (passes through as ?skip=N; lets you walk past the server page size on large children/root collections) |
--summarize |
bool | false | Return only id/name/alias fields for item collections |
--take |
int | -1 | Take count (passes through as ?take=N; combine with --skip to page) |
bin original-parent
umbraco document bin original-parent <id>| Flag | Type | Default | Description |
|---|---|---|---|
--fields |
string | — | Limit response fields (comma-separated top-level keys) |
children
umbraco document children <id>| Flag | Type | Default | Description |
|---|---|---|---|
--all |
bool | false | Walk every page until exhausted (auto-paginates with --take as the page size, default 500; combine with --skip to start partway through). Bounded by an internal 100k-item ceiling. |
--fields |
string | — | Project response fields client-side; supports comma-separated dotted paths such as id,name,documentType.alias,values.bodyText |
--first-n |
int | 0 | Return only the first N items from item collections |
--full |
bool | false | Return the full payload explicitly; cannot be combined with --fields, --summary, or --no-empty |
--ids-only |
bool | false | Return only item IDs for item collections |
--no-empty |
bool | false | Omit null, empty string, empty array, and empty object values from trimmed output |
--params |
string | — | Query parameters as JSON |
--resolve-doctype |
bool | false | Annotate each item's documentType with its alias (tree responses carry only the id; this fetches each distinct document type once) |
--skip |
int | -1 | Skip count (passes through as ?skip=N; lets you walk past the server page size on large children/root collections) |
--summarize |
bool | false | Return only id/name/alias fields for item collections |
--summary |
bool | false | Return a compact document shape with id, name, documentType, route/url, and state/date fields when present |
--take |
int | -1 | Take count (passes through as ?take=N; combine with --skip to page) |
domains get
umbraco document domains get <id>get
umbraco document get <id>| Flag | Type | Default | Description |
|---|---|---|---|
--fields |
string | — | Project response fields client-side; supports comma-separated dotted paths such as id,name,documentType.alias,values.bodyText |
--full |
bool | false | Return the full payload explicitly; cannot be combined with --fields, --summary, or --no-empty |
--no-empty |
bool | false | Omit null, empty string, empty array, and empty object values from trimmed output |
--summary |
bool | false | Return a compact document shape with id, name, documentType, route/url, and state/date fields when present |
--with-urls |
bool | false | Fetch published document URL info and include it as urls in the response |
grep
umbraco document grep <substring>Walks the document tree, fetches each document, and scans each serialized property value for an exact substring. This is intentionally different from document search: search is Examine-backed and can miss buried URLs, aliases, tokens, or strings inside rich text and block/grid JSON.
By default grep scans both the current draft representation and the published snapshot when one exists. Use --draft or --published to narrow the scan.
| Flag | Type | Default | Description |
|---|---|---|---|
--concurrency |
int | 6 | Maximum concurrent document fetches |
--doctype |
stringArray | [] | Restrict matches to a document type alias; repeat for multiple aliases |
--draft |
bool | false | Scan only current draft document payloads |
--ignore-case |
bool | false | Match case-insensitively |
--property |
stringArray | [] | Restrict matches to a property alias; repeat for multiple aliases |
--published |
bool | false | Scan only published document snapshots |
--regex |
bool | false | Treat the substring argument as a regular expression |
--start-id |
string | — | Document ID whose subtree should be scanned instead of the full tree |
public-access get
umbraco document public-access get <id>publish-descendants-result
umbraco document publish-descendants-result <id> <task-id>referenced-descendants
umbraco document referenced-descendants <id>| Flag | Type | Default | Description |
|---|---|---|---|
--all |
bool | false | Walk every page until exhausted (auto-paginates with --take as the page size, default 500; combine with --skip to start partway through). Bounded by an internal 100k-item ceiling. |
--fields |
string | — | Limit response fields (comma-separated top-level keys) |
--first-n |
int | 0 | Return only the first N items from item collections |
--ids-only |
bool | false | Return only item IDs for item collections |
--params |
string | — | Query parameters as JSON |
--skip |
int | -1 | Skip count (passes through as ?skip=N; lets you walk past the server page size on large children/root collections) |
--summarize |
bool | false | Return only id/name/alias fields for item collections |
--take |
int | -1 | Take count (passes through as ?take=N; combine with --skip to page) |
references
umbraco document references <id>Wraps GET /document/{id}/referenced-by. Used to answer 'what uses this node' for orphan checks, safe-delete verification, and taxonomy usage audits.
| Flag | Type | Default | Description |
|---|---|---|---|
--all |
bool | false | Walk every page until exhausted (auto-paginates with --take as the page size, default 500; combine with --skip to start partway through). Bounded by an internal 100k-item ceiling. |
--fields |
string | — | Limit response fields (comma-separated top-level keys) |
--first-n |
int | 0 | Return only the first N items from item collections |
--ids-only |
bool | false | Return only item IDs for item collections |
--params |
string | — | Query parameters as JSON |
--skip |
int | -1 | Skip count (passes through as ?skip=N; lets you walk past the server page size on large children/root collections) |
--summarize |
bool | false | Return only id/name/alias fields for item collections |
--take |
int | -1 | Take count (passes through as ?take=N; combine with --skip to page) |
root
umbraco document root| Flag | Type | Default | Description |
|---|---|---|---|
--all |
bool | false | Walk every page until exhausted (auto-paginates with --take as the page size, default 500; combine with --skip to start partway through). Bounded by an internal 100k-item ceiling. |
--fields |
string | — | Project response fields client-side; supports comma-separated dotted paths such as id,name,documentType.alias,values.bodyText |
--first-n |
int | 0 | Return only the first N items from item collections |
--full |
bool | false | Return the full payload explicitly; cannot be combined with --fields, --summary, or --no-empty |
--ids-only |
bool | false | Return only item IDs for item collections |
--no-empty |
bool | false | Omit null, empty string, empty array, and empty object values from trimmed output |
--params |
string | — | Query parameters as JSON |
--resolve-doctype |
bool | false | Annotate each item's documentType with its alias (tree responses carry only the id; this fetches each distinct document type once) |
--skip |
int | -1 | Skip count (passes through as ?skip=N; lets you walk past the server page size on large children/root collections) |
--summarize |
bool | false | Return only id/name/alias fields for item collections |
--summary |
bool | false | Return a compact document shape with id, name, documentType, route/url, and state/date fields when present |
--take |
int | -1 | Take count (passes through as ?take=N; combine with --skip to page) |
search
umbraco document search| Flag | Type | Default | Description |
|---|---|---|---|
--fields |
string | — | Project response fields client-side; supports comma-separated dotted paths such as id,name,documentType.alias,values.bodyText |
--full |
bool | false | Return the full payload explicitly; cannot be combined with --fields, --summary, or --no-empty |
--no-empty |
bool | false | Omit null, empty string, empty array, and empty object values from trimmed output |
--params |
string | — | Search parameters as JSON; convenience flags fill in missing keys, --params wins on collisions |
--query |
string | — | Search query |
--skip |
int | -1 | Skip count (passes through as ?skip=N; lets you walk past the server page size on large children/root collections) |
--summary |
bool | false | Return a compact document shape with id, name, documentType, route/url, and state/date fields when present |
--take |
int | -1 | Take count (passes through as ?take=N; combine with --skip to page) |
--under |
string | — | Limit search to documents under the given parent ID |
urls
umbraco document urls <id> [<id>...]| Flag | Type | Default | Description |
|---|---|---|---|
--absolute |
bool | false | Resolve returned URLs against the configured site host |
--culture |
string | — | Only include URL info for the given culture; defaults to all cultures |
version get
umbraco document version get <version-id>| Flag | Type | Default | Description |
|---|---|---|---|
--fields |
string | — | Limit response fields (comma-separated top-level keys) |
version list
umbraco document version list <document-id>| Flag | Type | Default | Description |
|---|---|---|---|
--all |
bool | false | Walk every page until exhausted (auto-paginates with --take as the page size, default 500; combine with --skip to start partway through). Bounded by an internal 100k-item ceiling. |
--culture |
string | — | Limit versions to one culture on variant content |
--fields |
string | — | Limit response fields (comma-separated top-level keys) |
--first-n |
int | 0 | Return only the first N items from item collections |
--ids-only |
bool | false | Return only item IDs for item collections |
--params |
string | — | Query parameters as JSON |
--skip |
int | -1 | Skip count (passes through as ?skip=N; lets you walk past the server page size on large children/root collections) |
--summarize |
bool | false | Return only id/name/alias fields for item collections |
--take |
int | -1 | Take count (passes through as ?take=N; combine with --skip to page) |
Mutation Commands
Safety: Always use
--dry-runfirst. Remove the flag only after verifying the dry-run output.
| Command | Description |
|---|---|
document bin delete <id> |
Permanently delete one document item from the recycle bin |
document bin empty |
Permanently delete everything in the document recycle bin |
document bulk-update |
Update multiple documents from an explicit ID list |
document copy <id> |
Copy a document |
document create |
Create a document |
document csv-update |
Update multiple documents from a CSV file |
document domains set <id> |
Replace the domains assigned to a document |
document move <id> |
Move a document |
document public-access remove <id> |
Remove the public-access rules from a document (makes it publicly visible again) |
document public-access set <id> |
Create or replace the public-access rules on a document |
document publish <id> |
Publish a document |
document publish-descendants <id> |
Publish a document and its entire subtree |
document restore <id> |
Restore a document item from the recycle bin |
document sort |
Reorder sibling document items into an explicit order |
document sort-children [parent-id] |
Sort all children of a node by a field |
document trash <id> |
Move a document to recycle bin |
document unpublish <id> |
Unpublish a document |
document update <id> |
Update a document |
document update-properties <id> |
Update document properties (merges into values[] by alias) |
document version prevent-cleanup <version-id> |
Pin a version so scheduled history cleanup never deletes it |
document version rollback <version-id> |
Roll the document back to this version |
bin delete
umbraco document bin delete <id>| Flag | Type | Default | Description |
|---|---|---|---|
--dry-run |
bool | false | Print the planned request without executing |
--force |
bool | false | Confirm permanent deletion |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document bin delete <id> [flags] --dry-run
# 2. Execute with the same flags
umbraco document bin delete <id> --force [flags]bin empty
umbraco document bin emptyDELETE /recycle-bin/document. Destroys every trashed document item; there is no undo.
| Flag | Type | Default | Description |
|---|---|---|---|
--dry-run |
bool | false | Print the planned request without executing |
--force |
bool | false | Confirm emptying the recycle bin |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document bin empty [flags] --dry-run
# 2. Execute with the same flags
umbraco document bin empty --force [flags]bulk-update
umbraco document bulk-update| Flag | Type | Default | Description |
|---|---|---|---|
--dry-run |
bool | false | Print the planned requests without executing |
--force |
bool | false | Confirm the bulk update when not using --dry-run |
--id |
stringArray | [] | Document ID to update; repeat for multiple documents |
--id-file |
string | — | Path to a file containing document IDs, one per line |
--json |
string | — | Full JSON payload applied to every document |
--merge-json |
string | — | Partial JSON payload merged into each current document before update |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document bulk-update [flags] --dry-run
# 2. Execute with the same flags
umbraco document bulk-update --force [flags]copy
umbraco document copy <id>| Flag | Type | Default | Description |
|---|---|---|---|
--culture |
string | — | Culture shortcut for --publish |
--dry-run |
bool | false | Print the planned request without executing |
--json |
string | — | Copy payload as JSON |
--publish |
bool | false | Publish the copied document after a successful copy |
--to |
string | — | Target parent ID shortcut |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document copy <id> [flags] --dry-run
# 2. Execute with the same flags
umbraco document copy <id> [flags]create
umbraco document createPOST /document, or POST /document/create-and-publish with --publish (requires Umbraco 18.1+): the document is created and published in one atomic server-side operation, with --culture naming the cultures to publish (omit for invariant content).
| Flag | Type | Default | Description |
|---|---|---|---|
--culture |
string | — | Comma-separated cultures to publish with --publish; omit for invariant content |
--dry-run |
bool | false | Print the planned request without executing |
--json |
string | — | Full JSON payload |
--print-template |
bool | false | Print an annotated JSON skeleton; substitute placeholders before passing to --json |
--publish |
bool | false | Create and publish atomically via POST /document/create-and-publish (Umbraco 18.1+) |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document create [flags] --dry-run
# 2. Execute with the same flags
umbraco document create [flags]csv-update
umbraco document csv-update| Flag | Type | Default | Description |
|---|---|---|---|
--dry-run |
bool | false | Print the planned CSV-driven updates without executing them |
--field |
stringArray | [] | Explicit alias=column CSV mapping; repeat for multiple properties |
--file |
string | — | Path to the CSV file |
--force |
bool | false | Confirm the CSV-driven updates when not using --dry-run |
--id-column |
string | id | CSV column containing document IDs |
--property |
stringArray | [] | Property alias to update from a CSV column with the same name; repeat for multiple properties |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document csv-update [flags] --dry-run
# 2. Execute with the same flags
umbraco document csv-update --force [flags]domains set
umbraco document domains set <id>PUT /document/{id}/domains. The PUT replaces the full set: pass every domain that should remain via repeated --domain host=isoCode flags (e.g. --domain example.dk=da-DK), or the raw payload via --json.
| Flag | Type | Default | Description |
|---|---|---|---|
--default-iso-code |
string | — | Default culture for unmatched hosts |
--domain |
stringArray | [] | Domain assignment as host=isoCode; repeat for multiple |
--dry-run |
bool | false | Print the planned request without executing |
--json |
string | — | Domains payload as JSON |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document domains set <id> [flags] --dry-run
# 2. Execute with the same flags
umbraco document domains set <id> [flags]move
umbraco document move <id>| Flag | Type | Default | Description |
|---|---|---|---|
--dry-run |
bool | false | Print the planned request without executing |
--json |
string | — | Action payload as JSON |
--to |
string | — | Target parent ID shortcut for {"target":{"id":...}} |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document move <id> [flags] --dry-run
# 2. Execute with the same flags
umbraco document move <id> [flags]public-access remove
umbraco document public-access remove <id>| Flag | Type | Default | Description |
|---|---|---|---|
--dry-run |
bool | false | Print the planned request without executing |
--force |
bool | false | Confirm removing member protection |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document public-access remove <id> [flags] --dry-run
# 2. Execute with the same flags
umbraco document public-access remove <id> --force [flags]public-access set
umbraco document public-access set <id>Sets member protection: which member groups (or named members) may view the document, plus the login and error pages. Payload shape:
{"loginDocument":{"id":""},"errorDocument":{"id":""},"memberGroupNames":["Members"],"memberUserNames":[]}
The CLI checks whether rules already exist and issues POST (create) or PUT (replace) accordingly.
| Flag | Type | Default | Description |
|---|---|---|---|
--dry-run |
bool | false | Print the planned request without executing |
--json |
string | — | Public-access payload as JSON |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document public-access set <id> [flags] --dry-run
# 2. Execute with the same flags
umbraco document public-access set <id> [flags]publish
umbraco document publish <id>| Flag | Type | Default | Description |
|---|---|---|---|
--culture |
string | — | Culture shortcut |
--dry-run |
bool | false | Print the planned request without executing |
--json |
string | — | Publish payload as JSON |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document publish <id> [flags] --dry-run
# 2. Execute with the same flags
umbraco document publish <id> [flags]publish-descendants
umbraco document publish-descendants <id>PUT /document/{id}/publish-with-descendants. Publishes the node and every published-state descendant; pass --include-unpublished to also publish drafts.
On variant content pass --culture per culture to publish; with no --culture the invariant default is used. The operation is asynchronous server-side — the response carries a taskId, and 'document publish-descendants-result ' reports completion.
| Flag | Type | Default | Description |
|---|---|---|---|
--culture |
stringArray | [] | Culture to publish; repeat for multiple (omit for invariant content) |
--dry-run |
bool | false | Print the planned request without executing |
--include-unpublished |
bool | false | Also publish descendants that have never been published |
--json |
string | — | Publish payload as JSON |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document publish-descendants <id> [flags] --dry-run
# 2. Execute with the same flags
umbraco document publish-descendants <id> [flags]restore
umbraco document restore <id>PUT /recycle-bin/document/{id}/restore. The restore target defaults to the item's original parent (looked up via the recycle-bin API); pass --to for a different parent, or --to root to restore at the content root.
| Flag | Type | Default | Description |
|---|---|---|---|
--dry-run |
bool | false | Print the planned request without executing |
--to |
string | — | Restore target parent ID, or 'root' (defaults to the original parent) |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document restore <id> [flags] --dry-run
# 2. Execute with the same flags
umbraco document restore <id> [flags]sort
umbraco document sortPUT /document/sort. Pass --ids with the desired order (sortOrder is assigned from position) and --parent for the common parent; omit --parent when sorting root-level items. IDs not listed keep their relative order after the sorted ones.
| Flag | Type | Default | Description |
|---|---|---|---|
--dry-run |
bool | false | Print the planned request without executing |
--ids |
string | — | Comma-separated GUIDs in the desired order |
--json |
string | — | Sort payload as JSON |
--parent |
string | — | Parent ID (omit for root-level items) |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document sort [flags] --dry-run
# 2. Execute with the same flags
umbraco document sort [flags]sort-children
umbraco document sort-children [parent-id]PUT /document/root/sort-children or /document/{id}/sort-children (Umbraco 18.1+). Reorders every child of the parent (root when [parent-id] is omitted) server-side by --field. For explicit manual ordering use 'document sort' instead.
| Flag | Type | Default | Description |
|---|---|---|---|
--culture |
string | — | Sort by the variant name of this culture (variant content only) |
--direction |
string | Ascending | Sort direction: Ascending or Descending (asc/desc accepted) |
--dry-run |
bool | false | Print the planned request without executing |
--field |
string | — | Sort field: Name, CreateDate, or UpdateDate (required) |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document sort-children [parent-id] [flags] --dry-run
# 2. Execute with the same flags
umbraco document sort-children [parent-id] [flags]trash
umbraco document trash <id>| Flag | Type | Default | Description |
|---|---|---|---|
--dry-run |
bool | false | Print the planned request without executing |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document trash <id> [flags] --dry-run
# 2. Execute with the same flags
umbraco document trash <id> [flags]unpublish
umbraco document unpublish <id>| Flag | Type | Default | Description |
|---|---|---|---|
--culture |
string | — | Culture shortcut |
--dry-run |
bool | false | Print the planned request without executing |
--json |
string | — | Unpublish payload as JSON |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document unpublish <id> [flags] --dry-run
# 2. Execute with the same flags
umbraco document unpublish <id> [flags]update
umbraco document update <id>| Flag | Type | Default | Description |
|---|---|---|---|
--culture |
string | — | Culture shortcut for --save-and-publish |
--dry-run |
bool | false | Print the planned request without executing |
--json |
string | — | Full replacement payload as JSON (fields not mentioned are reset by the server) |
--merge-json |
string | — | Partial JSON deep-merged into the current document before update (fields not mentioned are preserved) |
--property |
string | — | Update a single property alias without constructing the full payload |
--save-and-publish |
bool | false | Publish the document after a successful update |
--value |
string | — | String value used with --property |
--value-json |
string | — | JSON value used with --property |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document update <id> [flags] --dry-run
# 2. Execute with the same flags
umbraco document update <id> [flags]update-properties
umbraco document update-properties <id>Updates one or more property values on a document by merging into its values[] array.
Three input shapes are accepted:
Object form (most common for invariant docs): --json '{"isFeatured": true, "products": ["Umbraco CMS"]}' Each key becomes a values[] entry with culture=null, segment=null.
Array form (for culture/segment-variant properties): --json '[{"alias":"title","value":"Hi","culture":"en-US","segment":null}]' Used verbatim as values[].
Envelope form (matches 'document update --merge-json'): --json '{"values":[{"alias":"title","value":"Hi","culture":null,"segment":null}]}'
In all shapes the resulting values[] is merged by alias into the current document, so untouched properties survive.
| Flag | Type | Default | Description |
|---|---|---|---|
--dry-run |
bool | false | Print the planned request without executing |
--json |
string | — | Properties payload as JSON; accepts object {alias: value}, array [{alias, value, culture?, segment?}], or envelope {"values":[...]} |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document update-properties <id> [flags] --dry-run
# 2. Execute with the same flags
umbraco document update-properties <id> [flags]version prevent-cleanup
umbraco document version prevent-cleanup <version-id>PUT /document-version/{id}/prevent-cleanup. Pins the version by default; pass --disable to unpin it again.
| Flag | Type | Default | Description |
|---|---|---|---|
--disable |
bool | false | Allow cleanup to delete this version again |
--dry-run |
bool | false | Print the planned request without executing |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document version prevent-cleanup <version-id> [flags] --dry-run
# 2. Execute with the same flags
umbraco document version prevent-cleanup <version-id> [flags]version rollback
umbraco document version rollback <version-id>POST /document-version/{id}/rollback. Version IDs come from 'document version list'. On variant content pass --culture to roll back a single culture; omitting it rolls back the invariant data.
| Flag | Type | Default | Description |
|---|---|---|---|
--culture |
string | — | Culture to roll back on variant content |
--dry-run |
bool | false | Print the planned request without executing |
Safe pattern:
# 1. Rehearse with the exact flags you will execute with
umbraco document version rollback <version-id> [flags] --dry-run
# 2. Execute with the same flags
umbraco document version rollback <version-id> [flags]Discovering Commands
# Browse subcommands
umbraco document --help
# Inspect a specific endpoint schema
umbraco schema document.<method>