Globals

REST API operations for globals

Overview

The /globals REST API operations are in open beta starting with Panther version 1.98, 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 global helper functions (also called "global helpers" and simply "globals") 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 Rules or View Policies permission.

• For POST, PUT, and DELETE operations, your API token must have the Manage Rules or Manage Policies permission.

Operations

create global

POSThttps://your-api-host/globals

Body

application/json

body*string

The python body of the global

descriptionstring

The description of the global

id*string

The id of the global

tagsarray of string

The tags for the global

Response

200400409

OK response.

Body

application/json

bodystring

The python body of the global

createdAtstring

descriptionstring

The description of the global

idstring

The id of the global

lastModifiedstring

tagsarray of string

The tags for the global

Request

JavaScriptCurlPython

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

Response

200400409

{
  "body": "text",
  "createdAt": "text",
  "description": "text",
  "id": "text",
  "lastModified": "text",
  "tags": [
    "text"
  ]
}

get global

GEThttps://your-api-host/globals/{id}

Path parameters

id*string

ID of the global to fetch

Response

200404

OK response.

Body

application/json

bodystring

The python body of the global

createdAtstring

descriptionstring

The description of the global

idstring

The id of the global

lastModifiedstring

tagsarray of string

The tags for the global

Request

JavaScriptCurlPython

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

Response

200404

{
  "body": "text",
  "createdAt": "text",
  "description": "text",
  "id": "text",
  "lastModified": "text",
  "tags": [
    "text"
  ]
}

put global

put creates or updates a global

PUThttps://your-api-host/globals/{id}

Path parameters

id*string

The id of the global

Body

application/json

body*string

The python body of the global

descriptionstring

The description of the global

tagsarray of string

The tags for the global

Response

200201400

200 returned if the item already existed

Body

application/json

dataGlobalAPI.Global (object)

Request

JavaScriptCurlPython

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

Response

200201400

{
  "data": {
    "body": "text",
    "createdAt": "text",
    "description": "text",
    "id": "text",
    "lastModified": "text",
    "tags": [
      "text"
    ]
  }
}

delete global

DELETEhttps://your-api-host/globals/{id}

Path parameters

id*string

ID of the global to delete

Response

204400404

No Content response.

Request

JavaScriptCurlPython

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

Response

400404

{
  "message": "text"
}

list globals

GEThttps://your-api-host/globals

Query parameters

Response

200

OK response.

Body

application/json

nextstring

pagination token for the next page of results

resultsarray of GlobalAPI.Global (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "next": "text",
  "results": [
    {
      "body": "text",
      "createdAt": "text",
      "description": "text",
      "id": "text",
      "lastModified": "text",
      "tags": [
        "text"
      ]
    }
  ]
}