Globals
REST API operations for globals
Overview
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 theView Rules
orView Policies
permission.For
POST
,PUT
, andDELETE
operations, your API token must have theManage Rules
orManage Policies
permission.
Operations
The python body of the global
The description of the global
The id of the global
The tags for the global
OK response.
bad_request: Bad Request response.
exists: Conflict response.
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"
]
}
ID of the global to fetch
OK response.
not_found: Not Found response.
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 creates or updates a global
The id of the global
The python body of the global
The description of the global
The tags for the global
200 returned if the item already existed
201 returned if the item was created
bad_request: Bad Request response.
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"
]
}
}
ID of the global to delete
No Content response.
bad_request: Bad Request response.
not_found: Not Found response.
DELETE /globals/{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
OK response.
GET /globals 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",
"id": "text",
"lastModified": "text",
"tags": [
"text"
]
}
]
}
Last updated
Was this helpful?