Sign in
Docs
API referenceCoordinator

API reference

File a pipeline template

Have a token? Manage tokens in the console
POST
/v1/coordinator/pipelines

File a pipeline template: its stages, the states each stage holds and the WebAssembly steps that gate a move between them. An admin of the account, with steps:write. Every step it names must be filed and every stage must hold a state. A version once filed never changes: the same again answers existed; a different definition under a filed version is a conflict.

Needs scope steps: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.

Request Body

iohr.coordinator.v1.CreatePipelineRequest; path variables override their fields

application/json
  1. body

iohr.coordinator.v1.CreatePipelineRequest

account_id?string
definition?string

Response Body

iohr.coordinator.v1.CreatePipelineResponse

application/json
  1. response

iohr.coordinator.v1.CreatePipelineResponse

existed*boolean
pipeline?

iohr.coordinator.v1.Pipeline

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.coordinator.createPipeline({ definition: "<definition>" });  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
{  "existed": true,  "pipeline": {    "author": "string",    "created_at": "string",    "definition": "string",    "digest": "string",    "id": "string",    "title": "string",    "version": 0  }}