> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devhelm.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get regional run health without changing incident evaluation



## OpenAPI

````yaml /openapi/monitoring-api.json get /api/v1/monitors/{id}/runs/regional-health
openapi: 3.0.1
info:
  title: DevHelm API
  description: >-
    DevHelm monitoring and incident management API. Create and manage uptime
    monitors, incidents, alert channels, notification policies, and more.
  version: '1.0'
  contact:
    name: DevHelm
    url: https://devhelm.io
    email: support@devhelm.io
servers:
  - url: https://api.devhelm.io
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Alert Channels
    description: Alert channel CRUD and connectivity testing
  - name: Alert Deliveries
    description: 'Delivery audit trail: inspect per-attempt details for alert deliveries'
  - name: API Auth
    description: Identity and quota info for API key authentication
  - name: API Keys
    description: Organization API key management
  - name: Artifacts
    description: Run evidence file content
  - name: Audit Log
    description: Organization audit trail
  - name: Bundles
    description: Upload code for browser and multi-step checks
  - name: Check Results
    description: Query raw check results, uptime statistics, and summary data
  - name: Dashboard
    description: Overview dashboard aggregates
  - name: Definitions
    description: Code-monitor definition catalog and revisions
  - name: Deploy Lock
    description: Mutex for CLI deploy operations
  - name: Device Login
    description: Device-code login that gives the CLI a named, revocable API key
  - name: Device Login
    description: Dashboard approval for CLI device-code logins
  - name: Email Testing
    description: Receive domains, captured mail, and JSON inject
  - name: Entitlements
    description: Plan entitlements and usage limits
  - name: Environments
    description: Variable namespace management for monitors
  - name: Forensics
    description: >-
      Detection engine event-sourced history (policy snapshots, rule
      evaluations, state transitions)
  - name: Heartbeat
    description: Public ping endpoint for heartbeat monitors
  - name: Incident Policies
    description: Manage trigger, confirmation, and recovery rules for monitors
  - name: Incidents
    description: Incident management and lifecycle
  - name: Integrations
    description: Static catalog of supported alert channel integrations
  - name: Invites
    description: Organization invite management
  - name: Maintenance Windows
    description: Schedule alert-suppression windows for monitors
  - name: Members
    description: Organization member management
  - name: Monitor Alert Channels
    description: Manage alert channel mappings for a monitor
  - name: Monitor Assertions
    description: Manage assertions for a monitor
  - name: Monitor Auth
    description: Manage authentication configuration for a monitor
  - name: Monitor definitions
    description: Publish, rollback, and revision history for code monitors
  - name: Monitor History
    description: Scheduled ticks that did not run
  - name: Monitor Runs
    description: Per-monitor code run history and run-now
  - name: Monitor secret requests
    description: Secret keys a monitor requires and how they are fulfilled
  - name: Monitor session
    description: Cached sign-in session for a monitor
  - name: Monitors
    description: Monitor CRUD and lifecycle management
  - name: Notification Dispatches
    description: >-
      Dispatch debugging API: inspect which policies matched an incident and
      track delivery status
  - name: Notification Policies
    description: Org-level notification routing policies with JSONB match rules
  - name: Notifications
    description: In-app notification center
  - name: Organizations
    description: Organization management
  - name: Regions
    description: Public regions
  - name: Resource Groups
    description: Resource group CRUD and member management
  - name: Revisions
    description: Definition revision packages
  - name: Runs
    description: Code-monitor run list, snapshot, cases, events, and cancel
  - name: Secrets
    description: Organization environment secret management
  - name: Service Subscriptions
    description: Manage which services an organization tracks
  - name: Status Data
    description: Public service status catalog, components, uptime, and incident history
  - name: Status Pages
    description: Status page management
  - name: Synthetics metrics
    description: Measured metrics for the BROWSER and MULTI_STEP_API family
  - name: Tags
    description: Org-scoped tag management for monitors
  - name: Vault
    description: Organization vault management (admin-only)
  - name: Webhook Testing
    description: Inboxes that capture inbound HTTP and wait for events
  - name: Webhooks
    description: Webhook endpoint management, event catalog, and delivery history
  - name: Workspaces
    description: Workspace management within an organization
