# Instatus API 시작하기

Source: https://instatus.com/help/ko/api

모든 엔드포인트는 `https://api.instatus.com` URL 아래에 있습니다. 대체로 REST 구조를 따릅니다.

모든 요청은 `Content-Type: application/json` 헤더와 함께 JSON으로 인코딩해야 합니다.

오류를 포함한 Instatus API의 응답도 JSON으로 인코딩됩니다.

## 인증

Instatus API로 보내는 요청은 Authorization 헤더로 API 토큰을 제공해야 합니다.

API 키는 사용자 설정 → [개발자 설정](https://dashboard.instatus.com/developer)에서 받을 수 있습니다.

```bash
Authorization: Bearer <API_KEY>
```

## 페이지 ID 확인하기
페이지 ID는 다음 단계로 대시보드에서 확인할 수 있습니다.
1. 대시보드로 이동하세요.
2. 왼쪽 위의 프로젝트를 마우스 오른쪽 버튼으로 클릭해 메뉴를 여세요.
3. **Copy Project ID**를 클릭하면 페이지 ID가 클립보드에 복사됩니다.

![페이지 ID](https://instatus.com/help/page_id.png)

## 오류

모든 API 엔드포인트의 오류 응답에는 code와 message가 포함됩니다.

```json
{
  "error": {
    "code": "forbidden",
    "message": "Not authorized"
  }
}
```

## 상태 값

가능한 페이지 상태입니다. 현재 API(v2 이상)가 반환하는 세분화된 `status` 값입니다. 레거시 `summary.json` 엔드포인트와 [Webhook 알림](https://instatus.com/help/ko/webhooks)은 `UP`, `HASISSUES`, `UNDERMAINTENANCE`만 사용하는 축약된 형태를 씁니다.

- `UP`
- `HASISSUES`
- `ALLUNDERMAINTENANCE`
- `ALLDEGRADEDPERFORMANCE`
- `ALLPARTIALOUTAGE`
- `ALLMINOROUTAGE`
- `ALLMAJOROUTAGE`
- `SOMEUNDERMAINTENANCE`
- `SOMEDEGRADEDPERFORMANCE`
- `SOMEPARTIALOUTAGE`
- `SOMEMINOROUTAGE`
- `SOMEMAJOROUTAGE`
- `ONEUNDERMAINTENANCE`
- `ONEDEGRADEDPERFORMANCE`
- `ONEPARTIALOUTAGE`
- `ONEMINOROUTAGE`
- `ONEMAJOROUTAGE`

가능한 구성 요소 상태:

- `OPERATIONAL`
- `UNDERMAINTENANCE`
- `DEGRADEDPERFORMANCE`
- `PARTIALOUTAGE`
- `MAJOROUTAGE`

가능한 인시던트 상태:

- `INVESTIGATING`
- `IDENTIFIED`
- `MONITORING`
- `RESOLVED`

가능한 유지보수 상태:

- `NOTSTARTEDYET`
- `INPROGRESS`
- `COMPLETED`

## 엔드포인트로 이동하기:

- [상태 페이지](https://instatus.com/help/ko/api/status-pages)
- [워크스페이스](https://instatus.com/help/ko/api/workspaces)
- [구성 요소](https://instatus.com/help/ko/api/components)
- [인시던트](https://instatus.com/help/ko/api/incidents)
- [인시던트 업데이트](https://instatus.com/help/ko/api/incident-updates)
- [점검](https://instatus.com/help/ko/api/maintenances)
- [유지보수 업데이트](https://instatus.com/help/ko/api/maintenance-updates)
- [템플릿](https://instatus.com/help/ko/api/templates)
- [일반 공지](https://instatus.com/help/ko/api/generic-notices)
- [장애](https://instatus.com/help/ko/api/outages)
- [팀원](https://instatus.com/help/ko/api/teammates)
- [구독자](https://instatus.com/help/ko/api/subscribers)
- [메트릭](https://instatus.com/help/ko/api/metrics)
- [사용자 프로필](https://instatus.com/help/ko/api/user-profile)
- [공개 데이터](https://instatus.com/help/ko/api/public-data)
- [비공개 페이지](https://instatus.com/help/ko/api/private-pages)
- [대상 그룹](https://instatus.com/help/ko/api/audience-groups)
- [모니터](https://instatus.com/help/ko/api/monitors)
- [모니터링 연동](https://instatus.com/help/ko/api/monitoring-integrations)
- [라우팅 규칙](https://instatus.com/help/ko/api/routing-rules)
- [에스컬레이션 정책](https://instatus.com/help/ko/api/escalation-policies)
- [온콜 일정](https://instatus.com/help/ko/api/on-call-schedules)