HeadlessCustomModule REST API endpoint

Disclaimer: This endpoint documentation is generated from the latest Sitevision version. It might differ from the actual Sitevision environment where your website resides.

Use the RestApi utility of the Public API for server-side access of this endpoint.

HeadlessCustomModule

Management of REST sv:headlessCustomModule instances of the site.

Applicable to: sv:addonRepository

POST

Create a new REST headless custom module from configuration.

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

Name	Type	Description
name	`string`	The new name for the REST headless custom module. Must be unique and not consist only of numbers
executablesLimit	`integer`	Specifies the maximum number of versions allowed for a REST headless 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. Valid range is between 2-5

Example URL

190.1526119418572a8e7b4240/headlesscustommodule

Example response

{
   "id": "188.7141b1fb1870383673e16",
   "type": "sv:headlessCustomModule",
   "name": "example-addon",
   "path": "/Testsite/Addon Repository/example-addon"
}

DELETE

Delete a REST headless custom module.

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

Example URL

190.1526119418572a8e7b4240/headlesscustommodule/188.7141b1fb1870383673e16

Example response

{
   "id": "188.7141b1fb1870383673e16",
   "type": "sv:headlessCustomModule",
   "name": "example-addon",
   "path": "/Testsite/Addon Repository/example-addon"
}

Did you find the content on this page useful?

HeadlessCustomModule REST API endpoint