Zipkin

Zipkin Health API

Server health check

Documentation GitHub OpenAPI

Documentation

https://zipkin.io/zipkin-api/

Specifications

https://raw.githubusercontent.com/api-evangelist/zipkin/refs/heads/main/openapi/zipkin-health-api-openapi.yml

SDKs

GitHubRepository

https://github.com/openzipkin/zipkin

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/zipkin/refs/heads/main/json-schema/zipkin-api-v2-span-schema.json

https://raw.githubusercontent.com/api-evangelist/zipkin/refs/heads/main/json-schema/zipkin-api-v2-endpoint-schema.json

https://raw.githubusercontent.com/api-evangelist/zipkin/refs/heads/main/json-schema/zipkin-api-v2-annotation-schema.json

https://raw.githubusercontent.com/api-evangelist/zipkin/refs/heads/main/json-schema/zipkin-api-v2-dependency-link-schema.json

https://raw.githubusercontent.com/api-evangelist/zipkin/refs/heads/main/json-structure/zipkin-api-v2-span-structure.json

https://raw.githubusercontent.com/api-evangelist/zipkin/refs/heads/main/json-structure/zipkin-api-v2-endpoint-structure.json

https://raw.githubusercontent.com/api-evangelist/zipkin/refs/heads/main/json-structure/zipkin-api-v2-annotation-structure.json

https://raw.githubusercontent.com/api-evangelist/zipkin/refs/heads/main/json-structure/zipkin-api-v2-dependency-link-structure.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/zipkin/refs/heads/main/examples/zipkin-api-v2-get-services-example.json

https://raw.githubusercontent.com/api-evangelist/zipkin/refs/heads/main/examples/zipkin-api-v2-get-dependencies-example.json

https://raw.githubusercontent.com/api-evangelist/zipkin/refs/heads/main/examples/zipkin-api-v2-report-spans-example.json

https://raw.githubusercontent.com/api-evangelist/zipkin/refs/heads/main/examples/zipkin-api-v2-search-traces-example.json

OpenAPI Specification

openapi: 3.1.0
info:
  title: Zipkin API v2 Autocomplete Health API
  description: Zipkin's v2 HTTP API for querying and collecting distributed traces. Provides endpoints for submitting spans, querying traces, looking up services and span names, and retrieving dependency links between services.
  version: 2.0.0
  contact:
    name: OpenZipkin
    url: https://zipkin.io
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:9411
  description: Default Zipkin server
tags:
- name: Health
  description: Server health check
paths:
  /health:
    get:
      operationId: getHealth
      summary: Zipkin Health Check
      description: Returns OK if the server is healthy.
      tags:
      - Health
      responses:
        '200':
          description: Server is healthy
          content:
            text/plain:
              schema:
                type: string
                example: OK