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

post

Authorizations

Body

bodystringRequired

The python body of the global

descriptionstringOptional

The description of the global

idstringRequired

The id of the global

tagsstring[]Optional

The tags for the global

Responses

application/json

objectOptional

application/json

application/json

post

HTTPcURLJavaScriptPython

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

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

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

get global

get

Authorizations

Path parameters

idstringRequired

ID of the global to fetch

Responses

application/json

objectOptional

application/json

get

HTTPcURLJavaScriptPython

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

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

put global

put

put creates or updates a global

Authorizations

Path parameters

idstringRequired

The id of the global

Body

bodystringRequired

The python body of the global

descriptionstringOptional

The description of the global

tagsstring[]Optional

The tags for the global

Responses

application/json

objectOptional

application/json

application/json

put

HTTPcURLJavaScriptPython

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

{
  "body": "text",
  "description": "text",
  "tags": [
    "text"
  ]
}

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

delete global

delete

Authorizations

Path parameters

idstringRequired

ID of the global to delete

Responses

application/json

application/json

delete

HTTPcURLJavaScriptPython

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

No content

list globals

get

Authorizations

Query parameters

cursorstringOptional

the pagination token

limitinteger · int64Optional

the maximum results to return

Default: 100

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /globals 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",
      "id": "text",
      "lastModified": "text",
      "tags": [
        "text"
      ]
    }
  ]
}