Commit Graph

26 Commits

Author SHA1 Message Date
Adam Warner 323f51b773 API Section. Tidy up titles
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
2024-09-26 19:59:26 +01:00
DL6ER 83d5383d9b Add explicit description on how to re-generate a new certificate
Signed-off-by: DL6ER <dl6er@dl6er.de>
2024-01-21 21:30:23 +01:00
DL6ER fd50cbbe6b Add documentation about how to trust TLS/SSL certificate automatically generated by Pi-hole in both Firefox and Chrome
Signed-off-by: DL6ER <dl6er@dl6er.de>
2024-01-17 17:36:49 +01:00
Christian König ebee3d3c0c Correct API location
Signed-off-by: Christian König <ckoenig@posteo.de>
2024-01-06 22:16:15 +01:00
DL6ER 277e51b692 The SID should actually be URL-encoded in the query method
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-11-03 19:24:56 +01:00
DL6ER 62ba878fed Fix copy-paste error in the suggested URI
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-11-03 19:14:27 +01:00
DL6ER 96117fdf9b Apply suggestions from code review
Co-authored-by: yubiuser <ckoenig@posteo.de>
Signed-off-by: DL6ER <DL6ER@users.noreply.github.com>
2023-11-03 18:57:07 +01:00
DL6ER b89107ea8c Add C example
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-11-02 11:41:21 +01:00
DL6ER 2953f24cf1 Add Javascript (plain and jQuery) examples
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-11-02 11:37:29 +01:00
DL6ER 5a4dc22c02 Add authentication documentation
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-11-02 11:25:50 +01:00
Christian König f5db59acff Fix real spelling errors
Signed-off-by: Christian König <ckoenig@posteo.de>
2023-09-16 14:57:28 +02:00
DL6ER a7a5cb1f49 Remove obsolete API documentation. This is to be replaced by the OpenAPI documentation that ships with FTL
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-07-08 13:52:56 +02:00
DL6ER 64bbfe77c6 POST should not include the target to get pushed
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-07-08 13:41:42 +02:00
DL6ER d058074aa3 Update DNS cache page
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-07-08 13:41:41 +02:00
DL6ER bba123559b Update documentation
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-07-08 13:41:19 +02:00
DL6ER 3b36434e1a Use pymdownx.highlight instead of the deprecated codehilite
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-07-08 13:41:17 +02:00
DL6ER 6420a58ea4 Add API->authentication documentation
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-07-08 13:40:48 +02:00
DL6ER 14710581ad Use inline highlighting
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-07-08 13:40:48 +02:00
DL6ER df4d3e278a Add details for fields in API responses.
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-07-08 13:40:46 +02:00
DL6ER 1a5de9b086 Rename /api/dns/cacheinfo to /api/dns/cache
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-07-08 13:40:21 +02:00
DL6ER efa45649bf The domainlist endpoints now return the same data that would be returned via GET on success. This brings a more uniform experience.
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-07-08 13:40:21 +02:00
DL6ER febfd6addb Add documentation for single GET requests
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-07-08 13:40:21 +02:00
DL6ER 6cc622f355 Directly add JSON payload instead of sourceing from file
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-07-08 13:40:21 +02:00
DL6ER 81cc07c8a4 Rename /api/dns/status -> /api/dns/blocking and move black- and whitelist endpoints one level up
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-07-08 13:40:21 +02:00
DL6ER e601281eac Move white- and blacklist endpoints one level up
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-07-08 13:40:21 +02:00
DL6ER 6446bcb131 Pi-hole v6.0 API description for /api/dns
Signed-off-by: DL6ER <dl6er@dl6er.de>
2023-07-08 13:40:18 +02:00