Data Models

REST API operations for data models

Overview

The /data-models REST API operations are in open beta starting with Panther version 1.101, and are available to all customers. Please share any bug reports and feature requests with your Panther support team.

Use these API operations to interact with Data Models in Panther.

To call the API, see the How to use the Panther REST API instructions—including directions for how to invoke it directly from this documentation page.

Required permissions

• For GET operations, your API token must have the View Log Sources permission.

• For POST, PUT, and DELETE operations, your API token must have the Manage Log Sources permission.

Operations

create data model

post

Authorizations

Body

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

mappingsobject[]optional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-api-host/data-models' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "body": "text",
    "description": "text",
    "displayName": "text",
    "enabled": true,
    "id": "text",
    "logTypes": [
      "text"
    ],
    "mappings": [
      {
        "method": "text",
        "name": "text",
        "path": "text"
      }
    ]
  }'

200

400

409

200

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

OK response.

get data model

get

Authorizations

Path parameters

idstringrequired

ID of the data model to fetch

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-api-host/data-models/{id}' \
  --header 'X-API-Key: YOUR_API_KEY'

200

404

200

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

OK response.

put data model

put

put creates or updates a data model

Authorizations

Path parameters

idstringrequired

the id of the data model

Body

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

mappingsobject[]optional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://your-api-host/data-models/{id}' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "body": "text",
    "description": "text",
    "displayName": "text",
    "enabled": true,
    "id": "text",
    "logTypes": [
      "text"
    ],
    "mappings": [
      {
        "method": "text",
        "name": "text",
        "path": "text"
      }
    ]
  }'

200

201

400

200

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

200 returned if the item already existed

delete data model

delete

Authorizations

Path parameters

idstringrequired

ID of the data model to delete

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://your-api-host/data-models/{id}' \
  --header 'X-API-Key: YOUR_API_KEY'

204

400

404

204

No body

No Content response.

list data models

get

Authorizations

Query parameters

cursorstringoptional

the pagination token

limitinteger · int64 · default: 100optional

the maximum results to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-api-host/data-models' \
  --header 'X-API-Key: YOUR_API_KEY'

200

200

{
  "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"
        }
      ]
    }
  ]
}

OK response.