GET
/
v1
/
tenant
/
alerts
List alerts in a tenant
curl --request GET \
  --url https://{region}.api.plerion.com/v1/tenant/alerts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "prn:assets:12345678-fd05-414f-a367-b1ea84d345f1:aws:s3:bucket:ap-southeast-2:bucket-acl",
      "tenantId": "42749bc1-c99b-4c2c-a081-a6cda9370081",
      "integrationId": "458511a1-9bc2-4fce-97a0-0e3139588e6e",
      "status": "OPEN",
      "flagged": false,
      "acknowledged": false,
      "workflowId": "451ba59f-8599-4bf4-81f6-618df7f79301",
      "title": "Asset with risk score greater than or equal to 9",
      "createdAt": "2023-02-04T06:07:09.092Z",
      "updatedAt": "2023-02-05T06:07:02.959Z",
      "summary": [
        "Publicly Exposed"
      ],
      "alertType": "ASSET",
      "riskScore": 6.38,
      "discoveredDate": 1677911631914,
      "lastScannedAtTimestamp": 1677911631914,
      "rulesChangedAtTimestamp": 1677911631914,
      "closedAtTimestamp": 1677911631914,
      "meta": {
        "region": "ap-southeast-2",
        "service": "AWS::EC2",
        "provider": "AWS",
        "resourceId": "https://ap-southeast-2.console.aws.amazon.com/ec2/home?region=ap-southeast-2#ImageDetails:imageId=ami-24234234234",
        "resourceName": "<string>",
        "resourceType": "AWS::EC2::AMI",
        "firstObservedAt": "2025-02-10T10:26:55.842Z",
        "providerAccountId": 123456789012
      }
    }
  ],
  "meta": {
    "cursor": "k3d83a9b-k3dk-5lkd-2ldk-9kd77c1beb6",
    "perPage": 10
  }
}

Authorizations

​
Authorization
string
header
required

Bearer API Key. For example, "Bearer {Tenant API Key}"

Headers

​
Authorization
string
required

Bearer API Key. For example, "Bearer {Tenant API Key}"

​
Content-Type
string

application/json

Query Parameters

​
ids
string

Filter alerts based on id of the alert [Plerion Resource Names (prn)]. Accepts a comma-separated list of ids.

Example:

"id1,id2"

​
workflowIds
string

Filter alerts based on Plerion Workflow IDs. Accepts a comma-separated list of workflow ids.

Example:

"workflow1,workflow2"

​
integrationIds
string

Filter alerts based on Plerion integration ids. Accepts a comma-separated list of integration ids.

Example:

"integration1,integration2"

​
assetGroupIds
string

Filter alerts based on asset group ids. Accepts a comma-separated list of asset group ids.

Example:

"assetGroupId1,assetGroupId2"

​
statuses
enum<string>

Filter alerts based on statuses. Accepts a comma-separated list of statuses.

Available options:
OPEN,
RESOLVED
Example:

"OPEN"

​
resourceTypes
string

Filter alerts based on provider resource types. Accepts a comma-separated list of resource types.

Example:

"AWS::S3::Bucket,AWS::Lambda::Function"

​
providers
enum<string>

Filter alerts based on provider. Accepts a comma-separated list of providers.

Available options:
AWS,
Azure,
GCP,
Kubernetes
Example:

"AWS,GCP"

​
alertTypes
enum<string>

Filter alerts based on alert type. Accepts a comma-separated list of type.

Available options:
ASSET,
FINDING
Example:

"ASSET"

​
flagged
string

Filter alerts based on flag status. Accepts a single value. The supported values are true or false.

Example:

false

​
acknowledged
string

Filter alerts based on acknowledge status. Accepts a single value. The supported values are true or false.

Example:

false

​
sortBy
enum<string>

Order the list by supported field

Available options:
riskScore,
discoveredDate
Example:

"riskScore"

​
sortOrder
enum<string>

The sort order of the list. The parameter sortBy has to be provided to use sortOrder. If sortOrder is not provided the default order is ASC.

Available options:
ASC,
DESC
Example:

"ASC"

​
cursor
string

Get the next batch of alerts. Used for pagination.

Example:

"k3d83a9b-k3dk-5lkd-2ldk-9kd77c1beb6"

​
perPage
number

Specify the batch size of the list. Used for pagination

Required range: x <= 1000
Example:

100

Response

200
application/json

Alerts list

The response is of type object.