API reference
Record a deployment
Records that a service now runs a commit in an environment, from a deploy step in CI or a roll script. commit is the full hash; deployed_at defaults to now. Append only: the newest per service is what the list answers. Only names, hashes and times are kept.
Needs scope agents:write.
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.
org_id*stringThe account's id: org in GET /v1/me.
iohr.agents.v1.RecordDeploymentRequest; path variables override their fields
application/json- body
iohr.agents.v1.RecordDeploymentRequest
commit?stringdeployed_at?stringenvironment?stringorg_id?stringrepository?stringservice?stringsource?stringiohr.agents.v1.RecordDeploymentResponse
application/json- response
iohr.agents.v1.RecordDeploymentResponse
deployment?iohr.agents.v1.Deployment
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.recordDeployment("<org_id>", { commit: "<commit>", deployed_at: "<deployed_at>", environment: "<environment>", 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.
{ "deployment": { "commit": "string", "deployed_at": "string", "environment": "string", "head_commit": "string", "head_recorded_at": "string", "recorded_by": "string", "repository": "string", "service": "string", "source": "string", "state": "string" }}