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

# Health check

> Public liveness probe for the partner API. No authentication.



## OpenAPI

````yaml /api/promostandards/openapi.json get /api/promostandards/health
openapi: 3.1.0
info:
  title: DEKHQ Partner REST API
  version: 1.0.0
  description: >-
    JSON versions of the PromoStandards Order Status and Order Shipment
    Notification services. Same credentials, scopes and rate limit as the SOAP
    endpoints. Generated from the dekhq repo; do not edit by hand.
servers:
  - url: https://partners.dekhq.com
security:
  - basicAuth: []
paths:
  /api/promostandards/health:
    get:
      summary: Health check
      description: Public liveness probe for the partner API. No authentication.
      operationId: health
      responses:
        '200':
          description: The partner API is up.
          content:
            application/json:
              example:
                status: ok
                surface: promostandards-partner-api
                services:
                  - order-status-1.0.0
                  - order-shipment-notification-1.0.0
                protocols:
                  - soap
                  - rest
      security: []
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Your DEKHQ partner `id` and `password`.

````

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