setup
/setup [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.0100 | 6.0000 | json, xml |
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:
| Field | Description | Type |
|---|---|---|
loginrequired | Always false | boolean |
productkeyinvalid | Set to true if the product key is not valid when PageSeeder is already set up | boolean |
Error handling
| HTTP status code | Error condition |
|---|---|
| 401 | If PageSeeder is already set up and the user is not authenticated |
| 403 | If PageSeeder is already set up and the user is not an administrator |