CustomModule REST API endpoint

POST

Create a new custom module from configuration.

Requires the feature "addons" and that the user is authorized to MANAGE_ADDONS or has DEVELOPER authorization.

Name	Type	Values	Description	Since
name	string		The new name for the custom module
category	string	Template, PictureAndMedia, Integration, SocialMedia, Interactive, Ecommerce, Collaboration, Other	A category for the new custom module. Has to be one of Sitevision's default categories
allowedRoles	array		An array of security role names, e.g. ["Administrator", "Editor"]. Names must match existing security roles of the sv:site and matching roles will be used to limit access in the SiteVision editor	4.5.3.1
executablesLimit	integer	2-5	Specifies the maximum number of versions allowed for a custom module. If unspecified, the default limit is 3. When this limit is exceeded, the oldest non-active version is automatically removed when a new version is uploaded.	2025.03.1

Example URL

190.1526119418572a8e7b4240/custommodule

Example input

{
   "name": "example-addon",
   "category": "Integration",
   "allowedRoles": ["Administrator", "Editor"]
}

Example response

{
   "id": "180.1526119418572a8e7b4581",
   "type": "sv:customModule",
   "name": "example-addon",
   "path": "/Testsite/Addon Repository/example-addon"
}

DELETE

Delete a Custom Module.

Requires the feature "addons" and that the user is authorized to MANAGE_ADDONS or has DEVELOPER authorization.

Example URL

190.1526119418572a8e7b4240/custommodule/180.1526119418572a8e7b4581

Example response

{
   "id": "180.1526119418572a8e7b4581",
   "type": "sv:customModule",
   "name": "example-addon",
   "path": "/Testsite/Addon Repository/example-addon"
}