클라우드 계정

개요

상호 작용하려면 다음 API 작업을 사용하세요 AWS 클라우드 계정 를 Panther에서.

필수 권한

자체 호스팅 GET 작업을 수행하려면, API 토큰에 다음이 있어야 합니다 클라우드 보안 소스 보기 권한.
자체 호스팅 POST, PUT, 그리고 DELETE 작업을 수행하려면, API 토큰에 다음이 있어야 합니다 클라우드 보안 소스 관리 권한.

작업

create aws cloud account

post

Authorizations

X-API-KeystringRequired

Body

awsAccountIdstringRequired

The 12-digit AWS account ID

Pattern: ^[0-9]{12}$

integrationLabelstring · max: 36Required

The display name for the AWS Cloud Account integration

Pattern: ^[0-9a-zA-Z- ]+$

regionIgnoreListstring[]Optional

Regions to exclude from scanning

resourceRegexIgnoreListstring[]Optional

Regex patterns matching resource ARNs to exclude from scanning

resourceTypeIgnoreListstring[]Optional

Resource types to exclude from scanning (e.g. AWS.S3.Bucket)

Responses

201

Created response.

application/json

awsAccountIdstringOptional

The 12-digit AWS account ID (immutable)

integrationIdstringOptional

The unique ID of the AWS Cloud Account integration

integrationLabelstring · max: 36Optional

The display name for the AWS Cloud Account integration

Pattern: ^[0-9a-zA-Z- ]+$

regionIgnoreListstring[]Required

Regions to exclude from scanning

resourceRegexIgnoreListstring[]Required

Regex patterns matching resource ARNs to exclude from scanning

resourceTypeIgnoreListstring[]Required

Resource types to exclude from scanning (e.g. AWS.S3.Bucket)

400

bad_request: Bad Request response.

application/json

409

exists: Conflict response.

application/json

500

service: Internal Server Error response.

application/json

post/cloud-accounts/aws

POST /cloud-accounts/aws HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "awsAccountId": "text",
  "awsScanConfig": {
    "auditRole": "text"
  },
  "integrationLabel": "text",
  "regionIgnoreList": [
    "text"
  ],
  "resourceRegexIgnoreList": [
    "text"
  ],
  "resourceTypeIgnoreList": [
    "text"
  ]
}

{
  "awsAccountId": "text",
  "awsScanConfig": {
    "auditRole": "text"
  },
  "integrationId": "text",
  "integrationLabel": "text",
  "regionIgnoreList": [
    "text"
  ],
  "resourceRegexIgnoreList": [
    "text"
  ],
  "resourceTypeIgnoreList": [
    "text"
  ]
}

get aws cloud account

get

Authorizations

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the AWS Cloud Account to fetch

Responses

200

OK response.

application/json

awsAccountIdstringOptional

The 12-digit AWS account ID (immutable)

integrationIdstringOptional

The unique ID of the AWS Cloud Account integration

integrationLabelstring · max: 36Optional

The display name for the AWS Cloud Account integration

Pattern: ^[0-9a-zA-Z- ]+$

regionIgnoreListstring[]Required

Regions to exclude from scanning

resourceRegexIgnoreListstring[]Required

Regex patterns matching resource ARNs to exclude from scanning

resourceTypeIgnoreListstring[]Required

Resource types to exclude from scanning (e.g. AWS.S3.Bucket)

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/cloud-accounts/aws/{id}

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

{
  "awsAccountId": "text",
  "awsScanConfig": {
    "auditRole": "text"
  },
  "integrationId": "text",
  "integrationLabel": "text",
  "regionIgnoreList": [
    "text"
  ],
  "resourceRegexIgnoreList": [
    "text"
  ],
  "resourceTypeIgnoreList": [
    "text"
  ]
}

put aws cloud account

put

Authorizations

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the AWS Cloud Account to update

Body

integrationLabelstring · max: 36Required

The display name for the AWS Cloud Account integration

Pattern: ^[0-9a-zA-Z- ]+$

regionIgnoreListstring[]Optional

Regions to exclude from scanning

resourceRegexIgnoreListstring[]Optional

Regex patterns matching resource ARNs to exclude from scanning

resourceTypeIgnoreListstring[]Optional

Resource types to exclude from scanning (e.g. AWS.S3.Bucket)

Responses

200

OK response.

application/json

awsAccountIdstringOptional

The 12-digit AWS account ID (immutable)

integrationIdstringOptional

The unique ID of the AWS Cloud Account integration

integrationLabelstring · max: 36Optional

The display name for the AWS Cloud Account integration

Pattern: ^[0-9a-zA-Z- ]+$

regionIgnoreListstring[]Required

Regions to exclude from scanning

resourceRegexIgnoreListstring[]Required

Regex patterns matching resource ARNs to exclude from scanning

resourceTypeIgnoreListstring[]Required

Resource types to exclude from scanning (e.g. AWS.S3.Bucket)

400

bad_request: Bad Request response.

application/json

404

not_found: Not Found response.

application/json

500

service: Internal Server Error response.

application/json

put/cloud-accounts/aws/{id}

PUT /cloud-accounts/aws/{id} HTTP/1.1
Host: your-api-host
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 161

{
  "awsScanConfig": {
    "auditRole": "text"
  },
  "integrationLabel": "text",
  "regionIgnoreList": [
    "text"
  ],
  "resourceRegexIgnoreList": [
    "text"
  ],
  "resourceTypeIgnoreList": [
    "text"
  ]
}

{
  "awsAccountId": "text",
  "awsScanConfig": {
    "auditRole": "text"
  },
  "integrationId": "text",
  "integrationLabel": "text",
  "regionIgnoreList": [
    "text"
  ],
  "resourceRegexIgnoreList": [
    "text"
  ],
  "resourceTypeIgnoreList": [
    "text"
  ]
}

delete aws cloud account

delete

Authorizations

X-API-KeystringRequired

Path parameters

idstringRequired

ID of the AWS Cloud Account to delete

Responses

204

No Content response.

No content

400

bad_request: Bad Request response.

application/json

500

service: Internal Server Error response.

application/json

delete/cloud-accounts/aws/{id}

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

No content

이전API 토큰 다음상관 규칙

마지막 업데이트 2개월 전

도움이 되었나요?