# Check health

Source: https://musicnerd-docs.vercel.app/api-reference/health/get

Check health

## GET /api/health

Full OpenAPI specification: https://musicnerd-docs.vercel.app/spec/health.json

## Authentication

This operation's specification permits a request without authentication.

[Authentication guide](https://musicnerd-docs.vercel.app/authentication)

## Operation and referenced schemas

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Music Nerd API: health",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://musicnerd-api.vercel.app",
      "description": "Production"
    },
    {
      "url": "https://musicnerd-api-staging.vercel.app",
      "description": "Staging (staging database)"
    }
  ],
  "paths": {
    "/api/health": {
      "get": {
        "summary": "Check health",
        "description": "Confirms the API is up. No credentials and no database call.",
        "operationId": "getHealth",
        "security": [],
        "responses": {
          "200": {
            "description": "The API is up.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "ok"
                      ]
                    }
                  }
                },
                "example": {
                  "status": "ok"
                }
              }
            }
          }
        }
      }
    }
  }
}
```