Start a run
rig.run.createStart a run of a suite's current version and allocate its resources: fresh inbox addresses, public callback and mock URLs, route labels. Public Internet effect: those addresses accept mail and requests from anyone who knows them until the run ends (its ttl, default 30m, at most 24h). Idempotent per call. Starting a run counts nothing, and runs count toward the organisation's capacity limits; each email, callback or mock request the run's addresses accept counts one rig.interaction against the organisation's usage, and one refused for billing is recorded on the timeline as usage.refused. Finish the run when done rather than letting it expire.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ttl | No | How long the run and its resources live, 1m to 24h, such as "30m". Default from the suite (30m). | |
| reason | No | ||
| suite_id | Yes | ||
| external_id | No | Your reference for this run, such as a CI job id. |