Herzschläge - API-Dokumentation

Alle abrufen

Endpunkt

GET https://uprobot.co/api/heartbeats/

Beispiel

curl --request GET \
--url 'https://uprobot.co/api/heartbeats/' \
--header 'Authorization: Bearer {api_key}' \

Parameteren	Einzelheiten	Beschreibung
page	Optional Ganzzahl	Die Seitennummer, von der Sie Ergebnisse wünschen. Standardmäßig `1`.
results_per_page	Optional Ganzzahl	Wie viele Ergebnisse möchten Sie pro Seite. Erlaubte Werte sind: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Standardmäßig `25`.

Antwortbeispiel

{ "data": [ { "id": 1, "project_id": 0, "name": "Demo cron", "code": "12345678901112131415", "settings": { "run_interval": 1, "run_interval_type": "minutes", "run_interval_grace": 1, "run_interval_grace_type": "seconds" }, "is_ok": 1, "uptime": 75.5, "downtime": 24.5, "total_runs": 50, "total_missed_runs": 15, "last_run_datetime": "2021-03-30 19:17:22", "notifications": { "email_is_enabled": 0, "webhook": "", "slack": "", "twilio": "" }, "is_enabled": true, "datetime": "2021-03-09 11:30:20" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://uprobot.co/api/heartbeats?&page=1", "last": "https://uprobot.co/api/heartbeats?&page=1", "next": null, "prev": null, "self": "https://uprobot.co/api/heartbeats?&page=1" } }

Eins abrufen

Endpunkt

GET https://uprobot.co/api/heartbeats/{heartbeat_id}

Beispiel

curl --request GET \
--url 'https://uprobot.co/api/heartbeats/{heartbeat_id}' \
--header 'Authorization: Bearer {api_key}' \

Antwortbeispiel

{ "data": { "id": 1, "project_id": 0, "name": "Demo cron", "code": "12345678901112131415", "settings": { "run_interval": 1, "run_interval_type": "minutes", "run_interval_grace": 1, "run_interval_grace_type": "seconds" }, "is_ok": 1, "uptime": 75.5, "downtime": 24.5, "total_runs": 50, "total_missed_runs": 15, "last_run_datetime": "2021-03-30 19:17:22", "notifications": { "email_is_enabled": 0, "webhook": "", "slack": "", "twilio": "" }, "is_enabled": true, "datetime": "2021-03-09 11:30:20" } }

Erstellen

Endpunkt

POST https://uprobot.co/api/heartbeats

Parameteren	Einzelheiten	Beschreibung
name	Erforderlich Zeichenkette	-
run_interval	Optional Ganzzahl	-
run_interval_type	Optional Zeichenkette	Erlaubte Werte: `seconds`, `minutes`, `hours`, `days`
run_interval_grace	Optional Ganzzahl	-
run_interval_grace_type	Optional Zeichenkette	Erlaubte Werte: `seconds`, `minutes`, `hours`, `days`
is_ok_notifications	Optional Array	Benachrichtigungs-Handler-IDs
is_enabled	Optional Boolesch	-

Beispiel

curl --request POST \
--url 'https://uprobot.co/api/heartbeats' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'target=example.com' \

Antwortbeispiel

{ "data": { "id": 1 } }

Aktualisieren

Endpunkt

POST https://uprobot.co/api/heartbeats/{heartbeat_id}

Parameteren	Einzelheiten	Beschreibung
name	Optional Zeichenkette	-
run_interval	Optional Ganzzahl	-
run_interval_type	Optional Zeichenkette	Erlaubte Werte: `seconds`, `minutes`, `hours`, `days`
run_interval_grace	Optional Ganzzahl	-
run_interval_grace_type	Optional Zeichenkette	Erlaubte Werte: `seconds`, `minutes`, `hours`, `days`
is_ok_notifications	Optional Array	Benachrichtigungs-Handler-IDs
is_enabled	Optional Boolesch	-

Beispiel

curl --request POST \
--url 'https://uprobot.co/api/heartbeats/{heartbeat_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \

Antwortbeispiel

{ "data": { "id": 1 } }

Löschen

Endpunkt

DELETE https://uprobot.co/api/heartbeats/{heartbeat_id}

Beispiel

curl --request DELETE \
--url 'https://uprobot.co/api/heartbeats/{heartbeat_id}' \
--header 'Authorization: Bearer {api_key}' \