Usage

The hosts, bounds and retention a client builds against

The fixed facts of this deployment: the domain inbox addresses are minted under, the base URLs of callback and mock addresses, the gateway connectors dial, the ironfang-connect release to run when the API knows it, every per-organisation, per-suite and per-run bound, what is metered, and how long payload bytes and runs are kept. The bounds are capacity limits, the same whatever the account pays. Read-only. Needs rig.read.

get/v1/environment

Request

  • Base URL: https://api.ironfang.com/rig
  • URL: https://api.ironfang.com/rig/v1/environment
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Response

The environment

connect_urlstring uri required
hooks_base_urlstring uri required
inbox_domainstring required
limitsobject required

Every capacity bound, in the unit its name says. These are the same whatever the account pays; billing refusals are separate (see metering).

mock_base_urlstring uri required

Example response

{
  "connect_url": "wss://connect.rig.ironfang.com/v1/connect",
  "hooks_base_url": "https://hooks.rig.ironfang.com",
  "inbox_domain": "inbox.rig.ironfang.com",
  "metering": {
    "counted_events": [
      "email.received",
      "callback.received",
      "mock.request.received"
    ]
  },
  "mock_base_url": "https://mock.rig.ironfang.com"
}

Changes

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