---
title: "Rename Run"
method: PATCH
path: "/tool_health_check/runs/{run_id}"
---

# Rename Run

`PATCH /tool_health_check/runs/{run_id}`

## Request

- Base URL: `https://api.traversal.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.traversal.com/tool_health_check/runs/{run_id}`
- Auth: none declared

Rename a tool health check run.

## Path parameters

- `run_id` string, required

## Request body

- RenameToolHealthCheckRunRequest: Request to rename a tool health check run.
  - `name` string, required

## Response `200`

Successful Response

- ToolHealthCheckRun: Full run state returned by the polling endpoint.
  - `run_id` string, required
  - `name` string, required
  - `organization_id` string, required
  - `organization_name` string, required
  - `created_by` string, nullable
  - `status` 'pending' | 'running' | 'completed' | 'failed' | 'cancelled', required: Lifecycle status for a tool health check run.
  - `total_tools` integer, required
  - `completed_tools` integer, required
  - `passed_tools` integer, required
  - `failed_tools` integer, required
  - `no_evidence_tools` integer, required
  - `unsupported_tools` integer, required
  - `missing_integration_tools` integer, required
  - `pass_rate` number, nullable
  - `results` ToolHealthCheckResult[], required
    - `id` string, nullable
    - `tool_name` string, required
    - `display_name` string, required
    - `status` 'pending' | 'running' | 'passed' | 'no_evidence' | 'failed' | 'missing_integration' | 'unsupported' | 'skipped', required: Lifecycle status for one tool within a health check run.
    - `execution_mode` 'configured_input' | 'agent': How a tool health check should exercise each selected tool.
    - `required_integrations` RequiredIntegrationSummary[]
      - `integration_type` string, required
      - `data_types` string[]
      - `present` boolean, required
      - `instance_name` string, nullable
      - `last_health_status` string, nullable
    - `effective_input` object, nullable
    - `agent_session_id` string, nullable
    - `agent_user_chat_id` string, nullable
    - `evidence_preview` ToolHealthCheckEvidencePreview[]
      - `kind` string, required
      - `title` string, required
      - `summary` string, required
      - `platform_link` string, nullable
      - `timestamp` union
        - string, date-time
        - string
    - `evidence_count` integer, nullable
    - `duration_seconds` number, nullable
    - `error_message` string, nullable
    - `started_at` string, date-time, nullable
    - `completed_at` string, date-time, nullable
  - `error_message` string, nullable
  - `created_at` string, date-time, required
  - `started_at` string, date-time, nullable
  - `completed_at` string, date-time, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/traversal/apis/traversal-api.md) - [All operations](https://skmtc.dev/traversal/apis/traversal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/traversal/apis/traversal-api/revisions/31e1a8b7cf89?raw)