---
title: "Health check"
canonical_url: "https://twominutebilling.com/help/developers/api-reference/organization/health-check"
---
# Health check

<api-operation method="GET" path="/health">
<template v-slot:docs="">

## Response

<table>
<thead>
  <tr>
    <th>
      Field
    </th>
    
    <th>
      Type
    </th>
    
    <th>
      Description
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        status
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      <code>
        ok
      </code>
      
       when the database answers, <code>
        degraded
      </code>
      
       when it does not. One of <code>
        ok
      </code>
      
      , <code>
        degraded
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        db
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The database state. One of <code>
        up
      </code>
      
      , <code>
        down
      </code>
      
      .
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        service
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The service name.
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        env
      </code>
    </td>
    
    <td>
      <code>
        string
      </code>
    </td>
    
    <td>
      The runtime environment.
    </td>
  </tr>
</tbody>
</table>

## Status codes

<table>
<thead>
  <tr>
    <th>
      Status
    </th>
    
    <th>
      Meaning
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        200
      </code>
    </td>
    
    <td>
      Service + DB status
    </td>
  </tr>
</tbody>
</table>
</template>

<template v-slot:request="">

```bash [Request]
curl "$TMBILLING_URL/health"
```

</template>

<template v-slot:response="">

```json [200 OK]
{
  "status": "ok",
  "db": "up",
  "service": "tmbilling",
  "env": "production"
}
```

</template>
</api-operation>


## Sitemap

See the full [sitemap](https://twominutebilling.com/sitemap.md) for all pages.