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

# Engine + underlying vault health

> Operational status check. `is_paused` reflects the BarkerEngine pause state, and
`underlying_ok` reflects whether the underlying ERC-4626 vault is operating normally
(no upstream pause, accepting deposits).

Use this to gate the "Deposit" button in your UI — show a maintenance banner when
either flag is unhealthy. Cache 60s.




## OpenAPI

````yaml /openapi.yaml get /api/partner/products/{slug}/health
openapi: 3.0.3
info:
  title: Barker Yield Engine API
  version: 1.0.0
  description: >
    Yield-embed API for partners (wallets, payment apps).


    Authentication: `X-Api-Key` header, self-served from portal.barker.money.

    Revenue: 100% via on-chain fee split inside the engine contract — calling
    this API is free.

    Rate limit: 1000 req/min for production keys (`bk_live_*`), 100 req/min for
    sandbox keys (`bk_test_*`). Anti-abuse, not usage billing.


    Two integration modes — same engines, same key, same fee split, different UI
    surface:
      - Embed (iframe): drop-in UI hosted at app.barker.money, no contract calls in your code.
      - Headless API: your UI calls BarkerEngine (ERC-4626) directly with the user's wallet; this API serves metadata, position, fee stats, and webhooks.
    See https://docs.barker.money/integration-modes for the decision guide.


    Error responses share `{ success: false, code, message }`. Full code catalog
    at https://docs.barker.money/error-codes.
  contact:
    name: Barker
    url: https://docs.barker.money
servers:
  - url: https://api.barker.money
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: products
    description: Partner products (engines) — read access
  - name: position
    description: User position queries
  - name: webhooks
    description: Event subscriptions and callbacks
paths:
  /api/partner/products/{slug}/health:
    get:
      tags:
        - products
      summary: Engine + underlying vault health
      description: >
        Operational status check. `is_paused` reflects the BarkerEngine pause
        state, and

        `underlying_ok` reflects whether the underlying ERC-4626 vault is
        operating normally

        (no upstream pause, accepting deposits).


        Use this to gate the "Deposit" button in your UI — show a maintenance
        banner when

        either flag is unhealthy. Cache 60s.
      parameters:
        - $ref: '#/components/parameters/SlugParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/VaultHealth'
              example:
                success: true
                data:
                  is_paused: false
                  underlying_ok: true
                  last_block: 30142876
                  notes: ''
components:
  parameters:
    SlugParam:
      in: path
      name: slug
      required: true
      schema:
        type: string
      example: acme-usdc-base
  schemas:
    VaultHealth:
      type: object
      properties:
        is_paused:
          type: boolean
        underlying_ok:
          type: boolean
        last_block:
          type: integer
        notes:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

````