Skip to content

Commit

Permalink
update status docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cconard96 authored and trasher committed Apr 3, 2024
1 parent 207ad6c commit 989f993
Showing 1 changed file with 1 addition and 18 deletions.
19 changes: 1 addition & 18 deletions source/advanced/status.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ GLPI Status Monitoring
GLPI contains a helpful endpoint for monitoring its health at `/status.php` and the `glpi:system:status` CLI command.
The `/status.php` endpoint does not require you to be logged in and therefore only shows basic status information.
Sensitive information like the GLPI version and plugin names and versions (could be used to identify vulerabilities) are not shown.
Information from the PHP script and the CLI command is presented as JSON.
The difference with the CLI command though is that since it isn't accessible from the web, you can optionally retrieve private information too.

Services
Expand All @@ -24,21 +25,6 @@ A non exhaustive list of services available:
Status Endpoint
~~~~~~~~~~~~~~~

By default, the `/status.php` endpoint provides a plain-text output of the public status information.
The plain-text output is deprecated in favor of the JSON format, but it remains the default for backwards compatibility.

The following formats are currently supported and can be chosen by using the HTTP `Accept` header or the `format` query parameter.
When using the `format` parameter, the short format identifier should be used.

- JSON

- HTTP Accept - application/json
- Format parameter - json
- Plain-text (deprectated)

- HTTP Accept - text/plain
- Format parameter - plain

You can filter the output to a specific service using the `service` query parameter.

CLI Command
Expand All @@ -47,7 +33,4 @@ CLI Command
Similar to the `/status.php` endpoint, the CLI command `glpi:system:status` only shows the public status information by default.
However, since this tool is not available from the web interface, you may add the `-p` or `--private` option to see all of the status information.

By default, it uses the plain-text format for its output for backwards compatibility, but this is deprecated.
The same formats are supported as listed above in the "Status Endpoint" section and the short identifier can be passed in the `-f` or `--format` option.

You can filter the output to a specific service using the `-s` or `--service` option.

0 comments on commit 989f993

Please sign in to comment.