Cloud Accounts

Overview

Use these API operations to interact with AWS Cloud Accounts in Panther.

Required permissions

• For GET operations, your API token must have the View Cloud Security Sources permission.

• For POST, PUT, and DELETE operations, your API token must have the Manage Cloud Security Sources permission.

Operations

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