Local runner heartbeat | Opik Documentation

POST/v1/private/local-runners/{runnerId}/heartbeatsLocal runner heartbeat

Refresh local runner heartbeat

Parameters

runnerIdstring · uuidpathrequired

Request body

application/json

objectLocalRunnerHeartbeatRequest

capabilitiesarray of string

Show child attributes

Example request

{
  "capabilities": [
    "string"
  ]
}

Responses

objectLocalRunnerHeartbeatResponse

cancelled_job_idsarray of string · uuid

Show child attributes

Example response

{
  "cancelled_job_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

runnerIdrequiredpath parameter

curl -X POST 'http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/heartbeats' \
  -H 'Content-Type: application/json' \
  -d '{"capabilities":["string"]}'

const response = await fetch('http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/heartbeats', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"capabilities":["string"]}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/heartbeats', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"capabilities\":[\"string\"]}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/heartbeats",
    headers={"Content-Type": "application/json"},
    data='{"capabilities":["string"]}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"capabilities":["string"]}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/heartbeats", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/heartbeats");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"capabilities\":[\"string\"]}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/heartbeats"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"capabilities\":[\"string\"]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/heartbeats")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"capabilities\":[\"string\"]}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5173/api/v1/private/local-runners/00000000-0000-0000-0000-000000000000/heartbeats");
request.Content = new StringContent("{\"capabilities\":[\"string\"]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "cancelled_job_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}