Umbraco CMS MCP Dev

Create a new document blueprint from an existing document Use this to create a blueprint template based on an existing document, preserving its structure and content for reuse. Note: Blueprints created from documents are always created at the root level. Use the move-document-blueprint tool to relocate them to folders after creation if needed.

Creates a new document type in Umbraco. IMPORTANT: IMPLEMENTATION REQUIREMENTS 1. ALWAYS use the get-icons tool to find a valid icon name 2. When referencing data types, first find them using find-data-type to get their correct IDs 3. When adding compositions or allowed document types, first use get-document-type-root to find the actual IDs 4. The tool will automatically generate UUIDs for properties and containers 5. Document types can be created in folders by specifying a parentId, or at the root level by omitting the parentId 6. Do not try to add templates to document types they are not c…

Creates a new document type folder

Rollback document to a specific version

Creates an element with support for multiple cultures. Always follow these requirements when creating elements exactly, do not deviate in any way. ## COPY-FIRST APPROACH (RECOMMENDED) **FIRST: Try to copy an existing element** 1. Only use this if copy-element and search-element tools are available 2. Use search-element to find elements with the same document type 3. If similar elements exist AND copy-element tool is available: - Use copy-element to duplicate the existing structure - Use search-element to find the new element (copy returns empty string, not the new ID) …

Creates a new element folder

