---
title: "oz0 server healthcheck"
description: "Usage and flags for oz0 server healthcheck."
canonical_url: "https://docs.oz0.ai/reference/cli/oz0/server/healthcheck"
---
# oz0 server healthcheck

> Usage and flags for oz0 server healthcheck.

For: Operators and developers looking up a command.

Ask a server on this machine whether it is ready (GET /readyz on the edge's HTTPS port, which a fenced edge answers with 503) and exit 0 when it is, 1 when not. It is meant for HEALTHCHECK in a container and compose's depends_on. It reads only the answer's status, and the server's certificate comes from the cluster's own CA, which this command does not have, so it does not check the certificate: it takes loopback addresses only.

## Usage

```bash
oz0 server healthcheck [flags]
```

## Flags

<table>
<thead>
  <tr>
    <th>
      Flag
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Default
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        --timeout
      </code>
    </td>
    
    <td>
      duration
    </td>
    
    <td>
      <code>
        5s
      </code>
    </td>
    
    <td>
      how long to wait for an answer
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        --url
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      <code>
        https://127.0.0.1:7443/readyz
      </code>
    </td>
    
    <td>
      the readiness address to ask, on this machine
    </td>
  </tr>
</tbody>
</table>

## Inherited flags

<table>
<thead>
  <tr>
    <th>
      Flag
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Default
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        --context
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      <code>
        $OZ0_CONTEXT or &lt;config dir>/orchestrator-zero/context.json
      </code>
    </td>
    
    <td>
      CLI context file written by server init
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        --log-level
      </code>
    </td>
    
    <td>
      string
    </td>
    
    <td>
      <code>
        info
      </code>
    </td>
    
    <td>
      log level: debug, info, warn or error
    </td>
  </tr>
</tbody>
</table>

See [all `oz0` commands](https://docs.oz0.ai/reference/cli/oz0) and the [global flags](https://docs.oz0.ai/reference/cli/oz0#global-flags).


## Sitemap

See the full [sitemap](https://docs.oz0.ai/sitemap.md) for all pages.