GET /health
API가 온라인인지 확인하는 인증 불필요 엔드포인트예요.
업타임 모니터·배포 후 스모크 테스트에 사용하세요.
요청
http
GET /health HTTP/1.1
Host: api.mineplatform.kr
Accept: application/json동일 응답:
http
GET / HTTP/1.1
Host: api.mineplatform.kr- 메서드: GET only
- 인증: 없음
- 쿼리 파라미터: 없음
성공 응답
200 OK
json
{
"ok": true,
"service": "mineplatform-api"
}| 필드 | 타입 | 설명 |
|---|---|---|
ok | boolean | 항상 true (프로세스가 응답한 경우) |
service | string | 고정 값 "mineplatform-api" |
실패
| 상태 | 본문 | 의미 |
|---|---|---|
503 | { "error": "API server is not configured." } | 필수 시크릿 미설정 |
인증·DB 조회 없이 응답하므로, /health가 정상이어도 /v1/servers가 502일 수는 있어요.
데이터 API까지 확인하려면 키로 서버 목록을 한 번 호출하세요.
curl
bash
curl -sS "https://api.mineplatform.kr/health"주의
- 이 엔드포인트는 키 RPS에 포함되지 않아요.
- 응답이 정상이라고 해서 등록된 서버가 있다는 뜻은 아니에요.