Data Models
REST API operations for data models
Overview
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 theView Log Sources
permission.For
POST
,PUT
, andDELETE
operations, your API token must have theManage Log Sources
permission.
Operations
The python body of the data model
The description of the data model
The name used for the data model
enables/disables a data model
The id of the data model
The log type this data model should associate to. NOTE: only one data model can be assigned to a log type
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"
}
]
}
ID of the data model to fetch
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 creates or updates a data model
the id of the data model
The python body of the data model
The description of the data model
The name used for the data model
enables/disables a data model
The id of the data model
The log type this data model should associate to. NOTE: only one data model can be assigned to a log type
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"
}
]
}
ID of the data model to delete
DELETE /data-models/{id} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*
No content
the pagination token
the maximum results to return
100
GET /data-models HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*
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"
}
]
}
]
}
Last updated
Was this helpful?