API reference
Register a host
Register a host or change one: its name, environment, site, groups and labels. No address, key or password is kept here; those stay with the account's agent.
Needs scope infra:run.
bearerAuthorizationBearer <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.
host_id*stringThe host's id: a name the account picks, web-1.
iohr.infra.v1.UpsertHostRequest; path variables override their fields
application/json- body
iohr.infra.v1.UpsertHostRequest
host?iohr.infra.v1.Host
host_id?stringiohr.infra.v1.UpsertHostResponse
application/json- response
iohr.infra.v1.UpsertHostResponse
created*booleanhost?iohr.infra.v1.Host
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.upsertHost("<host_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.
{ "created": true, "host": { "agent_id": "string", "environment": "string", "host_id": "string", "labels": { "property1": "string", "property2": "string" }, "last_seen_at": "string", "name": "string", "reachability": "string", "site": "string", "updated_at": "string", "updated_by": "string" }}