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

/globals

Authorizations

Body

bodystringrequired

The python body of the global

descriptionstring

The description of the global

idstringrequired

The id of the global

tagsstring[]

The tags for the global

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-api-host/globals' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"body":"text","id":"text","tags":[null]}'

200

400

409

200

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

OK response.

get global

get

/globals/{id}

Authorizations

Path parameters

idstringrequired

ID of the global to fetch

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

200

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

OK response.

put global

put creates or updates a global

put

/globals/{id}

Authorizations

Path parameters

idstringrequired

The id of the global

Body

bodystringrequired

The python body of the global

descriptionstring

The description of the global

tagsstring[]

The tags for the global

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://your-api-host/globals/{id}' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"body":"text","tags":[null]}'

200

201

400

200

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

200 returned if the item already existed

delete global

delete

/globals/{id}

Authorizations

Path parameters

idstringrequired

ID of the global to delete

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

204

400

404

204

No body

No Content response.

list globals

get

/globals

Authorizations

Query parameters

cursorstring

the pagination token

limitinteger · int64 · default: 100

the maximum results to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

OK response.