API 토큰

API 토큰에 대한 REST API 작업

개요

를 입력하세요 /api-tokens REST API 작업은 Panther 버전 1.112부터 오픈 베타 상태이며 모든 고객이 사용할 수 있습니다. 버그 보고 및 기능 요청은 Panther 지원 팀과 공유해 주세요.

다음과 상호작용하려면 이 API 작업을 사용하세요 API 토큰 Panther에서. API 토큰은 자체적으로 다음을 사용하여 교체할 수 있습니다 POST api-tokens/self/rotate 엔드포인트.

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

필수 권한

• 다음에 대해 GET 작업을 수행하려면 API 토큰에 다음 권한이 있어야 합니다 API 토큰 정보 읽기 권한을 선택하세요.

• 다음에 대해 POST 및 DELETE 작업을 수행하려면 API 토큰에 다음 권한이 있어야 합니다 API 토큰 관리 권한을 선택하세요.

작업

Create an api token

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Body

application/json

allowedCIDRBlocksstring[]Optional

The set of CIDR blocks that are allowed to use this API token. If empty, all CIDR blocks are allowed

namestringRequired

The name of the token

Responses

200

OK response.

application/json

400

bad_request: Bad Request response.

application/json

post

/api-tokens

HTTPcURLJavaScriptPython

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

{
  "allowedCIDRBlocks": [
    "text"
  ],
  "name": "text",
  "permissions": [
    "AlertModify"
  ]
}

{
  "allowedCIDRBlocks": [
    "text"
  ],
  "createdAt": "text",
  "createdBy": {
    "id": "user",
    "type": "text"
  },
  "expiresAt": "text",
  "id": "text",
  "lastUsedAt": "text",
  "name": "text",
  "permissions": [
    "AlertModify"
  ],
  "rotatedAt": "text",
  "updatedAt": "text",
  "updatedBy": {
    "id": "user",
    "type": "text"
  },
  "value": "text"
}

Get an api token

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the api token. Note: if self is provided, the current api token will be returned

Responses

200

OK response.

application/json

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

get

/api-tokens/{id}

HTTPcURLJavaScriptPython

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

{
  "allowedCIDRBlocks": [
    "text"
  ],
  "createdAt": "text",
  "createdBy": {
    "id": "user",
    "type": "text"
  },
  "expiresAt": "text",
  "id": "text",
  "lastUsedAt": "text",
  "name": "text",
  "permissions": [
    "AlertModify"
  ],
  "rotatedAt": "text",
  "updatedAt": "text",
  "updatedBy": {
    "id": "user",
    "type": "text"
  },
  "value": "text"
}

Update an api token

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the api token. Note: if self is provided, the current api token will be updated

Body

application/json

allowedCIDRBlocksstring[]Optional

The set of CIDR blocks that are allowed to use this API token. If empty, all CIDR blocks are allowed

namestringRequired

The name of the token

Responses

200

OK response.

application/json

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

post

/api-tokens/{id}

HTTPcURLJavaScriptPython

POST /api-tokens/{id} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "allowedCIDRBlocks": [
    "text"
  ],
  "name": "text",
  "permissions": [
    "AlertModify"
  ]
}

{
  "allowedCIDRBlocks": [
    "text"
  ],
  "createdAt": "text",
  "createdBy": {
    "id": "user",
    "type": "text"
  },
  "expiresAt": "text",
  "id": "text",
  "lastUsedAt": "text",
  "name": "text",
  "permissions": [
    "AlertModify"
  ],
  "rotatedAt": "text",
  "updatedAt": "text",
  "updatedBy": {
    "id": "user",
    "type": "text"
  },
  "value": "text"
}

delete api token

delete

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the api token to delete. Note: if self is provided, the current api token will be deleted

Responses

204

No Content response.

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

delete

/api-tokens/{id}

HTTPcURLJavaScriptPython

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

No content

List api tokens

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Responses

200

OK response.

application/json

get

/api-tokens

HTTPcURLJavaScriptPython

GET /api-tokens HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*

200

OK response.

{
  "next": "text",
  "results": [
    {
      "allowedCIDRBlocks": [
        "text"
      ],
      "createdAt": "text",
      "createdBy": {
        "id": "user",
        "type": "text"
      },
      "expiresAt": "text",
      "id": "text",
      "lastUsedAt": "text",
      "name": "text",
      "permissions": [
        "AlertModify"
      ],
      "rotatedAt": "text",
      "updatedAt": "text",
      "updatedBy": {
        "id": "user",
        "type": "text"
      },
      "value": "text"
    }
  ]
}

Rotate an api token. If self is provided the current token will be rotated

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the api token to rotate. Note: if self is provided, the current api token will be rotated

Responses

200

OK response.

application/json

400

bad_request: Bad Request response.

application/json

403

forbidden: Forbidden response.

application/json

404

not_found: Not Found response.

application/json

post

/api-tokens/{id}/rotate

HTTPcURLJavaScriptPython

POST /api-tokens/{id}/rotate HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "allowedCIDRBlocks": [
    "text"
  ],
  "createdAt": "text",
  "createdBy": {
    "id": "user",
    "type": "text"
  },
  "expiresAt": "text",
  "id": "text",
  "lastUsedAt": "text",
  "name": "text",
  "permissions": [
    "AlertModify"
  ],
  "rotatedAt": "text",
  "updatedAt": "text",
  "updatedBy": {
    "id": "user",
    "type": "text"
  },
  "value": "text"
}