> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cyborg.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Health

Returns the health status of the CyborgDB service, to check that it is reachable and running.

```go theme={null}
func (c *Client) GetHealth(ctx context.Context) (map[string]string, error)
```

### Returns

A `map[string]string` with these keys:

| Key | Description |
| - | - |
| `status` | Service health, `"healthy"` when the service is up. |
| `api_version` | REST API version, e.g. `"v1"`. |
| `version` | CyborgDB service version. |

### Errors

<AccordionGroup>
  <Accordion title="*TransportError">
    The service can't be reached.
  </Accordion>

  <Accordion title="*ServiceError">
    The service returns `5xx`.
  </Accordion>
</AccordionGroup>

See [Errors](../errors).

### Example Usage

```go theme={null}
package main

import (
    "context"
    "fmt"
    "log"

    "github.com/cyborginc/cyborgdb-go"
)

func main() {
    client, err := cyborgdb.NewClient("http://localhost:8000", "your-api-key")
    if err != nil {
        log.Fatal(err)
    }

    health, err := client.GetHealth(context.Background())
    if err != nil {
        log.Fatal(err)
    }
    fmt.Println(health)
    // Output: map[api_version:v1 status:healthy version:0.18.0]
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.