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

# Probe an export's destination and persist the result



## OpenAPI

````yaml /api-reference/openapi.yaml post /api/system-management/public/v1/exports/{orgId}/{exportType}/destination/health-check
openapi: 3.1.0
info:
  title: Barndoor.ai Public API
  description: Unified public API specification for Barndoor.ai platform
  version: 2.18.0
servers:
  - url: https://{host}
    description: Barndoor public API
    variables:
      host:
        default: platform.barndoor.ai
        description: >-
          The host serving your Barndoor deployment. Defaults to production;
          override it for another environment or a dedicated deployment.
security:
  - ApiKey: []
  - OAuth2:
      - openid
      - profile
      - email
tags:
  - name: dlp
    x-group: Data Control Center
  - name: identity
    x-group: Identity
  - name: llm-gateway
    x-group: LLM Gateway
  - name: notification
    x-group: Notifications
  - name: policy
    x-group: Policies
  - name: registry
    x-group: MCP Gateway
  - name: system-management
    x-group: Log Exports
paths:
  /api/system-management/public/v1/exports/{orgId}/{exportType}/destination/health-check:
    post:
      tags:
        - system-management
      summary: Probe an export's destination and persist the result
      operationId: check-export-destination-health
      parameters:
        - description: Organization ID
          in: path
          name: orgId
          required: true
          schema:
            description: Organization ID
            type: string
        - description: Export type, e.g. datadog-json or s3
          in: path
          name: exportType
          required: true
          schema:
            description: Export type, e.g. datadog-json or s3
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DestinationResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
components:
  schemas:
    DestinationResponse:
      additionalProperties: false
      properties:
        destination:
          $ref: '#/components/schemas/ExportDestination'
        enabled:
          type: boolean
        export_type:
          type: string
        organization_id:
          type: string
        runtime_status:
          $ref: '#/components/schemas/ExportRuntimeStatus'
      required:
        - organization_id
        - export_type
        - enabled
        - destination
        - runtime_status
      type: object
    ErrorModel:
      additionalProperties: false
      properties:
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ExportDestination:
      additionalProperties: false
      properties:
        auth_method:
          type: string
        bucket:
          type: string
        credentials_rotated_at:
          type: string
        endpoint:
          type: string
        external_id:
          type: string
        has_credentials:
          type: boolean
        iam_role_arn:
          type: string
        path_prefix:
          type: string
        provider:
          type: string
        region:
          type: string
        use_path_style:
          type: boolean
        use_ssl:
          type: boolean
      type: object
    ExportRuntimeStatus:
      additionalProperties: false
      properties:
        health:
          $ref: '#/components/schemas/ExportHealthCheck'
        last_delivered_at:
          type: string
          format: date-time
        last_error:
          type: string
        last_error_at:
          type: string
          format: date-time
        last_file_name:
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    ExportHealthCheck:
      additionalProperties: false
      properties:
        checked_at:
          type: string
          format: date-time
        message:
          type: string
        source:
          type: string
        state:
          type: string
      type: object
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: >-
        A Barndoor API key, sent as `Authorization: Bearer <key>`. Keys are
        prefixed `bdai_` and are opaque — do not attempt to decode one.
        Interchangeable with an OAuth 2.0 access token.
    OAuth2:
      type: oauth2
      x-issuer: https://auth.barndoor.ai/realms/barndoor
      description: >-
        An OAuth 2.0 access token from Barndoor's identity provider, sent as
        `Authorization: Bearer <token>`. Public clients must use PKCE.
        Interchangeable with an API key.
      flows:
        authorizationCode:
          authorizationUrl: >-
            https://auth.barndoor.ai/realms/barndoor/protocol/openid-connect/auth
          tokenUrl: >-
            https://auth.barndoor.ai/realms/barndoor/protocol/openid-connect/token
          scopes:
            openid: Issue an OIDC ID token identifying the caller.
            profile: Read the caller's basic profile claims.
            email: Read the caller's email address.
            offline_access: Issue a refresh token. Optional — no operation requires it.
        clientCredentials:
          tokenUrl: >-
            https://auth.barndoor.ai/realms/barndoor/protocol/openid-connect/token
          scopes:
            openid: Issue an OIDC ID token identifying the caller.
            profile: Read the caller's basic profile claims.
            email: Read the caller's email address.
            offline_access: Issue a refresh token. Optional — no operation requires it.

````

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