Pēteris Caune
bdb6f18a3d
Add "uuid" field in API responses when read/write key is used
...
The API responses already contain ping_url, update_url, resume_url,
pause_url fields where the UUID can be extracted from, so we are
not exposing new information. The extraction can be finicky in,
say, shell-scripting scenarios. So for API user convenience we will
now also provide the check's code (UUID) as a separate field.
Fixes : #1007
2024-07-18 18:15:52 +03:00
Pēteris Caune
1ec4fbc0c9
Add a note about flip retention in docs
2024-02-15 11:16:01 +02:00
Pēteris Caune
2ea7ff5950
Improve copy in email.md
2024-02-06 10:09:25 +02:00
Pēteris Caune
7ba2374616
Add API docs for /api/v3/status/
...
Fixes #949
2024-01-29 11:31:05 +02:00
Pēteris Caune
964ec7a1d4
Update the API docs regarding OnCalendar schedules
2023-12-07 15:03:50 +02:00
Viktor Szépe
573b76a082
Fix typos ( #855 )
2023-07-02 15:14:13 +03:00
Pēteris Caune
651aec4ac7
Add API support for filtering checks by slug
...
Fixes : #844
2023-06-27 12:41:31 +03:00
Pēteris Caune
20e8408f24
Update v2->v3
2023-06-15 10:29:25 +03:00
Pēteris Caune
9172e8de62
Add API v3 docs
2023-06-15 10:22:49 +03:00
Pēteris Caune
0e2d2154c8
Make API docs fit better on mobile screens
2023-03-08 09:29:43 +02:00
Pēteris Caune
a316c36086
Fix more typos, spelling and grammar mistakes in docs
2023-02-19 14:37:19 +02:00
Pēteris Caune
a9b084ec9a
Add "Start Keyword" filtering for inbound emails
...
Fixes : #716
2023-01-16 13:19:35 +02:00
Pēteris Caune
4863dda6c3
Add /api/v2/ which reports check's status slightly differently
...
cc: #633
2022-12-19 22:31:38 +02:00
Pēteris Caune
dbb360e524
Improve TOC and section titles in Management API docs
2022-11-28 14:58:57 +02:00
Pēteris Caune
ea2f2d9ec0
Add more tests
2022-11-28 14:04:57 +02:00
Pēteris Caune
de7097e1eb
Improve docs
2022-11-28 13:40:40 +02:00
Martin Lablans
a55a2692dc
Allow to retrieve a ping's body ( #737 )
...
Add /api/v1/checks/<uuid>/pings/<n>/body endpoint for retrieving ping body (#737 )
2022-11-28 13:21:26 +02:00
Pēteris Caune
85f7a1c348
Update Ping API and Management API docs for run IDs
2022-11-10 11:49:38 +02:00
Pēteris Caune
5a0bf4062f
Add API support for resuming paused checks
...
Fixes : #687
2022-08-04 14:00:46 +03:00
Pēteris Caune
cd087d2fbf
Add API support for enabling/disabling filtering in message body
...
Specifically, add read/write support for the new fields:
* success_kw
* failure_kw
* filter_subject
* filter_body
The API still supports reading/writing the "subject" and
"subject_fail" fields, but these are now marked as deprecated
in API documentation.
Fixes : #653
2022-07-15 13:04:41 +03:00
Pēteris Caune
51f7fe7332
Expose subject and subject_fail in API GET calls, improve docs
2022-06-03 09:59:20 +03:00
Tyler
d61909ffd2
Expose subject and subject_fail via API
2022-06-03 09:12:46 +03:00
Pēteris Caune
e0d2f36928
Improve period and grace controls, allow up to 365 day periods
...
Fixes : #281
2021-11-04 15:44:51 +02:00
Pēteris Caune
5b9008e321
Implement alternative ping URLs, WIP
2021-09-09 09:32:10 +03:00
Pēteris Caune
c7317a87fc
Improve /api/v1/badges/ docs
2021-08-19 13:00:42 +03:00
Pēteris Caune
28506deb74
Improve /api/v1/badges/ docs
...
cc: #552
2021-08-19 12:42:24 +03:00
Pēteris Caune
98eb7cc14a
Add /api/v1/badges/ endpoint
...
cc: #552
2021-08-18 17:47:57 +03:00
Pēteris Caune
4756527185
Improve docs
2021-08-12 13:07:19 +03:00
Pēteris Caune
70519fcd89
Fix spelling, grammar, style mistakes
2020-12-28 14:06:54 +02:00
Pēteris Caune
0e77064c44
Update API to allow specifying channels by names
...
Fixes : #440
2020-10-14 15:37:04 +03:00
Pēteris Caune
b64c8d1cb8
API support for setting the allowed HTTP methods for making ping requests
2020-09-10 10:29:44 +03:00
Pēteris Caune
c13f65e118
Grammar and style fixes.
2020-09-09 17:53:24 +03:00
Pēteris Caune
3f44eac485
Update the section about read-write and read-only API keys.
2020-07-08 13:55:46 +03:00
Pēteris Caune
c160045bda
Update the section about read-write and read-only API keys.
2020-07-08 13:52:31 +03:00
Pēteris Caune
27a91bfe22
Tweak navigation in docs, added "Docs > Reliability Tips" page (cc: #384 )
2020-07-02 18:39:30 +03:00
Pēteris Caune
c3d8ee0965
Update API docs.
2020-06-15 13:25:55 +03:00
James Kirsop
90d4246848
Second interation of this
2020-06-12 13:39:03 +10:00
Pēteris Caune
beff11ceff
Fixing typo
2020-06-11 16:07:04 +03:00
Pēteris Caune
cdafc06c65
In urls.py, route "api/v1/checks/<sha1:unique_key>" directly to the hc.api.views.get_check_by_unique_key view.
...
Minor API documentation edits.
2020-06-11 15:24:45 +03:00
James Kirsop
8725c81144
Implementing new changes discussed to resolve #370
2020-06-11 17:00:27 +10:00
Pēteris Caune
a07325e40f
Add "Get a list of checks's logged pings" API call ( #371 )
2020-06-09 18:09:57 +03:00
Pēteris Caune
461ef5e088
Paused ping handling can be controlled via API. Fixes #376
2020-06-09 15:16:39 +03:00
Sandro Jäckel
38382d662d
Fix typos with codespell
2020-04-14 03:53:16 +02:00
Pēteris Caune
76ae42bc8f
"Get a single check" API call now supports read-only API keys. Fixes #346
2020-03-24 16:10:42 +02:00
Pēteris Caune
da4cf5241e
Minor cleanup, update CHANGELOG
2020-03-23 11:54:41 +02:00
James Kirsop
456a80f1fa
Adding tests and docs
2020-03-23 11:37:32 +11:00
Pēteris Caune
35e476be59
Document more response codes.
2020-03-04 12:12:38 +02:00
Pēteris Caune
ccba5e8731
Fix default values for timeout and grace parameters in API reference.
2020-03-02 13:50:27 +02:00
Pēteris Caune
dab0c4200e
API reference in Markdown
2020-03-02 13:37:29 +02:00
