Connectors

Mint a connector and its bootstrap token

Mints a connector on an active run and returns its bootstrap token once. The token is single-use, expires after ten minutes, and is bound to this organisation, this run and the route labels named (every label the run declares when none are given). Start ironfang-connect with it and a local target for each label; the connector exchanges it at the gateway for a session credential that lives no longer than the run. The platform only ever names a route label; what a label points at is decided on the connector's command line and never leaves the machine. Needs rig.connector. A run may have at most 16 connectors.

post/v1/runs/{runId}/connectors

Request

  • Base URL: https://api.ironfang.com/rig
  • URL: https://api.ironfang.com/rig/v1/runs/{runId}/connectors
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

namestring

A label for this connector in the timeline, such as the machine it runs on.

routesstring[]

Route labels to bind the credential to; a subset of what the run declares. Default all of them.

Response

Connector minted; the bootstrap token appears here and nowhere else

bootstrap_expires_atstring date-time required
bootstrap_tokenstring required

The single-use credential, prefixed ift_boot_. Pass it to ironfang-connect in IRONFANG_CONNECT_TOKEN.

commandstring required

The command line to complete with local targets.

gateway_urlstring uri required

The WebSocket endpoint the connector dials.

routesstring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.