---
title: "Ingest a run report"
method: POST
path: "/api/v1/runs"
tags: ["Runs"]
---

# Ingest a run report

`POST /api/v1/runs`

## Request

- Base URL: `https://dungbeetle.dev`
- URL: `https://dungbeetle.dev/api/v1/runs`
- Auth: one of:
  - HTTP basic
  - HTTP bearer

Requires the `runs:write` scope on agent tokens.

## Request body

- RunIngestPayload
  - `branch` string: Advisory client metadata.
  - `commit` string: Advisory client metadata.
  - `report` IngestReport, required
    - `mode` 'test' | 'update', required
    - `passed` boolean, required
    - `project` string, required
    - `startedAt` string, required
    - `finishedAt` string, required
    - `results` IngestResult[], required
      - `name` string, required
      - `kind` string, required
      - `status` 'passed' | 'failed' | 'missing' | 'updated' | 'error', required
      - `baselinePath` string
      - `diff` string
      - `error` string
      - `snapshot` string: Canonical candidate snapshot JSON (runs pushed with --with-snapshots).
      - `screenshotRefs` object: Content-addressed screenshot artifact ids, set by the server at ingest.
        - `baseline` string: sha-256 hex digest (content-addressed artifact id).
        - `candidate` string: sha-256 hex digest (content-addressed artifact id).
        - `diff` string: sha-256 hex digest (content-addressed artifact id).

## Response `201`

Run stored.

- object
  - `run` StoredRunWithUrl, required
    - `id` string, required
    - `repositoryId` string, required
    - `mode` string, required
    - `passed` boolean, required
    - `status` 'passed' | 'failed', required
    - `counts` object, required: Result counts keyed by status.
    - `branch` string, nullable, required
    - `commit` string, nullable, required
    - `startedAt` string, nullable, required
    - `finishedAt` string, nullable, required
    - `createdAt` string, required
    - `url` string, required: API URL of this run (`/api/v1/runs/{id}`).

## Other responses

- `400`: Invalid body or parameter (`code: validation_error`), or — on screenshot upload — a body that does not hash to the digest (`code: digest_mismatch`).
- `401`: Missing/malformed Authorization header (`code: unauthorized`), bad Basic credentials (`code: invalid_credentials`), or an invalid, expired, or revoked agent token (`code: invalid_agent_token`).
- `402`: The owning account is over a hard plan limit or its subscription is paused (`code: billing_blocked`). Existing data is preserved; writes resume after upgrading or freeing space.
- `403`: Agent token outside its granted scopes (`code: missing_scope`, with a `scope` field naming the required scope) or a route that is not agent-accessible at all (`code: agent_forbidden`). Basic-auth requests never see this.
- `413`: Request body exceeds the configured limit (default 25 MiB) (`code: payload_too_large`).
- `429`: Too many failed attempts or uploads from this client (`code: rate_limited`). Honor the `Retry-After` header; successful authenticated requests never count toward the limit.

---

[API](https://skmtc.dev/dungbeetle/apis/dungbeetle-cloud-api.md) · [All operations](https://skmtc.dev/dungbeetle/apis/dungbeetle-cloud-api/llms.txt) · [OpenAPI document](https://skmtc.dev/dungbeetle/apis/dungbeetle-cloud-api/revisions/74778b90420a?raw)