Device Heartbeat
POST
/api/v1/heartbeat
const url = 'https://example.com/api/v1/heartbeat';const options = {method: 'POST', headers: {'X-Device-ID': 'example', 'X-API-Key': 'example'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/heartbeat \ --header 'X-API-Key: example' \ --header 'X-Device-ID: example'Device heartbeat - updates last seen and checks for pending updates
Parameters
Section titled “ Parameters ”Header Parameters
Section titled “ Header Parameters ” X-Device-ID
required
X-Device-Id
string
X-API-Key
required
X-Api-Key
string
Responses
Section titled “ Responses ”Successful Response
Media type application/json
Example generated
exampleValidation Error
Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{ "detail": [ { "ctx": {}, "input": "example", "loc": [ "example" ], "msg": "example", "type": "example" } ]}