InOrbitdocs
Sign in
Docs
Have a token? Manage tokens in the console
POST
/v1/accounts/orgs/{org_id}/connections/{connection_id}/test

Runs the kind's test action now (an endpoint's check) and keeps the outcome as the connection's health: the status, the HTTP status code, the latency and, when it failed, why.

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

connection_id*string

The connection's id, con_ and a ULID, from List connections.

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

Response Body

iohr.connections.v1.TestConnectionResponse

application/json
  1. response

iohr.connections.v1.TestConnectionResponse

result?

iohr.connections.v1.ActionResult

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.testConnection("<org_id>", "<connection_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.

{  "result": {    "error_class": "string",    "executor": "string",    "latency_ms": 0,    "message": "string",    "ok": true,    "output": {      "fields": {        "property1": {          "bool_value": true,          "list_value": {            "values": [              {}            ]          },          "null_value": "NULL_VALUE",          "number_value": 0.1,          "string_value": "string",          "struct_value": {}        },        "property2": {          "bool_value": true,          "list_value": {            "values": [              {}            ]          },          "null_value": "NULL_VALUE",          "number_value": 0.1,          "string_value": "string",          "struct_value": {}        }      }    },    "started_at": "string",    "status": "string",    "status_code": 0,    "use_id": "string"  }}

Delete a connection DELETE

Deletes the connection with its sealed credential, its grants and its history. A token from signing in is revoked at the provider first, where the provider supports it. Needs scope `connections:write`.

List grants GET

Who may use which actions of the connection until when, newest first, live, expired and revoked. Needs scope `connections:read`.