Skip to main content
Identity & Access/ZIAM

ZiamGetHealth

Returns readiness for the ZIAM service and its required dependencies such as database and Redis. No authentication required.

GET/api/v1/ziam/health

Operation ID

ZiamGetHealth

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • ready
    Boolean

    Ready for this resource

    Example: true

  • checks
    LinkedHashMap

    Checks for this resource

    Example: (nested object)

    • *
      Object

      Map value