REST API

Panther REST API를 사용하여 Panther 엔티티와 상호작용하기

개요

Panther는 Panther 인스턴스의 특정 부분과 상호작용할 수 있는 REST API를 제공합니다. 현재 REST API를 통해 다음 엔티티들과 상호작용할 수 있습니다:

• 알러트

• 알러트 댓글

• API 토큰

• 데이터 모델

• 글로벌

• 로그 소스

• 쿼리

• 역할

• 룰

• 스케줄된 룰

• 단순/YAML 룰

• 정책

• 사용자

추가 작업은 GraphQL API.

Panther REST API 스키마 알아보기

OpenAPI 명세

OpenAPI 명세 파일을 다운로드하여 REST API 스키마를 확인하세요:

151KB

panther_open_api_v3_spec.yaml

열기

API 플레이그라운드

Panther REST API 사용 방법

1단계: Panther REST API URL 식별

REST API URL을 찾으려면:

• Panther 콘솔의 오른쪽 상단에서 톱니바퀴 아이콘을 클릭한 다음 API 토큰를 클릭합니다. 페이지 상단에서 API URL.

  • 만약 당신이 SaaS 형태로 Panther를 배포한 경우, REST URL은 아래에 표시된 부분이 됩니다:

  

  • 만약 당신이 클라우드 연결 또는 셀프호스팅 형태로 Panther를 배포한 경우, URL은 아래에 표시된 부분이 됩니다(포함하여 /v1):

  

모든 REST URL은 끝에 /public/graphql 가 제외되어 있다는 점에 유의하세요.

2단계: API 토큰 생성

• 다음 문서를 참조하세요 API 토큰을 생성하는 방법에 대한 지침. 각 엔티티 페이지(이 페이지의 하위 항목)에 각 REST API 작업에 필요한 권한이 나와 있습니다.

3단계: Panther REST API 호출

콘솔에서 API 플레이그라운드 로 테스트하는 것 외에도 Swagger, Postman 또는 이 문서를 사용하여 REST API를 호출할 수 있습니다:

Swagger

Swagger를 사용하여 REST API에 접근하기

1. 웹 브라우저에서 Swagger Editor.

2. 왼쪽의 코드 편집기에 위에서 찾은 Panther REST OpenAPI 명세 파일을 붙여넣습니다(위의 Panther REST API 스키마 알아보기.

3. 오른쪽에서, 서버 변수섹션의 api_host에 프로토콜을 제외한 Panther REST API URL(즉, https://).

4. 클릭 을 제외한)을 입력합니다..

5. 에서 권한 부여 사용 가능한 권한

   1. 아래의 모달:값

   2. 클릭 을 제외한)을 입력합니다..

   3. 클릭 에 API 토큰 값을 입력하세요..

6. 닫기

   1. 이제 API 호출을 시도할 수 있습니다:

   2. 클릭 엔드포인트를 선택하고 아래로 향하는 화살표를 클릭하여 확장합니다..

   3. 클릭 시도해보기.

실행

이 문서