알림 댓글

알림 댓글에 대한 REST API 작업

개요

설정은 /alert-comments REST API 작업은 Panther 버전 1.112부터 오픈 베타 상태이며 모든 고객에게 제공됩니다. 버그 리포트 및 기능 요청은 Panther 지원 팀에 공유해 주세요.

이 API 작업을 사용하여 상호작용하세요 알림 댓글 HTTP 소스 설정 중에는 스키마를 선택하지 마십시오.

API를 호출하려면 다음을 참조하세요 Panther REST API 사용 방법 지침—포함하여 이 문서 페이지에서 직접 호출하는 방법에 대한 안내.

필수 권한

• 다음을 위해 GET 작업을 수행하려면 API 토큰에 다음 권한이 있어야 합니다 알림 읽기 권한이 있어야 합니다.

• 다음을 위해 한 후 Panther에서 볼 수 있기까지 몇 분 기다려야 할 수 있습니다. 작업을 수행하려면 API 토큰에 다음 권한이 있어야 합니다 경고 관리 권한이 있어야 합니다.

작업

Create a comment for an alert

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Body

application/json

alertIdstringRequired

The alert ID the comment is associated with

bodystringRequired

The body of the comment

formatstring · enumRequired

The format of the comment

Possible values:

Responses

200

OK response.

application/json

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

post

/alert-comments

HTTPcURLJavaScriptPython

POST /alert-comments HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "alertId": "text",
  "body": "text",
  "format": "PLAIN_TEXT"
}

{
  "alertId": "text",
  "body": null,
  "createdAt": "text",
  "createdBy": {
    "id": "user",
    "type": "text"
  },
  "format": "PLAIN_TEXT",
  "id": "text",
  "updatedAt": "text",
  "updatedBy": {
    "id": "user",
    "type": "text"
  }
}

Get a comment for an alert

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the comment

Responses

200

OK response.

application/json

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

get

/alert-comments/{id}

HTTPcURLJavaScriptPython

GET /alert-comments/{id} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "alertId": "text",
  "body": null,
  "createdAt": "text",
  "createdBy": {
    "id": "user",
    "type": "text"
  },
  "format": "PLAIN_TEXT",
  "id": "text",
  "updatedAt": "text",
  "updatedBy": {
    "id": "user",
    "type": "text"
  }
}

Update a comment for an alert

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the comment

Body

application/json

alertIdstringRequired

The alert ID the comment is associated with

bodystringRequired

The body of the comment

formatstring · enumRequired

The format of the comment

Possible values:

Responses

200

OK response.

application/json

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

post

/alert-comments/{id}

HTTPcURLJavaScriptPython

POST /alert-comments/{id} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "alertId": "text",
  "body": "text",
  "format": "PLAIN_TEXT"
}

{
  "alertId": "text",
  "body": null,
  "createdAt": "text",
  "createdBy": {
    "id": "user",
    "type": "text"
  },
  "format": "PLAIN_TEXT",
  "id": "text",
  "updatedAt": "text",
  "updatedBy": {
    "id": "user",
    "type": "text"
  }
}

List alert comments

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Query parameters

alert-idstringRequired

The alert ID the comments are associated with

cursorstringOptional

the pagination token

limitinteger · int64 · max: 50Optional

the maximum results to return

Default: 25

Responses

200

OK response.

application/json

400

bad_request: Bad Request response.

application/json

get

/alert-comments

HTTPcURLJavaScriptPython

GET /alert-comments?alert-id=text HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "next": "text",
  "results": [
    {
      "alertId": "text",
      "body": null,
      "createdAt": "text",
      "createdBy": {
        "id": "user",
        "type": "text"
      },
      "format": "PLAIN_TEXT",
      "id": "text",
      "updatedAt": "text",
      "updatedBy": {
        "id": "user",
        "type": "text"
      }
    }
  ]
}