Indicates if ZITADEL is running.

It respondes as soon as ZITADEL started

Indicates if ZITADEL is running. It respondes as soon as ZITADEL started

Responses

• 200
• 403
• 404
• default

---

ZITADEL started

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

object

{}

Schema

Example (from schema)

---

Schema

object

{}

Schema

Example (from schema)

---

Schema

object

{}

Returned when the user does not have permission to access the resource.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Returned when the resource does not exist.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

ZITADEL NOT started yet

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

GET /healthz

Request

Base URL

https://$CUSTOM-DOMAIN/system/v1

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X GET 'https://$CUSTOM-DOMAIN/system/v1/healthz' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'https://$CUSTOM-DOMAIN/system/v1/healthz' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'https://$CUSTOM-DOMAIN/system/v1/healthz' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET 'https://$CUSTOM-DOMAIN/system/v1/healthz' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET 'https://$CUSTOM-DOMAIN/system/v1/healthz' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET 'https://$CUSTOM-DOMAIN/system/v1/healthz' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET 'https://$CUSTOM-DOMAIN/system/v1/healthz' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET 'https://$CUSTOM-DOMAIN/system/v1/healthz' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET 'https://$CUSTOM-DOMAIN/system/v1/healthz' \
-H 'Accept: application/json'