Dapr

Dapr Health API

Health check operations.

Documentation GitHub OpenAPI

Documentation

https://docs.dapr.io/reference/api/state_api/

https://docs.dapr.io/reference/api/pubsub_api/

https://docs.dapr.io/reference/api/service_invocation_api/

https://docs.dapr.io/reference/api/bindings_api/

https://docs.dapr.io/reference/api/secrets_api/

https://docs.dapr.io/reference/api/actors_api/

https://docs.dapr.io/reference/api/workflow_api/

https://docs.dapr.io/reference/api/configuration_api/

https://docs.dapr.io/reference/api/distributed_lock_api/

https://docs.dapr.io/reference/api/cryptography_api/

https://docs.dapr.io/reference/api/jobs_api/

https://docs.dapr.io/reference/api/health_api/

https://docs.dapr.io/reference/api/metadata_api/

Specifications

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

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/asyncapi/dapr-pubsub-asyncapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/state-item.json

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/cloud-event.json

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/binding.json

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/secret.json

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/actor.json

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/workflow.json

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/configuration-item.json

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/job.json

https://raw.githubusercontent.com/api-evangelist/dapr/refs/heads/main/json-schema/metadata.json

Other Resources

https://docs.dapr.io/developing-applications/building-blocks/state-management/

Client Libraries

https://docs.dapr.io/sdks/

https://docs.dapr.io/developing-applications/building-blocks/pubsub/

https://docs.dapr.io/developing-applications/building-blocks/service-invocation/

https://docs.dapr.io/developing-applications/building-blocks/bindings/

https://docs.dapr.io/developing-applications/building-blocks/secrets/

https://docs.dapr.io/developing-applications/building-blocks/actors/

https://docs.dapr.io/developing-applications/building-blocks/workflow/

https://docs.dapr.io/developing-applications/building-blocks/configuration/

https://docs.dapr.io/developing-applications/building-blocks/distributed-lock/

https://docs.dapr.io/developing-applications/building-blocks/cryptography/

https://docs.dapr.io/developing-applications/building-blocks/jobs/

https://docs.dapr.io/operations/observability/healthchecks/

https://docs.dapr.io/operations/observability/

OpenAPI Specification

openapi: 3.1.0
info:
  title: Dapr Actors Health API
  description: The Dapr Actors API provides virtual actor capabilities for distributed applications, including actor method invocation, state management, timers, and reminders. Actors provide a single-threaded programming model with guaranteed message ordering.
  version: 1.0.0
  contact:
    name: Dapr
    url: https://dapr.io
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:3500
  description: Dapr Sidecar
tags:
- name: Health
  description: Health check operations.
paths:
  /v1.0/healthz:
    get:
      summary: Dapr Health Check
      description: Returns the health status of the Dapr sidecar. Waits for all components to be initialized, the HTTP port to be available, and the app channel to be ready.
      operationId: healthCheck
      tags:
      - Health
      responses:
        '200':
          description: Sidecar is healthy and ready.
        '500':
          description: Sidecar is not healthy.
  /v1.0/healthz/outbound:
    get:
      summary: Dapr Outbound Health Check
      description: Returns the health status of the Dapr sidecar for outbound connections. Unlike the standard health check, this does not wait for the app channel to be ready, allowing applications to call Dapr sidecar APIs before the app is fully initialized.
      operationId: healthCheckOutbound
      tags:
      - Health
      responses:
        '200':
          description: Sidecar is healthy for outbound connections.
        '500':
          description: Sidecar is not healthy.
externalDocs:
  description: Dapr Actors API Reference
  url: https://docs.dapr.io/reference/api/actors_api/