The FirstSpirit REST Service is a web application providing a REST interface. Right now the module is in active development, giving access to several core functionalities. Crownpeak is asking customers to provide feedback on the existing endpoints and returned JSON data.

Warning:
In its current state, the module should only be used for testing and development purposes. This alpha release has not undergone security testing. Do not expose to public networks. Do not use it on a production server.

Installation

Download the latest version (currently 0.0.6-beta) from the Artifactory.
Place a file called fs-rest-service.properties in the lib directory of Tomcat (see Configuration).
Install the module using ServerManager.
A new web application /rest is created automatically. Select the correct web server and deploy the service.

Configuration

The file fs-rest-service.properties needs at least this configuration:

fs.rest.host=localhost
fs.rest.port=1088
fs.rest.mode=SOCKET

Change host name and port according to your local setup. The mode can be either SOCKET or HTTP.

If the REST service is used as part of a web application, it may be required to configure the CORS origins:

fs.rest.cors.allowedOriginPatterns=http://localhost:*

Usage

When the web application is deployed successfully, the base endpoint is available at /rest/v1/. The most simple query is /rest/v1/projects/.

Please note that each request requires an Authorization header using Basic Auth.

A list of all available endpoints is rendered using Swagger at /rest/swagger-ui/index.html.

Feedback

Do you have any questions about the usage? Does the result format not contain what you expected? Which endpoints do you miss?

Please direct any feedback to the FirstSpirit Community.

Changelog

Version 0.0.1-alpha

First public version

Version 0.0.2-alpha

Many new endpoints for creating content
Fixed an authentication issue in SaaS environment

Version 0.0.3-alpha

Rename changes display name, not uid
Scripts can now be modified
Folder management
Access GOM and rules for link-templates
More DTO schema information in Swagger

Version 0.0.4-alpha

Allow modification of most form element types
Deep-copy for page references
Fixed HTTP return codes

Version 0.0.6-beta

Update Spring Boot to 4.0.6

Comments

4 comments

Natalie Manusov

March 19, 2026 09:06
Version 0.0.2-alpha has been released (see changelog)
0
Natalie Manusov

March 27, 2026 15:52
Version 0.0.3-alpha has been released (see changelog)
0
Natalie Manusov

April 16, 2026 12:33
Version 0.0.4-alpha has been released (see changelog)
0
Natalie Manusov

May 05, 2026 08:47
Version 0.0.6-beta has been released (see changelog)
0

Please sign in to leave a comment.