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

# Get a HarnessRelease

> Returns one immutable HarnessRelease by ID, including its pinned image digest, platform, entrypoint protocol, public configuration schema, and optional declared model wire dialects. A release never changes after publication, so this is the exact artifact any HarnessProfile version pinning it will run; declared dialects filter unreachable ModelRoutingProfile candidates at Run admission.

Checkfu support posture: alpha; hosted. Required evidence journey: harness-registry. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.



## OpenAPI

````yaml /openapi.json get /v1/organizations/{organization_id}/harness-releases/{id}
openapi: 3.1.0
info:
  title: Checkfu API
  version: '2026-08-27'
  description: >-
    Authentication is declared per operation: API-key, runtime, or connector
    bearer; Automation signature; or credential-free pairing redemption. Every
    general Checkfu REST request requires the dated `Checkfu-Version` header
    (one of: 2026-08-27); the three MCP JSON-RPC transports use
    `MCP-Protocol-Version`, A2A uses `A2A-Version`, and the provider OAuth
    callback carries neither Checkfu header. API keys resolve one Workspace
    without a request selector; authenticated responses identify it with
    `Checkfu-Workspace-Id`.
servers:
  - url: https://api.checkfu.com
security:
  - bearerAuth: []
tags:
  - name: organizations
  - name: sourceRepositories
  - name: tenants
  - name: workspaces
  - name: principals
  - name: principalGroups
  - name: principalAccessCredentials
  - name: apiKeys
  - name: agents
  - name: harnesses
  - name: harnessRuntime
  - name: sandboxProfiles
  - name: computerProfiles
  - name: permissionAssignments
  - name: actionPolicies
  - name: files
  - name: memoryStores
  - name: dreams
  - name: modelCredentials
  - name: modelRoutingProfiles
  - name: blueprintInstallations
  - name: toolSources
  - name: skills
  - name: skillSources
  - name: agentSources
  - name: skillProposals
  - name: instructionProposals
  - name: catalog
  - name: concepts
  - name: support
  - name: connections
  - name: connectionVaults
  - name: connectionAssignments
  - name: connectedRuntimes
  - name: projects
  - name: collaboration
  - name: automationGraphs
  - name: automations
  - name: actionApprovals
  - name: standingApprovals
  - name: usage
  - name: models
  - name: outcomes
  - name: budgets
  - name: billing
  - name: sessions
  - name: audit
  - name: sessionExports
  - name: runs
  - name: runnerPools
  - name: transcripts
  - name: sessionWatches
  - name: webhookEndpoints
  - name: integrationGateway
  - name: agentDeployments
  - name: workEnvironments
  - name: computers
  - name: computerScreens
  - name: computerBrowserObservations
  - name: computerBrowserActions
  - name: environments
  - name: vaults
  - name: apiMcp
  - name: a2a