Creates a new element type in Umbraco. IMPORTANT: IMPLEMENTATION REQUIREMENTS 1. ALWAYS use the get-icons tool to find a valid icon name 2. When referencing data types, first find them using find-data-type to get their correct IDs 3. When adding compositions, first use get-document-type-root to find the actual ID of the document type 4. The tool will automatically generate UUIDs for properties and containers 5. Always create new element types in the root before copying to a new folder if required 6. Property container structure: - Properties MUST specify either a 'tab' or 'group' (or both…

Creates a new language

Description is built at runtime.

Creates a new folder in the media library. Use this to organize media items into folders. For uploading actual media files (images, documents, etc.), use the create-media tool instead.

Description is built at runtime.

Creates a new media type

Creates a new media type folder

Creates a member in Umbraco. Use this endpoint to create new members with the specified properties and groups.

Creates a new member group

Creates a new member type

Creates a new partial view

Creates a new partial view folder

Creates a new script

Creates a new script folder

Creates a new stylesheet.

Creates a new stylesheet folder

Creates a new template

Creates a new temporary file. The file will be deleted after 10 minutes. The temporary file id is used when uploading media files to Umbraco. The process is as follows: - Create a temporary file using this endpoint - Use the temporary file id when creating a media item using the media post endpoint Provide the file content as a base64 encoded string.

Creates a new user data record

Creates a new user group

Creates a new webhook Must contain at least one event from the events listed at /umbraco/management/api/v1/webhook/events endpoint. Cannot mix different event types in the same webhook.

Deletes a data type by Id

Deletes a data type folder by Id

Deletes a dictionary item by Id

Deletes a document by Id

Deletes one block from a document's BlockList, BlockGrid, or RichText property. Removes the block's contentData entry, its settingsData entry (via the layout settingsKey), its expose entries, and its layout entry (and, for RichText, its <umb-rte-block> markup element) together in a single document update. Acts on the property's top-level blocks only; BlockGrid blocks inside named areas can be deleted too. A BlockGrid block whose areas still contain blocks is refused — delete the nested blocks first. The document is saved, not published. Example: { documentId: "...", propertyAl…

Deletes a document blueprint by Id

Deletes a document blueprint folder by Id

Removes public access settings from a document by Id.

Permanently deletes a document from the recycle bin by its id

Deletes a document type by Id

Deletes a document type folder by Id

Deletes an element by Id

Deletes an element folder by Id

Permanently deletes an element folder from the recycle bin by Id

Permanently deletes an element from the recycle bin by its id

Deletes a document from the recycle bin by Id.

Deletes a language by ISO code

Deletes a saved search by name

Deletes a media item by Id. Works for all media types including folders, images, files, videos, etc.

Deletes a media item from the recycle bin by Id.

Permanently deletes a media item from the recycle bin by its id

Deletes a media type by Id

Deletes a media type folder by Id

Deletes a member by Id

Deletes a member group by Id

Deletes a member type by id

Deletes a partial view by its path

Deletes a partial view folder by its path

Deletes a specific redirect by its ID. Parameters: - id: The unique identifier of the redirect to delete (string)

Deletes a script by path

Deletes a script folder by path

Deletes a stylesheet by its path

Deletes a stylesheet folder by its path

Deletes a template by Id

Deletes a temporary file by Id

Deletes an avatar for a specific user by ID (admin only or self-service)

Deletes user data by its id

Deletes a user group by Id

Deletes all user groups

Deletes a webhook by id

Empties the element recycle bin.

Empties the media recycle bin.

Empties the document recycle bin.

Executes remedial actions for health issues. WARNING: This performs system remedial actions that may modify system configuration, files, or database content. Use with caution.

Executes template queries and returns generated LINQ code with sample results and execution time. IMPORTANT: Always follow the example format exactly. Example: {"take": 5} or { "documentTypeAlias": "article", "filters": [{"propertyAlias": "Name", "constraintValue": "Blog", "operator": "Contains"}, "take": 10 }

Finds a data type by Id or Name

Finds a dictionary by Id or name

Finds members by various filter criteria

Finds users by filtering with name, email, or other criteria

Gets all data types by recursively fetching from root and all children. This is the preferred approach when you need to understand the full folder structure. For large sites, this may take a while to complete. For smaller sites its more efficient than fetching all data types by folder.

Gets all document types by recursively fetching from root and all children. This is the preferred approach when you need to understand the full folder structure. For large sites, this may take a while to complete. For smaller sites its more efficient than fetching all documents by folder.

Gets all member groups with optional pagination

Gets all redirects from the Umbraco server. Returns a list of redirects with their details. Use "filter" to search redirects by original or destination URL. Results are paginated (100 per page by default). Check the returned "total" against the number of "items" returned - if total is greater, call again with "cursor" set to the returned "nextCursor" to page through the remaining redirects.

Gets logs for all webhooks

Gets allowed file extensions for media types

Get a collection of document items Use this to retrieve a filtered and paginated collection of document items based on various criteria like data type, ordering, and filtering.

Get a collection of media items Use this to retrieve a filtered and paginated collection of media items based on various criteria like data type, ordering, and filtering.

Retrieves a paginated list of cultures that Umbraco can be configured to use

Gets a data type by Id

Gets the ancestors of a data type by Id

Gets the ancestor chain (breadcrumb) for multiple data type Ids in one call. Returns one entry per requested Id, each containing that Id's chain of ancestors. Differs from get-data-type-ancestors which returns the tree-style ancestors of a single Id.

Gets full data types for multiple Ids in one call. Returns each data type's editor configuration values (e.g. dropdown options, numeric min/max), not just the lightweight item shape returned by get-data-types-by-id-array. Use when you need the same payload as get-data-type but for many Ids at once.

Gets the children data types or data type folders by the parent id

Gets global data type configuration settings including change permissions and default list view IDs

Gets a data type folder by Id

Gets the root level of the data type and data type folders in the tree.

Gets the JSON Schema for a data type by Id. Returns a JSON Schema describing the value structure for the specified data type, including its configured property editor settings. IMPORTANT: Use this tool BEFORE creating data types to understand the expected configuration structure for a specific property editor.

Gets JSON Schemas for multiple data types in a single batch request. Returns JSON Schemas describing the value structure for each specified data type. This is more efficient than calling get-data-type-schema multiple times when you need schemas for several data types.

Searches the data type tree for a data type by name. It does NOT allow for searching for data type folders.

Gets sibling data types or data type folders for a given descendant id

Searches data types in tree-node shape (with hasChildren and parent for tree navigation). Use this when paginating through tree results; for a flat search of items use get-data-type-search. Optional itemKind filter accepts 'Item', 'Folder' or 'All'.

Gets data types by IDs (or empty array if no IDs are provided)

Gets the default language

Gets a dictionary by Id

Gets the ancestors of a dictionary item by Id

Gets dictionary items by IDs (or empty array if no IDs are provided)

Gets the children of a dictionary item by Id

Gets the root level of the dictionary tree

Gets ancestor items for a document.

Gets the ancestor chain (breadcrumb) for multiple document Ids in one call. Returns one entry per requested Id, each containing that Id's chain of ancestors. Differs from get-document-ancestors which returns the tree-style ancestors of a single Id.

Check if document items are referenced Use this to verify if specific document items are being referenced by other content before deletion or modification.

Fetches the audit log for a document by Id.

Gets available segment options for a document by its id Use this to retrieve the available segment options (content variations) for a document. Useful for: • Understanding what content variations are available for a document • Determining which segments can be used when creating or editing document content • Viewing segment names, aliases, and associated cultures

Gets a document blueprint by Id

Gets the ancestors of a document blueprint by Id

Gets document blueprints by IDs (or empty array if no IDs are provided)

Gets the children of a document blueprint by Id

Gets a document blueprint folder by Id

Gets the root level of the document blueprint tree

Get scaffold information for a document blueprint Use this to retrieve the scaffold structure and default values for a document blueprint, typically used when creating new documents from blueprints.

Gets sibling document blueprints for a given descendant id

Gets a document by id Use this to retrieve existing documents. When creating new documents, first get an existing document of similar type, then use the Copy document endpoint.

Get items that reference a specific document item Use this to find all content, documents, or other items that are currently referencing a specific document item.

Get descendant references for a document item Use this to find all descendant references (child items) that are being referenced for a specific document item. Useful for: • Impact analysis: Before deleting a document folder, see what content would be affected • Dependency tracking: Find all content using documents from a specific folder hierarchy • Content auditing: Identify which descendant document items are actually being used

Gets child items for a document.

Gets the document configuration for the Umbraco instance.

Gets the domains assigned to a document by Id.

Gets the notifications for a document by Id.

Gets the public access settings for a document by Id. Set includeAncestors=true to also resolve protection inherited from an ancestor (the response's isProtectedByAncestor field reflects this).

Gets the published state of a document by Id.

Gets sibling documents in the recycle bin for a given descendant id

Gets root items for documents.

Gets sibling documents for a given descendant id

Get document types that are allowed at root level

Gets the document types that are allowed as children of a document type

Gets the document type Ids that may be a parent of the given document type. Counterpart of get-document-type-allowed-children — useful when validating where a content node of this type can be placed.

Gets the ancestors of a document type

Gets the ancestor chain (breadcrumb) for multiple document type Ids in one call. Returns one entry per requested Id, each containing that Id's chain of ancestors. Differs from get-document-type-ancestors which returns the tree-style ancestors of a single Id.

Gets the available compositions for a document type

Gets full document types for multiple Ids in one call. Returns each document type's properties, containers, compositions and allowed children, not just the lightweight item shape returned by get-document-types-by-id-array. Use when you need the same payload as get-document-type but for many Ids at once.

Gets the blueprints for a document type

Gets a document type by id

Gets the children of a document type. Use get-all-document-types instead unless you specifically need only child level items for a specific folder.

Gets the composition references for a document type

Gets the global configuration for document types

Gets a document type folder by Id

Gets the root level of the document type tree. Use get-all-document-types instead unless you specifically need only root level items.

Gets the JSON Schema for a document type by Id. Returns a complete JSON Schema describing the structure for creating documents of that type, including all property definitions and their value formats. IMPORTANT: Use this tool BEFORE creating documents to understand the expected property structure for a specific document type.

Gets sibling document types or document type folders for a given descendant id

Searches document types in tree-node shape (with hasChildren and parent for tree navigation). Optional itemKind filter accepts 'Item', 'Folder' or 'All'. Use this when paginating tree results; for a flat search of items use the corresponding item-search endpoint.

Gets document types by IDs (or empty array if no IDs are provided)

Gets the URLs for a document.

List document versions with pagination

Get specific document version by ID

Gets ancestor items for an element.

Check if element items are referenced Use this to verify if specific element items are being referenced by other content before deletion or modification.

Fetches the audit log for an element by Id.

Gets an element by id

Get items that reference a specific element item Use this to find all content, documents, or other items that are currently referencing a specific element item.

Gets child items for an element.

Gets the element configuration for the Umbraco instance.

Gets an element folder by Id

Get descendant references for an element folder Use this to find all descendant references (child items) that are being referenced for a specific element folder. Useful for: • Impact analysis: Before deleting an element folder, see what content would be affected • Dependency tracking: Find all content using elements from a specific folder hierarchy • Content auditing: Identify which descendant element items are actually being used

Gets the ancestor chain (breadcrumb) for multiple element Ids in one call. Returns one entry per requested Id, each containing that Id's chain of ancestors. Differs from get-element-ancestors which returns the tree-style ancestors of a single Id.

Gets the published version of an element by id. Unlike get-element-by-id, which returns the draft/current version, this returns only the data from the last published version of the element.

Gets root items for elements.

Gets sibling elements for a given descendant id.

List element versions with pagination

Get a specific element version by ID

Gets filtered user groups

Gets specific health check group details by name for system monitoring

Gets a paged list of health check groups for system monitoring

Returns a list of all available Umbraco icons that can be used in document types and element types

Generates resized image URLs for media items. Takes media item IDs and resize parameters to generate optimized image URLs. Returns an object containing: - Array of media items with their resize URL information - Each item includes the media ID and URL info with culture and resized URLs Parameters: - id: Array of media item UUIDs - height: Target height in pixels (default: 200) - width: Target width in pixels (default: 200) - mode: Resize mode (Crop, Max, Stretch, Pad, BoxPad, Min)

Lists all indexes with pagination support. Returns an object containing: - total: Total number of indexes (number) - items: Array of index objects with name, searcherName, and other properties

Gets a specific index by its name. Returns detailed information about the index including its configuration and status.

Gets document items by their ids

Gets element items by their ids

Gets element folder items by their ids

Gets media type items by their ids

Searches for member items

Gets user items for selection lists and pickers

Gets all languages with optional pagination

Gets a language by ISO code

Gets language items (optionally filtered by isoCode)

Get log viewer levels

Get log viewer level counts

Get log viewer logs

Get log viewer message templates

Get log viewer saved searches

Gets a saved search by name

Validates the size of the logs, for the given start and end date, or the lase day if not provided

Gets all manifests (both public and private) from the Umbraco installation. Each manifest contains an extensions property showing what the package exposes to Umbraco. Use to see which packages are installed, troubleshoot package issues, or list available extensions.

Gets private manifests from the Umbraco installation. Private manifests require authentication and contain administrative/sensitive extensions.

Gets public manifests from the Umbraco installation. Public manifests can be accessed without authentication and contain public-facing extensions.

Gets ancestor items for a media.

Gets the ancestor chain (breadcrumb) for multiple media Ids in one call. Returns one entry per requested Id, each containing that Id's chain of ancestors. Differs from get-media-ancestors which returns the tree-style ancestors of a single Id.

Check if media items are referenced Use this to verify if specific media items are being referenced by other content before deletion or modification.

Fetches the audit log for a media item by Id.

Gets a media item by id Use this to retrieve existing media items.

Gets media items by an array of IDs

Get items that reference a specific media item Use this to find all content, documents, or other items that are currently referencing a specific media item.

Get descendant references for a media item Use this to find all descendant references (child items) that are being referenced for a specific media item. Useful for: • Impact analysis: Before deleting a media folder, see what content would be affected • Dependency tracking: Find all content using media from a specific folder hierarchy • Content auditing: Identify which descendant media items are actually being used

Gets child items for a media.

Gets the media configuration for the Umbraco instance.

Gets sibling media items in the recycle bin for a given descendant id

Gets root items for media.

Gets sibling media items for a given descendant id

Get media types that are allowed at root level

Gets the media types that are allowed as children of a media type

Gets the media type Ids that may be a parent of the given media type. Counterpart of get-media-type-allowed-children — useful when validating where a media item of this type can be placed.

Gets the ancestors of a media type

Gets the ancestor chain (breadcrumb) for multiple media type Ids in one call. Returns one entry per requested Id, each containing that Id's chain of ancestors. Differs from get-media-type-ancestors which returns the tree-style ancestors of a single Id.

Gets the available compositions for a media type

Gets full media types for multiple Ids in one call. Returns each media type's properties, allowedMediaTypes and compositions, not just the lightweight item shape returned by get-media-type-by-ids. Use when you need the same payload as get-media-type-by-id but for many Ids at once.

Gets a media type by id

Gets media types by ids

Gets the children of a media type

Gets the composition references for a media type

Gets the configuration for media types

Gets a media type folder by Id

Lists media type folders with pagination support

Gets the root level of the media type tree

Gets the JSON Schema for a media type by Id. Returns a JSON Schema describing the structure for creating media of that type, including all property definitions and their value formats. IMPORTANT: Use this tool BEFORE creating media to understand the expected property structure for a specific media type.

Gets sibling media types or media type folders for a given descendant id

Gets the URLs for a media item.

Gets a member by Id

Gets the ancestor chain for multiple member Ids in one call. Members are flat in Umbraco, so the ancestors array is typically empty; exposed for parity with the other entity ancestors-batch endpoints.

Check if member accounts are referenced Use this to verify if specific member accounts are being referenced by content.

Get items that reference a specific member Use this to find all content, documents, or other items that are currently referencing a specific member account.

Get descendant references for a member Use this to find all descendant references that are being referenced for a specific member account.

Gets a member group by Id

Gets member groups by an array of IDs

Gets the root level of the member group tree

Gets a member type by Id

Gets the ancestor chain (breadcrumb) for multiple member type Ids in one call. Returns one entry per requested Id, each containing that Id's chain of ancestors.

Gets the available compositions for a member type

Gets full member types for multiple Ids in one call. Returns each member type's properties and compositions including the per-property memberCanEdit / memberCanView / isSensitive flags, not just the lightweight item shape returned by get-member-types-by-id-array. Use when you need the same payload as get-member-type-by-id but for many Ids at once.

Gets a member type by id

Gets the composition references for a member type

Gets the configuration for member types

Gets the root level of the member type tree

Gets the JSON Schema for a member type by Id. Returns a JSON Schema describing the structure for creating members of that type, including all property definitions and their value formats. IMPORTANT: Use this tool BEFORE creating members to understand the expected property structure for a specific member type.

Gets sibling member types or member type folders for a given descendant id

Gets member types by IDs (or empty array if no IDs are provided)

Gets members by IDs (or empty array if no IDs are provided)

Gets Models Builder dashboard information and current status. Returns an object containing: - mode: The Models Builder mode, one of: 'Nothing', 'InMemoryAuto', 'SourceCodeManual', 'SourceCodeAuto' (string) - canGenerate: Whether models can be generated (boolean) - outOfDateModels: Whether models are out of date (boolean) - lastError: Last error message if any (string | null) - version: Version information (string | null) - modelsNamespace: Namespace for generated models (string | null) - trackingOutOfDateModels: Whether tracking is enabled (boolean)

Gets the out-of-date status of Models Builder models. Returns an object containing: - status: The out-of-date status, one of: 'OutOfDate', 'Current', 'Unknown' (string)

Gets the ancestors of a partial view in the tree structure

Gets a partial view by its path

Gets the children of a partial view in the tree structure

Gets a partial view folder by its path

Gets the root partial views in the tree structure

Searches for partial views by name or path

Gets sibling partial views for a given descendant path

Gets partial view snippets with optional filtering

Gets a specific partial view snippet by its ID

Checks if a property type is used within Umbraco

Gets child items for a document in the recycle bin.

Get the original parent location of a document item in the recycle bin Returns information about where the document item was located before deletion.

Get references to deleted document items in the recycle bin Use this to find content that still references deleted document items before permanently deleting them.

Gets root items for the document recycle bin.

Gets child items for an element in the recycle bin.

Get the original parent location of an element folder in the recycle bin Returns information about where the element folder was located before deletion.

Get the original parent location of an element item in the recycle bin Returns information about where the element item was located before deletion.

Lists all content that references any deleted element in the recycle bin (not scoped to a specific element). Useful before emptying the recycle bin to see what still references deleted elements.

Gets root items for the element recycle bin.

Gets sibling elements in the recycle bin for a given descendant id.

Gets child items for a media item in the recycle bin.

Get the original parent location of a media item in the recycle bin Returns information about where the media item was located before deletion.

Get references to deleted media items in the recycle bin Use this to find content that still references deleted media items before permanently deleting them.

Gets root items for the media recycle bin.

Gets a specific redirect by its ID. Parameters: - id: The unique identifier of the redirect (string) Returns the redirect details.

Gets the current status of redirect management. Returns information about whether redirects are enabled and other status details.

Gets the document types and properties that use a specific data type. This is the recommended method to find all document types that reference a particular data type. Usage examples: - Find all document types using the RichText editor data type - Identify properties that reference a specific data type before modifying or deleting it - Perform bulk updates to all properties using a specific data type Returns a detailed list with content type information (id, type, name, icon) and all properties (name, alias) that use the specified data type. Results are paginated (20 per pag…

Gets relations by relation type ID

Gets all relation types with pagination

Gets a relation type by Id

Gets a script by path

Gets a script folder by path

Gets script items

Gets script tree ancestors

Gets script tree children

Gets script tree root

Gets sibling scripts for a given descendant path

Lists all searchers with pagination support. Returns an object containing: - total: Total number of searchers (number) - items: Array of searcher objects with name and isEnabled properties

Gets search results from a specific searcher by name with query parameters. Returns search results from the specified searcher with pagination support.

Gets the server configuration settings. Returns an object containing: - allowPasswordReset: Whether password reset is allowed (boolean) - versionCheckPeriod: The period between version checks in minutes (number) - allowLocalLogin: Whether local login is allowed (boolean) Example response: { "allowPasswordReset": true, "versionCheckPeriod": 1440, "allowLocalLogin": true }

Gets information about the Umbraco server. Returns an object containing: - version: The Umbraco version (string) - assemblyVersion: The assembly version (string) - baseUtcOffset: The server's UTC offset (string) - runtimeMode: The server's runtime mode, one of: 'BackofficeDevelopment', 'Development', 'Production' (string) Example response: { "version": "15.3.1", "assemblyVersion": "15.3.1.0", "baseUtcOffset": "-07:00:00", "runtimeMode": "BackofficeDevelopment" }

Gets the current status of the Umbraco server. Returns the server status (serverStatus) which can be one of: - Unknown: Status cannot be determined - Boot: Server is starting up - Install: Server is in installation mode - Upgrade: Server is performing an upgrade - Run: Server is running normally - BootFailed: Server failed to start Example response: { "serverStatus": "Run" }

Gets server troubleshooting information. Returns an array of diagnostic items, where each item contains: - name: The name/identifier of the diagnostic check (string) - data: The diagnostic data or result for that check (string) Example response: { "items": [ { "name": "Server OS", "data": "Darwin 23.6.0 Darwin Kernel Version 23.6.0: Mon Jul 29 21:14:30 PDT 2024; root:xnu-10063.141.2~1/RELEASE_ARM64_T6000" }, { "name": "Server Framework", "data": ".NET 9.0.0" }, { "name": "Default Language", "data": "en…

Checks the server upgrade status and requirements. Returns an object containing: - type: The type of upgrade information (string) - comment: A description or message about the upgrade (string) - url: A URL with more information about the upgrade (string) Example response: { "type": "UpgradeAvailable", "comment": "A new version of Umbraco is available", "url": "https://our.umbraco.com/download/releases/15.3.2" }

Gets ancestor folders for navigation breadcrumbs by descendant path

Lists child files and folders in a static file directory by parent path

Gets root-level static files and folders in the Umbraco file system

Lists static files with optional path filtering for browsing the file system

Gets the ancestors of a stylesheet in the tree structure

Gets a stylesheet by its path

Gets the children of a stylesheet in the tree structure

Gets a stylesheet folder by its path

Gets the root stylesheets in the tree structure

Searches for stylesheets by name or path

Gets sibling stylesheets for a given descendant path

Retrieves a paginated list of tags used in the Umbraco instance

Gets a template by Id

Gets the ancestors of a template by Id

Gets the ancestor chain (breadcrumb) for multiple template Ids in one call. Returns one entry per requested Id, each containing that Id's chain of ancestors. Differs from get-template-ancestors which returns the tree-style ancestors of a single Id.

Gets the children templates or template folders by the parent id

Gets template configuration settings including whether templates are disabled system-wide

Returns schema for template queries: available document types, properties, and operators

Gets root items for templates.

Searches the template tree for a template by name. It does NOT allow for searching for template folders.

Gets sibling templates for a given descendant id

Gets templates by IDs (or empty array if no IDs are provided)

Gets a temporary file by id

Gets the global configuration for temporary files This endpoint tells you the following - imageFileTypes - which files are considered as images - disallowedUploadedFilesExtensions - which file extensions are not allowed to be uploaded - allowedUploadedFileExtensions - which file extensions are allowed to be uploaded - maxFileSize - the maximum file size in bytes, if null then there is no limit

Lists users with pagination and filtering options

Gets multiple users identified by the provided Ids in one call.

Gets a user by their unique identifier

Calculates start nodes for a user by their ID based on permissions

Gets user configuration settings including user invitation settings and password requirements

Gets the current authenticated user's information

Gets current user configuration settings including login preferences and password requirements

Gets the current user's available login providers

Gets the current user's permissions for the specified entity

Gets the current user's document permissions for specific documents

Gets the current user's media permissions for specific media items

Retrieves user data records with pagination and filtering

Retrieves a specific personal key-value storage record by its unique identifier for the authenticated user. User data stores user preferences, settings, and configuration values that persist permanently and are organized by group (category) and identifier (key).

Gets a user group by Id

Gets user groups by an array of IDs

Gets all user groups

Gets a paged list of webhooks

Gets a webhook by id

Gets a list of available webhook events

Gets webhooks by IDs (or empty array if no IDs are provided)

Gets logs for a specific webhook. Results are paginated (100 per page by default). Check the returned "total" against the number of "items" returned - if total is greater, call again with "cursor" set to the returned "nextCursor" to page through the remaining logs.

Checks if a data type is used within Umbraco

Move a data type by Id

Moves a dictionary item by Id

Move a document to a new location

Moves a document blueprint by Id

Move a document to the recycle bin

Move a document type to a new location

Move an element to a new location

Moves an element folder to a new location

Moves an element folder to the recycle bin

Move an element to the recycle bin

Move a media item to a new location

Move a media item to the recycle bin

Move a media type to a new location

Adds public access settings to a document by Id.

Rebuilds a specific index by name. This operation will trigger a full rebuild of the index, which may take some time depending on the amount of content. Use this only when asked to by the user.

Create a new log viewer saved search

Triggers the generation/build of Models Builder models. This endpoint initiates the process of generating strongly-typed models from Umbraco content types. The operation runs asynchronously and does not return any response data. Use this tool to: - Generate models after making changes to document types, media types, or member types - Refresh models when they become out of date - Ensure the latest content type definitions are reflected in generated models Note: This operation may take some time to complete depending on the number of content types. Use get-models-builder-dashbo…

Publishes a document by Id. IMPORTANT: If workflow approval is required, use the initiate-workflow-action function instead. This function bypasses approval workflows and publishes directly to the live site. When the culture is not provided, the default culture is null. When the schedule is not provided, the default schedule is null.

Publishes a document and its descendants by Id. This is an asynchronous operation that may take time for large document trees. The tool will poll for completion and return the final result when finished.

Publishes an element by Id. IMPORTANT: If workflow approval is required, use the initiate-workflow-action function instead. This function bypasses approval workflows and publishes directly to the live site. When the culture is not provided, the default culture is null. When the schedule is not provided, the default schedule is null.

Updates the domains assigned to a document by Id. Default value of the defaultIsoCode is null. Domain isoCode in the domains array should be in the format of 'en-US' amd be a valid domain name from the Umbraco instance.

Updates the notifications for a document by Id.

Updates public access settings for a document by Id.

Renames a partial view

Renames a script by name and folder path

Renames a stylesheet

Restores a document from the recycle bin.

Restores an element folder from the recycle bin

Restores an element from the recycle bin.

Restores a media item from the recycle bin.

Rollback an element to a specific version

Executes health checks for a specific group. WARNING: This will run system diagnostics which may take time and could temporarily affect system performance.

Searches for documents by query, skip, and take.

Search for document types by name

Searches for elements by query, skip, and take.

Searches for member type items

Prevent cleanup for a specific element version

Sorts the order of documents under a parent.

Sorts the children of the document identified by Id by a system field (Name, CreateDate or UpdateDate) in the given direction (Ascending or Descending). This is DIFFERENT from sort-document: sort-document reorders children according to an explicit list of ids and sort orders you provide, whereas sort-document-children sorts every child of {id} automatically by the chosen field and direction - no explicit ordering is required. When sorting by Name, an optional culture selects which variant name to sort by; the culture is not validated, so children that do not vary by it (or an unrecognise…

Sorts the root-level documents by a system field (Name, CreateDate or UpdateDate) in the given direction (Ascending or Descending). This is the root-level equivalent of sort-document-children: it sorts every document at the root of the content tree automatically by the chosen field and direction - no explicit ordering is required. This is DIFFERENT from sort-document, which reorders documents according to an explicit list of ids and sort orders you provide. When sorting by Name, an optional culture selects which variant name to sort by; the culture is not validated, so documents that do …

Sorts the order of media items under a parent.

Sorts the children of the media item identified by Id by a system field (Name, CreateDate or UpdateDate) in the given direction (Ascending or Descending). This is DIFFERENT from sort-media: sort-media reorders children according to an explicit list of ids and sort orders you provide, whereas sort-media-children sorts every child of {id} automatically by the chosen field and direction - no explicit ordering is required.

Sorts the root-level media items by a system field (Name, CreateDate or UpdateDate) in the given direction (Ascending or Descending). This is the root-level equivalent of sort-media-children: it sorts every media item at the root of the media library automatically by the chosen field and direction - no explicit ordering is required. This is DIFFERENT from sort-media, which reorders media items according to an explicit list of ids and sort orders you provide.

Unpublishes a document by Id.

Unpublishes an element by Id.

Updates a document by Id and publishes it in a single operation. IMPORTANT: If workflow approval is required, use update-document followed by initiate-workflow-action instead. This function bypasses approval workflows and publishes directly to the live site. ### Cultures To Publish - culturesToPublish controls which of the document's variants get published. - Umbraco only accepts real culture codes here - wildcards ("*") and nulls are rejected with an error. - When the document does not vary by culture (invariant content), pass an empty array `[]` to publish the single invariant …

Updates an element by Id and publishes it in a single operation. ### Cultures To Publish - culturesToPublish controls which of the element's variants get published. - Umbraco only accepts real culture codes here - wildcards ("*") and nulls are rejected with an error. - When the element does not vary by culture (invariant content), pass an empty array `[]` to publish the single invariant variant. - When the element varies by culture, provide the culture codes of the variants you want published. If you must use this tool: - Always read the current element first with get-element-b…

Updates or adds property values within BlockList, BlockGrid, or RichText block content. This tool enables targeted updates to individual block properties without sending the entire JSON payload. You can update existing properties, add new properties, or do both in a single call. It automatically handles deep traversal of nested block structures (e.g., RichText blocks containing nested blocks). Key features: - Update existing properties or add new ones to blocks - Property must exist on the Element Type (including compositions) - Support for both content and settings blocks - …

Updates a data type by Id

Updates a data type folder by Id

Updates a dictionary item by Id

Updates a document by Id. USE AS LAST RESORT ONLY. IMPORTANT: Prefer these specialized tools instead: - update-document-name: For renaming a document (or a specific culture variant) - the safe way to change the name - update-document-properties: For updating individual property values (simpler, safer) - update-block-property: For updating properties within BlockList/BlockGrid/RichText blocks Only use this tool when you need to update document-level metadata (template, variants) or when the specialized tools cannot handle your specific use case. If you must use this tool: - A…

Updates a document blueprint by Id

Updates a document blueprint folder

Renames a document (or a specific culture variant of a document) without requiring the full document JSON payload. A document's name lives on its variant(s), not as a property, so update-document-properties cannot change it. This tool performs a surgical read-modify-write: it fetches the document, updates only the name of the matching variant, and leaves every other variant, all property values, and the template completely untouched. Key features: - Renames the invariant variant by default, or a specific culture's variant when 'culture' is provided - Validates 'culture' against t…

Updates or adds property values on a document without requiring the full document JSON payload. This tool simplifies property updates by handling the read-modify-write cycle internally. You can update existing properties, add new properties, or do both in a single call. Key features: - Update existing properties or add new ones - Property must exist on the document type (including compositions) - Full i18n support with culture and segment parameters - Automatic validation of property aliases against document type - Culture/segment requirements validated against property varia…

Updates a document type by Id

Updates a document type folder by Id

Prevent cleanup for a specific document version

Updates an element by Id. USE AS LAST RESORT ONLY. IMPORTANT: Prefer update-element-properties for changing individual property values — it is simpler and safer because it preserves everything else. Only use this tool when you must replace the element's values/variants wholesale, or change variant-level data the properties tool cannot handle. If you must use this tool: - Always read the current element first with get-element-by-id. - Send the full set of values AND variants — they are replaced wholesale, so any value or variant you omit is removed. - Include one variant entry pe…

Updates or adds property values within BlockList, BlockGrid, or RichText block content on an element. This tool enables targeted updates to individual block properties without sending the entire JSON payload. You can update existing properties, add new properties, or do both in a single call. It automatically handles deep traversal of nested block structures (e.g., RichText blocks containing nested blocks). Key features: - Update existing properties or add new ones to blocks - Property must exist on the Element Type (including compositions) - Support for both content and settin…

Updates an element folder

Updates or adds property values on an element without requiring the full element JSON payload. This tool simplifies property updates by handling the read-modify-write cycle internally. You can update existing properties, add new properties, or do both in a single call. Key features: - Update existing properties or add new ones - Property must exist on the element type (including compositions) - Full i18n support with culture and segment parameters - Automatic validation of property aliases against element type - Culture/segment requirements validated against property variance…

Updates an existing language by ISO code

Updates a media item by Id. Works for all media types including folders, images, files, videos, etc. Always read the current media value first and only update the required values. Don't miss any properties from the original media that you are updating. This cannot be used for moving media to a new folder. Use the move endpoint to do that.

Updates a media type by Id

Updates a media type folder by Id

Updates a member by Id

Updates a member group by Id

Updates a member type by id

Updates a partial view

Updates a script by path

Updates a stylesheet by path

Updates a template by Id

Updates an existing user data record

Updates a user group by Id

Updates a webhook by id

Uploads an avatar for a specific user by ID (admin only or self-service)

Uploads an avatar for the current authenticated user

Validates a create document model, using the Umbraco API.

Validates a document type using the Umbraco API (PUT, does not persist changes).

Validates a document type using the Umbraco API (POST, does not persist changes).

Validates a create element model, using the Umbraco API.

Validates the request model for updating an element without actually updating it.

Validates a media item using the Umbraco API.

Validates media data before updating an existing media item by Id

Validates member data before creation using the Umbraco API. Use this endpoint to validate member data structure, properties, and business rules before attempting to create a new member.

Validates member data before updating using the Umbraco API. Use this endpoint to validate member data structure, properties, and business rules before attempting to update an existing member.