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

# Ping the configured inference proxy

> Administrator-only server-side health request that does not expose gateway credentials.



## OpenAPI

````yaml /openapi/next.yaml post /gateway/proxy/health
openapi: 3.1.0
info:
  title: Blue — Service Contract
  version: 0.1.0
  description: >
    The client-side contract the `blue` CLI expects from the provisioned
    service. The reference `control-api` implements it; any BYO service that
    honors these shapes can be swapped in. Gateway-mode inference JWT issuance
    is OPTIONAL — governance-only deployments need only `GET
    /governance-config`. CLI callers use OAuth 2.0 access tokens issued through
    RFC 8628 device authorization; dashboard callers use an HTTP-only Better
    Auth session cookie.
servers:
  - url: https://harness.example.com
    description: Replace with the Control API URL for your deployment.
security:
  - oauthDevice: []
tags:
  - name: System
    description: Service health and authenticated identity.
  - name: Configuration
    description: Personalized governance policy and client reconciliation state.
  - name: Gateway
    description: Per-user managed inference-gateway credential lifecycle.
  - name: Sessions
    description: Raw-session upload, metadata, and download lifecycle.
  - name: Administration
    description: Organization-administrator policy and client operations.
  - name: User management
    description: >-
      Organization user lifecycle, session revocation, and invitation
      operations.
  - name: Identity provisioning
    description: SCIM 2.0 user and group provisioning for an external identity provider.
paths:
  /gateway/proxy/health:
    post:
      tags:
        - Gateway
      summary: Ping the configured inference proxy
      description: >-
        Administrator-only server-side health request that does not expose
        gateway credentials.
      operationId: checkGatewayProxyHealth
      responses:
        '200':
          description: Current reachability and latency of the inference proxy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayProxyHealthResponse'
        '400':
          description: Inference proxy is not configured
        '403':
          description: Administrator access required
components:
  schemas:
    GatewayProxyHealthResponse:
      type: object
      required:
        - status
        - checked_at
        - latency_ms
      properties:
        status:
          type: string
          enum:
            - healthy
            - unhealthy
        checked_at:
          type: string
          format: date-time
        latency_ms:
          type: integer
          minimum: 0
        http_status:
          type:
            - integer
            - 'null'
          minimum: 100
          maximum: 599
        error:
          type:
            - string
            - 'null'
  securitySchemes:
    oauthDevice:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        OAuth 2.0 access token obtained through RFC 8628 at
        /api/auth/device/code and /api/auth/oauth2/token. The API enforces
        governance:read, session:write, and client-status:write as appropriate.

````