쿼리

저장된 및 예약된 쿼리에 대한 REST API 작업

개요

이러한 API 작업을 사용하여 상호작용합니다 저장된 및 예약된 검색 Panther에서.

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

API를 통해 관리되는 쿼리는 SQL로 작성되어야 합니다; 다음을 사용할 수 없습니다 PantherFlow.

필수 권한

• 에 대해 GET 작업의 경우, API 토큰에는 쿼리 데이터 레이크 권한이 있어야 합니다.

• 에 대해 POST, PUT그리고 DELETE 작업의 경우, API 토큰에는 저장된 검색 관리 권한이 있어야 합니다.

작업

create query

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Body

application/json

descriptionstringOptional

The description of the query

namestringRequired

The name of the query

sqlstringRequired

The raw sql of the query

Responses

200

OK response.

application/json

400

bad_request: Bad Request response.

application/json

409

exists: Conflict response.

application/json

post

/queries

HTTPcURLJavaScriptPython

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

{
  "description": "text",
  "emailConfig": {
    "preferAttachment": false,
    "recipients": [
      "text"
    ],
    "sendEmpty": false
  },
  "name": "text",
  "schedule": {
    "cron": "text",
    "disabled": true,
    "rateMinutes": 1,
    "timeoutMinutes": 1
  },
  "sql": "text"
}

{
  "createdAt": "text",
  "description": "text",
  "emailConfig": {
    "preferAttachment": false,
    "recipients": [
      "text"
    ],
    "sendEmpty": false
  },
  "id": "text",
  "managed": true,
  "name": "text",
  "schedule": {
    "cron": "text",
    "disabled": true,
    "rateMinutes": 1,
    "timeoutMinutes": 1
  },
  "sql": "text",
  "updatedAt": "text"
}

get query

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the query to fetch

Responses

200

OK response.

application/json

404

not_found: Not Found response.

application/json

get

/queries/{id}

HTTPcURLJavaScriptPython

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

{
  "createdAt": "text",
  "description": "text",
  "emailConfig": {
    "preferAttachment": false,
    "recipients": [
      "text"
    ],
    "sendEmpty": false
  },
  "id": "text",
  "managed": true,
  "name": "text",
  "schedule": {
    "cron": "text",
    "disabled": true,
    "rateMinutes": 1,
    "timeoutMinutes": 1
  },
  "sql": "text",
  "updatedAt": "text"
}

update query

post

updates a query

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

Body

application/json

descriptionstringOptional

The description of the query

namestringRequired

The name of the query

sqlstringRequired

The raw sql of the query

Responses

200

OK response.

application/json

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

post

/queries/{id}

HTTPcURLJavaScriptPython

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

{
  "description": "text",
  "emailConfig": {
    "preferAttachment": false,
    "recipients": [
      "text"
    ],
    "sendEmpty": false
  },
  "name": "text",
  "schedule": {
    "cron": "text",
    "disabled": true,
    "rateMinutes": 1,
    "timeoutMinutes": 1
  },
  "sql": "text"
}

{
  "createdAt": "text",
  "description": "text",
  "emailConfig": {
    "preferAttachment": false,
    "recipients": [
      "text"
    ],
    "sendEmpty": false
  },
  "id": "text",
  "managed": true,
  "name": "text",
  "schedule": {
    "cron": "text",
    "disabled": true,
    "rateMinutes": 1,
    "timeoutMinutes": 1
  },
  "sql": "text",
  "updatedAt": "text"
}

delete query

delete

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the query to delete

Responses

204

No Content response.

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

delete

/queries/{id}

HTTPcURLJavaScriptPython

DELETE /queries/{id} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*

No content

list queries

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Query parameters

cursorstringOptional

the pagination token

limitinteger · int64Optional

the maximum results to return

Default: 100

Responses

200

OK response.

application/json

get

/queries

HTTPcURLJavaScriptPython

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

200

OK response.

{
  "next": "text",
  "results": [
    {
      "createdAt": "text",
      "description": "text",
      "emailConfig": {
        "preferAttachment": false,
        "recipients": [
          "text"
        ],
        "sendEmpty": false
      },
      "id": "text",
      "managed": true,
      "name": "text",
      "schedule": {
        "cron": "text",
        "disabled": true,
        "rateMinutes": 1,
        "timeoutMinutes": 1
      },
      "sql": "text",
      "updatedAt": "text"
    }
  ]
}