This documentation is still in progress. We are working hard to update all our screenshots to the new Magnolia 6 style. Please bear with us.

Page tree
Skip to end of metadata
Go to start of metadata

This page describes the commands endpoint, which can be used to trigger commands defined in catalogs

Commands can perform duties within the system or connect to external resources. 

The REST resource must be called with HTTP POST.

You can only call commands via REST which are whitelisted at /modules/rest-services/rest-endpoints/commands/enabledCommands. (For further details see REST module configuring the commands endpoint and REST security.)

Request URLs

The endpoint recognizes URLs with or without a catalog parameter.

POST  /commands/v2/{catalogName}/{commandName}

POST  /commands/v2/{commandName}

Parameters

Parameter

Description

Parameter type

Data type

commandName

required

The name of the command as defined in the Command definition.

path String

catalogName

optional default catalog name is default

The name of the Command catalog.

path

String

body

required

Request body in JSON or XML format; it contains the parameters required to execute the command.

body

String

Example

Publish (activate) the page /travel/hello.

curl http://localhost:8080/magnoliaAuthor/.rest/commands/v2/website/activate \
  -H "Content-Type: application/json" \
  -X POST --user superuser:superuser \
  --data \
'{
  "repository": "website",
  "path": "/travel/hello",
  "recursive": "false"
}'

You cannot send the request as XML, you only can receive the response in XML with the Accept header.