REST API

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

개요

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

• 알러트

• 알러트 댓글

• 알러트 컨텍스트 태그

• API 토큰

• 상관 규칙

• 데이터 모델

• 글로벌

• 로그 소스

• 쿼리

• 역할

• 룰

• 예약된 룰

• 간단한/YAML 룰

• 정책

• 사용자

추가 작업은 GraphQL API.

Panther REST API 스키마 알아보기

OpenAPI 명세

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

177KB

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

REST API에 접근하기 위해 Swagger 사용

1. 웹 브라우저에서 Swagger 편집기.

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

3. 오른쪽에서, 서버 변수에서, api_host에 프로토콜 없이(즉, https://).

4. 를 제외하고) Panther REST API URL을 입력하세요. 승인.

5. 에서 사용 가능한 인증 모달:

   1. 아래의 값에 API 토큰 값을 입력하세요.

   2. 를 제외하고) Panther REST API URL을 입력하세요. 승인.

   3. 를 제외하고) Panther REST API URL을 입력하세요. 닫기.

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

   1. 엔드포인트를 선택하고 아래를 가리키는 화살표를 클릭하여 확장하세요.

   2. 를 제외하고) Panther REST API URL을 입력하세요. 시도해 보기.

   3. 를 제외하고) Panther REST API URL을 입력하세요. 실행.

Postman

이 문서