데이터 모델

데이터 모델에 대한 REST API 작업

개요

이러한 API 작업을 사용하여 상호작용합니다 데이터 모델 Panther에서.

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

필수 권한

• 에 대해 GET 작업의 경우, API 토큰에는 로그 소스 보기 권한이 있어야 합니다.

• 에 대해 POST, PUT그리고 DELETE 작업의 경우, API 토큰에는 로그 소스 관리 권한이 있어야 합니다.

작업

create data model

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Body

application/json

bodystringOptional

The python body of the data model

descriptionstringOptional

The description of the data model

displayNamestringOptional

The name used for the data model

enabledbooleanOptional

enables/disables a data model

idstringRequired

The id of the data model

logTypesstring[]Optional

The log type this data model should associate to. NOTE: only one data model can be assigned to a log type

Responses

200

OK response.

application/json

400

bad_request: Bad Request response.

application/json

409

exists: Conflict response.

application/json

post

/data-models

HTTPcURLJavaScriptPython

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

{
  "body": "text",
  "description": "text",
  "displayName": "text",
  "enabled": true,
  "id": "text",
  "logTypes": [
    "text"
  ],
  "mappings": [
    {
      "method": "text",
      "name": "text",
      "path": "text"
    }
  ]
}

{
  "body": "text",
  "createdAt": "text",
  "description": "text",
  "displayName": "text",
  "enabled": true,
  "id": "text",
  "lastModified": "text",
  "logTypes": [
    "text"
  ],
  "mappings": [
    {
      "method": "text",
      "name": "text",
      "path": "text"
    }
  ]
}

get data model

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the data model to fetch

Responses

200

OK response.

application/json

404

not_found: Not Found response.

application/json

get

/data-models/{id}

HTTPcURLJavaScriptPython

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

{
  "body": "text",
  "createdAt": "text",
  "description": "text",
  "displayName": "text",
  "enabled": true,
  "id": "text",
  "lastModified": "text",
  "logTypes": [
    "text"
  ],
  "mappings": [
    {
      "method": "text",
      "name": "text",
      "path": "text"
    }
  ]
}

put data model

put

put creates or updates a data model

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

the id of the data model

Body

application/json

bodystringOptional

The python body of the data model

descriptionstringOptional

The description of the data model

displayNamestringOptional

The name used for the data model

enabledbooleanOptional

enables/disables a data model

idstringRequired

The id of the data model

logTypesstring[]Optional

The log type this data model should associate to. NOTE: only one data model can be assigned to a log type

Responses

200

200 returned if the item already existed

application/json

201

201 returned if the item was created

application/json

400

bad_request: Bad Request response.

application/json

put

/data-models/{id}

HTTPcURLJavaScriptPython

PUT /data-models/{id} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "body": "text",
  "description": "text",
  "displayName": "text",
  "enabled": true,
  "id": "text",
  "logTypes": [
    "text"
  ],
  "mappings": [
    {
      "method": "text",
      "name": "text",
      "path": "text"
    }
  ]
}

{
  "body": "text",
  "createdAt": "text",
  "description": "text",
  "displayName": "text",
  "enabled": true,
  "id": "text",
  "lastModified": "text",
  "logTypes": [
    "text"
  ],
  "mappings": [
    {
      "method": "text",
      "name": "text",
      "path": "text"
    }
  ]
}

delete data model

delete

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the data model to delete

Responses

204

No Content response.

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

delete

/data-models/{id}

HTTPcURLJavaScriptPython

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

No content

list data models

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

/data-models

HTTPcURLJavaScriptPython

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

200

OK response.

{
  "next": "text",
  "results": [
    {
      "body": "text",
      "createdAt": "text",
      "description": "text",
      "displayName": "text",
      "enabled": true,
      "id": "text",
      "lastModified": "text",
      "logTypes": [
        "text"
      ],
      "mappings": [
        {
          "method": "text",
          "name": "text",
          "path": "text"
        }
      ]
    }
  ]
}