Skip to main content

Alpha This is a new service. Help us improve it and give your feedback.

MUST

MUST return 200 for api root

Root path MUST define a 200 response.

Valid Example

paths:
  /:
    get:
      summary: Get API information.
      description: Get API information.
      operationId: getApiInfo
      tags:
        - API Meta Information
      responses:
        '200':
          description: This response returns a information about the API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiInfo'
        default:
          $ref: '#/components/responses/UnexpectedError'

UKHSA Guidelines Versioning

Published: 27 February 2025
Last updated: 14 August 2025
Page Source