Sign in
Docs
API referenceCoordinator

API reference

Beat a gate slot

Have a token? Manage tokens in the console
POST
/v1/coordinator/gate-slots/{ticket_id}/heartbeat

The holder is alive: extends the slot by 90 seconds. A stale fencing token, or a slot that expired or was released, is a 409 and changes nothing.

Needs scope coordinator:write.

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

ticket_id*string

The ticket's id, gsl_ and a ULID.

Request Body

iohr.coordinator.v1.HeartbeatGateSlotRequest; path variables override their fields

application/json
  1. body

iohr.coordinator.v1.HeartbeatGateSlotRequest

account_id?string
fencing_token?string
Formatint64
ticket_id?string

Response Body

iohr.coordinator.v1.HeartbeatGateSlotResponse

application/json
  1. response

iohr.coordinator.v1.HeartbeatGateSlotResponse

slot?

iohr.coordinator.v1.GateSlot

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.coordinator.heartbeatGateSlot("<ticket_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
{  "slot": {    "ahead": 0,    "expires_at": "string",    "fencing_token": "string",    "granted_at": "string",    "host": "string",    "id": "string",    "label": "string",    "queued_at": "string",    "slot_limit": 0,    "state": "string",    "user_subject": "string"  }}