HashiCorp Vault Vault System Backend API — Health

naftiko: 1.0.0-alpha2
info:
  label: HashiCorp Vault Vault System Backend API — Health
  description: 'HashiCorp Vault Vault System Backend API — Health. 1 operations. Lead operation: HashiCorp Vault Read health
    status. Self-contained Naftiko capability covering one Hvault business surface.'
  tags:
  - Hvault
  - Health
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HVAULT_API_KEY: HVAULT_API_KEY
capability:
  consumes:
  - type: http
    namespace: system-backend-health
    baseUri: https://vault.example.com/v1
    description: HashiCorp Vault Vault System Backend API — Health business capability. Self-contained, no shared references.
    resources:
    - name: sys-health
      path: /sys/health
      operations:
      - name: getsystemhealth
        method: GET
        description: HashiCorp Vault Read health status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: standbyok
          in: query
          type: boolean
          description: Whether to return 200 for standby nodes
        - name: activecode
          in: query
          type: integer
          description: HTTP status code for active nodes
        - name: standbycode
          in: query
          type: integer
          description: HTTP status code for standby nodes
        - name: sealedcode
          in: query
          type: integer
          description: HTTP status code for sealed vaults
        - name: uninitcode
          in: query
          type: integer
          description: HTTP status code for uninitialized vaults
    authentication:
      type: apikey
      key: X-Vault-Token
      value: '{{env.HVAULT_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: system-backend-health-rest
    port: 8080
    description: REST adapter for HashiCorp Vault Vault System Backend API — Health. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/sys/health
      name: sys-health
      description: REST surface for sys-health.
      operations:
      - method: GET
        name: getsystemhealth
        description: HashiCorp Vault Read health status
        call: system-backend-health.getsystemhealth
        with:
          standbyok: rest.standbyok
          activecode: rest.activecode
          standbycode: rest.standbycode
          sealedcode: rest.sealedcode
          uninitcode: rest.uninitcode
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: system-backend-health-mcp
    port: 9090
    transport: http
    description: MCP adapter for HashiCorp Vault Vault System Backend API — Health. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: hashicorp-vault-read-health-status
      description: HashiCorp Vault Read health status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: system-backend-health.getsystemhealth
      with:
        standbyok: tools.standbyok
        activecode: tools.activecode
        standbycode: tools.standbycode
        sealedcode: tools.sealedcode
        uninitcode: tools.uninitcode
      outputParameters:
      - type: object
        mapping: $.