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

# Check secret password (Heartbeat)

> Initiates a heartbeat check to verify the secret's password is still valid



## OpenAPI

````yaml /api-specs/acb-secrets.yaml post /api/secrets/{id}/heartbeat
openapi: 3.0.3
info:
  title: Application Credentials Broker API
  description: >-
    API for managing secrets and folders in the Application Credentials Broker
    system
  version: 1.4.0
  contact:
    name: API Support
    email: support@example.com
servers:
  - url: https://your-syteca-host/SytecaACB
    description: On-premises Syteca ACB service (v1.2 or later)
    variables:
      hostname:
        default: your-syteca-host.example.com
        description: Your Syteca Application Server hostname
  - url: https://your-syteca-host/EkranACB
    description: Legacy URL prefix for ACB deployments updated from pre-v1.2
    variables:
      hostname:
        default: your-syteca-host.example.com
        description: Your Syteca Application Server hostname
security:
  - AccessTokenAuth: []
paths:
  /api/secrets/{id}/heartbeat:
    post:
      tags:
        - Secrets
      summary: Check secret password (Heartbeat)
      description: >-
        Initiates a heartbeat check to verify the secret's password is still
        valid
      operationId: checkSecretPassword
      parameters:
        - name: id
          in: path
          required: true
          description: The ID of the secret to check
          schema:
            type: integer
            format: int32
            minimum: 1
      responses:
        '200':
          description: Heartbeat check completed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckSecretPasswordResponseDto'
              example:
                check_password_status: Valid
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Secret not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    CheckSecretPasswordResponseDto:
      type: object
      properties:
        check_password_status:
          $ref: '#/components/schemas/PasswordCheckStatus'
      required:
        - check_password_status
    ErrorResponse:
      type: object
      properties:
        status:
          type: integer
          description: HTTP status code
        message:
          type: string
          description: Error message
      required:
        - status
        - message
    PasswordCheckStatus:
      type: string
      enum:
        - None
        - Valid
        - Invalid
        - Failed
      description: Status of the last password check (heartbeat)
  securitySchemes:
    AccessTokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Access token for authentication

````