| name | umbraco-mediatype |
| description | Media type operations |
| metadata | {"version":"0.4.8","requires":{"bins":["umbraco"],"skills":["umbraco-shared"]}} |
mediatype
PREREQUISITE: Read ../umbraco-shared/SKILL.md for auth, global flags, and security rules.
umbraco mediatype <command> [flags]
Read Commands
| Command | Description |
|---|
mediatype children <id> | Get child media types of a folder (paginated; --skip/--take/--all) |
mediatype export <id> | Export a media type as a .udt document |
mediatype get <id> | Get media type by ID |
mediatype list | List media types (paginated; --skip/--take/--all) |
mediatype search | Search media types |
children
umbraco mediatype 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) |
export
umbraco mediatype export <id>
| Flag | Type | Default | Description |
|---|
--fields | string | — | Limit response fields (comma-separated top-level keys) |
get
umbraco mediatype get <id>
| Flag | Type | Default | Description |
|---|
--fields | string | — | Limit response fields (comma-separated top-level keys) |
list
umbraco mediatype list
| 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. |
--exclude-folders | bool | false | Alias for --types-only |
--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 |
--recursive | bool | false | Walk media type folders recursively |
--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) |
--types-only | bool | false | Return media types only, excluding folders |
search
umbraco mediatype search
| Flag | Type | Default | Description |
|---|
--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) |
--take | int | -1 | Take count (passes through as ?take=N; combine with --skip to page) |
Mutation Commands
Safety: Always use --dry-run first. Remove the flag only after verifying the dry-run output.
| Command | Description |
|---|
mediatype create | Create a media type |
mediatype delete <id> | Delete a media type |
mediatype update <id> | Update a media type (--json replaces, --merge-json merges) |
create
umbraco mediatype create
| Flag | Type | Default | Description |
|---|
--dry-run | bool | false | Print the planned request without executing |
--json | string | — | Create payload as JSON |
Safe pattern:
umbraco mediatype create --dry-run
umbraco mediatype create
delete
umbraco mediatype delete <id>
| Flag | Type | Default | Description |
|---|
--dry-run | bool | false | Print the planned request without executing |
--force | bool | false | Confirm permanent deletion |
Safe pattern:
umbraco mediatype delete <id> --dry-run
umbraco mediatype delete <id> --force
update
umbraco mediatype update <id>
| Flag | Type | Default | Description |
|---|
--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 resource before update (fields not mentioned are preserved) |
Safe pattern:
umbraco mediatype update <id> --dry-run
umbraco mediatype update <id>
Discovering Commands
umbraco mediatype --help
umbraco schema mediatype.<method>