paths:
  /v1/organizations/{organization_id}/harness-releases/{id}:
    get:
      tags:
        - harnessRuntime
      summary: Get a HarnessRelease
      description: >-
        Returns one immutable HarnessRelease by ID, including its pinned image
        digest, platform, entrypoint protocol, public configuration schema, and
        optional declared model wire dialects. A release never changes after
        publication, so this is the exact artifact any HarnessProfile version
        pinning it will run; declared dialects filter unreachable
        ModelRoutingProfile candidates at Run admission.


        Checkfu support posture: alpha; hosted. Required evidence journey:
        harness-registry. Deployment-specific readiness and the latest proven
        release are available from GET /v1/support/capabilities.
      operationId: harnessRuntime.getHarnessRelease
      parameters:
        - name: organization_id
          in: path
          schema:
            $ref: '#/components/schemas/OrganizationId'
          required: true
        - name: id
          in: path
          schema:
            $ref: '#/components/schemas/HarnessReleaseId'
          required: true
        - name: checkfu-version
          in: header
          schema:
            type: string
            enum:
              - '2026-08-27'
          required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Objects_25'
          headers:
            checkfu-workspace-id:
              description: The Workspace resolved from the authenticated bearer credential.
              required: true
              schema:
                $ref: '#/components/schemas/WorkspaceId'
        '400':
          description: Typed Checkfu wire error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - validation.malformed
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#validation-malformed
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    required:
                      - type
                      - message
                      - more
                    additionalProperties: false
                additionalProperties: false
        '401':
          description: Typed Checkfu wire error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - type
                      - message
                      - more
                    properties:
                      type:
                        type: string
                        enum:
                          - auth.invalid_key
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#auth-invalid-key
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    additionalProperties: false
                additionalProperties: false
        '403':
          description: >-
            The organization, tenant, or workspace backing this key is
            administratively disabled. | Deployment governance or retention
            policy denied the request.
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - auth.disabled_tenancy
                          message:
                            type: string
                          more:
                            type: string
                            enum:
                              - >-
                                https://docs.checkfu.com/reference/errors#auth-disabled-tenancy
                            description: >-
                              Stable public documentation and remedy for this
                              error type.
                        required:
                          - type
                          - message
                          - more
                        additionalProperties: false
                    additionalProperties: false
                  - $ref: '#/components/schemas/PolicyDeniedError'
        '404':
          description: >-
            The requested resource does not exist in the resolved deployment
            boundary.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationNotFoundError'
        '429':
          description: Typed Checkfu wire error
          headers:
            retry-after:
              description: >-
                Delay in seconds for rate limits or deployment quotas with a
                known release or UTC reset boundary
              required: false
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - type
                      - message
                      - more
                    properties:
                      type:
                        type: string
                        enum:
                          - budget.exceeded
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#budget-exceeded
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    additionalProperties: false
                additionalProperties: false
        '500':
          description: >-
            An unexpected internal failure occurred; the message contains an
            opaque incident reference.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeInternalError'
      security:
        - bearerAuth: []
