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

POSThttps://your-api-host/data-models

Body

application/json

bodystring

The python body of the data model

descriptionstring

The description of the data model

displayNamestring

The name used for the data model

enabledboolean

enables/disables a data model

id*string

The id of the data model

logTypesarray of string

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

mappingsarray of DataModelAPI.DataModelMapping (object)

Response

200400409

OK response.

Body

application/json

bodystring

The python body of the data model

createdAtstring

descriptionstring

The description of the data model

displayNamestring

The name used for the data model

enabledboolean

enables/disables a data model

idstring

The id of the data model

lastModifiedstring

logTypesarray of string

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

mappingsarray of DataModelAPI.DataModelMapping (object)

Request

JavaScriptCurl

const response = await fetch('https://your-api-host/data-models', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text"
    }),
});
const data = await response.json();

Response

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

get data model

GEThttps://your-api-host/data-models/{id}

Path parameters

id*string

ID of the data model to fetch

Response

200404

OK response.

Body

application/json

DataModelAPI.DataModelcreateResponseBody (any)

Request

JavaScriptCurl

const response = await fetch('https://your-api-host/data-models/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

put data model

put creates or updates a data model

PUThttps://your-api-host/data-models/{id}

Path parameters

id*string

the id of the data model

Body

application/json

bodystring

The python body of the data model

descriptionstring

The description of the data model

displayNamestring

The name used for the data model

enabledboolean

enables/disables a data model

id*string

The id of the data model

logTypesarray of string

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

mappingsarray of DataModelAPI.DataModelMapping (object)

Response

200201400

200 returned if the item already existed

Body

application/json

DataModelAPI.DataModelcreateResponseBody (any)

Request

JavaScriptCurl

const response = await fetch('https://your-api-host/data-models/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text"
    }),
});
const data = await response.json();

delete data model

DELETEhttps://your-api-host/data-models/{id}

Path parameters

id*string

ID of the data model to delete

Response

204400404

No Content response.

Request

JavaScriptCurl

const response = await fetch('https://your-api-host/data-models/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

list data models

GEThttps://your-api-host/data-models

Query parameters

Response

200

OK response.

Body

application/json

nextstring

pagination token for the next page of results

resultsarray of DataModelAPI.DataModelcreateResponseBody (any)

Request

JavaScriptCurl

const response = await fetch('https://your-api-host/data-models', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "next": "text",
  "results": []
}