---
title: "Keep the run from retention until a date"
method: PUT
path: "/v1/runs/{runId}/hold"
tags: ["Runs"]
---

# Keep the run from retention until a date

`PUT /v1/runs/{runId}/hold`

## Request

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

Retention leaves the run, its events and its payloads alone until the date, at most a year ahead. Holding again replaces the date. Recorded as retention.held on the run's timeline. Needs rig.run.

## Path parameters

- `runId` string, uuid, required

## Request body

- object
  - `until` string, date-time, required

## Response `200`

The run with its hold.

- object
  - `run` Run, required
    - `created_at` string, date-time, required
    - `created_by` string
    - `expires_at` string, date-time, required
    - `external_id` string
    - `finished_at` string, date-time
    - `id` string, uuid, required
    - `organisation_id` string, uuid, required
    - `outcome` 'pass' | 'fail' | 'none': Present once finished.
    - `project_id` string, uuid, required
    - `reason` string
    - `started_at` string, date-time, required
    - `status` 'active' | 'finished' | 'cancelled' | 'expired', required
    - `suite_id` string, uuid, required
    - `suite_version_id` string, uuid, required
    - `ttl_seconds` integer, required

## Other responses

- `404`: No such object in this organisation (`not_found`).
- `422`: A field is invalid; the message names it (`invalid_request`).

---

[API](https://skmtc.dev/ironfang/apis/ironfang-rig-api.md) · [All operations](https://skmtc.dev/ironfang/apis/ironfang-rig-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ironfang/apis/ironfang-rig-api/revisions/3e86a312dad1?raw)