forked from Telodendria/Telodendria
1.4 KiB
1.4 KiB
Administrator API: Configuration
As mentioned in Setup, Telodendria's configuration is intended to be managed via the configuration API. Consult the Configuration document for a complete list of supported configuration options. This document simply describes the API used to update the configuration.
API Endpoints
GET /_telodendria/admin/config
Retrieve the current configuration.
| Requires Token | Rate Limited |
|---|---|
| Yes | Yes |
| Response Code | Description |
|---|---|
| 200 | The current configuration was successfully retrieved. |
POST /_telodendria/admin/config
Installs a new configuration. This endpoint validates the request body, ensuring it is a proper configuration, then it replaces the existing configuration with the new one.
| Requires Token | Rate Limited |
|---|---|
| Yes | Yes |
| Response Code | Description |
|---|---|
| 200 | The new configuration was successfully installed. |
200 Response Format
| Field | Type | Description |
|---|---|---|
restart_required |
Boolean |
Whether or not the process needs to be restarted to finish applying the configuration. If this is true, then the restart endpoint should be used at a convenient time to apply the configuration. |