ServerService

Services related to the operation of the XL Deploy server process.

POST /server/gc Runs the garbage collector on the repository.
GET /server/info Returns information about the configuration of the sever.
POST /server/license/reload Reload and validate the license file from disk.
POST /server/logout Logs out the current user.
POST /server/maintenance/start Put server into MAINTENANCE mode (prepare for shutdown).
POST /server/maintenance/stop Put server into RUNNING mode.
POST /server/shutdown Stops the server process in a graceful manner.
GET /server/state Returns the information about the current server state (is it RUNNING or in MAINTENANCE mode).
PUT /server/view-as View as user.

POST /server/gc

Runs the garbage collector on the repository.
Permissions
admin
Response body
Empty

GET /server/info

Returns information about the configuration of the sever.
Response body
ServerInfo - an information object.
Content type: text/xml,application/xml

POST /server/license/reload

Reload and validate the license file from disk.
Permissions
admin
Response body
Empty

POST /server/logout

Logs out the current user.
Response body
Empty

POST /server/maintenance/start

Put server into MAINTENANCE mode (prepare for shutdown).
Permissions
admin
Response body
Empty

POST /server/maintenance/stop

Put server into RUNNING mode.
Permissions
admin
Response body
Empty

POST /server/shutdown

Stops the server process in a graceful manner.
Permissions
admin
Response body
Long - PID of the JVM process
Content type: text/plain

GET /server/state

Returns the information about the current server state (is it RUNNING or in MAINTENANCE mode).
Response body
ServerState - server state (RUNNING, MAINTENANCE)
Content type: text/xml,application/xml

PUT /server/view-as

View as user.
Permissions
admin
Parameters
Query user String
Query role String
Response body
Empty