Daemon Heartbeat
curl --request POST \
--url https://api.hyperspell.com/daemon/heartbeat \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user_key": "<string>",
"daemon_version": "unknown",
"last_sync_version": 0,
"uptime_s": 0
}
'import requests
url = "https://api.hyperspell.com/daemon/heartbeat"
payload = {
"user_key": "<string>",
"daemon_version": "unknown",
"last_sync_version": 0,
"uptime_s": 0
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
user_key: '<string>',
daemon_version: 'unknown',
last_sync_version: 0,
uptime_s: 0
})
};
fetch('https://api.hyperspell.com/daemon/heartbeat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperspell.com/daemon/heartbeat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'user_key' => '<string>',
'daemon_version' => 'unknown',
'last_sync_version' => 0,
'uptime_s' => 0
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hyperspell.com/daemon/heartbeat"
payload := strings.NewReader("{\n \"user_key\": \"<string>\",\n \"daemon_version\": \"unknown\",\n \"last_sync_version\": 0,\n \"uptime_s\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hyperspell.com/daemon/heartbeat")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user_key\": \"<string>\",\n \"daemon_version\": \"unknown\",\n \"last_sync_version\": 0,\n \"uptime_s\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperspell.com/daemon/heartbeat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_key\": \"<string>\",\n \"daemon_version\": \"unknown\",\n \"last_sync_version\": 0,\n \"uptime_s\": 0\n}"
response = http.request(request)
puts response.read_body{
"ok": true
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Daemon
Daemon Heartbeat
Record a daemon heartbeat. The dashboard reads these to show active daemons.
POST
/
daemon
/
heartbeat
Daemon Heartbeat
curl --request POST \
--url https://api.hyperspell.com/daemon/heartbeat \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user_key": "<string>",
"daemon_version": "unknown",
"last_sync_version": 0,
"uptime_s": 0
}
'import requests
url = "https://api.hyperspell.com/daemon/heartbeat"
payload = {
"user_key": "<string>",
"daemon_version": "unknown",
"last_sync_version": 0,
"uptime_s": 0
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
user_key: '<string>',
daemon_version: 'unknown',
last_sync_version: 0,
uptime_s: 0
})
};
fetch('https://api.hyperspell.com/daemon/heartbeat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperspell.com/daemon/heartbeat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'user_key' => '<string>',
'daemon_version' => 'unknown',
'last_sync_version' => 0,
'uptime_s' => 0
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hyperspell.com/daemon/heartbeat"
payload := strings.NewReader("{\n \"user_key\": \"<string>\",\n \"daemon_version\": \"unknown\",\n \"last_sync_version\": 0,\n \"uptime_s\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hyperspell.com/daemon/heartbeat")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user_key\": \"<string>\",\n \"daemon_version\": \"unknown\",\n \"last_sync_version\": 0,\n \"uptime_s\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperspell.com/daemon/heartbeat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_key\": \"<string>\",\n \"daemon_version\": \"unknown\",\n \"last_sync_version\": 0,\n \"uptime_s\": 0\n}"
response = http.request(request)
puts response.read_body{
"ok": true
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
APIKeyAsUser
API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.
Body
application/json
Response
Successful Response
Was this page helpful?
⌘I