https://{region}.api.plerion.com
servers:
- url: https://{region}.api.plerion.com
description: Production API server - Select your preferred region
variables:
region:
default: au
enum:
- au
- sg1
- in1
- us1
security: []
tags:
- name: QUICK_START
x-displayName: Quick Start
description: >-
This section describes how to quickly get started with the Plerion API
using curl. For a more detailed guide, see the sections below.
1. Install curl if it isn't already installed on your machine. To check if
curl is installed, execute curl --version in the command
line. If the output is information about the version of curl, it is
installed. If you get a message similar to command not found:
curl, you need to download and install curl. For more
information, see the curl project
download page.
2. Create a Tenant API key accessing Tenant API Keys Dashboard. Warning: Treat your API key like a password. Do not store it as plain text or expose it in any code base.
3. Use the curl command to make your request. Pass your API
key in an Authorization header. Replace {PLERION_API_KEY}
with your API key.
export PLERION_API_URL=au.api.plerion.com
export PLERION_API_KEY={PLERION_API_KEY}
curl --request GET \\
--url "https://$PLERION_API_URL/v1/tenant/findings" \\
--header "Authorization: Bearer $PLERION_API_KEY"
- name: Overview
x-displayName: Overview
description: >-
Plerion API uses API keys to authenticate requests. You can view and
manage your API keys in the Plerion app Tenant API Keys Dashboard.
API responses are JSON-encoded.
To authenticate to Plerion API send the API Key using bearer auth in the Authorization header
Authorization: Bearer $PLERION_API_KEY
All API requests must be made over HTTPS. Calls made over plain HTTP will
fail. API requests without authentication will also fail.
Plerion uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted). Codes in the 5xx range indicate an error with Plerion's servers. Some 4xx errors that could be handled programmatically include an error code that briefly explains the error reported. Detailed description for the status code can be found in th Response Status Codes section.
| Status Code | Definition | Description |
|---|---|---|
| 200 | OK | The request has succeeded. |
| 201 | Created | The request has been fulfilled and resulted in a new resource being created. |
| 204 | No Content | The server has fulfilled the request but does not need to return an entity-body. |
| 400 | Bad Request | The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. |
| 401 | Unauthorized | The request requires user authentication. If the request already included Authorization credentials, then the 401 response indicates that authorization has been refused for those credentials. |
| 403 | Forbidden | The server understood the request, but is refusing to fulfill it. Authorization will not fix the issue and the request SHOULD NOT be repeated. |
| 404 | Not Found | The server has not found anything matching the Request-URI. |
| 405 | Method Not Allowed | The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. |
| 409 | Conflict | The request could not be completed due to a conflict with the current state of the resource. |
| 429 | Too Many Requests | Too many requests occurred during the allotted time period and rate limiting was applied. |
| 500 | Internal Server Error | The request did not complete due to an internal error on the server side. The server encountered an unexpected condition which prevented it from fulfilling the request. |
| 503 | Service Unavailable | The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. |
588158338731au.api.plerion.comcurl command.
export PLERION_API_URL=au.api.plerion.com
export PLERION_API_KEY={$PLERION_API_KEY}
export PLERION_AWS_ACCOUNT_ID=588158338731
# Fetch the template URL
export TEMPLATE_URL=$(curl -s GET "https://$PLERION_API_URL/v1/tenant/cloudformation-templates?type=AWSAccount" -H "Authorization: Bearer $PLERION_API_KEY" | jq -r '.data.templateURL')
# Generate the temporary auth token
export TEMP_AUTH_TOKEN=$(curl -s -X POST "https://$PLERION_API_URL/v1/tenant/integrations/token" -H "Authorization: Bearer $PLERION_API_KEY" | jq -r '.data.token')
# Fetch the external ID
export EXTERNAL_ID=$(curl -s -X GET "https://$PLERION_API_URL/v1/tenant/external-id" -H "Authorization: Bearer $PLERION_API_KEY" | jq -r '.data.externalId')
# Create the stack
export PLERION_STACK_NAME=plerion-aws-integration
aws cloudformation create-stack --stack-name $PLERION_STACK_NAME --template-url $TEMPLATE_URL --capabilities CAPABILITY_NAMED_IAM \
--parameters ParameterKey=ExternalId,ParameterValue=$EXTERNAL_ID \
ParameterKey=PlerionAccountId,ParameterValue=$PLERION_AWS_ACCOUNT_ID \
ParameterKey=AuthToken,ParameterValue=$TEMP_AUTH_TOKEN \
ParameterKey=Capabilities,ParameterValue=ALL \
ParameterKey=KMSKeyAccessMode,ParameterValue="ALL_KEYS" \
ParameterKey=PlerionURL,ParameterValue=$PLERION_API_URL
# Wait for the stack to complete
aws cloudformation wait stack-create-complete --stack-name $PLERION_STACK_NAME
export PLERION_API_URL=au.api.plerion.com
export PLERION_API_KEY={$PLERION_API_KEY}
export PLERION_AWS_ACCOUNT_ID=588158338731
# Fetch the template URL
export TEMPLATE_URL=$(curl -s GET "https://$PLERION_API_URL/v1/tenant/cloudformation-templates?type=AWSAccount" -H "Authorization: Bearer $PLERION_API_KEY" | jq -r '.data.templateURL')
# Generate the temporary auth token
export TEMP_AUTH_TOKEN=$(curl -s -X POST "https://$PLERION_API_URL/v1/tenant/integrations/token" -H "Authorization: Bearer $PLERION_API_KEY" | jq -r '.data.token')
# Fetch the external ID
export EXTERNAL_ID=$(curl -s -X GET "https://$PLERION_API_URL/v1/tenant/external-id" -H "Authorization: Bearer $PLERION_API_KEY" | jq -r '.data.externalId')
# Update an existing stack
export PLERION_STACK_NAME=plerion-aws-integration
aws cloudformation update-stack --stack-name $PLERION_STACK_NAME --template-url $TEMPLATE_URL --capabilities CAPABILITY_NAMED_IAM \
--parameters ParameterKey=ExternalId,ParameterValue=$EXTERNAL_ID \
ParameterKey=PlerionAccountId,ParameterValue=$PLERION_AWS_ACCOUNT_ID \
ParameterKey=AuthToken,ParameterValue=$TEMP_AUTH_TOKEN \
ParameterKey=Capabilities,ParameterValue=ALL \
ParameterKey=KMSKeyAccessMode,ParameterValue="ALL_KEYS" \
ParameterKey=PlerionURL,ParameterValue=$PLERION_API_URL
# Wait for the stack to complete
aws cloudformation wait stack-update-complete --stack-name $PLERION_STACK_NAME
- name: Compliance frameworks
x-displayName: Compliance Frameworks
description: >-
Compliance Frameworks help our customers meet their regulatory and
compliance obligations, and reduce compliance risk, enabling them to
achieve their strategic objectives.
Plerion offers customers hundreds of prebuilt detections delivering
continuous assurance against industry standards and best practices.
- name: Well-Architected frameworks
x-displayName: Well-Architected Frameworks
description: >-
The AWS Well-Architected Framework helps customers design secure,
high-performing, resilient, and efficient cloud infrastructure. Plerion
continuously assesses your environment against the AWS Well-Architected
pillars, aligning your architecture with AWS best practices and
accelerating improvement.
- name: Tenant usage
x-displayName: Tenant Usage
description: Plerion Usage information for the Tenant
- name: Audit logs
x-displayName: Audit Logs
description: >-
Audit logs provide a comprehensive trail of user activities and system
operations within a tenant.
These logs capture important events such as user logins, API calls,
configuration changes, and other security-relevant activities. Audit logs
help with compliance, security monitoring, and troubleshooting.
paths:
/v1/tenant/findings:
get:
tags:
- Findings
summary: List
description: >-
Use the list findings API to filter findings across the tenant with many
options from Provider, Service, Detection, Severity, Integration, etc.
By
default all `PASSED` and `FAILED` findings are returned. To list
only failed findings filter by `statuses=FAILED`
Date range filtering is supported using the `firstObservedAtStart` and
`firstObservedAtEnd` parameters:
- `firstObservedAtStart` alone: Includes findings with a first observed
time from the specified date to the present.
- `firstObservedAtEnd` alone: Includes findings with a first observed
time up to the specified date.
- Both provided: Includes findings with a first observed time within the
specified date range.
Date strings must follow ISO 8601 format (e.g., `2023-02-01T18:09:07Z`).
operationId: listTenantFindings
parameters:
- $ref: '#/components/parameters/paramAuthHeader'
- in: header
name: Content-Type
description: application/json
schema:
type: string
- in: query
name: ids
description: >-
Filter findings based on Plerion Resource Names (prn) or ids.
Accepts a comma-separated list of ids.
schema:
type: string
example: id1,id2
- in: query
name: detectionIds
description: >-
Filter findings based on Plerion Detection IDs. Accepts a
comma-separated list of detection ids.
schema:
type: string
example: PLERION-AWS-1,PLERION-AWS-2
- in: query
name: regions
description: >-
Filter findings based on Provider regions. Accepts a comma-separated
list of regions.
schema:
type: string
example: us-east-1,us-west-2
- in: query
name: assetIds
description: >-
Filter findings based on Asset Plerion Resource Names (prn) or asset
ids. Accepts a comma-separated list of asset ids.
schema:
type: string
example: assetId1,assetId2
- in: query
name: integrationIds
description: >-
Filter findings based on Plerion integration ids. Accepts a
comma-separated list of integration ids.
schema:
type: string
example: integration1,integration2
- in: query
name: assetGroupIds
description: >-
Filter findings based on asset group ids. Accepts a comma-separated
list of asset group ids.
schema:
type: string
example: assetGroupId1,assetGroupId2
- in: query
name: environmentIds
description: >-
Filter findings on the environment. This parameter accepts any
combination of environment name or environment IDs (UUIDs) in a
comma-separated list.
**Supported environment names:**
- `production` - Production environment
- `non-production` - Non-production environment
schema:
type: string
example: production,550e8400-e29b-41d4-a716-446655440000
- in: query
name: severityLevels
description: >-
Filter findings based on severity levels. Accepts a comma-separated
list of severity levels.
schema:
type: string
enum:
- CRITICAL
- HIGH
- MEDIUM
- LOW
example: CRITICAL,HIGH
- in: query
name: statuses
description: >-
Filter findings based on statuses. Accepts a comma-separated list of
statuses.
schema:
type: string
enum:
- PASSED
- FAILED
example: FAILED
- in: query
name: slaStatuses
description: >-
Filter findings based on SLA status. Only applies to FAILED findings
that are tracked against an SLA. Accepts a comma-separated list of
SLA statuses: breached (past the resolution deadline), nearBreach
(inside the warning window but not yet breached), and withinSla
(still ahead of the warning window).
schema:
type: string
enum:
- breached
- nearBreach
- withinSla
example: breached,nearBreach
- in: query
name: resourceTypes
description: >-
Filter findings based on provider resource types. Accepts a
comma-separated list of resource types.
schema:
type: string
example: AWS::S3::Bucket,AWS::Lambda::Function
- in: query
name: providers
description: >-
Filter findings based on provider. Accepts a comma-separated list of
providers.
schema:
type: string
enum:
- AWS
- Azure
- GCP
- Kubernetes
example: AWS,GCP
- in: query
name: services
description: >
Filter findings based on cloud provider services. Accepts a
comma-separated list of service names. Each service can be specified
either by its name alone (e.g., `S3`, `Lambda`, `EC2`) or prefixed
with its provider in the format `Provider::Service` (e.g.,
`AWS::S3`, `GCP::Compute`, `Azure::VirtualMachine`).
schema:
type: string
example: AWS::S3,GCP::Compute,Azure::VirtualMachine
- in: query
name: isExempted
description: >-
Filter findings based on whether the finding is exempted. Accepts
`true` or `false`.
schema:
type: string
format: boolean
example: true
- in: query
name: firstObservedAtStart
description: >-
Start of the date range for filtering findings based on the first
observed time.
Specify the start of the range using a valid ISO 8601 date-time
string.
If `firstObservedAtStart` is provided and `firstObservedAtEnd` is
omitted,
results will include findings from this date to the present.
Supported formats include:
- `yyyy-MM-ddTHH:mm:ssZ` (e.g., `2020-12-18T08:00:00Z`)
- `yyyy-MM-ddTHH:mm:ss.SSSZ` (e.g., `2020-12-18T08:00:00.000Z`)
schema:
type: string
format: date-time
example: '2023-02-01T18:09:07Z'
- in: query
name: firstObservedAtEnd
description: >-
End of the date range for filtering findings based on the first
observed time.
Specify the end of the range using a valid ISO 8601 date-time
string.
If `firstObservedAtEnd` is provided and `firstObservedAtStart` is
omitted,
results will include findings up to this date.
Supported formats include:
- `yyyy-MM-ddTHH:mm:ssZ` (e.g., `2020-12-18T08:00:00Z`)
- `yyyy-MM-ddTHH:mm:ss.SSSZ` (e.g., `2020-12-18T08:00:00.000Z`)
schema:
type: string
format: date-time
example: '2023-02-01T18:09:07Z'
- in: query
name: sortBy
description: Order the list by supported field
schema:
type: string
enum:
- status
- provider
- resourceType
- service
- detectionId
- firstObservedAt
- lastObservedAt
- severityLevel
- resourceFullName
- assetId
- region
- integrationId
example: provider
- in: query
name: sortOrder
description: >-
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`
schema:
type: string
enum:
- ASC
- DESC
example: ASC
- in: query
name: perPage
description: Specify the batch size of the list. Used for pagination
schema:
type: number
example: 100
maximum: 1000
- in: query
name: cursor
description: >-
Get the next batch of findings. Used for pagination. When cursor is
provided, the response will not include total count.
schema:
type: string
example: k3d83a9b-k3dk-5lkd-2ldk-9kd77c1beb6
responses:
'200':
description: Findings list
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Finding'
meta:
type: object
properties:
cursor:
type: string
example: k3d83a9b-k3dk-5lkd-2ldk-9kd77c1beb6
perPage:
type: integer
example: 10
total:
type: integer
description: >-
Total number of findings available for the given
filter
example: 42
page:
type: integer
example: 1
hasNextPage:
type: boolean
example: true
hasPreviousPage:
type: boolean
example: false
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
security:
- APIKey: []
components:
parameters:
paramAuthHeader:
name: Authorization
in: header
description: Bearer API Key. For example, "Bearer {Tenant API Key}"
required: true
schema:
type: string
schemas:
Finding:
type: object
properties:
schemaVersion:
type: string
example: '2022-06-09'
id:
type: string
example: >-
prn:findings:458511a1-9bc2-4fce-97a0-0e3139588e6e:plerion-aws-16:arn:aws:iam::1111222233334444:policy/test-policy
organizationId:
type: string
example: dc16d897-7f52-4b73-be57-96c7c9a853da
tenantId:
type: string
example: 42749bc1-c99b-4c2c-a081-a6cda9370081
integrationId:
type: string
example: 458511a1-9bc2-4fce-97a0-0e3139588e6e
provider:
type: string
example: AWS
executionId:
type: string
example: 1675576960384
assetId:
type: string
example: >-
prn:assets:458511a1-9bc2-4fce-97a0-0e3139588e6e:aws:iam:policy:us-east-1:arn:aws:iam::1111222233334444:policy/test-policy
providerAccountId:
type: string
example: 1111222233334444
resourceType:
type: string
example: AWS::IAM::Policy
detectionId:
type: string
example: PLERION-AWS-16
status:
type: string
example: FAILED
severityLevel:
type: string
example: HIGH
message:
type: string
example: Policy allows full administrative privileges is attached
firstObservedAt:
type: string
example: '2023-02-04T06:02:40.594Z'
createdAt:
type: string
example: '2023-02-04T06:07:09.092Z'
lastObservedAt:
type: string
example: '2023-02-05T06:02:40.384Z'
updatedAt:
type: string
example: '2023-02-05T06:07:02.959Z'
slaDueAt:
type:
- string
- 'null'
description: >-
SLA resolution deadline. Null if the finding is not tracked against
an SLA.
example: '2023-02-11T06:02:40.594Z'
slaWarnAt:
type:
- string
- 'null'
description: >-
Start of the SLA warning window. Null if the finding is not tracked
against an SLA.
example: '2023-02-09T06:02:40.594Z'
slaId:
type:
- string
- 'null'
description: >-
Identifier of the SLA the finding matched. Null if the finding is
not tracked against an SLA.
example: 8f2c1b9a-4d3e-4a6b-9c8d-1e2f3a4b5c6d
parameters:
type: array
items:
type: string
format: nullable
tags:
type: array
items:
type: string
format: nullable
fullResourceName:
type: string
example: arn:aws:iam::1111222233334444:policy/test-policy
resourceId:
type: string
example: test-policy
providerFullResourceName:
type: string
example: arn:aws:iam::1111222233334444:policy/test-policy
region:
type: string
example: us-east-1
service:
type: string
example: IAM
likelihood:
type: string
example: 3
impact:
type: string
example: 5
calculatedSeverity:
type: string
example: 2
modifiedSeverityLevel:
type: string
format: nullable
example: CRITICAL
attackPaths:
type: object
format: nullable
isExempted:
type: boolean
example: false
meta:
type: object
resourceTags:
type: array
format: nullable
items:
type: object
properties:
Key:
type: string
example: Public
Value:
type: string
example: true
resourceURL:
type: string
example: >-
https://us-east-1.console.aws.amazon.com/iam/home#/policies/arn:aws:iam::1111222233334444:policy/test-policy
InternalServerErrorResponse:
type: object
properties:
message:
type: string
example: Internal server error
responses:
'400':
description: Bad Request
content:
application/json:
schema:
properties:
errors:
type: array
items:
type: object
properties:
field:
type: string
code:
type: string
message:
type: string
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
securitySchemes:
APIKey:
type: http
scheme: bearer
bearerFormat: apiKey
description: Bearer API Key. For example, "Bearer {Tenant API Key}"
````