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

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.

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.

Header Parameters

idempotency-key?string

Makes a retry safe: a repeat with the same key and the same body within a day answers what the first call did (with Idempotency-Replayed: true) instead of running again; the same key with another body is 422 unprocessable. 1 to 255 visible characters; a UUID is a good one.

Length1 <= length <= 255

Request Body

iohr.agents.v1.RevokeAgentRequest; path variables override their fields

application/json
  1. body

iohr.agents.v1.RevokeAgentRequest

agent_id?string
org_id?string

Response Body

iohr.agents.v1.RevokeAgentResponse

application/json
  1. response

iohr.agents.v1.RevokeAgentResponse

agent?

iohr.agents.v1.Agent

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

{  "agent": {    "agent_id": "string",    "arch": "string",    "capabilities": [      "string"    ],    "checks": {      "accepted": 0,      "checks_hash": "string",      "reconciled_at": "string",      "rejected": [        {          "key": "string",          "reason": "string"        }      ]    },    "clock_skew_ms": "string",    "domains": [      "string"    ],    "enrolled_at": "string",    "environment": "string",    "last_seen_at": "string",    "name": "string",    "os": "string",    "policy_hash": "string",    "revoked_at": "string",    "rtt_last_ms": 0,    "rtt_p95_ms": 0,    "status": "string",    "version": "string"  }}

Create an agent enrollment POST

A one-time token (`ioe_…`) that enrolls one agent for an environment and the account's verified domains, within the hour. The token is in this answer only; the platform keeps its hash. Every domain must be verified for the account. Needs scope `agents:write`.

Delete an agent DELETE

Revokes the agent if it is not already, then takes it off the list. Needs scope `agents:write`.