paths:
  /api/v1/monitors/{id}/runs/regional-health:
    get:
      tags:
        - monitor-run-diagnostics-controller
      summary: Get regional run health without changing incident evaluation
      operationId: health
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: >-
                  #/components/schemas/SingleValueResponseMonitorRegionalHealthDto
        '400':
          description: Bad request — the payload failed validation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized — missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment required — the plan or quota does not allow this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden — the actor lacks permission for this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found — the requested resource does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict — the request collides with current resource state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '410':
          description: Gone — the resource is no longer available
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many requests — retry after the window resets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error — see the message field for details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Bad gateway — an upstream provider returned an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Service unavailable — try again shortly
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SingleValueResponseMonitorRegionalHealthDto:
      required:
        - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/MonitorRegionalHealthDto'
    ErrorResponse:
      required:
        - category
        - code
        - message
        - status
        - timestamp
        - retryable
      type: object
      properties:
        status:
          type: integer
          description: HTTP status code (mirrors the response status line)
          format: int32
          example: 404
        code:
          type: string
          description: >-
            Stable machine code for this error, such as NOT_FOUND or
            SYNTHETICS_USAGE_CAPPED
          example: NOT_FOUND
        category:
          $ref: '#/components/schemas/ErrorCategory'
        retryable:
          type: boolean
          description: Whether a later attempt can succeed without changing the request
          example: false
        message:
          type: string
          description: Human-readable error message; safe to surface to end users
          example: Monitor not found
        timestamp:
          type: integer
          description: Server time when the error was produced (epoch milliseconds)
          format: int64
          example: 1737302400000
        requestId:
          type: string
          description: >-
            Opaque per-request id; same value as the X-Request-Id response
            header. Use in support tickets.
          nullable: true
          example: 5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a
        errors:
          type: array
          description: >-
            Structured per-field rejections; populated for validation errors,
            null otherwise
          nullable: true
          items:
            nullable: true
            allOf:
              - $ref: '#/components/schemas/ErrorEntry'
        retryAfterSeconds:
          type: integer
          description: Seconds to wait before retrying a rate limit
          format: int64
          nullable: true
          example: 30
        resource:
          type: string
          description: Meter or resource this limit applies to
          nullable: true
          example: browser_runs
        used:
          type: integer
          description: Amount used in the current period
          format: int64
          nullable: true
          example: 1000
        limit:
          type: integer
          description: Maximum allowed for this period or plan
          format: int64
          nullable: true
          example: 1000
        resetsAt:
          type: string
          description: When this quota window resumes (ISO-8601)
          nullable: true
          example: '2026-11-01T00:00:00Z'
        plan:
          type: string
          description: Plan this refusal was evaluated against
          nullable: true
          example: FREE
        upgradeUrl:
          type: string
          description: Page where an admin can change the plan
          nullable: true
          example: https://app.devhelm.io/settings/billing
        canRaise:
          type: string
          description: Role that can raise this limit
          nullable: true
          example: org admin
        owner:
          type: string
          description: Who owns the resource when a write is refused
          nullable: true
        required:
          type: string
          description: Missing scope, secret key, or other required value
          nullable: true
        have:
          type: integer
          description: Current amount compared with the plan limit
          format: int64
          nullable: true
          example: 10
        reason:
          type: string
          description: 'Why permission was refused: scope or role'
          nullable: true
          example: role
          enum:
            - scope
            - role
        next:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/ErrorNext'
        details:
          type: object
          additionalProperties:
            type: object
            description: >-
              Extra fields for this error, such as a missing secret key and
              environment
            nullable: true
          description: >-
            Extra fields for this error, such as a missing secret key and
            environment
          nullable: true
        expiredAt:
          type: string
          description: When this evidence expired
          format: date-time
          nullable: true
        policy:
          type: string
          description: Retention written when the artifact was saved, such as P7D
          nullable: true
      description: Uniform error envelope returned for every non-2xx response
      example:
        status: 404
        code: NOT_FOUND
        category: not_found
        message: Monitor not found
        timestamp: 1737302400000
        requestId: 5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a
    MonitorRegionalHealthDto:
      required:
        - regions
      type: object
      properties:
        regionalDisplayHealth:
          type: string
          description: >-
            Target evidence from complete fresh parallel cycles; additive only.
            Consumers retain MonitorDto.displayHealth precedence for blocked,
            capped and quarantined states
          nullable: true
          enum:
            - healthy
            - down
            - degraded
            - recovering
            - infra
            - flaky
            - blocked
            - capped
            - paused
            - never_run
            - confirming
        evaluationCycleId:
          type: string
          description: Cycle used for the regional presentation
          format: uuid
          nullable: true
        regions:
          type: array
          description: Latest health-voting execution for each configured region
          items:
            $ref: '#/components/schemas/Region'
        lastFailure:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RunDto'
        failingCycleCount:
          type: integer
          description: >-
            Failing cycles since evaluation changed; null outside retained
            history
          format: int64
          nullable: true
      description: Regional presentation from runs, independent of incident evaluation
    ErrorCategory:
      type: string
      description: Machine class clients use to choose the next action
      enum:
        - validation
        - blocked
        - auth
        - permission
        - ownership
        - plan
        - quota
        - rate_limit
        - conflict
        - confirmation_required
        - not_found
        - gone
        - platform
    ErrorEntry:
      required:
        - code
        - message
      type: object
      properties:
        code:
          minLength: 1
          type: string
          description: >-
            Stable machine-readable code; see ValidationErrorCode for the
            registry
          example: MONITOR_HEARTBEAT_GRACE_EXCEEDS_INTERVAL
        field:
          type: string
          description: >-
            JSON-pointer-like path to the offending field, or null for
            request-wide errors
          nullable: true
          example: config.gracePeriod
        message:
          minLength: 1
          type: string
          description: Human-readable message; safe to surface to end users
      description: One structured validation rejection
    ErrorNext:
      type: object
      properties:
        command:
          type: string
          description: Command that fixes this error
          nullable: true
          example: devhelm account usage
        docs:
          type: string
          description: Documentation page for this error
          nullable: true
          example: https://docs.devhelm.io/errors/SYNTHETICS_USAGE_CAPPED
      description: Command and documentation that fix this error
    Region:
      required:
        - buckets
        - region
      type: object
      properties:
        region:
          type: string
          description: Execution region
        uptimePercent:
          type: number
          description: Final target uptime in this region
          format: double
          nullable: true
        buckets:
          type: array
          description: Clock-aligned chart buckets
          items:
            $ref: '#/components/schemas/Bucket'
      description: Buckets for each selected region
    RunDto:
      required:
        - attempts
        - bindingVersionSnapshot
        - bundleDigest
        - capturePolicySnapshot
        - enqueuedAt
        - evidence
        - executionAttempts
        - id
        - monitorId
        - phase
        - region
        - revisionId
        - source
        - tabCounts
        - organizationId
        - countsTowardHealth
        - cancelRequested
        - stream
        - attempt
        - attemptOf
        - billable
      type: object
      properties:
        id:
          type: string
          description: Unique run identifier
          format: uuid
        organizationId:
          type: integer
          description: Organization this run belongs to
          format: int32
        monitorId:
          type: string
          description: Monitor this run belongs to
          format: uuid
        monitorName:
          type: string
          description: Monitor display name
          nullable: true
        monitorType:
          type: string
          description: Monitor type
          nullable: true
          enum:
            - HTTP
            - DNS
            - MCP_SERVER
            - TCP
            - ICMP
            - HEARTBEAT
            - BROWSER
            - MULTI_STEP_API
        host:
          type: string
          description: Target host from the environment BASE_URL
          nullable: true
        environmentId:
          type: string
          description: Environment this run executed in
          format: uuid
          nullable: true
        environmentName:
          type: string
          description: Environment display name
          nullable: true
        revisionId:
          type: string
          description: Revision this run executed
          format: uuid
        revision:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RevisionDto'
        region:
          minLength: 1
          type: string
          description: Probe region for this run
        source:
          type: string
          description: What triggered this run
          enum:
            - schedule
            - run_now
            - ci
            - fast_retry
            - remote_validation
            - deployment_validation
            - session_renew
        countsTowardHealth:
          type: boolean
          description: Whether this run votes on monitor health
        enqueuedAt:
          type: string
          description: When this run was enqueued
          format: date-time
        startDeadlineAt:
          type: string
          description: When this queued run must start
          format: date-time
          nullable: true
        evaluationCycleId:
          type: string
          description: Evaluation cycle grouping this run with retries
          format: uuid
          nullable: true
        retryOfRunId:
          type: string
          description: Parent run when this is a fast retry
          format: uuid
          nullable: true
        retriedFromRunId:
          type: string
          description: Fast-retry parent run
          format: uuid
          nullable: true
        phase:
          type: string
          description: Current run phase
          enum:
            - created
            - queued
            - starting
            - running
            - finalizing
            - finished
        cancelRequested:
          type: boolean
          description: Whether cancel was requested
        outcome:
          type: string
          description: Outcome; null until the run is finished
          nullable: true
          enum:
            - passed
            - failed
            - execution_error
            - timed_out
            - passed_on_retry
            - cancelled
            - inconclusive
        headline:
          type: string
          description: Last control headline
          nullable: true
        executionLine:
          type: string
          description: Live execution one-liner
          nullable: true
        metaLine:
          type: string
          description: Server-composed header meta line
          nullable: true
        bundleDigest:
          minLength: 1
          type: string
          description: Package digest frozen at create
        startedAt:
          type: string
          description: When execution claimed a seat
          format: date-time
          nullable: true
        finishedAt:
          type: string
          description: When the run finished
          format: date-time
          nullable: true
        updatedAt:
          type: string
          description: When the run row last changed
          format: date-time
          nullable: true
        lastHeartbeatAt:
          type: string
          description: Last supervisor heartbeat
          format: date-time
          nullable: true
        cancelledBy:
          type: string
          description: Who requested cancel
          nullable: true
        artifactsExpiredAt:
          type: string
          description: When artifact bytes expired
          format: date-time
          nullable: true
        pinnedAt:
          type: string
          description: When this run was pinned past retention
          format: date-time
          nullable: true
        purgedAt:
          type: string
          description: When stored evidence was purged
          format: date-time
          nullable: true
        capturePolicySnapshot:
          type: object
          additionalProperties:
            type: object
            description: Capture settings frozen at create
          description: Capture settings frozen at create
        bindingVersionSnapshot:
          type: object
          additionalProperties:
            type: object
            description: Resolved secret key names frozen at create
          description: Resolved secret key names frozen at create
        durationMs:
          type: integer
          description: Wall time from claim to finish
          format: int64
          nullable: true
        queueWaitMs:
          type: integer
          description: Time spent waiting for a seat
          format: int64
          nullable: true
        queuePosition:
          type: integer
          description: Live queue position; null when not queued
          format: int32
          nullable: true
        heartbeatAgeMs:
          type: integer
          description: Milliseconds since the last supervisor heartbeat
          format: int64
          nullable: true
        stream:
          type: boolean
          description: True while the run is still live and clients may stream
        evidence:
          type: array
          description: List evidence chips in SHOT → TRACE → VIDEO → NET order
          items:
            $ref: '#/components/schemas/RunEvidenceDto'
        tabCounts:
          $ref: '#/components/schemas/RunTabCountsDto'
        live:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RunLiveDto'
        attempt:
          type: integer
          description: Selected in-check attempt (1-based)
          format: int32
        attemptOf:
          type: integer
          description: In-check attempt count
          format: int32
        attempts:
          type: array
          description: In-check attempts
          items:
            $ref: '#/components/schemas/RunAttemptDto'
        incidentId:
          type: string
          description: Open incident for this monitor
          format: uuid
          nullable: true
        execution:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RunExecutionDto'
        executionAttempts:
          type: array
          description: Persisted worker execution attempts
          items:
            $ref: '#/components/schemas/RunExecutionAttemptDto'
        url:
          type: string
          description: Dashboard URL for this run
          nullable: true
        triggerId:
          type: string
          description: Groups runs started by one manual trigger; null for other runs
          format: uuid
          nullable: true
        session:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RunSessionContext'
        runtimeId:
          type: string
          description: Runtime profile that executed this run
          nullable: true
        cause:
          type: string
          description: >-
            Platform cause for an execution error, inconclusive finish, or
            network failure
          nullable: true
          enum:
            - platform
            - runtime_unavailable
            - testing_quota_exhausted
            - no_seat
            - lease_lost
            - target_unreachable
        billable:
          type: boolean
          description: Whether a finished run counts against the included run pool
        failure:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RunFailureDto'
        artifactsExpireAt:
          type: string
          description: When artifact bytes will expire
          format: date-time
          nullable: true
      description: Code-monitor run
    Bucket:
      required:
        - start
        - passed
        - failed
        - timedOut
        - couldntRun
        - passedOnRetry
        - durationSamples
      type: object
      properties:
        start:
          type: string
          description: Inclusive clock-aligned bucket start
          format: date-time
        passed:
          type: integer
          description: Health-voting region cycles whose final attempt passed
          format: int64
        failed:
          type: integer
          description: Health-voting region cycles whose final attempt failed
          format: int64
        timedOut:
          type: integer
          description: Region cycles whose final attempt timed out
          format: int64
        couldntRun:
          type: integer
          description: Region cycles with a final non-target outcome
          format: int64
        passedOnRetry:
          type: integer
          description: Passed cycles that had an earlier failed attempt
          format: int64
        durationSamples:
          type: integer
          description: Executions with a completed duration in this bucket
          format: int64
        p50Ms:
          type: number
          description: Median duration of completed executions in milliseconds
          format: double
          nullable: true
        p95Ms:
          type: number
          description: p95 duration of completed executions in milliseconds
          format: double
          nullable: true
      description: Clock-aligned chart buckets
    RevisionDto:
      required:
        - createdAt
        - definitionId
        - digest
        - entrypoint
        - files
        - id
        - keys
        - number
      type: object
      properties:
        id:
          type: string
          description: Revision identifier
          format: uuid
        definitionId:
          type: string
          description: Parent definition
          format: uuid
        number:
          type: integer
          description: Monotonic revision number within the definition
          format: int32
        digest:
          minLength: 1
          type: string
          description: Closure digest from POST /bundles (sha256:<hex>)
        entrypoint:
          minLength: 1
          type: string
          description: Entrypoint file that runs
        files:
          type: array
          description: Paths present in the zip
          items:
            type: string
            description: Paths present in the zip
        keys:
          type: array
          description: Secret key names the code demands
          items:
            type: string
            description: Secret key names the code demands
        downloadUntil:
          type: string
          description: When package bytes expire for download
          format: date-time
          nullable: true
        purgedAt:
          type: string
          description: When package bytes were purged
          format: date-time
          nullable: true
        gitSha:
          type: string
          description: Git commit SHA when sourced from Git
          nullable: true
        gitMessage:
          type: string
          description: Git commit message
          nullable: true
        gitFile:
          type: string
          description: Declaring Git file path
          nullable: true
        authoredBy:
          type: string
          description: Who authored this package
          nullable: true
        source:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/CodeSource'
        createdAt:
          type: string
          description: When the revision was minted
          format: date-time
        state:
          type: string
          description: draft, tested_passed, tested_failed, live, previous, or discarded
          nullable: true
          enum:
            - draft
            - tested_passed
            - tested_failed
            - live
            - previous
            - discarded
        testRunId:
          type: string
          description: Latest validation run for this revision
          format: uuid
          nullable: true
        testOutcome:
          type: string
          description: Latest test outcome; absent until a test finishes
          nullable: true
          enum:
            - passed
            - failed
        liveStats:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RevisionLiveStatsDto'
        expiresAt:
          type: string
          description: When this draft expires; preserved after discard
          format: date-time
          nullable: true
        createdByKind:
          type: string
          description: Tool that created this draft
          nullable: true
          enum:
            - dashboard
            - git
            - terraform
            - api
            - mcp
        baseRevision:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RevisionReferenceDto'
      description: Definition revision package
    RunEvidenceDto:
      required:
        - kind
        - state
      type: object
      properties:
        kind:
          type: string
          description: Evidence kind in SHOT → TRACE → VIDEO → NET order
          enum:
            - screenshot
            - trace
            - video
            - network
        state:
          type: string
          description: Whether the artifact is usable
          enum:
            - present
            - bad
            - processing
            - expired
      description: List evidence chip
    RunTabCountsDto:
      type: object
      properties:
        steps:
          type: integer
          description: Step rows for the selected attempt
          format: int32
        assets:
          type: integer
          description: Items across asset kinds, excluding dead no-browser rows
          format: int32
        diff:
          type: integer
          description: 1 when a diff baseline exists or this run passed on retry
          format: int32
      description: Run detail tab counts
      required:
        - steps
        - assets
        - diff
    RunLiveDto:
      type: object
      properties:
        stepIndex:
          type: integer
          description: Current step index
          format: int32
          nullable: true
        stepTitle:
          type: string
          description: Current step title
          nullable: true
        stepCount:
          type: integer
          description: Known step count for this attempt
          format: int32
        artifactsUploaded:
          type: integer
          description: Artifacts already available
          format: int32
          nullable: true
        artifactsExpected:
          type: integer
          description: Artifacts expected for this run
          format: int32
          nullable: true
      description: Live run progress
      required:
        - stepCount
    RunAttemptDto:
      type: object
      properties:
        attempt:
          type: integer
          description: 1-based attempt number
          format: int32
        outcome:
          type: string
          description: Attempt outcome; null while the case is open
          nullable: true
          enum:
            - passed
            - failed
            - execution_error
            - timed_out
            - passed_on_retry
            - cancelled
            - inconclusive
        startedAt:
          type: string
          description: When this attempt started
          format: date-time
          nullable: true
        finishedAt:
          type: string
          description: When this attempt finished
          format: date-time
          nullable: true
      description: In-check attempt
      required:
        - attempt
    RunExecutionDto:
      required:
        - createdAt
        - harness
        - id
        - imageDigest
        - monitorType
        - requiredCapabilities
        - runtime
      type: object
      properties:
        id:
          type: string
          description: Immutable execution image identifier
          format: uuid
        runtime:
          $ref: '#/components/schemas/RuntimeProfileDto'
        harness:
          $ref: '#/components/schemas/HarnessReleaseDto'
        monitorType:
          type: string
          description: Monitor type supported by this image
          enum:
            - HTTP
            - DNS
            - MCP_SERVER
            - TCP
            - ICMP
            - HEARTBEAT
            - BROWSER
            - MULTI_STEP_API
        imageDigest:
          minLength: 1
          type: string
          description: Immutable image digest
        customerManifestSha256:
          type: string
          description: Measured customer environment manifest hash
          nullable: true
        buildManifestSha256:
          type: string
          description: Measured image build manifest hash
          nullable: true
        requiredCapabilities:
          type: array
          description: Capabilities required by this image
          items:
            type: string
            description: Capabilities required by this image
        createdAt:
          type: string
          description: When the image identity was registered
          format: date-time
      description: Frozen execution identity; null when historical identity is unknown
    RunExecutionAttemptDto:
      required:
        - capabilities
        - recordedAt
        - supervisor
        - runGeneration
        - protocolMajor
      type: object
      properties:
        runGeneration:
          type: integer
          description: Claim generation for this execution attempt
          format: int32
        supervisor:
          $ref: '#/components/schemas/HarnessReleaseDto'
        protocolMajor:
          type: integer
          description: Negotiated execution protocol major
          format: int32
        capabilities:
          type: array
          description: Negotiated execution capabilities
          items:
            type: string
            description: Negotiated execution capabilities
        recordedAt:
          type: string
          description: When execution attempt metadata was recorded
          format: date-time
      description: Persisted worker execution attempts
    RunSessionContext:
      required:
        - id
      type: object
      properties:
        id:
          maxLength: 255
          minLength: 0
          type: string
          description: Caller-provided CI session identifier
        label:
          maxLength: 255
          minLength: 0
          type: string
          description: 'CI session label, such as CI #4812'
          nullable: true
        commit:
          maxLength: 64
          minLength: 0
          type: string
          description: Commit that started this CI session
          nullable: true
        branch:
          maxLength: 255
          minLength: 0
          type: string
          description: Branch that started this CI session
          nullable: true
        url:
          maxLength: 2048
          minLength: 0
          pattern: ^[hH][tT][tT][pP][sS]?://\S+$
          type: string
          description: HTTP or HTTPS URL of the CI job
          nullable: true
      description: CI session that started this run; absent on historical runs
    RunFailureDto:
      required:
        - kind
      type: object
      properties:
        kind:
          type: string
          description: Failure category
          enum:
            - assertion
            - timeout
            - navigation
            - network
            - target_blocked
            - script_error
            - wait_timeout
            - setup
        step:
          type: string
          description: Step title that failed; null when the run failed before a step
          nullable: true
        message:
          type: string
          description: Reporter message, trimmed
          nullable: true
        file:
          type: string
          description: User source file; null when the reporter did not capture one
          nullable: true
        line:
          type: integer
          description: 1-based line in the user source file
          format: int32
          nullable: true
        index:
          type: integer
          description: 0-based index of the failed step
          format: int32
          nullable: true
      description: >-
        Why a run failed, including the source location when the reporter
        captured one
    CodeSource:
      type: object
      properties:
        repo:
          maxLength: 512
          minLength: 0
          type: string
          description: Repository that produced this code
          nullable: true
        branch:
          maxLength: 255
          minLength: 0
          type: string
          description: Branch that produced this code
          nullable: true
        commit:
          maxLength: 64
          minLength: 0
          type: string
          description: Commit that produced this code
          nullable: true
        file:
          maxLength: 512
          minLength: 0
          type: string
          description: Declaring file in that repository
          nullable: true
      description: Advisory source location. Untrusted, and unknown when omitted
    RevisionLiveStatsDto:
      type: object
      properties:
        runs:
          type: integer
          description: Scheduled runs and fast retries of this revision
          format: int64
        failed:
          type: integer
          description: How many of those runs failed
          format: int64
      description: Scheduled runs of this revision, and how many failed
      required:
        - runs
        - failed
    RevisionReferenceDto:
      required:
        - id
        - number
      type: object
      properties:
        id:
          type: string
          description: Related revision identifier
          format: uuid
        number:
          type: integer
          description: Revision number within its definition
          format: int32
      description: Live revision this draft was based on
    RuntimeProfileDto:
      required:
        - id
        - nodeVersion
        - playwrightVersion
        - status
      type: object
      properties:
        id:
          minLength: 1
          type: string
          description: Runtime environment identifier
        nodeVersion:
          minLength: 1
          type: string
          description: Node version available to checks
        playwrightVersion:
          minLength: 1
          type: string
          description: Playwright version available to checks
        status:
          type: string
          description: Runtime support status
          enum:
            - baking
            - available
            - deprecated
            - retired
        eolAt:
          type: string
          description: When runtime support ends
          format: date-time
          nullable: true
        availableAt:
          type: string
          description: When this runtime became available
          format: date-time
          nullable: true
        deprecatedAt:
          type: string
          description: When this runtime was deprecated; null while current
          format: date-time
          nullable: true
        packages:
          type: object
          additionalProperties:
            type: string
            description: Pinned npm packages available to checks
            nullable: true
          description: Pinned npm packages available to checks
          nullable: true
        nodeBuiltins:
          type: array
          description: Node built-in modules available to checks
          nullable: true
          items:
            type: string
            description: Node built-in modules available to checks
        reservedBindings:
          type: array
          description: Environment bindings this runtime reads
          nullable: true
          items:
            type: string
            description: Environment bindings this runtime reads
        browser:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/BrowserCapabilityEnvelope'
      description: Default execution environment; null uses the catalog default
    HarnessReleaseDto:
      required:
        - createdAt
        - id
        - provenance
        - protocolMajor
      type: object
      properties:
        id:
          minLength: 1
          type: string
          description: Supervisor harness release identifier
        sourceSha:
          type: string
          description: Source commit for this release
          nullable: true
        provenance:
          minLength: 1
          type: string
          description: Release provenance
        protocolMajor:
          type: integer
          description: Harness protocol major version
          format: int32
        compatibilityManifestSha256:
          type: string
          description: Compatibility manifest hash
          nullable: true
        createdAt:
          type: string
          description: When the release was registered
          format: date-time
      description: Supervisor release used for this attempt
    BrowserCapabilityEnvelope:
      type: object
      properties:
        iframes:
          type: boolean
          description: Cross-origin iframes are enabled
        stripeElements:
          type: boolean
          description: Stripe Elements iframes are enabled
        popups:
          type: boolean
          description: Popup windows are enabled
        downloads:
          type: boolean
          description: File downloads are enabled
        viewport:
          type: boolean
          description: Viewport emulation is enabled
        geolocation:
          type: boolean
          description: Geolocation emulation is enabled
        clipboard:
          type: boolean
          description: Clipboard access is enabled
        upload:
          type: boolean
          description: File upload is enabled
      description: Browser capability envelope for this runtime
      required:
        - iframes
        - stripeElements
        - popups
        - downloads
        - viewport
        - geolocation
        - clipboard
        - upload
  securitySchemes:
    BearerAuth:
      type: http
      description: API key (dh_live_...) or Auth0 JWT token
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.