components:
  schemas:
    OrganizationId:
      type: string
      allOf:
        - pattern: ^org_[0-9a-f]{32}$
    HarnessReleaseId:
      type: string
      allOf:
        - pattern: ^hrel_[0-9a-f]{32}$
    Objects_25:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/HarnessReleaseId'
        organization_id:
          $ref: '#/components/schemas/OrganizationId'
        digest:
          type: string
          allOf:
            - pattern: ^sha256:[0-9a-f]{64}$
        artifact:
          $ref: '#/components/schemas/Union_54'
        configuration_schema:
          $ref: '#/components/schemas/Union_39'
        source_provenance:
          type: object
          properties:
            kind:
              type: string
              enum:
                - github
            repository:
              $ref: '#/components/schemas/GitHubRepositoryUrlWithoutTraversal'
            commit_sha:
              type: string
              allOf:
                - pattern: ^[0-9a-f]{40}$
            runner_id:
              $ref: '#/components/schemas/RunnerId'
            build_id:
              $ref: '#/components/schemas/HarnessBuildId'
          required:
            - kind
            - repository
            - commit_sha
            - runner_id
            - build_id
          additionalProperties: false
        created_at:
          type: string
      required:
        - id
        - organization_id
        - digest
        - artifact
        - configuration_schema
        - created_at
      additionalProperties: false
    WorkspaceId:
      type: string
      allOf:
        - pattern: ^wrkspc_[0-9a-f]{32}$
    PolicyDeniedError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - policy.denied
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#policy-denied
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: Deployment governance or retention policy denied the request.
    ValidationNotFoundError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.not_found
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#validation-not-found
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        The requested resource does not exist in the resolved deployment
        boundary.
    RuntimeInternalError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - runtime.internal
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#runtime-internal
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        An unexpected internal failure occurred; the message contains an opaque
        incident reference.
    Union_54:
      anyOf:
        - $ref: '#/components/schemas/Objects_20'
        - anyOf:
            - type: object
              properties:
                argv: false
                prompt_transport: false
                output_mode: false
                resume_flag: false
                output_schema_flag: false
                output_schema_transport: false
                kind:
                  type: string
                  enum:
                    - oci
                protocol:
                  type: string
                  enum:
                    - acp-v1
                image:
                  $ref: '#/components/schemas/OciImageReference'
                entrypoint:
                  type: string
                  allOf:
                    - maxLength: 4096
                    - pattern: >-
                        ^\/(?!\.{1,2}(?:\/|$))[A-Za-z0-9._-]+(?:\/(?!\.{1,2}(?:\/|$))[A-Za-z0-9._-]+)*$
                arguments:
                  $ref: '#/components/schemas/HarnessProcessArgumentVectorUtf8Bytes'
                working_directory:
                  type: string
                  allOf:
                    - maxLength: 4096
                    - pattern: >-
                        ^\/(?!\.{1,2}(?:\/|$))[A-Za-z0-9._-]+(?:\/(?!\.{1,2}(?:\/|$))[A-Za-z0-9._-]+)*$
                platform:
                  type: object
                  properties:
                    os:
                      type: string
                      enum:
                        - linux
                    architecture:
                      type: string
                      enum:
                        - amd64
                        - arm64
                  required:
                    - os
                    - architecture
                  additionalProperties: false
                model_wire_dialects:
                  type: array
                  items:
                    type: string
                    enum:
                      - anthropic_messages
                      - openai_chat
                      - openai_responses
                      - fal_queue
                  allOf:
                    - minItems: 1
                    - maxItems: 4
                    - uniqueItems: true
                mcp_delivery:
                  type: string
                  enum:
                    - session_http
                    - none
                managed_adapter_release:
                  type: object
                  properties:
                    engine:
                      type: string
                      enum:
                        - vercel-harness-v1
                    harness_id:
                      type: string
                      enum:
                        - claude-code
                        - codex
                        - cursor
                        - hermes
                        - opencode
                        - pi
                    integration_descriptor_digest:
                      type: string
                      allOf:
                        - pattern: ^sha256:[0-9a-f]{64}$
                  required:
                    - engine
                    - harness_id
                    - integration_descriptor_digest
                  additionalProperties: false
              required:
                - kind
                - protocol
                - image
                - entrypoint
                - arguments
                - working_directory
                - platform
              additionalProperties: false
            - $ref: '#/components/schemas/OneShotArgvPromptPath'
    Union_39:
      anyOf:
        - type: boolean
        - $ref: '#/components/schemas/HarnessConfigurationSchemaObject'
    GitHubRepositoryUrlWithoutTraversal:
      type: string
      allOf:
        - pattern: >-
            ^https:\/\/github\.com\/[A-Za-z\d](?:[A-Za-z\d-]{0,38})\/[A-Za-z\d._-]{1,100}$
    RunnerId:
      type: string
      allOf:
        - pattern: ^rnr_[0-9a-f]{32}$
    HarnessBuildId:
      type: string
      allOf:
        - pattern: ^hbld_[0-9a-f]{32}$
    Objects_20:
      type: object
      properties:
        kind:
          type: string
          enum:
            - managed
        protocol:
          type: string
          enum:
            - mock
        preset:
          type: string
          allOf:
            - pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$
        adapter_version:
          type: string
          allOf:
            - minLength: 1
        recipe_digest:
          type: string
          allOf:
            - pattern: ^sha256:[0-9a-f]{64}$
      required:
        - kind
        - protocol
        - preset
        - adapter_version
        - recipe_digest
      additionalProperties: false
    OciImageReference:
      type: string
    HarnessProcessArgumentVectorUtf8Bytes:
      type: array
      items:
        $ref: '#/components/schemas/HarnessProcessArgumentUtf8Bytes'
      allOf:
        - maxItems: 256
          description: >-
            At most 256 exact process arguments and 131072 aggregate UTF-8 bytes
            including one terminator per argument
    OneShotArgvPromptPath:
      type: object
      properties:
        kind:
          type: string
          enum:
            - oci
        protocol:
          type: string
          enum:
            - oneshot-v1
        arguments: false
        image:
          $ref: '#/components/schemas/OciImageReference'
        entrypoint:
          type: string
          allOf:
            - maxLength: 4096
            - pattern: >-
                ^\/(?!\.{1,2}(?:\/|$))[A-Za-z0-9._-]+(?:\/(?!\.{1,2}(?:\/|$))[A-Za-z0-9._-]+)*$
        argv:
          $ref: '#/components/schemas/OneShotArgvPlaceholders'
        working_directory:
          type: string
          allOf:
            - maxLength: 4096
            - pattern: >-
                ^\/(?!\.{1,2}(?:\/|$))[A-Za-z0-9._-]+(?:\/(?!\.{1,2}(?:\/|$))[A-Za-z0-9._-]+)*$
        prompt_transport:
          $ref: '#/components/schemas/Union_44'
        output_mode:
          $ref: '#/components/schemas/Union_45'
        resume_flag:
          type: string
          allOf:
            - maxLength: 65536
            - pattern: ^[^\u0000]*$
              description: >-
                Exact process argument text, preserving whitespace; U+0000 is
                forbidden and UTF-8 encoding is limited to 65536 bytes
            - minLength: 1
        output_schema_flag:
          type: string
          allOf:
            - maxLength: 65536
            - pattern: ^[^\u0000]*$
              description: >-
                Exact process argument text, preserving whitespace; U+0000 is
                forbidden and UTF-8 encoding is limited to 65536 bytes
            - minLength: 1
        output_schema_transport:
          type: string
          enum:
            - argv_json
            - argv_path
        platform:
          type: object
          properties:
            os:
              type: string
              enum:
                - linux
            architecture:
              type: string
              enum:
                - amd64
                - arm64
          required:
            - os
            - architecture
          additionalProperties: false
        model_wire_dialects:
          type: array
          items:
            type: string
            enum:
              - anthropic_messages
              - openai_chat
              - openai_responses
              - fal_queue
          allOf:
            - minItems: 1
            - maxItems: 4
            - uniqueItems: true
        mcp_delivery: false
      required:
        - kind
        - protocol
        - image
        - entrypoint
        - argv
        - working_directory
        - prompt_transport
        - output_mode
        - platform
      additionalProperties: false
    HarnessConfigurationSchemaObject:
      type: object
      additionalProperties:
        description: >-
          A value in the JSON data model: null, boolean, finite number, string,
          array, or object.
        allOf:
          - x-checkfu-json-budget:
              maximumBytes: 65536
              maximumDepth: 32
              maximumNodes: 4000
              maximumInspectionWork: 4000
      allOf:
        - x-checkfu-json-budget:
            maximumBytes: 65536
            maximumDepth: 32
            maximumNodes: 4000
            maximumInspectionWork: 4000
        - maxProperties: 4000
          description: >-
            harness configuration schema of at most 64 KiB, depth 32, and 4,000
            nodes
    HarnessProcessArgumentUtf8Bytes:
      type: string
      allOf:
        - maxLength: 65536
        - pattern: ^[^\u0000]*$
          description: >-
            Exact process argument text, preserving whitespace; U+0000 is
            forbidden and UTF-8 encoding is limited to 65536 bytes
    OneShotArgvPlaceholders:
      type: array
      items:
        $ref: '#/components/schemas/HarnessProcessArgumentUtf8Bytes'
      allOf:
        - maxItems: 256
          description: >-
            At most 256 exact process arguments and 131072 aggregate UTF-8 bytes
            including one terminator per argument
    Union_44:
      type: string
      enum:
        - stdin
        - argv_path
    Union_45:
      type: string
      enum:
        - stream_json
        - text
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````