Skip to content

Commit

Permalink
Add /admin/status to endpoint docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kelvinqian00 committed Oct 29, 2024
1 parent e16d6e2 commit d645cfc
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions doc/endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ The response body contains a newly generated JSON Web Token (JWT) on success. A

- `GET http://example.org/admin/env`: Get select environment variables about the configuration which may aid in client-side operations.
- `GET http://example.org/admin/openapi`: Get an OpenAPI JSON spec of the endpoint API, which can then be visualized using an OpenAPI viewer like Swagger.
- `GET http://example.org/admin/status`: Get LRS status information, such as the number of statements in the LRS.
- `DELETE http://example.org/admin/agents`: Runs a *hard delete* of all records of an actor, and associated records (statements, attachments, etc). Intended for privacy purposes like GDPR. Body should be a JSON object of form `{"actor-ifi":<actor-ifi>}`. Disabled unless the configuration variable enableAdminDeleteActor to be set to `true`.

### Reaction Management Routes
Expand Down

0 comments on commit d645cfc

Please sign in to comment.