Developer · CONNECTION

Ironfang + NodeHub

Run Ironfang Render jobs and templates, Finance e-invoices, Audit website audits and findings, and Rig test environments.

Explore 138 workflow actions for Ironfang, including account permissions and operation limits.

77 read actions61 write actions

WORKFLOW ACTIONS

What you can configure.

Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.

Audit: A page's observation history, newest first

Read

Returns paginated observations for a page within the authenticated organisation.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: Apply one decision to several findings

Write

The same path as a single update, once per finding, so each one gets its own event and nothing is attributed differently for having been done in a batch.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Archive a monitor (one-way; its audits and evidence remain)

Write

Permanently archives the organisation's monitor so it cannot be resumed or run again.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Assign, schedule, acknowledge, accept the risk, or close a finding

Write

A person cannot mark a finding fixed: that is a claim about the page which only a passing observation can make, so closing one by hand needs a resolution such as falsepositive or acceptedrisk.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Change a monitor's name, cadence, anchor, timezone, capture profile or change po

Write

A cadence, anchor or timezone change clears the next slot; the scheduler recomputes it on its next tick.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Create a deterministic rule

Write

Validates the rule type and configuration, then creates a versioned rule for the selected site.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Create a monitor

Write

mode is fullsite (crawler discovery under the site's crawl policy) or urlset (exactly the given urls, validated against the site's hosts, patterns and the public-target policy; the whole set is.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Create a site

Write

Registers a public website for the authenticated organisation.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Disable a rule for future audits

Write

Affects future audits only.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Enable a rule for future audits

Write

Enables the organisation's rule for evaluation by future audits.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Enable or disable an endpoint, or change its subscribed events

Write

Enabling clears the consecutive-failure count.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Get a monitor with its URL set

Read

Returns the organisation's monitor configuration together with its configured URL set.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: Get a site

Read

Returns stored site configuration and complete activity facts.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: Get audit lifecycle, compliance and integrity state

Read

Returns the organisation's audit record, including its processing status and recorded compliance and evidence-integrity results.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: Get one finding

Read

Returns a finding belonging to the authenticated organisation, including its current triage state.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: Get the active revision of a rule

Read

Resolves a rule's stable lineage identifier to its current revision within the authenticated organisation.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: Install a rule pack

Write

Installs the selected catalogue pack on the organisation's site using the supplied variable values.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: List endpoint deliveries

Read

Without query parameters preserves the legacy 200 records ordered by nextattemptat, including payloads.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: List every revision of a rule, newest first

Read

Returns the revision history for the organisation's rule in descending version order, preserving access to the configurations referenced by earlier audit results.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: List export jobs

Read

Returns evidence export jobs for the authenticated organisation, including their recorded delivery state.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: List lifecycle webhook endpoints

Read

Returns the authenticated organisation's webhook endpoint configurations.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: List monitors

Read

Returns the organisation's non-archived monitors, newest first, with the site name, the pages one run may capture and the page captures the monitor may ask for over the current month.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: List organisation audits

Read

Returns audit runs across the sites owned by the authenticated organisation, including each run's current lifecycle state.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: List site audits

Read

Returns audit runs for the selected site within the authenticated organisation.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: List sites

Read

Returns the sites owned by the authenticated organisation, including their stored audit configuration and complete per-site activity facts.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: List the Ironfang Audit signing-key ledger

Read

Publishes the public signing-key ledger and lifecycle metadata used to inspect Ironfang Audit evidence signatures.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: List the site's monitors

Read

Returns the organisation's non-archived monitors for the selected site, including their scheduling configuration.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: List the site's versioned deterministic rules

Read

Returns the deterministic rules configured for a site owned by the authenticated organisation, with their version and configuration metadata.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: One observation with its artifacts and rule results

Read

Returns an observation belonging to the authenticated organisation, including its captured artifact metadata and deterministic rule results.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: Packs installed on this site

Read

Includes latestversion and upgradeavailable.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: Page observations of an audit

Read

Supply limit or cursor to opt into bounded pages ordered by immutable createdat then ID descending.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: Page organisation webhook deliveries

Read

Requires audit.integrations.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: Pause scheduling

Write

Pauses future scheduling for the organisation's monitor.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Price an extension of hosted evidence retention

Write

Prices keeping the hosted evidence of the chosen audits (every hosted artifact of each) and artifacts for months whole months past each one's current deadline.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Queue a manual S3 export

Write

Queues delivery of a completed audit's evidence bundle to an S3 destination owned by the same organisation.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Queue an audit now with the monitor's scope frozen as the scheduler would freeze

Write

Admits and queues an immediate audit with the monitor's current scope, capture profile and change policy frozen into the run.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Re-queue a failed delivery

Write

Requests another attempt for a failed delivery belonging to the organisation's webhook endpoint.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Read one organisation-owned delivery

Read

Returns retained payload and latest response without a history scan.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: Recent notification emails and their delivery state

Read

Returns recent notification-email records for the authenticated organisation and their recorded delivery states.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: Replace a urlset monitor's URL list

Write

Makes the monitor's URL set exactly the given list and returns the monitor: a URL already in the set keeps its identity and label, a URL absent from the list is removed, and duplicates after.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Replace the preferences

Write

Recipients must be current members of the organisation, checked against Warden with the caller's own token; an API key may keep the list but not change it.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Resume scheduling

Write

Resumes scheduling for the organisation's non-archived monitor using its configured cadence and scope.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Retire a rule

Write

Stops the rule being evaluated in future audits.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Retire an endpoint (soft; its delivery history is kept)

Write

Retires the organisation's webhook endpoint from future event delivery while preserving its existing delivery history.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Revise a rule

Write

Writes the next version of the rule and makes it active.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Send a signed endpoint.test event

Write

Sends a signed endpoint.test event to the organisation's webhook endpoint and reports whether the destination accepted it.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Stream an authenticated raw artifact

Read

Streams an artifact owned by the authenticated organisation using its stored media type.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: Tenant-scoped setup facts and recent activity for the portal

Read

Returns setup counts and recent activity for the authenticated organisation.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: The append-only history of a finding

Read

Every state change, assignment and comment, newest first, each attributed to the person or to the system.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: The finding inbox

Read

Outstanding problems rather than audit results.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: The monitor's audits, newest first

Read

Returns audits associated with the organisation's monitor, ordered from newest to oldest.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: The numbers at the top of the finding inbox

Read

Open, acknowledged and accepted counts, how many are regressions, how many are past a due date somebody set, and the median time to resolution.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: The organisation's recent product events, newest first

Read

Types: audit.started, audit.completed (every terminal audit, with status), audit.partial, audit.failed, change.detected, compliance.failed, monitor.skipped (reason is overlap, nourls, or the billing.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: The rule pack catalogue

Read

Ironfang-maintained rule templates.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: This month's metered use, capacity and hosted evidence

Read

The month (UTC) as the organisation's billing account has it for Ironfang Audit's meters - captures (audit.capture) and retentionextension (audit.retentionextension): the free allowance, what has.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: Trigger an asynchronous audit

Write

Admits and queues an audit for the organisation's site and returns its initial lifecycle state.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Uninstall a pack

Write

Retires the rules it created.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: Upgrade an installed pack, or change its values

Write

The explicit action.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Audit: What changed against the observation before it

Read

Computed from stored evidence under the audit's change policy - normalised text hunks (whitespace collapsed, numbers masked, ignored selectors removed), scores, URL/title/status changes, rule.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Audit: Which events the organisation is emailed about, to whom, and whether as a daily

Read

Returns the organisation's selected notification events, recipients and digest preference, together with the available event type catalogue.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Finance: Cancel an async job

Write

Cancel unfinished tenant-owned work with finance:einvoices:write.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Finance: Cancel an ordered batch

Write

Cancel unfinished tenant-owned work with finance:einvoices:write.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Finance: Create an async job

Write

Accept work durably using finance:einvoices:write.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Finance: Delete saved result bytes and findings

Write

Requires finance:einvoices:write.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Finance: Fetch one ruleset by its immutable id

Read

Returns the customer-safe identity of one ruleset: enough to select it, to know its state, and to reproduce a validation that named it.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Finance: Generate e-invoice

Write

Generate a UBL invoice or credit note from structured data and validate it against EN 16931 (and the chosen ruleset and profile); the result is saved for reports.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Finance: Get an async job

Read

Read tenant-owned job metadata with finance:einvoices:read.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Finance: Get an ordered batch

Read

Read tenant-owned job metadata with finance:einvoices:read.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Finance: List batches

Read

Tenant-scoped metadata, newest first by creation time and ID.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Finance: List delivery history with keyset pagination

Read

List delivery history with keyset pagination.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Finance: List jobs

Read

Tenant-scoped metadata, newest first by creation time and ID.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Finance: List rulesets available for selection and reproduction

Read

Lists the immutable rulesets a caller may validate against: scheduled, sendable and historical releases.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Finance: List saved validation and generation results

Read

Returns a bounded page of result metadata, newest first by creation time and operation ID.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Finance: Read a delivery and its immutable attempt history

Read

Read a delivery and its immutable attempt history.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Finance: Read a saved validation or generation result

Read

Returns the exact original JSON while retained.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Finance: Read Ironfang Finance report signing public keys

Read

Operator-configured Ed25519 public keys only.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Finance: Read Ironfang Finance usage for a month

Read

Requires finance:billing:manage.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Finance: Retry failed delivery without rerunning validation

Write

Retry failed delivery without rerunning validation.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Render: Archive a document template

Write

Archives the template: it can no longer be edited, published or rendered without a revision number.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Render: Cancel a job

Write

A queued job is cancelled and its reservation released at once; a running one stops at its next safe point, and counts only if it had already produced a usable output.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Render: Create a document template

Write

Stores a draft.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Render: Create a template

Write

Store HTML containing {{placeholders}}.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Render: Delete a template

Write

Removes a stored template from the authenticated account so it can no longer be used for new template renders.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Render: Fetch a document template

Read

The template and its draft.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Render: Fetch a revision

Read

One revision, with its source.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Render: Fetch a template

Read

Returns a stored rendering template belonging to the authenticated account, including its HTML and output dimensions.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Render: List batches

Read

Tenant-scoped metadata, newest first by creation time and ID.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Render: List deliveries

Read

Newest first, optionally for one destination.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Render: List document templates

Read

The account's document templates, newest first, without their sources.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Render: List jobs

Read

Newest first.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Render: List revisions

Read

The template's revisions, newest first, without their sources.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Render: List templates

Read

Paged newest first.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Render: One delivery, with the body it posted

Read

The list omits payloads because they are the largest part of a delivery and are wanted one at a time, when something has gone wrong.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Render: Poll a batch

Read

counts totals the items by state and done is true once none of them can change.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Render: Poll a job

Read

status is queued, running, cancellationrequested, succeeded, failed or cancelled.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Render: Publish an existing revision

Write

Points unversioned renders at this revision - a rollback, or forward again.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Render: Publish the draft

Write

Makes the draft the published revision: a new immutable revision, numbered after the last - or, when the draft is exactly the latest revision, that one again.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Render: Replace a document template's draft

Write

Replaces the draft.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Render: Replace a template

Write

Replaces the authenticated account's stored template with the supplied name, HTML and dimensions.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Render: Request history

Read

One row per authenticated render in the last seven days, newest first, synchronous calls and jobs alike: kind, outcome, safe error code, cache hit or miss, the meter it counted against and the.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Render: Send a delivery again

Write

Puts a delivery back on the queue with a fresh attempt ladder, for after you have fixed whatever was wrong.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Render: Submit a durable render job

Write

The same renders as the synchronous endpoints - kind is one of screenshot, pdf, qr, image, clip, sitepreview, document or bundle and request is that endpoint's body (an image job names its template.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Render: Submit up to 100 jobs together

Write

One default request plus items that override parts of it, merged one level deep: an item's field wins, everything else comes from the default.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Render: Usage this period

Read

This UTC calendar month's Ironfang Render usage from your organisation's billing account: for every Render meter, what was used, how much of it the free allowance covered, what is held by work in.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Render: Validate a draft against data

Write

Compiles the draft, checks the data (the body's, else the sample data) against its schema and runs the template, without printing or billing.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Render: What Ironfang Render does, is building and does not offer

Read

A dated statement of capabilities with a status of live, planned or notoffered.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: A signed receipt for the run

Write

A signed statement of what the run was and how it ended: project, suite and version, status and outcome, every verdict, the event count and the head of the event hash chain.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Rig: Allocate a resource

Write

Allocates one more resource on an active run, beyond what the suite declared, with the run's expiry.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Rig: Arm a fault

Write

Arms deterministic interference on one resource of an active run.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Rig: Cancel a run

Write

Ends an active run without an outcome and writes run.cancelled.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Rig: Create a project

Write

Creates a project.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Rig: Create a suite

Write

Creates a suite and its first version from a definition.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Rig: Disarm a fault

Write

Disarms an active fault and records fault.removed.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Rig: Export the run's evidence bundle

Write

Builds the run's evidence bundle from what it recorded and returns it: a ZIP holding manifest.json (the run, counts, and every file's size and SHA-256), events.json (the whole timeline in sequence.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Rig: Finish a run

Write

Ends an active run with the outcome you report (pass, fail, or none when you make no claim) and writes run.completed to its timeline.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Rig: Get a project

Read

Returns one project.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: Get a run

Read

Returns one run's state, lifetime and outcome.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: Get a suite

Read

Returns the suite and its current version.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: Get an event

Read

Returns one event of the run with its full data.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: Keep the run from retention until a date

Write

Retention leaves the run, its events and its payloads alone until the date, at most a year ahead.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Rig: Lift a retention hold

Write

Recorded as retention.released.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Rig: List a run's connectors

Read

Returns every connector minted for the run with its state (pending, online, offline), the routes it is bound to and when it was last seen, plus how many deliveries are still waiting for a connector.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: List a run's faults

Read

Returns every fault armed on the run - active, spent and removed - in the order they were armed, with how often each has fired.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: List a run's resources

Read

Returns every resource allocated to the run, in allocation order, with the address or URL each one answers at.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: List a suite's versions

Read

Returns up to 100 versions, newest first, each with its full definition.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: List projects

Read

Returns the organisation's projects, newest first, as a bounded keyset page.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: List runs

Read

Returns the organisation's runs, newest first, with optional filters.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: List suites

Read

Returns the organisation's suites, newest first, optionally within one project.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: Read the timeline

Read

Returns the run's events in sequence order after since, which is a sequence number (0 for the start).

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: Replace a mock's rules

Write

Replaces the rules a mockhttp resource answers with, in order, while the run is active.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Rig: Replay a recorded callback

Write

Forwards a callback the run received to its connector route again, exactly as recorded, to prove the application handles a repeat.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Rig: Revise a suite

Write

Records a new version when the definition changed and answers the current version unchanged when it did not, so sending the same document twice creates one version.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Rig: Runs, events and metered interactions

Read

Counts the organisation's runs started in the window and the events those runs recorded, by type, plus how many runs are active now.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: Start a run

Write

Starts a run of the suite's current version and allocates every resource the definition declares: a fresh inbox address, callback URL, mock URL or route label each, unguessable and unique to this run.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

Rig: Tenant-scoped setup facts and recent activity for the portal

Read

Counts of projects, suites and runs, the moments that mark setup (a key first reached the product, the first run started, the first run finished), and the seven most recent runs as activity.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: The hosts, bounds and retention a client builds against

Read

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.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: The keys evidence is signed with

Read

The public keys bundles and receipts are signed with, by key id, so a verifier can trust a signature by key rather than by the key it carries.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

Rig: Wait for an event

Write

Blocks until an event after since matches, or the timeout passes.

Permissions and limits

Account permissions

An Ironfang if_live_ platform API key with the product scopes

A repeated request may repeat the external action. Review the previous result before retrying a write.

SETUP

Start with a controlled test.

01Connect the intended account

Use the account and permissions required for your process. Review the connection check before configuring a workflow action.

02Review inputs and access

Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.

03Confirm the result

Inspect step outputs and confirm the result in Ironfang. A saved workflow is not a completed provider action.

Follow the workflow quickstart

EXPLORE YOUR STACK