Sign in
Docs
API referenceAgents

API reference

Record a repository's head

Have a token? Manage tokens in the console
POST
/v1/accounts/orgs/{org_id}/deployments/heads

Records the head of a repository's default branch (main when branch is left out), so deployments compare with it. Run it on every merge; it replaces the last head.

Needs scope agents: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

org_id*string

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

Request Body

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

application/json
  1. body

iohr.agents.v1.RecordHeadRequest

branch?string
commit?string
org_id?string
repository?string

Response Body

iohr.agents.v1.RecordHeadResponse

application/json
  1. response

iohr.agents.v1.RecordHeadResponse

branch*string
commit*string
recorded_at*string
repository*string
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.recordHead("<org_id>", {    branch: "<branch>",    commit: "<commit>",    repository: "<repository>",  });  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
{  "branch": "string",  "commit": "string",  "recorded_at": "string",  "repository": "string"}