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

# Health check

> Returns a simple liveness response with the current server time, plus the timestamp of the last successful publish run so clients can tell how fresh the served data is.



## OpenAPI

````yaml /openapi.json get /api/v1/health
openapi: 3.1.0
info:
  title: k-Data
  version: 0.1.0
  description: >-
    Preview read-only API for reshaped public data collected from Kushiro City
    sources. Response shapes, URLs, and published datasets may change without
    notice.
  license:
    name: CC BY 4.0
    url: https://creativecommons.org/licenses/by/4.0/deed.ja
servers:
  - url: https://data.kushiro.app
    description: Production
security: []
tags:
  - name: service
    description: Service metadata and health endpoints.
  - name: sources
    description: Published source summaries.
  - name: metrics
    description: Numeric data records.
  - name: points
    description: >-
      Facility and location-style data records such as public facilities, AED
      locations, evacuation sites, and indexes.
  - name: terms
    description: Terms of use and attribution notes.
paths:
  /api/v1/health:
    get:
      tags:
        - service
      summary: Health check
      description: >-
        Returns a simple liveness response with the current server time, plus
        the timestamp of the last successful publish run so clients can tell how
        fresh the served data is.
      operationId: getHealth
      responses:
        '200':
          description: The service is reachable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
              examples:
                default:
                  value:
                    status: ok
                    time: '2026-05-06T00:00:00.000Z'
                    last_published_at: '2026-05-05T18:04:11.372Z'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    Health:
      type: object
      required:
        - status
        - time
        - last_published_at
      properties:
        status:
          type: string
          enum:
            - ok
        time:
          type: string
          format: date-time
        last_published_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Timestamp of the last successful publish run applied to the read
            model (ISO 8601 UTC). Null when nothing has been published yet. Use
            this to check how fresh the served data is.
      additionalProperties: false
    InternalServerError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          example: internal server error
      additionalProperties: false
  responses:
    InternalServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
          examples:
            default:
              value:
                error: internal server error

````