S3 소스(Beta)

개요

S3 Sources API 엔드포인트는 Panther 버전 1.122부터 오픈 베타로 제공되며, 모든 고객이 사용할 수 있습니다. 버그 신고 및 기능 요청은 Panther 지원 팀과 공유해 주세요.

이 API 작업을 사용하여 S3 소스 와 Panther에서 상호작용하세요.

필수 권한

• ~의 경우 GET 작업의 경우, API 토큰에 다음 권한이 있어야 합니다. 로그 소스 보기 권한.

• ~의 경우 POST, PUT, 그리고 DELETE 작업의 경우, API 토큰에 다음 권한이 있어야 합니다. 로그 소스 관리 권한.

create s3 source

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Body

application/json

awsAccountIdstringRequired

The 12-digit AWS account ID where the S3 bucket resides

integrationLabelstringRequired

The integration label (name)

kmsKeystringOptional

KMS key ARN for server-side encryption. Omit if the bucket is not KMS-encrypted.

logProcessingRolestringRequired

The IAM role ARN that Panther assumes to read from the S3 bucket

logStreamTypestring · enumRequired

The log stream type. Supported: Auto, JSON, JsonArray, Lines, XML, CloudWatchLogs

Possible values:

managedBucketNotificationsbooleanRequired

Whether Panther should configure the S3 bucket notifications automatically

s3BucketstringRequired

The S3 bucket name

Responses

201

Created response.

application/json

awsAccountIdstringOptional

The AWS account ID where the S3 bucket resides

integrationIdstringOptional

The unique ID of the S3 log source

integrationLabelstringOptional

The integration label (name)

kmsKeystringOptional

KMS key ARN for server-side encryption. Omit if the bucket is not KMS-encrypted.

logProcessingRolestringOptional

The IAM role ARN that Panther assumes to read from the S3 bucket

logStreamTypestring · enumOptional

The log stream type. Supported: Auto, JSON, JsonArray, Lines, XML, CloudWatchLogs

Possible values:

managedBucketNotificationsbooleanOptional

Whether Panther should configure the S3 bucket notifications automatically

s3BucketstringOptional

The S3 bucket name

400

bad_request: Bad Request response.

application/json

409

exists: Conflict response.

application/json

500

service: Internal Server Error response.

application/json

post

/log-sources/s3

HTTPcURLJavaScriptPython

POST /log-sources/s3 HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 363

{
  "awsAccountId": "text",
  "integrationLabel": "text",
  "kmsKey": "text",
  "logProcessingRole": "text",
  "logStreamType": "Auto",
  "logStreamTypeOptions": {
    "jsonArrayEnvelopeField": "text",
    "retainEnvelopeFields": true,
    "xmlRootElement": "text"
  },
  "managedBucketNotifications": true,
  "s3Bucket": "text",
  "s3PrefixLogTypes": [
    {
      "excludedPrefixes": [
        "text"
      ],
      "logTypes": [
        "text"
      ],
      "prefix": "text"
    }
  ]
}

{
  "awsAccountId": "text",
  "integrationId": "text",
  "integrationLabel": "text",
  "kmsKey": "text",
  "logProcessingRole": "text",
  "logStreamType": "Auto",
  "logStreamTypeOptions": {
    "jsonArrayEnvelopeField": "text",
    "retainEnvelopeFields": true,
    "xmlRootElement": "text"
  },
  "managedBucketNotifications": true,
  "s3Bucket": "text",
  "s3PrefixLogTypes": [
    {
      "excludedPrefixes": [
        "text"
      ],
      "logTypes": [
        "text"
      ],
      "prefix": "text"
    }
  ]
}

get s3 source

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the S3 source to fetch

Responses

200

OK response.

application/json

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

500

service: Internal Server Error response.

application/json

get

/log-sources/s3/{id}

HTTPcURLJavaScriptPython

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

{
  "awsAccountId": "text",
  "integrationId": "text",
  "integrationLabel": "text",
  "kmsKey": "text",
  "logProcessingRole": "text",
  "logStreamType": "Auto",
  "logStreamTypeOptions": {
    "jsonArrayEnvelopeField": "text",
    "retainEnvelopeFields": true,
    "xmlRootElement": "text"
  },
  "managedBucketNotifications": true,
  "s3Bucket": "text",
  "s3PrefixLogTypes": [
    {
      "excludedPrefixes": [
        "text"
      ],
      "logTypes": [
        "text"
      ],
      "prefix": "text"
    }
  ]
}

put s3 source

put

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the S3 source to update

Body

application/json

integrationLabelstringRequired

The integration label (name)

kmsKeystringOptional

KMS key ARN for server-side encryption. Omit if the bucket is not KMS-encrypted.

logProcessingRolestringRequired

The IAM role ARN that Panther assumes to read from the S3 bucket

logStreamTypestring · enumRequired

The log stream type. Supported: Auto, JSON, JsonArray, Lines, XML, CloudWatchLogs

Possible values:

managedBucketNotificationsbooleanRequired

Whether Panther should configure the S3 bucket notifications automatically

Responses

200

OK response.

application/json

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

409

exists: Conflict response.

application/json

500

service: Internal Server Error response.

application/json

put

/log-sources/s3/{id}

HTTPcURLJavaScriptPython

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

{
  "integrationLabel": "text",
  "kmsKey": "text",
  "logProcessingRole": "text",
  "logStreamType": "Auto",
  "logStreamTypeOptions": {
    "jsonArrayEnvelopeField": "text",
    "retainEnvelopeFields": true,
    "xmlRootElement": "text"
  },
  "managedBucketNotifications": true,
  "s3PrefixLogTypes": [
    {
      "excludedPrefixes": [
        "text"
      ],
      "logTypes": [
        "text"
      ],
      "prefix": "text"
    }
  ]
}

{
  "awsAccountId": "text",
  "integrationId": "text",
  "integrationLabel": "text",
  "kmsKey": "text",
  "logProcessingRole": "text",
  "logStreamType": "Auto",
  "logStreamTypeOptions": {
    "jsonArrayEnvelopeField": "text",
    "retainEnvelopeFields": true,
    "xmlRootElement": "text"
  },
  "managedBucketNotifications": true,
  "s3Bucket": "text",
  "s3PrefixLogTypes": [
    {
      "excludedPrefixes": [
        "text"
      ],
      "logTypes": [
        "text"
      ],
      "prefix": "text"
    }
  ]
}

delete s3 source

delete

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the S3 source to delete

Responses

204

No Content response.

400

bad_request: Bad Request response.

application/json

500

service: Internal Server Error response.

application/json

delete

/log-sources/s3/{id}

HTTPcURLJavaScriptPython

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

No content