| `query` | A simple query returning full or partial matches. |
| `types` | A comma-separated list of specific content type variables. |
| `sites` | A comma-separated list of site identifiers or keys. |
|\n| `page` | Integer | Which page of results to show. Defaults to `1`. |\n| `perPage` | Integer | Number of results to display per page. Defaults to `10`. |\n| `orderBy` | String | Sorting parameter: `name` (default), `velocity_var_name`, `mod_date`, or `sort_order`. |\n| `direction` | String | `ASC` (default) or `DESC` for ascending or descending. |","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilteredContentTypesForm"},"example":{"filter":{"query":"","types":"Blog,Activity","sites":"demo.dotcms.com,SYSTEM_HOST"},"page":1,"perPage":10,"orderBy":"name","direction":"ASC"}}},"required":true},"responses":{"200":{"description":"Content types filtered successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityListContentTypeView"},"example":{"entity":[{"baseType":"string","clazz":"string","defaultType":true,"description":"string","fixed":false,"folder":"string","folderPath":"string","host":"string","iDate":0,"icon":"string","id":"string","layout":[],"metadata":{},"modDate":0,"multilingualable":true,"nEntries":0,"name":"string","siteName":"string","sortOrder":0,"system":true,"variable":"string","versionable":true,"workflows":[]}],"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":{"currentPage":0,"perPage":0,"totalEntries":0},"permissions":[]}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"415":{"description":"Unsupported Media Type"},"500":{"description":"Internal Server Error"}}}},"/api/v1/contenttype/page":{"get":{"tags":["getPagesContentTypes","Content Type"],"summary":"Retrieves a list of content types for a page","description":"Returns a list of content type objects based on the filtering criteria.","operationId":"getPagesContentTypes","parameters":[{"name":"pagePathOrId","in":"query","description":"The URL or Identifier of the page to filter content types for the palette","schema":{"type":"string"}},{"name":"language","in":"query","description":"Optional Language id","schema":{"type":"string","default":"-1"}},{"name":"filter","in":"query","description":"String to filter/search for specific content types; leave blank to return all.","schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number in response pagination.\n\nDefault: `1`","schema":{"type":"integer","format":"int64","default":1}},{"name":"per_page","in":"query","description":"Number of results per page for pagination.\n\nDefault: `10`","schema":{"type":"integer","format":"int64","default":10}},{"name":"orderby","in":"query","description":"Column(s) to sort the results. Multiple columns can be combined in a comma-separated list. Column names can also be set within a SQL string function, such as `upper()`.\n\nSome possible values:\n\n`name`, `velocity_var_name`, `mod_date`, `sort_order`\n\n`description`, `structuretype`, `category`, `inode`","schema":{"type":"string","default":"usage"}},{"name":"direction","in":"query","description":"Sort direction: choose between ascending or descending.","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}},{"name":"type","in":"query","description":"List of variable names of [base content type](https://www.dotcms.com/docs/latest/base-content-types).","style":"form","schema":{"type":"array","items":{"type":"string","enum":["ANY","CONTENT","WIDGET","FORM","FILEASSET","HTMLPAGE","PERSONA","VANITY_URL","KEY_VALUE","DOTASSET"]},"enum":["ANY","CONTENT","WIDGET","FORM","FILEASSET","HTMLPAGE","PERSONA","VANITY_URL","KEY_VALUE","DOTASSET"]}},{"name":"host","in":"query","description":"Filter by site identifier.","schema":{"type":"string"}}],"responses":{"200":{"description":"Content types retrieved successfully","content":{"application/json":{"example":{"entity":[{"baseType":"string","clazz":"string","defaultType":true,"description":"string","fixed":true,"folder":"string","folderPath":"string","host":"string","iDate":0,"icon":"string","id":"string","layout":[],"metadata":{},"modDate":0,"multilingualable":true,"nEntries":0,"name":"string","siteName":"string","sortOrder":0,"system":true,"variable":"string","versionable":true,"workflows":[]}],"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":{"currentPage":0,"perPage":0,"totalEntries":0},"permissions":[]}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/api/v1/contenttype/basetypes":{"get":{"tags":["Content Type"],"summary":"Retrieves base content types","description":"Returns a list of base content types.","operationId":"getContentTypeBaseTypes","responses":{"200":{"description":"Base content types retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityBaseContentTypesView"},"example":{"entity":[{"index":"int","label":"string","name":"string","types":null}],"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"500":{"description":"Internal Server Error"}}}},"/api/v1/contenttype/render/id/{idOrVar}":{"get":{"tags":["Content Type"],"summary":"Retrieves a single content type with their rendered custom fields","description":"Returns a content type based on the provided ID or Velocity variable name. Additionally, the Velocity code in all of its custom fields will be parsed.","operationId":"getContentTypeRenderedCustomFieldIdVar","parameters":[{"name":"idOrVar","in":"path","description":"The ID or Velocity variable name of the content type to retrieve.\n\nVariable name example: `htmlpageasset` (Default page content type)","required":true,"schema":{"type":"string"}},{"name":"languageId","in":"query","description":"The language ID for localization.","schema":{"type":"integer","format":"int64"}},{"name":"live","in":"query","description":"Determines whether live versions of language variables are used in the returned object.","schema":{"type":"boolean"}},{"name":"inode","in":"query","description":"Optional contentlet inode. When provided, contentlet-specific Velocity variables ($inode, $identifier, $lang, etc.) will be available when rendering Custom Fields.","schema":{"type":"string"}}],"responses":{"200":{"description":"Content type retrieved successfully","content":{"application/json":{"example":{"entity":[{"baseType":"string","clazz":"string","defaultType":true,"description":"string","fields":[],"fixed":false,"folder":"string","folderPath":"string","host":"string","iDate":0,"icon":"string","id":"string","layout":[],"metadata":{},"modDate":0,"multilingualable":true,"name":"string","siteName":"string","sortOrder":0,"system":true,"variable":"string","systemActionMappings":{},"versionable":true,"workflows":[]}],"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":{"currentPage":0,"perPage":0,"totalEntries":0},"permissions":[]}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/api/v1/contenttype/id/{idOrVar}/metadata":{"patch":{"tags":["Content Type"],"summary":"Updates the metadata of a Content Type","description":"Merges the provided key/value pairs into the Content Type's `metadata` map without touching fields, workflows, or any other structural property. Keys present in the body are added or overwritten; keys absent from the body are left unchanged. To remove a key, set its value explicitly to `null`.\n\nKnown metadata keys:\n- `CONTENT_EDITOR2_ENABLED` *(boolean)* — enables the new content editor\n- `DOT_STYLE_EDITOR_SCHEMA` *(JSON string)* — Style Editor schema definition","operationId":"updateContentTypeMetadata","parameters":[{"name":"idOrVar","in":"path","description":"The ID or Velocity variable name of the Content Type to update.\n\nExample value: `htmlpageasset` (Default page content type)","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A flat JSON object whose keys are merged into the Content Type's existing metadata. Set a key's value to `null` to remove it. An absent or empty body is treated as a no-op — the current metadata is returned unchanged with HTTP 200.","content":{"application/json":{"schema":{"type":"object","description":"Metadata key/value pairs to merge"},"example":{"DOT_STYLE_EDITOR_SCHEMA":"{\"contentType\":\"htmlpageasset\",\"sections\":[{\"title\":\"New Section\",\"fields\":[{\"type\":\"dropdown\",\"label\":\"Color\",\"id\":\"color\",\"config\":{\"options\":[{\"label\":\"Red\",\"value\":\"red\"}]}}]}]}"}}}},"responses":{"200":{"description":"Metadata updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityContentTypeDetailView"}}}},"400":{"description":"Bad request — invalid JSON body"},"401":{"description":"User not authenticated"},"403":{"description":"User does not have permission to edit this Content Type"},"404":{"description":"Content Type not found"},"500":{"description":"Internal server error"}}}},"/api/v1/contenttype/{typeId}/fields":{"get":{"tags":["Content Type Field"],"summary":"Get content type fields (deprecated)","description":"Retrieves all fields for a specific content type. Use v2 API instead for new implementations.","operationId":"getContentTypeFieldsV1","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Fields retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityListMapView"}}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{}}},"404":{"description":"Content type not found","content":{"application/json":{}}},"500":{"description":"Internal server error","content":{"application/json":{}}}},"deprecated":true},"put":{"tags":["Content Type Field"],"summary":"Update content type fields (deprecated)","description":"Updates multiple fields for a content type. Use v2 API instead.","operationId":"updateContentTypeFieldsV1","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Array of field objects to save on the content type.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContentTypeFieldView"}}}},"required":true},"responses":{"200":{"description":"Fields updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityListMapView"}}}},"400":{"description":"Bad request - invalid field data","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{}}},"404":{"description":"Not found - content type not found","content":{"application/json":{}}}},"deprecated":true},"post":{"tags":["Content Type Field"],"summary":"Create content type field (deprecated)","description":"Creates a new field for a content type. Use v2 API instead.","operationId":"createContentTypeFieldV1","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"A SINGLE field object to create on the content type. This endpoint creates exactly one field: if you pass a JSON array, only the first element is saved (it returns 200 and silently drops the rest). To add multiple fields at once, use PUT /api/v1/contenttype/{typeId}/fields (which takes an array), or include them inline as the 'fields' array when creating the content type via POST /api/v1/contenttype.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentTypeFieldView"}}},"required":true},"responses":{"200":{"description":"Field created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityMapStringObjectView"}}}},"400":{"description":"Bad request - invalid field data","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{}}},"404":{"description":"Not found - content type not found","content":{"application/json":{}}}},"deprecated":true},"delete":{"tags":["Content Type Field"],"summary":"Delete multiple fields (deprecated)","description":"Deletes multiple fields from a content type by their field IDs. Use v2 API instead for new implementations.","operationId":"deleteContentTypeFieldsV1","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Array of field IDs to delete","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"Fields deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityMapView"}}}},"400":{"description":"Bad request - invalid field IDs","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{}}},"404":{"description":"Content type or one or more fields not found","content":{"application/json":{}}},"500":{"description":"Internal server error","content":{"application/json":{}}}},"deprecated":true}},"/api/v1/contenttype/{typeId}/fields/id/{fieldId}":{"get":{"tags":["Content Type Field"],"summary":"Get content type field by ID (deprecated)","description":"Retrieves a specific field from a content type by its unique field ID. Use v2 API instead for new implementations.","operationId":"getContentTypeFieldByIdV1","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","description":"Field ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Field retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityMapStringObjectView"}}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{}}},"404":{"description":"Content type or field not found","content":{"application/json":{}}},"500":{"description":"Internal server error","content":{"application/json":{}}}},"deprecated":true},"put":{"tags":["Content Type Field"],"summary":"Update content type field by ID (deprecated)","description":"Updates a specific field in a content type by its field ID. Use v2 API instead for new implementations.","operationId":"updateContentTypeFieldByIdV1","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","description":"Field ID to update","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Field JSON data with updates","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Field updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityMapStringObjectView"}}}},"400":{"description":"Bad request - invalid field data or missing field ID","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{}}},"404":{"description":"Content type or field not found","content":{"application/json":{}}},"500":{"description":"Internal server error","content":{"application/json":{}}}},"deprecated":true},"delete":{"tags":["Content Type Field"],"summary":"Delete content type field by ID (deprecated)","description":"Deletes a specific field from a content type by its field ID. Use v2 API instead for new implementations.","operationId":"deleteContentTypeFieldByIdV1","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","description":"Field ID to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Field deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{}}},"404":{"description":"Content type or field not found","content":{"application/json":{}}},"500":{"description":"Internal server error","content":{"application/json":{}}}},"deprecated":true}},"/api/v1/contenttype/{typeId}/fields/var/{fieldVar}":{"get":{"tags":["Content Type Field"],"summary":"Get content type field by variable name (deprecated)","description":"Retrieves a specific field from a content type by its variable name. Use v2 API instead for new implementations.","operationId":"getContentTypeFieldByVariableV1","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","description":"Field variable name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Field retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityMapStringObjectView"}}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{}}},"404":{"description":"Content type or field not found","content":{"application/json":{}}},"500":{"description":"Internal server error","content":{"application/json":{}}}},"deprecated":true},"put":{"tags":["Content Type Field"],"summary":"Update content type field by variable name (deprecated)","description":"Updates a specific field in a content type by its variable name. Use v2 API instead for new implementations.","operationId":"updateContentTypeFieldByVariableV1","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","description":"Field variable name to update","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Field JSON data with updates","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Field updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityMapStringObjectView"}}}},"400":{"description":"Bad request - invalid field data","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{}}},"404":{"description":"Content type or field not found","content":{"application/json":{}}},"500":{"description":"Internal server error","content":{"application/json":{}}}},"deprecated":true},"delete":{"tags":["Content Type Field"],"summary":"Delete content type field by variable name (deprecated)","description":"Deletes a specific field from a content type by its variable name. Use v2 API instead for new implementations.","operationId":"deleteContentTypeFieldByVariableV1","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","description":"Field variable name to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Field deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{}}},"404":{"description":"Content type or field not found","content":{"application/json":{}}},"500":{"description":"Internal server error","content":{"application/json":{}}}},"deprecated":true}},"/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables":{"get":{"tags":["Content Type Field"],"summary":"Get field variables by field ID","description":"Retrieves all field variables for a specific field identified by its ID","operationId":"getFieldVariablesByFieldId","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","description":"Field ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Field variables retrieved successfully","content":{"application/json":{}}},"404":{"description":"Not found - field not found","content":{"application/json":{}}}}},"post":{"tags":["Content Type Field"],"summary":"Create field variable by field ID","description":"Creates a new field variable for a specific field identified by its ID","operationId":"createFieldVariableByFieldId","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","description":"Field ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Field variable data","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Field variable created successfully","content":{"application/json":{}}},"400":{"description":"Bad request - invalid field variable data","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{}}},"404":{"description":"Not found - field not found","content":{"application/json":{}}}}}},"/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables":{"get":{"tags":["Content Type Field"],"summary":"Get field variables by field variable name","description":"Retrieves all field variables for a specific field identified by its velocity variable name","operationId":"getFieldVariablesByFieldVar","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","description":"Field velocity variable name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Field variables retrieved successfully","content":{"application/json":{}}},"404":{"description":"Not found - field not found","content":{"application/json":{}}}}},"post":{"tags":["Content Type Field"],"summary":"Create field variable by field variable name","description":"Creates a new field variable for a specific field identified by its velocity variable name","operationId":"createFieldVariableByFieldVar","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","description":"Field velocity variable name","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Field variable data","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Field variable created successfully","content":{"application/json":{}}},"400":{"description":"Bad request - invalid field variable data","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{}}},"404":{"description":"Not found - field not found","content":{"application/json":{}}}}}},"/api/v1/contenttype/{typeId}/fields/id/{fieldId}/variables/id/{fieldVarId}":{"get":{"tags":["Content Type Field"],"summary":"Get specific field variable by field ID","description":"Retrieves a specific field variable by field ID and variable ID","operationId":"getFieldVariableByFieldId","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","description":"Field ID","required":true,"schema":{"type":"string"}},{"name":"fieldVarId","in":"path","description":"Field variable ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Field variable retrieved successfully","content":{"application/json":{}}},"404":{"description":"Not found - field or field variable not found","content":{"application/json":{}}}}},"put":{"tags":["Content Type Field"],"summary":"Update field variable by field ID","description":"Updates an existing field variable for a specific field identified by its ID","operationId":"updateFieldVariableByFieldId","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","description":"Field ID","required":true,"schema":{"type":"string"}},{"name":"fieldVarId","in":"path","description":"Field variable ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Updated field variable data","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Field variable updated successfully","content":{"application/json":{}}},"400":{"description":"Bad request - invalid field variable data","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{}}},"404":{"description":"Not found - field or field variable not found","content":{"application/json":{}}}}},"delete":{"tags":["Content Type Field"],"summary":"Delete field variable by field ID","description":"Deletes a specific field variable for a field identified by its ID","operationId":"deleteFieldVariableByFieldId","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}},{"name":"fieldId","in":"path","description":"Field ID","required":true,"schema":{"type":"string"}},{"name":"fieldVarId","in":"path","description":"Field variable ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Field variable deleted successfully","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{}}},"404":{"description":"Not found - field or field variable not found","content":{"application/json":{}}}}}},"/api/v1/contenttype/{typeId}/fields/var/{fieldVar}/variables/id/{fieldVarId}":{"get":{"tags":["Content Type Field"],"summary":"Get specific field variable by field variable name","description":"Retrieves a specific field variable by field velocity variable name and variable ID","operationId":"getFieldVariableByFieldVar","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","description":"Field velocity variable name","required":true,"schema":{"type":"string"}},{"name":"fieldVarId","in":"path","description":"Field variable ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Field variable retrieved successfully","content":{"application/json":{}}},"404":{"description":"Not found - field or field variable not found","content":{"application/json":{}}}}},"put":{"tags":["Content Type Field"],"summary":"Update field variable by field variable name","description":"Updates an existing field variable for a specific field identified by its velocity variable name","operationId":"updateFieldVariableByFieldVar","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","description":"Field velocity variable name","required":true,"schema":{"type":"string"}},{"name":"fieldVarId","in":"path","description":"Field variable ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Updated field variable data","content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Field variable updated successfully","content":{"application/json":{}}},"400":{"description":"Bad request - invalid field variable data","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{}}},"404":{"description":"Not found - field or field variable not found","content":{"application/json":{}}}}},"delete":{"tags":["Content Type Field"],"summary":"Delete field variable by field variable name","description":"Deletes a specific field variable for a field identified by its velocity variable name","operationId":"deleteFieldVariableByFieldVar","parameters":[{"name":"typeId","in":"path","description":"Content type ID","required":true,"schema":{"type":"string"}},{"name":"fieldVar","in":"path","description":"Field velocity variable name","required":true,"schema":{"type":"string"}},{"name":"fieldVarId","in":"path","description":"Field variable ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Field variable deleted successfully","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{}}},"404":{"description":"Not found - field or field variable not found","content":{"application/json":{}}}}}},"/api/v1/ema":{"get":{"tags":["Apps"],"operationId":"getDetails","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/ws/v1/system/events":{"get":{"tags":["Administration"],"operationId":"getEvents","parameters":[{"name":"lastcallback","in":"query","schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/ws/v1/system/syncevents":{"get":{"tags":["Administration"],"operationId":"getSyncEvents","parameters":[{"name":"lastcallback","in":"query","schema":{"type":"integer","format":"int64"}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/experiments/{experimentId}/variants":{"post":{"tags":["Experiment"],"operationId":"addVariant","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddVariantForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{experimentId}/_archive":{"put":{"tags":["Experiment"],"operationId":"archive","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityExperimentView"}}}}}}},"/api/v1/experiments/scheduled/{experimentId}/_cancel":{"post":{"tags":["Experiment"],"operationId":"cancel","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments":{"get":{"tags":["Experiment"],"operationId":"list","parameters":[{"name":"pageId","in":"query","schema":{"type":"string"}},{"name":"name","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["RUNNING","SCHEDULED","ENDED","DRAFT","ARCHIVED"]}}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityExperimentView"}}}}}},"post":{"tags":["Experiment"],"operationId":"create_2","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExperimentForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{experimentId}":{"delete":{"tags":["Experiment"],"operationId":"delete_6","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewString"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityViewString"}}}}}},"patch":{"tags":["Experiment"],"operationId":"update_2","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExperimentForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{experimentId}/goals/primary":{"delete":{"tags":["Experiment"],"operationId":"deleteGoal","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{experimentId}/targetingConditions/{id}":{"delete":{"tags":["Experiment"],"operationId":"deleteTargetingCondition","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{experimentId}/variants/{name}":{"put":{"tags":["Experiment"],"operationId":"updateVariant","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperimentVariantForm"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ExperimentVariantForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}},"delete":{"tags":["Experiment"],"operationId":"deleteVariant","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{experimentId}/_end":{"post":{"tags":["Experiment"],"operationId":"end","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{id}":{"get":{"tags":["Experiment"],"operationId":"get_3","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{id}/results":{"get":{"tags":["Experiment"],"operationId":"getResult","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityExperimentResults"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityExperimentResults"}}}}}}},"/api/v1/experiments/health":{"get":{"tags":["Experiment"],"operationId":"healthcheck","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}}}}},"/api/v1/experiments/isUserIncluded":{"post":{"tags":["Experiment"],"operationId":"isUserIncluded","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExcludedExperimentListForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityExperimentSelectedView"}}}}}}},"/api/v1/experiments/{experimentId}/variants/{name}/_promote":{"put":{"tags":["Experiment"],"operationId":"promoteVariant","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExperimentVariantForm"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ExperimentVariantForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/experiments/{experimentId}/_start":{"post":{"tags":["Experiment"],"operationId":"start","parameters":[{"name":"experimentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}},"application/javascript":{"schema":{"$ref":"#/components/schemas/ResponseEntitySingleExperimentView"}}}}}}},"/api/v1/content/fileassets/{inode}/resourcelink":{"get":{"tags":["File Assets"],"operationId":"findResourceLink_1","parameters":[{"name":"inode","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json;charset=UTF-8":{}}}}}},"/api/v1/folder/createfolders/{siteName}":{"post":{"tags":["Folders"],"summary":"Create folders by paths on a site","description":"Creates one or more folders on the specified site. The request body is a raw JSON array of folder paths (e.g., [\"/path1\", \"/path2/subpath\"]). Nested paths will create intermediate folders as needed.","operationId":"createFoldersBySiteName","parameters":[{"name":"siteName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"Folders created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityListView"}}}},"401":{"description":"Authentication required"},"403":{"description":"Insufficient permissions"},"404":{"description":"Site not found"}}}},"/api/v1/folder/{siteName}":{"delete":{"tags":["Folders"],"summary":"Delete one or more path for a site","description":"Delete one or more path for a site if they exist","operationId":"deleteFoldersBySiteName","parameters":[{"name":"siteName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"Folders deleted successfully","content":{"application/json":{"example":{"entity":["/folder-1/folder-2/target-folder"],"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"401":{"description":"Unauthorized access"},"404":{"description":"Folders not found"},"403":{"description":"Insufficient permissions to delete folders"}}}},"/api/v1/folder/{folderId}":{"get":{"tags":["Folders"],"summary":"Find a folder by ID","description":"Retrieves a folder by its identifier. Returns 404 if the folder does not exist.","operationId":"findFolderById","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Folder retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityFolderView"}}}},"401":{"description":"Authentication required"},"403":{"description":"Insufficient permissions"},"404":{"description":"Folder not found"}}}},"/api/v1/folder/byPath":{"post":{"tags":["Folders"],"summary":"Find subfolders by path (deprecated)","description":"Retrieves subfolders of a given path, filtered by the path sent. This endpoint is deprecated — use GET /api/v1/folder/search instead.","operationId":"findSubFoldersByPath","parameters":[{"name":"offset","in":"query","description":"Number of results to skip for pagination. Must be >= 0.","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Maximum number of results to return. Default 40. Use -1 for unlimited (capped at 10000 as a safety limit).","schema":{"type":"integer","format":"int32","default":40}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SearchByPathForm"}}}},"responses":{"200":{"description":"Subfolders retrieved successfully (deprecated endpoint)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityFolderSearchResultView"}}}},"400":{"description":"Path property must be sent"},"401":{"description":"Authentication required"},"403":{"description":"Insufficient permissions"},"404":{"description":"Site not found"}},"deprecated":true}},"/api/v1/folder/siteId/{siteId}/path/{path}":{"get":{"tags":["Folders"],"summary":"Load folder and subfolders by path","description":"Finds a folder by the given path within the specified site and returns the folder along with all its subfolders, respecting the user's permissions.","operationId":"loadFolderAndSubFoldersByPath","parameters":[{"name":"siteId","in":"path","required":true,"schema":{"type":"string"}},{"name":"path","in":"path","required":true,"schema":{"pattern":".+","type":"string"}}],"responses":{"200":{"description":"Folder and subfolders retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityFolderWithSubfoldersView"}}}},"401":{"description":"Authentication required"},"403":{"description":"Insufficient permissions"},"404":{"description":"Folder not found"}}}},"/api/v1/folder/sitename/{siteName}/uri/{uri}":{"get":{"tags":["Folders"],"summary":"Load a folder by site name and URI","description":"Retrieves a folder by its URI path within the specified site.","operationId":"loadFolderByURI","parameters":[{"name":"siteName","in":"path","description":"Site hostname the folder lives on (e.g. 'demo.dotcms.com').","required":true,"schema":{"type":"string"}},{"name":"uri","in":"path","description":"Folder path within the site, as a plain path — e.g. 'application/themes/travel' (a leading slash is optional and added if missing). Embedded slashes are allowed (they select nested folders). Pass the raw path; do NOT percent-encode the slashes (a pre-encoded '%2F...' will not match).","required":true,"schema":{"pattern":".+","type":"string"}}],"responses":{"200":{"description":"Folder retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityFolderView"}}}},"401":{"description":"Authentication required"},"403":{"description":"Insufficient permissions"},"404":{"description":"Folder not found"}}}},"/api/v1/folder/search":{"get":{"tags":["Folders"],"summary":"Search folders","description":"Returns folders within a site matching an optional name filter and/or path scope. Supports recursive depth control, standard pagination, and sorting. With no 'name' and default path '/' + recursive=true, all site folders are returned. Each folder carries the detail fields a folder-edit form needs (title, sortOrder, filesMasks, defaultFileType, showOnMenu, defaultBaseType). Set 'includePermissions=true' to also receive the permission types the requesting user holds on each folder; that flag caps 'perPage' (see the parameter description).","operationId":"searchFolders","parameters":[{"name":"name","in":"query","description":"Optional case-insensitive partial match on folder name (minimum 2 characters when provided)","schema":{"type":"string"}},{"name":"path","in":"query","description":"Path scope for the search. Defaults to '/' (site root).","schema":{"type":"string","default":"/"}},{"name":"recursive","in":"query","description":"false = direct children of 'path' only (default); true = search all descendants","schema":{"type":"boolean","default":false}},{"name":"siteId","in":"query","description":"Site ID to scope the search (required)","schema":{"type":"string"}},{"name":"orderby","in":"query","description":"Column to sort by.","schema":{"type":"string","enum":["name","mod_date"],"default":"name"}},{"name":"direction","in":"query","description":"Sort direction","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}},{"name":"page","in":"query","description":"Page number (1-based, default 1)","schema":{"type":"integer","format":"int32","default":1}},{"name":"per_page","in":"query","description":"Number of results per page (default 40)","schema":{"type":"integer","format":"int32","default":40}},{"name":"includePermissions","in":"query","description":"When true, each returned folder includes a 'permissions' array with the permission types the requesting user holds on it (READ, EDIT, PUBLISH, EDIT_PERMISSIONS, CAN_ADD_CHILDREN). When false (the default) 'permissions' is null — meaning 'not requested', which is not the same as an empty array ('requested, no grants'). Because permissions are resolved per page, enabling this flag caps 'perPage' at the value of the 'content.drive.folder.search.permissions.max.per.page' configuration property (default 200); a larger 'perPage' is rejected with a 400.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Paginated list of matching folders","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityFolderSearchView"}}}},"400":{"description":"'siteId' is required; 'name' must be at least 2 characters if provided; 'perPage' exceeds the maximum allowed when 'includePermissions' is true"},"401":{"description":"User is not authenticated"},"500":{"description":"Internal server error"}}}},"/api/v1/folder/{id}/file-browser-selected":{"put":{"tags":["Folders"],"summary":"Select folder in file browser","description":"Marks a folder as the currently selected folder in the file browser session.","operationId":"selectFolderInFileBrowser","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Folder selected successfully"},"401":{"description":"Authentication required"}}}},"/api/v1/form/{idOrVar}/successCallback":{"get":{"tags":["Forms"],"operationId":"getSuccessCallbackFunction","parameters":[{"name":"idOrVar","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/javascript":{}}}}}},"/api/v1/health/check/{checkName}":{"get":{"tags":["Health"],"summary":"Get specific health check result","description":"Returns the result of a specific health check identified by name. Useful for monitoring individual components or debugging specific health issues.","operationId":"getHealthCheck","parameters":[{"name":"checkName","in":"path","description":"Name of the health check to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved health check result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"403":{"description":"Forbidden - Authentication required"},"404":{"description":"Health check not found"},"500":{"description":"Internal Server Error"}}}},"/api/v1/health/checks":{"get":{"tags":["Health"],"summary":"Get all health check names","description":"Returns a list of all registered health check names. Useful for discovering available health checks and building monitoring interfaces.","operationId":"getHealthCheckNames","responses":{"200":{"description":"Successfully retrieved health check names","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"403":{"description":"Forbidden - Authentication required"},"500":{"description":"Internal Server Error"}}}},"/api/v1/health/liveness":{"get":{"tags":["Health"],"summary":"Get liveness health status","description":"Returns liveness health checks suitable for application dashboards. This endpoint provides detailed JSON information about critical system components required for the application to be considered alive.","operationId":"getLivenessHealth","responses":{"200":{"description":"Successfully retrieved liveness health status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"403":{"description":"Forbidden - Authentication required"},"500":{"description":"Internal Server Error"}}}},"/api/v1/health":{"get":{"tags":["Health"],"summary":"Get overall health status","description":"Returns comprehensive health status including all registered health checks. Authentication requirements are controlled by the health.detailed.authentication.required configuration property.","operationId":"getOverallHealth","responses":{"200":{"description":"Successfully retrieved overall health status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"403":{"description":"Forbidden - Authentication required"},"500":{"description":"Internal Server Error"}}}},"/api/v1/health/readiness":{"get":{"tags":["Health"],"summary":"Get readiness health status","description":"Returns readiness health checks to determine if the application is ready to receive traffic. This endpoint provides detailed JSON information about system components required for the application to be considered ready to serve requests.","operationId":"getReadinessHealth","responses":{"200":{"description":"Successfully retrieved readiness health status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"500":{"description":"Internal Server Error"}}}},"/api/v1/health/status":{"get":{"tags":["Health"],"summary":"Get system status summary","description":"Returns a simple boolean summary of system health status with alive and ready flags. Provides a quick overview of system health without detailed check information.","operationId":"getSystemStatus","responses":{"200":{"description":"Successfully retrieved system status summary","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"403":{"description":"Forbidden - Authentication required"},"500":{"description":"Internal Server Error"}}}},"/api/v1/health/refresh/{checkName}":{"post":{"tags":["Health"],"summary":"Force refresh a specific health check","description":"Triggers an immediate refresh of a specific health check identified by name, bypassing any caching mechanisms. Useful for testing individual components or getting up-to-date status after targeted maintenance.","operationId":"refreshHealthCheck","parameters":[{"name":"checkName","in":"path","description":"Name of the health check to refresh","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully refreshed the health check","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"403":{"description":"Forbidden - Authentication required"},"404":{"description":"Health check not found"},"500":{"description":"Internal Server Error"}}}},"/api/v1/health/refresh":{"post":{"tags":["Health"],"summary":"Force refresh all health checks","description":"Triggers an immediate refresh of all registered health checks, bypassing any caching mechanisms. Useful for getting up-to-date health status after configuration changes or system maintenance.","operationId":"refreshHealthChecks","responses":{"200":{"description":"Successfully triggered health checks refresh","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"403":{"description":"Forbidden - Authentication required"},"500":{"description":"Internal Server Error"}}}},"/api/v1/esindex/activate/{params}":{"put":{"tags":["Search Index"],"operationId":"activateIndex","parameters":[{"name":"params","in":"path","required":true,"schema":{"pattern":".*","type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"deprecated":true}},"/api/v1/esindex/clear/{params}":{"put":{"tags":["Search Index"],"operationId":"clearIndex","parameters":[{"name":"params","in":"path","required":true,"schema":{"pattern":".*","type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"deprecated":true}},"/api/v1/esindex/close/{params}":{"put":{"tags":["Search Index"],"operationId":"closeIndex","parameters":[{"name":"params","in":"path","required":true,"schema":{"pattern":".*","type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"deprecated":true}},"/api/v1/esindex/create/{params}":{"put":{"tags":["Search Index"],"operationId":"createIndex","parameters":[{"name":"params","in":"path","required":true,"schema":{"pattern":".*","type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/plain":{}}}},"deprecated":true}},"/api/v1/esindex/deactivate/{params}":{"put":{"tags":["Search Index"],"operationId":"deactivateIndex","parameters":[{"name":"params","in":"path","required":true,"schema":{"pattern":".*","type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"deprecated":true}},"/api/v1/esindex/failed":{"get":{"tags":["Search Index"],"operationId":"downloadRemainingRecordsAsCsv","responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"delete":{"tags":["Search Index"],"operationId":"deleteFailedRecords","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/esindex/{indexName}":{"put":{"tags":["Search Index"],"operationId":"modIndex","parameters":[{"name":"indexName","in":"path","required":true,"schema":{"pattern":".*","type":"string"}},{"name":"action","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"delete":{"tags":["Search Index"],"operationId":"deleteIndex","parameters":[{"name":"indexName","in":"path","required":true,"schema":{"pattern":".*","type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/esindex/cache":{"delete":{"tags":["Search Index"],"operationId":"flushIndiciesCache","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/esindex/active/{params}":{"get":{"tags":["Search Index"],"operationId":"getActive","parameters":[{"name":"params","in":"path","required":true,"schema":{"pattern":".*","type":"string"}}],"responses":{"default":{"description":"default response","content":{"text/plain":{}}}},"deprecated":true}},"/api/v1/esindex/cluster":{"get":{"tags":["Search Index"],"operationId":"getClusterStats","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/esindex":{"get":{"tags":["Search Index"],"operationId":"getIndexStatus","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/esindex/reindex":{"get":{"tags":["Search Index"],"operationId":"getReindexationProgress","responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"post":{"tags":["Search Index"],"operationId":"startReindex","parameters":[{"name":"contentType","in":"query","schema":{"type":"string","default":"DOTALL"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}},"delete":{"tags":["Search Index"],"operationId":"stopReindexation","parameters":[{"name":"switch","in":"query","schema":{"type":"boolean","default":true}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/esindex/indexlist/{params}":{"get":{"tags":["Search Index"],"operationId":"indexList","parameters":[{"name":"params","in":"path","required":true,"schema":{"pattern":".*","type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/esindex/open/{params}":{"put":{"tags":["Search Index"],"operationId":"openIndex","parameters":[{"name":"params","in":"path","required":true,"schema":{"pattern":".*","type":"string"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"deprecated":true}},"/api/v1/esindex/optimize":{"post":{"tags":["Search Index"],"operationId":"optimizeIndices","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/jobs/abandoned":{"get":{"tags":["Job Queue"],"summary":"Retrieves abandoned jobs","description":"Fetches a paginated list of abandoned jobs. Results can be paginated using query parameters.","operationId":"getAbandonedJobs","parameters":[{"name":"page","in":"query","description":"Page number to retrieve (1-based indexing).","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of records per page.","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Successfully retrieved the paginated list of abandoned jobs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobPaginatedResultView"}}}},"401":{"description":"Unauthorized: Invalid or missing user authentication."},"403":{"description":"Forbidden: User does not have necessary permissions to view jobs."},"500":{"description":"Internal Server Error: An unexpected error occurred while retrieving jobs."}}}},"/api/v1/jobs/active":{"get":{"tags":["Job Queue"],"summary":"Retrieves active jobs","description":"Fetches a paginated list of active jobs. Results can be paginated using query parameters.","operationId":"getActiveJobs","parameters":[{"name":"page","in":"query","description":"Page number to retrieve (1-based indexing).","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of records per page.","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Successfully retrieved the paginated list of active jobs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobPaginatedResultView"}}}},"401":{"description":"Unauthorized: Invalid or missing user authentication."},"403":{"description":"Forbidden: User does not have necessary permissions to view jobs."},"500":{"description":"Internal Server Error: An unexpected error occurred while retrieving jobs."}}}},"/api/v1/jobs/{queueName}/active":{"get":{"tags":["Job Queue"],"summary":"Retrieves active jobs in a queue","description":"Fetches a paginated list of active jobs. Results can be paginated using query parameters.for the specified queue.","operationId":"getActiveJobsByQueue","parameters":[{"name":"queueName","in":"path","description":"Logical name of the queue.","required":true,"schema":{"type":"string","example":"image-processing"}},{"name":"page","in":"query","description":"Page number to retrieve (1-based indexing).","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of records per page.","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Successfully retrieved active jobs for the queue.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobPaginatedResultView"}}}},"401":{"description":"Unauthorized: Invalid or missing user authentication."},"403":{"description":"Forbidden: User does not have permission to view jobs in this queue."},"404":{"description":"Not Found: Queue with the specified name does not exist."},"500":{"description":"Internal Server Error: An unexpected error occurred while retrieving jobs."}}}},"/api/v1/jobs/{jobId}/cancel":{"post":{"tags":["Job Queue"],"summary":"Cancel a job","description":"Sends an asynchronous cancellation request for the specified job. The job may still complete if it has already finished or cannot be interrupted.","operationId":"cancelJobQueueJob","parameters":[{"name":"jobId","in":"path","description":"Unique identifier (UUID) of the job to cancel.","required":true,"schema":{"type":"string","format":"uuid","example":"e6d9bae8-657b-4e2f-8524-c0222db66355"}}],"responses":{"200":{"description":"Cancellation request accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"},"example":{"entity":"Cancellation request successfully sent to job e6d9bae8-657b-4e2f-8524-c0222db66355"}}}},"401":{"description":"Unauthorized: Invalid or missing user authentication."},"403":{"description":"Forbidden: User does not have permission to cancel this job."},"404":{"description":"Not Found: Job with the specified ID does not exist or is already completed/cancelled."},"500":{"description":"Internal Server Error: An unexpected error occurred while attempting to cancel the job."}}}},"/api/v1/jobs/canceled":{"get":{"tags":["Job Queue"],"summary":"Retrieves canceled jobs","description":"Fetches a paginated list of canceled jobs. Results can be paginated using query parameters.","operationId":"getCanceledJobs","parameters":[{"name":"page","in":"query","description":"Page number to retrieve (1-based indexing).","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of records per page.","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Successfully retrieved the paginated list of canceled jobs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobPaginatedResultView"}}}},"401":{"description":"Unauthorized: Invalid or missing user authentication."},"403":{"description":"Forbidden: User lacks permission to view jobs."},"500":{"description":"Internal Server Error: An unexpected error occurred while retrieving jobs."}}}},"/api/v1/jobs/completed":{"get":{"tags":["Job Queue"],"summary":"Retrieves completed jobs","description":"Fetches a paginated list of completed jobs. Results can be paginated using query parameters.","operationId":"getCompletedJobs","parameters":[{"name":"page","in":"query","description":"Page number to retrieve (1-based indexing).","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of records per page.","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Successfully retrieved the paginated list of completed jobs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobPaginatedResultView"}}}},"401":{"description":"Unauthorized: Invalid or missing user authentication."},"403":{"description":"Forbidden: User does not have necessary permissions to view jobs."},"500":{"description":"Internal Server Error: An unexpected error occurred while retrieving jobs."}}}},"/api/v1/jobs/{queueName}/upload":{"post":{"tags":["Job Queue"],"summary":"Creates a new job with form data","description":"Creates and queues a new background job with multipart form data parameters. Returns the job ID and initial status information.","operationId":"createJobWithFormData","parameters":[{"name":"queueName","in":"path","description":"Name of the job queue to submit to","required":true,"schema":{"type":"string","example":"image-processing"}}],"requestBody":{"description":"This endpoint accepts a `multipart/form-data` request with two fields:\n\n| **Field** | **Type** | **Required** | **Description** |\n|-----------|----------|--------------|-----------------|\n| `file` | File | ❌ No | The file to be processed by the queue.|\n| `form` | String | ❌ No | A JSON string containing job-specific parameters.|\n\n**Example `form` value:**\n\n```json\n{\n \"contentType\":\"CustomContentType\", \"workflowActionId\":\"Workflow-UUID\", \"language\":\"en-us\", \"stopOnError\":true,\n}\n```","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/JobParamsSchema"}}}},"responses":{"200":{"description":"Job created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobStatusView"},"example":{"entity":{"jobId":"e6d9bae8-657b-4e2f-8524-c0222db66355","statusUrl":"http://localhost:8080/api/v1/_import/e6d9bae8-657b-4e2f-8524-c0222db66355"},"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"400":{"description":"Bad Request: Invalid parameters, malformed multipart payload, or file issues."},"401":{"description":"Unauthorized: Invalid or missing user authentication."},"403":{"description":"Forbidden: User lacks permission to enqueue jobs in the specified queue."},"404":{"description":"Not Found: Queue with the specified name does not exist."},"500":{"description":"Internal Server Error: An unexpected error occurred while creating the job."}}}},"/api/v1/jobs/{queueName}":{"post":{"tags":["Job Queue"],"summary":"Creates a new job with JSON parameters","description":"Creates and queues a new background job with JSON parameters. Returns the job ID and initial status information.","operationId":"createJobWithJson","parameters":[{"name":"queueName","in":"path","description":"Name of the job queue to submit to","required":true,"schema":{"type":"string","example":"image-processing"}}],"requestBody":{"description":"Job parameters as JSON key-value pairs","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}},"required":true},"responses":{"200":{"description":"Job created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobStatusView"},"example":{"entity":{"jobId":"e6d9bae8-657b-4e2f-8524-c0222db66355","statusUrl":"http://localhost:8080/api/v1/_import/e6d9bae8-657b-4e2f-8524-c0222db66355"},"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"400":{"description":"Bad Request: Invalid parameters or malformed JSON."},"401":{"description":"Unauthorized: Invalid or missing user authentication."},"403":{"description":"Forbidden: User lacks permission to enqueue jobs in the specified queue."},"404":{"description":"Not Found: Queue with the specified name does not exist."},"500":{"description":"Internal Server Error: An unexpected error occurred while creating the job."}}}},"/api/v1/jobs/failed":{"get":{"tags":["Job Queue"],"summary":"Retrieves failed jobs","description":"Fetches a paginated list of failed jobs. Results can be paginated using query parameters.","operationId":"getFailedJobs","parameters":[{"name":"page","in":"query","description":"Page number to retrieve (1-based indexing).","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of records per page.","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Successfully retrieved the paginated list of failed jobs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobPaginatedResultView"}}}},"401":{"description":"Unauthorized: Invalid or missing user authentication."},"403":{"description":"Forbidden: User does not have necessary permissions to view jobs."},"500":{"description":"Internal Server Error: An unexpected error occurred while retrieving jobs."}}}},"/api/v1/jobs/{jobId}/status":{"get":{"tags":["Job Queue"],"summary":"Retrieves job status information","description":"Returns detailed status information for a specific job including progress, state, and results.","operationId":"getJobStatus_1","parameters":[{"name":"jobId","in":"path","description":"Unique identifier (UUID) of the job.","required":true,"schema":{"type":"string","format":"uuid","example":"e6d9bae8-657b-4e2f-8524-c0222db66355"}}],"responses":{"200":{"description":"Job status retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"400":{"description":"Bad request - Invalid job ID"},"401":{"description":"Unauthorized - User not authenticated"},"403":{"description":"Forbidden - User lacks required permissions"},"404":{"description":"Job not found"},"500":{"description":"Internal server error"}}}},"/api/v1/jobs/queues":{"get":{"tags":["Job Queue"],"summary":"Retrieves available job queues","description":"Returns a list of all available job queue names that can be used for submitting jobs.","operationId":"getQueues","responses":{"200":{"description":"Queues retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityView"}}}},"401":{"description":"Unauthorized - User not authenticated"},"403":{"description":"Forbidden - User lacks required permissions"},"500":{"description":"Internal server error"}}}},"/api/v1/jobs":{"get":{"tags":["Job Queue"],"summary":"Retrieves jobs","description":"Fetches a paginated list of all jobs regardless of state. Results can be paginated using query parameters.","operationId":"listJobs","parameters":[{"name":"page","in":"query","description":"Page number to retrieve (1-based indexing).","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of records per page.","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Successfully retrieved the paginated list of jobs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobPaginatedResultView"}}}},"401":{"description":"Unauthorized: Invalid or missing user authentication."},"403":{"description":"Forbidden: User does not have necessary permissions to view jobs."},"500":{"description":"Internal Server Error: An unexpected error occurred while retrieving jobs."}}}},"/api/v1/jobs/{jobId}/monitor":{"get":{"tags":["Job Queue"],"summary":"Monitor a job in real time","description":"Establishes a Server-Sent Events (SSE) connection to monitor the progress of a specific job in real-time. This endpoint will continuously send updates as the job progresses, including status changes and completion information.","operationId":"monitorJob","parameters":[{"name":"jobId","in":"path","description":"The unique identifier (UUID) of the job whose status is to be retrieved.","required":true,"schema":{"type":"string","format":"uuid","example":"e6d9bae8-657b-4e2f-8524-c0222db66355"}}],"responses":{"200":{"description":"Server-Sent Events stream established successfully. Events will be sent as the job progresses.","content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/EventOutput"}}}},"401":{"description":"Unauthorized: Invalid or missing user authentication."},"403":{"description":"Forbidden: User does not have permissions to monitor the specified job."},"404":{"description":"Not Found: Job with the specified ID could not be found."},"500":{"description":"Internal Server Error: An unexpected error occurred while establishing the monitoring connection."}}}},"/api/v1/jobs/successful":{"get":{"tags":["Job Queue"],"summary":"Retrieves successful jobs","description":"Fetches a paginated list of successful jobs. Results can be paginated using query parameters.","operationId":"getSuccessfulJobs","parameters":[{"name":"page","in":"query","description":"Page number to retrieve (1-based).","schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Number of records per page.","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Successfully retrieved the paginated list of successful jobs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobPaginatedResultView"}}}},"401":{"description":"Unauthorized: Invalid or missing user authentication."},"403":{"description":"Forbidden: User does not have necessary permissions to view jobs."},"500":{"description":"Internal Server Error: An unexpected error occurred while retrieving jobs."}}}},"/api/v1/languages/i18n":{"post":{"tags":["Language"],"summary":"Get internationalized messages","description":"Retrieves internationalized (i18n) message strings for the specified locale and message keys. The locale is determined from the request body's country and language fields. Returns a map of message keys to their translated string values.","operationId":"getI18nMessages","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/I18NForm"}}}},"responses":{"200":{"description":"Messages returned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityMapStringStringView"}}}},"400":{"description":"Invalid request form data"},"401":{"description":"Authentication required"},"500":{"description":"Internal server error"}}}},"/api/v1/languages":{"get":{"tags":["Language"],"summary":"List all available languages","description":"Returns all configured languages in the system, keyed by language code. Each entry contains the full language details including country, language code, and display name.","operationId":"listLanguages","responses":{"200":{"description":"Languages returned successfully","content":{"application/json":{"schema":{"type":"object","description":"Map of language codes to language details (RestLanguage objects)"}}}},"401":{"description":"Authentication required"}}}},"/api/v1/jvm":{"get":{"tags":["Administration"],"operationId":"getJvmInfo","responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/maintenance/_contentlets":{"delete":{"tags":["Maintenance"],"summary":"Bulk delete contentlets by identifier","description":"Permanently destroys contentlets and all their language siblings. Bypasses trash. Each contentlet is destroyed independently — one failure does not block others.","operationId":"deleteContentlets","requestBody":{"description":"List of contentlet identifiers to permanently destroy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteContentletsForm"}}},"required":true},"responses":{"200":{"description":"Bulk deletion completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityDeleteContentletsResultView"}}}},"400":{"description":"Bad request - missing or empty identifiers","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - CMS Administrator role required","content":{"application/json":{}}}}}},"/api/v1/maintenance/_pushedAssets":{"delete":{"tags":["Maintenance"],"summary":"Delete all pushed assets records","description":"Deletes ALL records from the pushed assets tracking table. Clears push publishing history, making all assets appear as \"never pushed\" to all endpoints.","operationId":"deletePushedAssets","responses":{"200":{"description":"Pushed assets deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - CMS Administrator role required","content":{"application/json":{}}}}}},"/api/v1/maintenance/_systemJobs/{group}/{name}":{"delete":{"tags":["Maintenance"],"summary":"Delete a Quartz scheduler job","description":"Removes a Quartz scheduler job (and all associated triggers) from the scheduler by its group and name. Used to clean up errored or orphaned jobs after upgrades. Returns 404 if no matching job exists in the scheduler.","operationId":"deleteSystemJob","parameters":[{"name":"group","in":"path","description":"Quartz job group name","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","description":"Quartz job name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Job deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySystemJobDeleteView"}}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - CMS Administrator role and Maintenance portlet access required","content":{"application/json":{}}},"404":{"description":"No job matches the supplied group and name","content":{"application/json":{}}}}}},"/api/v1/maintenance/_downloadAssets":{"get":{"tags":["Maintenance"],"operationId":"downloadAssets","parameters":[{"name":"oldAssets","in":"query","schema":{"type":"boolean","default":true}},{"name":"maxSize","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/maintenance/_downloadClusterLog/{fileName}":{"get":{"tags":["Maintenance"],"operationId":"downloadClusterLogFile","parameters":[{"name":"fileName","in":"path","required":true,"schema":{"pattern":".+","type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/maintenance/_downloadDb":{"get":{"tags":["Maintenance"],"operationId":"downloadDb","responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/maintenance/_downloadLog/{fileName}":{"get":{"tags":["Maintenance"],"operationId":"downloadLogFile","parameters":[{"name":"fileName","in":"path","required":true,"schema":{"pattern":".+","type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/maintenance/_downloadStarter":{"get":{"tags":["Maintenance"],"operationId":"downloadStarter","parameters":[{"name":"maxSize","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/maintenance/_downloadStarterWithAssets":{"get":{"tags":["Maintenance"],"operationId":"downloadStarterWithAssets","parameters":[{"name":"oldAssets","in":"query","schema":{"type":"boolean","default":true}},{"name":"maxSize","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/octet-stream":{},"application/json":{}}}}}},"/api/v1/maintenance/_oldVersions":{"delete":{"tags":["Maintenance"],"summary":"Drop old asset versions","description":"Deletes all versions of versionable objects (contentlets, containers, templates, links, workflow history) older than the specified date. Can take minutes on large datasets.","operationId":"dropOldVersions","parameters":[{"name":"date","in":"query","description":"Cutoff date in yyyy-MM-dd format. Versions older than this are deleted.","required":true,"schema":{"type":"string"},"example":"2025-06-15"}],"responses":{"200":{"description":"Old versions deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityDropOldVersionsResultView"}}}},"400":{"description":"Bad request - missing or invalid date format","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - CMS Administrator role required","content":{"application/json":{}}}}}},"/api/v1/maintenance/assets/_clean":{"get":{"tags":["Maintenance"],"summary":"Get latest clean-assets job","description":"Returns the most recent clean-assets job (active, or most recently completed). Returns null entity if no clean-assets job has ever run.","operationId":"getLatestCleanAssetsJob","responses":{"200":{"description":"Latest job status","content":{"application/json":{"schema":{"type":"object","description":"ResponseEntityView wrapping the latest Job (id, state, progress, result) or null if none exists"}}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - CMS Administrator role required","content":{"application/json":{}}}}},"post":{"tags":["Maintenance"],"summary":"Request a clean-assets job","description":"Enqueues a clean orphan assets job on the cluster job queue. Returns immediately with {jobId, statusUrl}. Rejects with 409 Conflict if a clean-assets job is already pending or running anywhere in the cluster.","operationId":"requestCleanAssetsJob","responses":{"200":{"description":"Job enqueued","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobStatusView"}}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - CMS Administrator role required","content":{"application/json":{}}},"409":{"description":"Conflict - a clean-assets job is already running","content":{"application/json":{}}}}}},"/api/v1/maintenance/assets/_fix":{"get":{"tags":["Maintenance"],"summary":"Get latest fix-assets job","description":"Returns the most recent fix-assets job (active, or most recently completed). Returns null entity if no fix-assets job has ever run.","operationId":"getLatestFixAssetsJob","responses":{"200":{"description":"Latest job status","content":{"application/json":{"schema":{"type":"object","description":"ResponseEntityView wrapping the latest Job (id, state, progress, result) or null if none exists"}}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - CMS Administrator role required","content":{"application/json":{}}}}},"post":{"tags":["Maintenance"],"summary":"Request a fix-assets job","description":"Enqueues a fix-assets inconsistencies job on the cluster job queue. Returns immediately with {jobId, statusUrl}. Rejects with 409 Conflict if a fix-assets job is already pending or running anywhere in the cluster.","operationId":"requestFixAssetsJob","responses":{"200":{"description":"Job enqueued","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityJobStatusView"}}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - CMS Administrator role required","content":{"application/json":{}}},"409":{"description":"Conflict - a fix-assets job is already running","content":{"application/json":{}}}}}},"/api/v1/maintenance/_threads":{"get":{"tags":["Maintenance"],"summary":"JVM thread dump","description":"Returns a full JVM thread dump as structured JSON, including state, priority, stack traces, locked monitors/synchronizers, and deadlock detection. Use hideSystem=true (default) to filter to dotCMS threads only.","operationId":"getThreadDump","parameters":[{"name":"hideSystem","in":"query","description":"When true (default), only return threads with com.dotmarketing or com.dotcms frames","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Thread dump captured","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityThreadDumpView"}}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - CMS Administrator role required","content":{"application/json":{}}}}}},"/api/v1/maintenance/_threads/info":{"get":{"tags":["Maintenance"],"summary":"JVM thread info","description":"Returns lightweight JVM startup and thread-count summary (start time, uptime, current and peak thread count).","operationId":"getThreadInfo","responses":{"200":{"description":"JVM thread info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityThreadSystemInfoView"}}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - CMS Administrator role required","content":{"application/json":{}}}}}},"/api/v1/maintenance/_pgDumpAvailable":{"get":{"tags":["Maintenance"],"operationId":"isPgDumpAvailable","responses":{"default":{"description":"default response","content":{"text/plain":{}}}}}},"/api/v1/maintenance/_sessions":{"get":{"tags":["Maintenance"],"summary":"List active HTTP sessions","description":"Returns every active HTTP session tracked by SessionMonitor. Real session ids are never exposed; each entry instead carries a short HMAC-derived token that must be passed back to DELETE /v1/maintenance/_sessions/{token} to invalidate the session. The CSRF secret used to derive these tokens is stored in the caller's HTTP session and is valid for 15 minutes — re-call this endpoint to refresh.","operationId":"listSessions","responses":{"200":{"description":"List of active sessions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySessionListView"}}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - CMS Administrator role required","content":{"application/json":{}}}}},"delete":{"tags":["Maintenance"],"summary":"Invalidate all sessions except the caller's","description":"Walks every active HTTP session tracked by SessionMonitor, skips the caller's own session, and invalidates the rest. Returns the count of invalidated sessions.","operationId":"killAllSessions","responses":{"200":{"description":"Sessions invalidated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityKillSessionsResultView"}}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - CMS Administrator role required","content":{"application/json":{}}}}}},"/api/v1/maintenance/_sessions/{token}":{"delete":{"tags":["Maintenance"],"summary":"Invalidate a single session","description":"Invalidates the session whose HMAC-obfuscated token is supplied. The caller's own session cannot be invalidated this way. The CSRF secret must have been issued by GET /v1/maintenance/_sessions within the last 15 minutes — otherwise this endpoint returns 403 and the client must re-list to refresh.","operationId":"killSession","parameters":[{"name":"token","in":"path","description":"HMAC-obfuscated session token returned by GET /_sessions","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Session invalidated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"400":{"description":"Bad request - attempting to invalidate caller's own session","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - missing or expired CSRF token, or insufficient role","content":{"application/json":{}}},"404":{"description":"No active session matches the supplied token","content":{"application/json":{}}}}}},"/api/v1/maintenance/_systemJobs":{"get":{"tags":["Maintenance"],"summary":"List Quartz scheduler jobs","description":"Returns every Quartz scheduler job across all job groups, with trigger details (next fire time, misfire instruction) and current running status. Errored jobs (e.g. class not found after upgrade) are returned with an 'error' field so admins can clean them up. Note: these are Quartz scheduler jobs, NOT the JobQueueManager jobs exposed at /api/v1/jobs — those are a separate system.","operationId":"listSystemJobs","responses":{"200":{"description":"List of Quartz scheduler jobs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySystemJobListView"}}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - CMS Administrator role and Maintenance portlet access required","content":{"application/json":{}}}}}},"/api/v1/maintenance/_searchAndReplace":{"post":{"tags":["Maintenance"],"summary":"Database-wide search and replace","description":"Performs a find/replace across text content in contentlets, containers, templates, fields, and links. Only affects working/live versions. This is a dangerous, irreversible operation. Returns 200 with hasErrors=true if some tables failed — check the response body.","operationId":"searchAndReplace","requestBody":{"description":"Search and replace parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchAndReplaceForm"}}},"required":true},"responses":{"200":{"description":"Search and replace completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySearchAndReplaceResultView"}}}},"400":{"description":"Bad request - searchString is empty or missing","content":{"application/json":{}}},"401":{"description":"Unauthorized - authentication required","content":{"application/json":{}}},"403":{"description":"Forbidden - CMS Administrator role required","content":{"application/json":{}}}}}},"/api/v1/maintenance/_shutdown":{"delete":{"tags":["Maintenance"],"operationId":"shutdown","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/maintenance/_shutdownCluster":{"delete":{"tags":["Maintenance"],"operationId":"shutdownCluster","parameters":[{"name":"rollingDelay","in":"query","schema":{"type":"integer","format":"int32","default":60}}],"responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/menu":{"get":{"tags":["Navigation"],"operationId":"getMenus","responses":{"default":{"description":"default response","content":{"application/json":{},"application/javascript":{}}}}}},"/api/v1/notification/delete":{"put":{"tags":["Notifications"],"operationId":"delete_7","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeleteForm"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/notification/id/{id}":{"delete":{"tags":["Notifications"],"operationId":"delete_8","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/notification/getNewNotificationsCount":{"get":{"tags":["Notifications"],"operationId":"getNewNotificationsCount","parameters":[{"name":"params","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/notification/getNotifications/{params}":{"get":{"tags":["Notifications"],"operationId":"getNotifications","parameters":[{"name":"params","in":"path","required":true,"schema":{"pattern":".*","type":"string"}},{"name":"Range","in":"header","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/notification/markAsRead":{"put":{"tags":["Notifications"],"operationId":"markAsRead","responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/api/v1/osgi/jar/{jar}/_deploy":{"put":{"tags":["OSGi Plugins"],"summary":"deploys bundle","operationId":"deploy","parameters":[{"name":"jar","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"404":{"description":"Bundle not found"},"400":{"description":"Error loading OSGI Bundle"}}}},"/api/v1/osgi/available-plugins":{"get":{"tags":["OSGi Plugins"],"summary":"get available plugins","operationId":"getAvailablePlugis","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityListView"}}}}}}},"/api/v1/osgi/extra-packages":{"get":{"tags":["OSGi Plugins"],"summary":"get extra packages","operationId":"getExtraPackages","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}}}},"put":{"tags":["OSGi Plugins"],"summary":"modify extra packages","operationId":"modifyExtraPackages","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExtraPackagesForm"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}}}}},"/api/v1/osgi":{"get":{"tags":["OSGi Plugins"],"summary":"Returns a list of all bundles installed","operationId":"getInstalledBundles_1","parameters":[{"name":"ignoresystembundles","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityBundleListView"}}}}}},"post":{"tags":["OSGi Plugins"],"summary":"Upload bundles to the OSGI framework","description":"Uploads one or more plugin JARs to the OSGi upload folder and schedules their processing. A 200 confirms the upload was accepted, NOT that the plugin is live: if new packages must be exported the OSGi framework is restarted cluster-wide asynchronously, after this response returns. Restart completion is signalled by the OSGI_FRAMEWORK_RESTART system event and successful deployment by the OSGI_BUNDLES_LOADED event; an asynchronous failure is reported via the OSGI_BUNDLES_UPLOAD_FAILED event and an error notification (check the server logs for the full stack trace). Clients should react to these events rather than assume the plugin is active once the 200 is received.","operationId":"uploadBundles","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FormDataMultiPart"}}}},"responses":{"200":{"description":"Bundle upload accepted and scheduled. Any required OSGi restart happens asynchronously; watch the OSGI_FRAMEWORK_RESTART / OSGI_BUNDLES_LOADED / OSGI_BUNDLES_UPLOAD_FAILED system events for the outcome.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntitySetStringView"}}}},"403":{"description":"Can not access the upload folder or invalid OSGI Upload request"}}}},"/api/v1/osgi/dotsystem":{"get":{"tags":["OSGi Plugins"],"summary":"Returns the dot system list of all bundles installed","operationId":"getSystemInstalledBundles","parameters":[{"name":"ignoresystembundles","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityBundleListView"}}}}}}},"/api/v1/osgi/_processExports/{bundle}":{"get":{"tags":["OSGi Plugins"],"summary":"Process exports","operationId":"processBundle_1","parameters":[{"name":"bundle","in":"path","required":true,"schema":{"pattern":".*","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}}}}},"/api/v1/osgi/_restart":{"put":{"tags":["OSGi Plugins"],"summary":"restarts the OSGI framework","operationId":"restart","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}}}}},"/api/v1/osgi/jar/{jar}/_start":{"put":{"tags":["OSGi Plugins"],"summary":"starts bundle","operationId":"start_1","parameters":[{"name":"jar","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"404":{"description":"Bundle not found"},"400":{"description":"Can not stop system bundle"}}}},"/api/v1/osgi/jar/{jar}/_stop":{"put":{"tags":["OSGi Plugins"],"summary":"stops bundle","operationId":"stop","parameters":[{"name":"jar","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityStringView"}}}},"404":{"description":"Bundle not found"},"400":{"description":"Can not stop system bundle"}}}},"/api/v1/osgi/jar/{jar}":{"delete":{"tags":["OSGi Plugins"],"summary":"Undeploys bundle","operationId":"undeploy","parameters":[{"name":"jar","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityBooleanView"}}}},"404":{"description":"Bundle not found"},"400":{"description":"Can not stop system bundle"}}}},"/api/v1/nav/{uri}":{"get":{"tags":["Navigation"],"summary":"Get site navigation tree","description":"Returns the dotCMS site navigation tree starting at the given **folder** URI, up to the specified depth. Only objects marked as 'show on menu' are included. The URI must resolve to a folder — page URIs (e.g., '/index', '/about-us/team') will return 404. Use '/' to fetch the navigation tree for the site root.","operationId":"getNavigationTree","parameters":[{"name":"uri","in":"path","description":"Starting folder URI for the navigation tree (e.g., '/about-us', '/blog', or '/' for the site root). Must resolve to a folder — page URIs return 404.","required":true,"schema":{"pattern":".*","type":"string"}},{"name":"depth","in":"query","description":"Total number of levels to include, counting the starting node as level 1. depth=1 returns only the starting node with no children; depth=2 returns the node plus its direct children. Values exceeding the actual tree depth return the full subtree. Values less than 1 are treated as 1. (default: 1)","schema":{"type":"integer","format":"int32"}},{"name":"languageId","in":"query","description":"Tags each returned node with this language ID. Note: folder names are language-neutral in dotCMS and are not translated — this parameter only affects the 'languageId' attribute on each node, not the visible 'title'. Defaults to the language of the current request.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Navigation tree retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityMapView"}}}},"400":{"description":"Invalid depth or languageId parameter"},"401":{"description":"Authentication required"},"403":{"description":"Insufficient permissions"},"404":{"description":"Navigation path not found"}}}},"/api/v1/page/{pageId}/content":{"post":{"tags":["Page"],"summary":"Replace the content mapping of a page","description":"Replaces all container-to-contentlet assignments for the page (DEFAULT variant, or a named variant when 'variantName' is provided). This is a full replacement, not a patch: omitting a container slot removes its content. The body is a bare JSON array of container entries; each entry maps one container instance to its ordered list of contentlets. Duplicate entries are merged automatically. To build the payload, fetch GET /api/v1/page/json/{uri} first (faster than /render — no Velocity execution): use 'page.containers' for the path-based identifier and 'page.layout.body.rows[].columns[].containers[]' for the uuid of each slot.","operationId":"addContentToPage","parameters":[{"name":"pageId","in":"path","description":"Identifier of the HTML Page to update","required":true,"schema":{"type":"string"}},{"name":"variantName","in":"query","description":"Variant name for A/B testing (defaults to DEFAULT)","schema":{"type":"string"}}],"requestBody":{"description":"Array of container entries. Full replacement: omitting a slot removes its content from the page.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PageContainerEntryView"}},"example":[{"identifier":"//demo.dotcms.com/application/containers/default/","uuid":"10","contentletsId":["7b33f0b474ba3b82c3a908b81dce5e2c"]}]}},"required":true},"responses":{"200":{"description":"Contentlets saved successfully","content":{"application/json":{"example":{"entity":[{"containerId":"some-container-id","contentletId":"some-contentlet-id","uuid":"some-uuid"},{"containerId":"other-container-id","contentletId":"other-contentlet-id","uuid":"other-uuid"}],"errors":[],"i18nMessagesMap":{},"messages":[],"pagination":null,"permissions":[]}}}},"400":{"description":"Bad request or data exception"},"409":{"description":"Conflict — net content loss exceeds the configured threshold; refresh and retry"}}}},"/api/v1/page/{pageId}/languages":{"get":{"tags":["Page"],"summary":"Check page availability by language (deprecated)","description":"Returns all available languages in dotCMS, each with a flag indicating whether the page is available in that language. This endpoint is deprecated -- use the more generic ContentResource.getExistingLanguagesForContent endpoint instead.","operationId":"checkPageLanguageVersions","parameters":[{"name":"pageId","in":"path","description":"Identifier of the HTML Page to check language versions for","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Language availability list retrieved successfully (deprecated endpoint)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityLanguagesForPageView"}}}},"401":{"description":"Authentication required"},"404":{"description":"Page not found"}},"deprecated":true}},"/api/v1/page/_check-permission":{"post":{"tags":["Page"],"summary":"Check user permission on a page","description":"Returns true if the page exists and the current user has the specified permission type over it. Supports both regular HTML pages and URL-mapped content. The permission type defaults to READ if not specified.","operationId":"checkPagePermission","requestBody":{"description":"Form with page path, host ID, language ID, and permission type to check","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageCheckPermissionForm"}}},"required":true},"responses":{"200":{"description":"Permission check result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityBooleanView"}}}},"401":{"description":"Authentication required"},"404":{"description":"Page not found at the specified path"}}}},"/api/v1/page/copyContent":{"put":{"tags":["Page"],"summary":"Copy a contentlet on a page","description":"Creates a copy of a contentlet that is part of the multi-tree on a page. The contentlet must exist and be associated with the page specified in the form. Returns the copied contentlet as a map of properties.","operationId":"copyPageContent","requestBody":{"description":"Form containing the contentlet and page information for the copy operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyContentletForm"}}},"required":true},"responses":{"200":{"description":"Contentlet copied successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityMapView"}}}},"400":{"description":"Bad request - form is required or contentlet not found"},"401":{"description":"Authentication required"},"403":{"description":"User does not have required permissions"}}}},"/api/v1/page/{pageId}/_deepcopy":{"put":{"tags":["Page"],"summary":"Deep copy a page and all its content","description":"Creates a deep copy of a page: (1) creates a copy of the page itself, and (2) for each contentlet in the multi-tree related to the page, creates a copy. Returns the copied page as a map of properties.","operationId":"deepCopyPage","parameters":[{"name":"pageId","in":"path","description":"Identifier of the HTML Page to deep copy","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Page deep copied successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityMapView"}}}},"401":{"description":"Authentication required"},"403":{"description":"User does not have required permissions"},"404":{"description":"Page not found"}}}},"/api/v1/page/actions":{"post":{"tags":["Page"],"summary":"Find available workflow actions for a page","description":"Returns the page data along with the list of available workflow actions for the specified page path. Supports both regular HTML pages and URL-mapped content. The response includes the page contentlet properties and the workflow actions that the current user can perform.","operationId":"findAvailablePageActions","requestBody":{"description":"Form with page path, host ID, language ID, and render mode for action lookup","content":{"*/*":{"schema":{"$ref":"#/components/schemas/FindAvailableActionsForm"}}},"required":true},"responses":{"200":{"description":"Available workflow actions retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityPageWorkflowActionsView"}}}},"401":{"description":"Authentication required"},"404":{"description":"Page not found at the specified path and language"}}}},"/api/v1/page/{pageId}/content/tree":{"get":{"tags":["Page"],"summary":"Get the multi-tree content structure of a page","description":"Returns the multi-tree data associated with a page, which represents the mapping between containers, contentlets, and their positions on the page. Each entry includes the page ID, container ID, contentlet ID, relation type, tree order, personalization, and variant ID.","operationId":"getPageContentTree","parameters":[{"name":"pageId","in":"path","description":"Identifier of the HTML Page","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Content tree retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityMulitreeView"}}}},"401":{"description":"Authentication required"},"403":{"description":"User does not have required permissions"},"404":{"description":"Page not found"}}}},"/api/v1/page/{pageId}/render/versions":{"get":{"tags":["Page"],"summary":"Get live and preview render versions of a page","description":"Returns the page render for both the live and preview (working) versions. Includes a boolean 'diff' flag indicating whether the live and preview versions differ.","operationId":"getPageRenderVersions","parameters":[{"name":"pageId","in":"path","description":"Identifier of the HTML Page","required":true,"schema":{"type":"string"}},{"name":"langId","in":"query","description":"Language ID (defaults to the system default language)","schema":{"type":"string"}}],"responses":{"200":{"description":"Page render versions retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityPageLivePreviewVersionView"}}}},"401":{"description":"Authentication required"},"403":{"description":"User does not have required permissions"},"404":{"description":"Page not found"}}}},"/api/v1/page/types":{"get":{"tags":["Page"],"summary":"Get content types associated with pages","description":"Returns all content types associated with pages, including both the base HTMLPAGE type and all content types with URL map patterns. Results are paginated and can be filtered and sorted.","operationId":"getPageContentTypes","parameters":[{"name":"filter","in":"query","description":"Filter text for content type names","schema":{"type":"string","default":""}},{"name":"page","in":"query","description":"Page number for pagination (zero-based)","schema":{"type":"integer","format":"int32"}},{"name":"per_page","in":"query","description":"Number of results per page","schema":{"type":"integer","format":"int32"}},{"name":"orderby","in":"query","description":"Field to order results by (default: UPPER(name))","schema":{"type":"string","default":"UPPER(name)"}},{"name":"direction","in":"query","description":"Sort direction: ASC or DESC (default: ASC)","schema":{"type":"string","default":"ASC"}}],"responses":{"200":{"description":"Page content types retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityPaginatedDataView"}}}},"401":{"description":"Authentication required"},"403":{"description":"User does not have required permissions"}}}},"/api/v1/page/{pageId}/personas":{"get":{"tags":["Page"],"summary":"Get personalized personas for a page","description":"Returns a paginated list of personas with a flag indicating whether each persona has been customized (personalized) on the specified page. Useful for identifying which personas have page-specific content variations.","operationId":"getPersonalizedPersonasOnPage","parameters":[{"name":"filter","in":"query","description":"Filter text to narrow persona results","schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number for pagination (zero-based)","schema":{"type":"integer","format":"int32"}},{"name":"per_page","in":"query","description":"Number of results per page","schema":{"type":"integer","format":"int32"}},{"name":"orderby","in":"query","description":"Field to order results by (default: title)","schema":{"type":"string","default":"title"}},{"name":"direction","in":"query","description":"Sort direction: ASC or DESC (default: ASC)","schema":{"type":"string","default":"ASC"}},{"name":"hostId","in":"query","description":"Host identifier to scope persona lookup","schema":{"type":"string"}},{"name":"pageId","in":"path","description":"Identifier of the HTML Page","required":true,"schema":{"type":"string"}},{"name":"respectFrontEndRoles","in":"query","description":"Whether to respect front-end roles for permission checks","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Personas with personalization flags retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityListPersonalizationPersonaPageView"}}}},"401":{"description":"Authentication required"},"403":{"description":"User does not have required permissions"},"404":{"description":"Page not found"}}}},"/api/v1/page/_render-sources/{uri}":{"get":{"tags":["Page"],"summary":"Get render sources for a page","description":"Returns references only (path + identifier, no file content, no container code) mapping a rendered page to its source files. The page is identified by a URI path segment, exactly like `GET /api/v1/page/render/{uri}`.\n\nThe URI must be a plain path (e.g. `index`, `about/team`). To address a specific site, use the `host_id` query parameter.\n\nIncludes the page reference, theme VTL files, all containers referenced by the template (only content types actually placed under the applied persona/variant are included), and widget contentlets placed on the page.\n\n**Widget source field:**\nEach widget entry includes a `source` field:\n- `FILE` — the widget's Velocity lives in a file asset; `path` and `identifier` are populated. Retrieve the VTL content via `GET /api/v2/assets`.\n- `CODE` — the widget's Velocity is inline (in the content type's `widgetCode` field and/or the contentlet's own fields). No `path`/`identifier` are returned. Retrieve the content type definition via `GET /api/v1/contenttype/id/{contentTypeVar}` and the placed contentlet via `GET /api/v1/content/id/{contentletId}`.\n\n**Other source lookups:**\n- Theme folder files: `GET /api/v1/folder/sitename/{site}/uri/{uri}`\n- DB container code: `GET /api/v1/containers/working?containerId=