Sign in
Docs
API referenceInfrastructure

API reference

Report a run's events (worker)

Have a token? Manage tokens in the console
POST
/v1/infra/worker/runs/{run_id}/report

For the account's agent: a batch of a claimed run's events, already redacted, which also renews the lease.

Needs scope infra:worker.

Authorization

bearer
headerAuthorizationBearer <JWT>

An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Path Parameters

run_id*string

The run's id, run_ and 32 hex characters, from Start a run or List a stack's runs.

Request Body

iohr.infra.v1.ReportRunEventsRequest; path variables override their fields

application/json
  1. body

iohr.infra.v1.ReportRunEventsRequest

events?array<>
run_id?string

Response Body

iohr.infra.v1.ReportRunEventsResponse

application/json
  1. response

iohr.infra.v1.ReportRunEventsResponse

accepted*integer
Formatint32
lease_until*string
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  const { value } = await api.infra.reportRunEvents("<run_id>", {});  console.log(value);} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);  process.exitCode = 1;}

npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.

Example Response
{  "accepted": 0,  "lease_until": "string"}