OpenAPI 명세 다운로드

API 엔드포인트를 탐색하거나 클라이언트 라이브러리를 생성하기 위해 OpenAPI/Swagger 명세를 다운로드하세요.

​
API 키를 생성하는 방법은?

새 API 키를 생성하려면 다음으로 이동하세요:조직 드롭다운 > 조직 설정 > API 키 > 새 API 키 생성.

Rootly는 세 가지 범위의 API 키를 지원합니다:

API 키 유형권한
글로벌 API 키글로벌 API 키는 생성 시 온콜 및 인시던트 대응 역할이 할당됩니다. 할당된 역할의 권한이 키의 권한을 제어합니다. 글로벌 API 키는 Rootly 인스턴스 내의 모든 엔티티와 상호 작용할 수 있습니다.
팀 API 키팀 API 키는 팀 관리자와 동일한 권한을 상속받습니다. 팀이 소유한 모든 Rootly 엔티티(예: 팀의 일정 및 에스컬레이션 정책)에 대해 전체 읽기 및 편집 권한을 가집니다.
개인 API 키개인 API 키는 API 키를 생성한 사용자의 권한을 상속받습니다.

​
JSON:API Specification

Rootly는 JSON:API (https://jsonapi.org) 명세를 사용합니다:

  • JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests.
  • JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability.
  • JSON:API requires use of the JSON:API media type (application/vnd.api+json) 데이터 교환을 위해.

​
인증 및 요청

요청을 인증하기 위해 HTTPS를 통한 표준 HTTP 인증을 사용합니다.

curl --request GET \
--header 'Content-Type: application/vnd.api+json' \
--header 'Authorization: Bearer YOUR-TOKEN' \
--url https://api.rootly.com/v1/incidents

​
속도 제한

  • 기본적으로 약 3000 GET 호출 API 키당 매 60초마다 제한이 있습니다. 이 제한은 60초 슬라이딩 윈도우를 사용하여 현재 시간부터 뒤로 계산됩니다. 더 높은 임계값을 지원하도록 제한을 구성할 수 있지만, 먼저 Rootly 고객 성공 관리자에게 연락하여 조정해야 합니다.
  • 기본적으로 약 3000 PUT, POST, PATCH 또는 DELETE 호출 API 키당 매 60초마다 제한이 있습니다. 이 제한은 60초 슬라이딩 윈도우를 사용하여 현재 시간부터 뒤로 계산됩니다. 더 높은 임계값을 지원하도록 제한을 구성할 수 있지만, 먼저 Rootly 고객 성공 관리자에게 연락하여 조정해야 합니다.
  • API 호출에 대한 응답은 429 HTTP 상태 코드 - 요청 제한 초과를 반환하며 Rootly는 이벤트를 수집하지 않습니다.
  • 제한에 대한 정보를 제공하는 추가 헤더가 반환됩니다:
    • RateLimit-Limit - 소비자가 허용된 최대 요청 수입니다.
    • RateLimit-Remaining - 현재 속도 제한 윈도우에서 남은 요청 수입니다.
    • RateLimit-Reset - 현재 속도 제한 윈도우가 재설정되는 시간(UTC 에포크 초)입니다.

​
페이지네이션

  • 페이지네이션은 컬렉션의 항목을 반환하는 모든 엔드포인트에서 지원됩니다.
  • 페이지네이션은 page 쿼리 매개변수

​
예시

curl --request GET \
--header 'Content-Type: application/vnd.api+json' \
--header 'Authorization: Bearer YOUR-TOKEN' \
--url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10