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

# Liveness and authentication check

> Returns 200 and echoes the resolved team and scope when the admin key authenticates.



## OpenAPI

````yaml nodeapi/openapi/admin-api.json GET /health
openapi: 3.1.0
info:
  description: |-
    Programmatic, API-key-authenticated surface for managing
    Validation Cloud RPC endpoints and retrieving usage. Only the
    currently-implemented endpoints are documented; the broader PRD
    surface is intentionally omitted until served.

    `/admin/v1` is a strict contract — breaking changes are made
    under `/admin/v2`, never in place. Clients branch on the stable
    `error.code` enum, not on HTTP status alone.
  title: Validation Cloud Node API — Admin API
  version: 1.0.0
servers:
  - url: https://api.validationcloud.io/admin/v1
security: []
externalDocs:
  description: ''
  url: ''
paths:
  /health:
    get:
      tags:
        - Health
      summary: Liveness and authentication check
      description: >-
        Returns 200 and echoes the resolved team and scope when the admin key
        authenticates.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/admin.healthResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/admin.errorEnvelope'
          description: Unauthorized
      security:
        - AdminApiKey: []
components:
  schemas:
    admin.healthResponse:
      properties:
        scope:
          enum:
            - READ
            - WRITE
          example: READ
          type: string
        status:
          example: ok
          type: string
        team_id:
          format: uuid
          type: string
      type: object
    admin.errorEnvelope:
      properties:
        error:
          $ref: '#/components/schemas/admin.errorBody'
      type: object
    admin.errorBody:
      properties:
        code:
          enum:
            - unauthorized
            - forbidden
            - invalid_request
            - not_found
            - endpoint_limit_reached
            - plan_not_eligible
            - rate_limited
            - internal_error
          example: invalid_request
          type: string
        message:
          example: from must be an RFC3339 timestamp
          type: string
      type: object
  securitySchemes:
    AdminApiKey:
      description: >-
        Admin API key under the `ApiKey` scheme: `Authorization: ApiKey
        vc_adm_...`. Each key is bound to one team and carries a READ or WRITE
        scope; the usage endpoints require only READ.
      in: header
      name: Authorization
      type: apiKey

````

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