GCS 소스(Beta)

개요

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

이 API 작업을 사용하여 상호 작용하세요 Google Cloud Storage(GCS) 소스 Panther에서.

필수 권한

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

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

작업

get gcs source

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the GCS source to fetch

Responses

200

OK response.

application/json

credentialsstringOptional

The GCP credentials JSON content (service account key or WIF config). Required on create, optional on update.

credentialsTypestring · enumOptional

The type of credentials being used: service_account or wif (Workload Identity Federation).

Possible values:

gcsBucketstringOptional

The GCS bucket name

integrationIdstringOptional

The id of the GCS source

integrationLabelstringOptional

The integration label (name)

logStreamTypestring · enumOptional

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

Possible values:

projectIdstringOptional

The GCP project ID. Optional for service_account credentials. Required for WIF.

subscriptionIdstringOptional

The GCP Pub/Sub subscription ID used to receive GCS bucket notifications

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/gcs/{id}

HTTPcURLJavaScriptPython

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

{
  "credentials": "text",
  "credentialsType": "service_account",
  "gcsBucket": "text",
  "integrationId": "text",
  "integrationLabel": "text",
  "logStreamType": "Auto",
  "logStreamTypeOptions": {
    "jsonArrayEnvelopeField": "text",
    "xmlRootElement": "text"
  },
  "prefixLogTypes": [
    {
      "excludedPrefixes": [
        "text"
      ],
      "logTypes": [
        "text"
      ],
      "prefix": "text"
    }
  ],
  "projectId": "text",
  "subscriptionId": "text"
}

put gcs source

put

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the GCS source to update

Body

application/json

credentialsstringOptional

The GCP credentials JSON content (service account key or WIF config). Required on create, optional on update.

credentialsTypestring · enumRequired

The type of credentials being used: service_account or wif (Workload Identity Federation).

Possible values:

gcsBucketstringRequired

The GCS bucket name

integrationLabelstringRequired

The integration label (name)

logStreamTypestring · enumRequired

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

Possible values:

projectIdstringOptional

The GCP project ID. Optional for service_account credentials. Required for WIF.

subscriptionIdstringRequired

The GCP Pub/Sub subscription ID used to receive GCS bucket notifications

Responses

200

OK response.

application/json

credentialsstringOptional

The GCP credentials JSON content (service account key or WIF config). Required on create, optional on update.

credentialsTypestring · enumOptional

The type of credentials being used: service_account or wif (Workload Identity Federation).

Possible values:

gcsBucketstringOptional

The GCS bucket name

integrationIdstringOptional

The id of the GCS source

integrationLabelstringOptional

The integration label (name)

logStreamTypestring · enumOptional

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

Possible values:

projectIdstringOptional

The GCP project ID. Optional for service_account credentials. Required for WIF.

subscriptionIdstringOptional

The GCP Pub/Sub subscription ID used to receive GCS bucket notifications

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/gcs/{id}

HTTPcURLJavaScriptPython

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

{
  "credentials": "text",
  "credentialsType": "service_account",
  "gcsBucket": "text",
  "integrationLabel": "text",
  "logStreamType": "Auto",
  "logStreamTypeOptions": {
    "jsonArrayEnvelopeField": "text",
    "xmlRootElement": "text"
  },
  "prefixLogTypes": [
    {
      "excludedPrefixes": [
        "text"
      ],
      "logTypes": [
        "text"
      ],
      "prefix": "text"
    }
  ],
  "projectId": "text",
  "subscriptionId": "text"
}

{
  "credentials": "text",
  "credentialsType": "service_account",
  "gcsBucket": "text",
  "integrationId": "text",
  "integrationLabel": "text",
  "logStreamType": "Auto",
  "logStreamTypeOptions": {
    "jsonArrayEnvelopeField": "text",
    "xmlRootElement": "text"
  },
  "prefixLogTypes": [
    {
      "excludedPrefixes": [
        "text"
      ],
      "logTypes": [
        "text"
      ],
      "prefix": "text"
    }
  ],
  "projectId": "text",
  "subscriptionId": "text"
}

create gcs source

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Body

application/json

credentialsstringOptional

The GCP credentials JSON content (service account key or WIF config). Required on create, optional on update.

credentialsTypestring · enumRequired

The type of credentials being used: service_account or wif (Workload Identity Federation).

Possible values:

gcsBucketstringRequired

The GCS bucket name

integrationLabelstringRequired

The integration label (name)

logStreamTypestring · enumRequired

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

Possible values:

projectIdstringOptional

The GCP project ID. Optional for service_account credentials. Required for WIF.

subscriptionIdstringRequired

The GCP Pub/Sub subscription ID used to receive GCS bucket notifications

Responses

201

Created response.

application/json

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/gcs

HTTPcURLJavaScriptPython

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

{
  "credentials": "text",
  "credentialsType": "service_account",
  "gcsBucket": "text",
  "integrationLabel": "text",
  "logStreamType": "Auto",
  "logStreamTypeOptions": {
    "jsonArrayEnvelopeField": "text",
    "xmlRootElement": "text"
  },
  "prefixLogTypes": [
    {
      "excludedPrefixes": [
        "text"
      ],
      "logTypes": [
        "text"
      ],
      "prefix": "text"
    }
  ],
  "projectId": "text",
  "subscriptionId": "text"
}

{
  "credentials": "text",
  "credentialsType": "service_account",
  "gcsBucket": "text",
  "integrationId": "text",
  "integrationLabel": "text",
  "logStreamType": "Auto",
  "logStreamTypeOptions": {
    "jsonArrayEnvelopeField": "text",
    "xmlRootElement": "text"
  },
  "prefixLogTypes": [
    {
      "excludedPrefixes": [
        "text"
      ],
      "logTypes": [
        "text"
      ],
      "prefix": "text"
    }
  ],
  "projectId": "text",
  "subscriptionId": "text"
}

delete gcs source

delete

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the GCS 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/gcs/{id}

HTTPcURLJavaScriptPython

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

No content