Refresh device presence

Authenticated presence only. Does not fetch, dispatch, complete or replay an action, extend its expiry, or change any grant. Used during long execution when ordinary device polling is paused.

POST/v1/device/{deviceId}/heartbeat

Authorization

AuthorizationBearer token (device child credential) · headerrequired

Child device credential, independently revocable from its setup token.

Path parameters

deviceIdstring<uuid>required

Header parameters

x-openlaunch-workspacestringrequired

Workspace routing identifier for the device credential; not a secret.

matches ^[a-f0-9]{64}$

Request body

requiredapplication/json

object

Responses

200

Successful response

dataobjectrequired

Show properties

lastSeenintegerrequired

400

Invalid request or validation failure

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

401

Missing or invalid credential

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

403

Insufficient access or grant

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

404

Resource not found

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

413

Request body exceeds the 16 KiB limit

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

429

Rate limit or workspace capacity limit

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

500

Internal error

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

503

Service or required integration is not configured

errorobjectrequired

Show properties

codestringrequired

messagestring

issuesobject[]

Show properties

Array of object

pathstring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (device child credential)Remember on this deviceInclude my values in samples

Parameters

deviceIdpath*x-openlaunch-workspaceheader*Workspace routing identifier for the device credential; not a secret.

Bodyapplication/json

Request body

Request

curl -X POST 'https://www.openlaunch.dev/v1/device/497f6eca-6276-4993-bfeb-53cbbbba6f08/heartbeat' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'x-openlaunch-workspace: string' \
  -H 'Content-Type: application/json' \
  -d '{}'

const response: Response = await fetch("https://www.openlaunch.dev/v1/device/497f6eca-6276-4993-bfeb-53cbbbba6f08/heartbeat", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "x-openlaunch-workspace": "string",
    "Content-Type": "application/json"
  },
  body: "{}"
});

import requests

response = requests.post(
    "https://www.openlaunch.dev/v1/device/497f6eca-6276-4993-bfeb-53cbbbba6f08/heartbeat",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "x-openlaunch-workspace": "string",
        "Content-Type": "application/json"
    },
    data="{}",
)

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader("{}")
	req, err := http.NewRequest("POST", "https://www.openlaunch.dev/v1/device/497f6eca-6276-4993-bfeb-53cbbbba6f08/heartbeat", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
	req.Header.Set("x-openlaunch-workspace", "string")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

Response

{
  "data": {
    "lastSeen": 0
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}