알러트 컨텍스트 태그

알러트 컨텍스트 태그에 대한 REST API 작업

개요

다음 API 작업을 사용하여 상호작용하세요 알러트 컨텍스트 태그 Panther에서.

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

필수 권한

• 에 대해 GET 작업의 경우, API 토큰에는 알러트 읽기 권한이 있어야 합니다.

• 에 대해 POST, DELETE및 PATCH 작업의 경우, API 토큰에는 알러트 관리 권한이 있어야 합니다.

작업

List all context tags

get

Returns all context tags, both managed (system-defined) and custom (user-defined)

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Query parameters

cursorstringOptional

Pagination token from a previous request

limitinteger · int64 · min: 1 · max: 2000Optional

Maximum number of results to return

Default: 2000

managedbooleanOptional

Filter by tag type: true for managed tags only, false for custom tags only, omit for all tags

Responses

200

OK response.

application/json

Response for listing context tags

nextstringOptional

Pagination token for the next page of results

400

bad_request: Bad Request response.

application/json

get

/alert-context-tags

HTTPcURLJavaScriptPython

GET /alert-context-tags HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "next": "text",
  "results": [
    {
      "category": "text",
      "managed": true,
      "tag": "text"
    }
  ]
}

Create a custom context tag

post

Creates a new custom context tag. Returns 409 Conflict if the tag already exists.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Body

application/json

Request to create a custom context tag

tagstring · min: 1 · max: 30Required

The tag value to create

Pattern: ^[a-z0-9_-]+$

Responses

201

Created response.

400

bad_request: Bad Request response.

application/json

409

exists: Conflict response.

application/json

post

/alert-context-tags

HTTPcURLJavaScriptPython

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

{
  "tag": "text"
}

No content

Delete a custom context tag

delete

Deletes a custom context tag. Managed tags cannot be deleted.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

tagstring · min: 1 · max: 30Required

The tag value to delete

Pattern: ^[a-z0-9_-]+$

Responses

204

No Content response.

400

bad_request: Bad Request response.

application/json

delete

/alert-context-tags/{tag}

HTTPcURLJavaScriptPython

DELETE /alert-context-tags/{tag} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Rename a custom context tag

patch

Atomically renames a custom context tag. Returns 404 if the tag doesn't exist, 409 if the target tag already exists.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

tagstring · min: 1 · max: 30Required

The current tag value to rename

Pattern: ^[a-z0-9_-]+$

Body

application/json

Request to rename a custom context tag

tagstring · min: 1 · max: 30Required

The new tag value

Pattern: ^[a-z0-9_-]+$

Responses

204

No Content response.

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

409

exists: Conflict response.

application/json

patch

/alert-context-tags/{tag}

HTTPcURLJavaScriptPython

PATCH /alert-context-tags/{tag} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "tag": "text"
}

No content