Sign in
Docs
API referenceInfrastructure

API reference

Get a host

Have a token? Manage tokens in the console
GET
/v1/infra/hosts/{host_id}

One of the account's hosts: its name, groups, labels and reachability.

Needs scope infra:read.

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

host_id*string

The host's id: a name the account picks, web-1.

Response Body

iohr.infra.v1.GetHostResponse

application/json
  1. response

iohr.infra.v1.GetHostResponse

host?

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.getHost("<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.

Example Response
{  "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"  }}