REST API

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

개요

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

• 알러트

• 알러트 댓글

• 알러트 컨텍스트 태그

• API 토큰

• 클라우드 계정

• 상관 규칙

• 데이터 모델

• 전역 항목

• 로그 소스

• 로그 소스 알람

• 쿼리

• 역할

• 룰

• 예약된 규칙

• Simple/YAML 규칙

• 정책

• 사용자

추가 작업은 다음에서 사용할 수 있습니다 GraphQL API.

Panther REST API 스키마를 확인해 보세요

OpenAPI 사양

다음 OpenAPI 사양 파일을 다운로드하여 REST API 스키마를 확인할 수 있습니다:

다운로드 panther-labs-api.yaml

API 플레이그라운드

Panther REST API 사용 방법

1단계: Panther REST API URL 식별

REST API URL을 찾으려면:

• Panther Console의 왼쪽 탐색 모음 하단에서 설정를 클릭한 다음 개발자 도구 > API 토큰. 페이지 상단에서 다음을 확인하세요 API URL.

  • Panther를 실행 중인 SaaS 배포의 REST URL은 아래에 표시된 부분이 됩니다:

  

  • Panther를 실행 중인 Cloud Connected 또는 자체 호스팅 Panther 배포의 URL은 아래에 표시된 부분(다음을 포함)입니다: /v1):

  

모든 REST URL에는 /public/graphql 가 끝부분에 포함되지 않는다는 점에 유의하세요.

2단계: API 토큰 생성

• 참고 API 토큰 생성 방법에 대한 이 지침. 각 엔터티 페이지(이 페이지 아래에 중첩됨)에서 각 REST API 작업에 필요한 권한을 찾을 수 있습니다. 다음을 참조하세요. 콘솔 및 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. 오른쪽에서, 아래의 서버 변수에서 사용할 예제 SQL 쿼리를 참조하세요. api_host, 프로토콜을 제외한 Panther REST API URL을 입력합니다(즉, 다음을 제외하고 https://).

4. 클릭합니다 권한 부여.

5. 다음 사용 가능한 인증 모달:

   1. 아래 값, API 토큰 값을 입력합니다.

   2. 클릭합니다 권한 부여.

   3. 클릭합니다 닫기.

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

   1. 엔드포인트를 선택한 다음, 아래쪽 화살표를 클릭하여 확장합니다.

   2. 클릭합니다 직접 사용해 보기.

   3. 클릭합니다 실행.

Postman

이 문서