Suomi.fi

Suomi.fi Health check API

Health check endpoints

Documentation GitHub OpenAPI

Operations 2

GET /health/liveness Liveness #

GET /health/readiness Readiness #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/suomi-fi:suomi-fi-health-check-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Suomi Fi Health check API
  version: 0.1.0
  description: 'Operations tagged Health check across 2 of this provider''s published API definitions: suomi-fi-ptv-v12-openapi.json, suomi-fi-ptv-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api-gw.palvelutietovaranto.suomi.fi
  description: Development server
tags:
- name: Health Check
  description: Health check endpoints
paths:
  /health/liveness:
    get:
      operationId: getLiveness
      summary: Liveness
      tags:
      - Health Check
      responses:
        '200':
          description: Healthy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthyResponseType'
        '503':
          description: Unhealthy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnhealthyResponseType'
    servers:
    - url: https://api-gw.palvelutietovaranto.suomi.fi
      description: Development server
  /health/readiness:
    get:
      operationId: getReadiness
      summary: Readiness
      tags:
      - Health Check
      responses:
        '200':
          description: Healthy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthyResponseType'
        '503':
          description: Unhealthy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnhealthyResponseType'
    servers:
    - url: https://api-gw.palvelutietovaranto.suomi.fi
      description: Development server
components:
  schemas:
    HealthyResponseType:
      type: string
      pattern: ^healthy$
      description: Healthy response
      title: HealthyResponseType
    UnhealthyResponseType:
      type: string
      pattern: ^unhealthy$
      description: Unhealthy response
      title: UnhealthyResponseType
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer auth
    apiKeyHeader:
      name: x-api-key
      in: header
      description: API-key auth
      type: apiKey
externalDocs:
  url: https://kehittajille.suomi.fi/palvelut/palvelutietovaranto/rajapinta-ja-arkkitehtuuriuudistus
  description: PTV - Suomi.fi Service developers documentation
x-refined-from:
- suomi-fi-ptv-v12-openapi.json
- suomi-fi-ptv-openapi.yml
x-tagGroups:
- name: Core
  tags:
  - Service channel
  - Connection
  - General description
  - Organization
  - Service
  - Service collection
- name: Reference data
  tags:
  - Languages
  - Countries
  - Municipalities
  - Regions
  - Wellbeing services counties
  - Postal codes
  - Industrial classes
  - Life events
  - Ontology terms
  - Service classes
  - Target groups
- name: Infrastructure
  tags:
  - Health check