Instatus API 시작하기

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

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

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

인증

Instatus API로 보내는 요청은 Authorization 헤더로 API 키를 보내야 합니다.

Authorization: Bearer <API_KEY>

키는 대시보드 › 개발자에서 키 만들기로 만듭니다. 키는 여러 개 둘 수 있으며, 각각 "GitHub Actions"나 "Terraform"처럼 이름을 붙일 수 있습니다. 키는 inst_sk_로 시작합니다.

키로 할 수 있는 일

키마다 다음 설정이 있습니다.

  • 역할: 멤버, 편집자 또는 Business 플랜의 사용자 지정 역할. 역할은 사람에게와 마찬가지로 키가 무엇을 보고 변경할 수 있는지 정합니다. 키는 소유자가 될 수 없으므로 결제, 역할, 삭제는 사람만 할 수 있습니다.
  • 접근 권한: 보기 및 변경 또는 보기만. 보기만으로 설정한 키는 역할이 허용하더라도 아무것도 변경할 수 없습니다.
  • 프로젝트: 나중에 추가하는 프로젝트를 포함한 모든 프로젝트, 또는 선택한 프로젝트만.
  • 만료: 키가 더 이상 작동하지 않는 날짜. Free 플랜에서는 최대 90일, Pro에서는 최대 1년, Business와 Enterprise에서는 만료 없음을 포함해 원하는 기간으로 정할 수 있습니다. 팀 소유자는 팀 설정 › API 키에서 더 짧은 한도를 정할 수 있습니다. 키 설정 도입 전에 만든 키에는 적용되지 않으며, 기존 키는 플랜이 바뀌어도 날짜가 그대로 유지됩니다.
  • 허용된 IP: Business 플랜에서는 지정한 IP 주소나 범위에서만 키가 작동합니다.

키는 팀 또는 회원님 개인에게 속합니다.

  • 팀 키는 만든 사람이 팀을 떠나도 계속 작동합니다. CI, 스크립트, 연동에 사용하세요.
  • 개인 키는 회원님으로서 작동하며, 회원님이 할 수 있는 것 이상은 절대 하지 않습니다. 역할로 나와 같음을 사용할 수 있으며, 회원님이 팀을 떠나면 작동하지 않습니다.

팀 소유자는 팀 설정 › API 키에서 키 규칙을 정합니다. 키의 최대 유효 기간, 멤버가 팀 키를 만들 수 있는지, 개인 키를 허용할지를 설정할 수 있습니다.

키를 만들거나 변경, 순환, 취소하면 팀의 활동에 표시되며, 유출되어 취소된 키도 마찬가지입니다. 키나 연결된 앱을 통해 한 작업은 그곳에 '사람(키 또는 앱 이름을 통해)' 형식으로 표시됩니다.

키를 안전하게 보관하기

  • 키는 만들 때 한 번만 표시됩니다. 그때 복사해서 비밀 값으로 보관하세요.
  • 키를 바꾸려면 키를 열고 순환을 클릭합니다. 이전 키가 계속 작동할 기간을 최대 7일까지 선택할 수 있으므로, 그 키를 사용하는 모든 곳을 업데이트할 시간이 있습니다.
  • 메뉴에서 키를 취소하면 즉시 작동을 멈춥니다.

키 설정 도입 전에 만든 키는 그대로 계속 작동합니다. 개발자 페이지에 "키 설정 도입 전에 생성됨"으로 표시되며, 여기에서 제한을 추가하거나 새 키로 교체할 수 있습니다.

키 오류

키로 요청을 할 수 없을 때 오류에는 다음 코드 중 하나가 담기며, 메시지에서 무엇을 바꿔야 하는지 알려 줍니다.

코드상태이유
invalid_key401키가 존재하지 않습니다. 키 전체를 복사했는지 확인하세요.
key_expired401키의 만료일이 지났습니다.
key_revoked401키가 취소되었습니다.
key_owner_left401개인 키의 주인이 팀을 떠났습니다.
key_view_only403보기만으로 설정한 키인데 요청이 무언가를 변경합니다.
role_not_allowed403키의 역할로는 이 항목을 보거나 변경할 수 없습니다.
ip_not_allowed403키가 허용하지 않는 IP 주소에서 온 요청입니다.
page_not_allowed403키가 이 프로젝트를 사용할 수 없습니다.
account_action_not_allowed403키로는 페이지, 팀, 워크스페이스를 만들거나 삭제할 수 없습니다. 대시보드를 사용하세요.
route_not_allowed403문서화된 API에 포함되지 않은 경로입니다.

페이지 ID 확인하기

페이지 ID는 다음 단계로 대시보드에서 확인할 수 있습니다.

  1. 대시보드로 이동하세요.
  2. 왼쪽 위의 프로젝트를 마우스 오른쪽 버튼으로 클릭해 메뉴를 여세요.
  3. Copy Project ID를 클릭하면 페이지 ID가 클립보드에 복사됩니다.
페이지 ID

오류

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

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

상태 값

가능한 페이지 상태입니다. 현재 API(v2 이상)가 반환하는 세분화된 status 값입니다. 레거시 summary.json 엔드포인트와 Webhook 알림은 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

엔드포인트로 이동하기: