InOrbitdocs
Sign in
Docs
Have a token? Manage tokens in the console
GET
/v1/connectors/{connector_id}

One connector of the catalogue, by its id (incident-io, pagerduty, datadog, grafana, discord, ...).

Needs scope connections:read.

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

connector_id*string

The connector's id, from List connectors; also the kind of a connection made from it.

Response Body

iohr.connections.v1.GetConnectorResponse

application/json
  1. response

iohr.connections.v1.GetConnectorResponse

connector?

iohr.connections.v1.Connector

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.connections.getConnector("<connector_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.

{  "connector": {    "actions": [      {        "auth_modes": [          "string"        ],        "class": "string",        "model": "string",        "name": "string",        "params": [          {            "after_consent": true,            "choices": [              "string"            ],            "default": "string",            "help": "string",            "label": "string",            "max": "string",            "name": "string",            "required": true,            "secret": true,            "type": "string"          }        ],        "title": "string"      }    ],    "ai": true,    "auth_modes": [      {        "fields": [          {            "after_consent": true,            "choices": [              "string"            ],            "default": "string",            "help": "string",            "label": "string",            "max": "string",            "name": "string",            "required": true,            "secret": true,            "type": "string"          }        ],        "label": "string",        "mode": "string",        "needs_app": true,        "optional_scopes": [          "string"        ],        "refresh": true,        "scopes": [          "string"        ]      }    ],    "category": "string",    "config_fields": [      {        "after_consent": true,        "choices": [          "string"        ],        "default": "string",        "help": "string",        "label": "string",        "max": "string",        "name": "string",        "required": true,        "secret": true,        "type": "string"      }    ],    "description": "string",    "docs": "string",    "hosts": [      "string"    ],    "icon": "string",    "id": "string",    "kind": "string",    "name": "string",    "redirect_url": "string",    "setup": {      "description": "string",      "mcp_url": "string",      "snippets": [        {          "label": "string",          "language": "string",          "path": "string",          "text": "string"        }      ],      "suggested_scopes": [        "string"      ]    },    "status": "string",    "triggers": [      {        "name": "string",        "title": "string"      }    ]  }}

List connectors GET

The connector catalogue (RFC 0044): every app a connection can be made from, with its category, auth modes and the fields each asks for (secret ones are sealed and never answered), its settings, its actions with their class and parameters, the hosts it may call, and whether it is `available`, `coming_soon` or `needs_app` (it signs in and this platform has no OAuth app for it yet). `kind` is `connector`, or `client` for an AI assistant that uses InOrbit over MCP (its `setup` says how); `ai` marks an AI model provider (bring your own key). Needs scope `connections:read`.

List connections GET

The account's connections, newest first: kind, executor (`cloud` or an agent), configuration, what kind of credential it holds (never the credential), status, last test and live grants. Needs scope `connections:read`.