Skip to main content

 Services

Web services from /about to /webhooks

setup

/setup [GET]

com.pageseeder.Setup

Description

This service returns the setup information if PageSeeder is not already configured. 

Parameters

No parameters required.

Permission

If the value of DBURL database property is empty, this service can be invoked without authentication as PageSeeder assumes that the setup has not been completed.

Otherwise, only administrators can invoke it.

Response

The response reflects the current state of the PageSeeder setup. It includes the values from the global and database properties used to set up PageSeeder.

The response is identical to /setup [POST] except for the following fields:

FieldDescriptionType
loginrequiredAlways false boolean
productkeyinvalidSet to true if the product key is not valid when PageSeeder is already set upboolean

Error handling

HTTP status codeError condition
401If PageSeeder is already set up and the user is not authenticated
403If PageSeeder is already set up and the user is not an administrator

Created on , last edited on