InOrbitdocs
Sign in
Docs
Have a token? Manage tokens in the console
DELETE
/v1/accounts/orgs/{org_id}/agents/{agent_id}

Revokes the agent if it is not already, then takes it off the list.

Needs scope agents:write.

Authorization

bearer
headerAuthorizationBearer <token>

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

Path Parameters

org_id*string

The account's id: org in GET /v1/me.

agent_id*string

The agent's id (agt_…), from List agents.

Response Body

iohr.agents.v1.DeleteAgentResponse

application/json
  1. response

iohr.agents.v1.DeleteAgentResponse

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.agents.deleteAgent("<org_id>", "<agent_id>");  console.log(value);} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);}

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.

{}

Revoke an agent POST

Cuts the agent off: its session closes within seconds and its identity is deleted, so it cannot connect again. It stays in the list as revoked. Needs scope `agents:write`.

Run a check through an agent POST

Sends one check to an online agent and waits up to 30 seconds for its result: `ok`, `failed` or `refused` by the agent's local policy, with the latency, the HTTP status and an error class, never a body. A named host must be inside the agent's verified domains; a private address or an internal name goes to the agent, whose policy decides. `auth` is a reference the agent resolves in your secret store (`vault:`, `k8s:`, `env:`, `file:`), never a secret. Needs scope `agents:write`.