글로벌

글로벌에 대한 REST API 작업

개요

다음 API 작업을 사용하여 전역 헬퍼 함수 Panther에서 ("전역 헬퍼"라고도 하며 간단히 "글로벌"이라고도 함).

API를 호출하려면 다음을 참조하세요. Panther REST API를 사용하는 방법 안내— 이 문서 페이지에서 직접 호출하는 방법에 대한 지침 포함.

필수 권한

• 에 대해 GET 작업을 수행하려면 API 토큰에 규칙 보기 또는 정책 보기 권한이 있어야 합니다.

• 에 대해 POST, PUT, 그리고 DELETE 작업을 수행하려면 API 토큰에 규칙 관리 또는 정책 관리 권한이 있어야 합니다.

작업

create global

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Body

application/json

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

200

OK response.

application/json

bodystringOptional

The python body of the global

createdAtstringOptional

descriptionstringOptional

The description of the global

idstringOptional

The id of the global

lastModifiedstringOptional

tagsstring[]Optional

The tags for the global

400

bad_request: Bad Request response.

application/json

409

exists: Conflict response.

application/json

post

/globals

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

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the global to fetch

Responses

200

OK response.

application/json

bodystringOptional

The python body of the global

createdAtstringOptional

descriptionstringOptional

The description of the global

idstringOptional

The id of the global

lastModifiedstringOptional

tagsstring[]Optional

The tags for the global

404

not_found: Not Found response.

application/json

get

/globals/{id}

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

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

The id of the global

Body

application/json

bodystringRequired

The python body of the global

descriptionstringOptional

The description of the global

tagsstring[]Optional

The tags for the global

Responses

200

200 returned if the item already existed

application/json

201

201 returned if the item was created

application/json

400

bad_request: Bad Request response.

application/json

put

/globals/{id}

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

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the global to delete

Responses

204

No Content response.

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

delete

/globals/{id}

HTTPcURLJavaScriptPython

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

No content

list globals

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Query parameters

cursorstringOptional

the pagination token

limitinteger · int64Optional

the maximum results to return

Default: 100

name-containsstringOptional

Substring search by name (case-insensitive)

created-bystringOptional

Only include rules whose creator matches this user ID or actor ID

last-modified-bystringOptional

Only include rules last modified by this user ID or actor ID

Responses

200

OK response.

application/json

nextstringOptional

pagination token for the next page of results

get

/globals

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"
      ]
    }
  ]
}