Get specific asset in a tenant

Get

curl --request GET \
  --url https://{region}.api.plerion.com/v1/tenant/assets/{assetId} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "schemaVersion": "2022-06-09",
    "id": "prn:assets:afeb4e5f-0370-4b43-8e37-7e4efc719358:aws:ec2:instance:ap-southeast-2:i-085a328dba59f229b",
    "organizationId": "dc16d897-7f52-4b73-be57-96c7c9a853da",
    "tenantId": "42749bc1-c99b-4c2c-a081-a6cda9370081",
    "integrationId": "458511a1-9bc2-4fce-97a0-0e3139588e6e",
    "executionId": 1675576960384,
    "provider": "AWS",
    "type": "AWS::EC2::Instance",
    "name": "i-085a328dba59f229b",
    "createdAt": "2023-02-04T06:07:09.092Z",
    "firstObservedAt": "2023-02-04T06:02:40.594Z",
    "lastObservedAt": "2023-02-05T06:02:40.384Z",
    "updatedAt": "2023-02-05T06:07:02.959Z",
    "tags": [
      {
        "Key": "Department",
        "Value": "Finance"
      }
    ],
    "isPubliclyExposed": false,
    "isVulnerable": false,
    "numberOfLowVulnerabilities": 85,
    "numberOfMediumVulnerabilities": 60,
    "numberOfHighVulnerabilities": 15,
    "numberOfCriticalVulnerabilities": 5,
    "vulnerabilityScore": 9,
    "hasKev": false,
    "hasExploit": false,
    "isExploitable": false,
    "isInVpc": false,
    "lastScanId": 1679594910265,
    "lastScannedAt": "2023-03-23T18:17:20.003Z",
    "imageId": "<string>",
    "platform": "<string>",
    "hasAdminPrivileges": false,
    "hasOverlyPermissivePrivileges": false,
    "hasAuthorizer": false,
    "hasTracingEnabled": false,
    "policy": {},
    "numberOfLowSecrets": 3,
    "numberOfMediumSecrets": 1,
    "numberOfHighSecrets": 0,
    "numberOfCriticalSecrets": 2,
    "lowSecrets": [
      {}
    ],
    "mediumSecrets": [
      {}
    ],
    "highSecrets": [
      {}
    ],
    "criticalSecrets": [
      {}
    ],
    "operatingSystem": [
      {
        "architecture": "x86_64",
        "name": "Ubuntu",
        "platform": "Linux/UNIX",
        "version": "24.04.2 LTS (Noble Numbat)",
        "versionId": 24.04,
        "activeKernel": "4.14.246-197.484.amzn2.x86_64",
        "buildNumber": "20348.fe_release.210507-1500",
        "lcuVersion": "10.0.20348.2762"
      }
    ],
    "riskScore": 9.36,
    "region": "us-east-1",
    "service": "AWS::EC2",
    "resourceId": "i-085a328dba59f229b",
    "resourceName": "test-instance",
    "resourceTags": [
      {
        "Key": "Public",
        "Value": true
      }
    ],
    "resourceType": "AWS::EC2::Instance",
    "fullResourceName": "arn:aws:iam::1111222233334444:policy/test-policy",
    "providerAccountId": 123456789012,
    "resourceURL": "https://us-east-1.console.aws.amazon.com/iam/home#/policies/arn:aws:iam::1111222233334444:policy/test-policy",
    "rawData": {}
  }
}

GET

tenant

assets

{assetId}

Get

curl --request GET \
  --url https://{region}.api.plerion.com/v1/tenant/assets/{assetId} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "schemaVersion": "2022-06-09",
    "id": "prn:assets:afeb4e5f-0370-4b43-8e37-7e4efc719358:aws:ec2:instance:ap-southeast-2:i-085a328dba59f229b",
    "organizationId": "dc16d897-7f52-4b73-be57-96c7c9a853da",
    "tenantId": "42749bc1-c99b-4c2c-a081-a6cda9370081",
    "integrationId": "458511a1-9bc2-4fce-97a0-0e3139588e6e",
    "executionId": 1675576960384,
    "provider": "AWS",
    "type": "AWS::EC2::Instance",
    "name": "i-085a328dba59f229b",
    "createdAt": "2023-02-04T06:07:09.092Z",
    "firstObservedAt": "2023-02-04T06:02:40.594Z",
    "lastObservedAt": "2023-02-05T06:02:40.384Z",
    "updatedAt": "2023-02-05T06:07:02.959Z",
    "tags": [
      {
        "Key": "Department",
        "Value": "Finance"
      }
    ],
    "isPubliclyExposed": false,
    "isVulnerable": false,
    "numberOfLowVulnerabilities": 85,
    "numberOfMediumVulnerabilities": 60,
    "numberOfHighVulnerabilities": 15,
    "numberOfCriticalVulnerabilities": 5,
    "vulnerabilityScore": 9,
    "hasKev": false,
    "hasExploit": false,
    "isExploitable": false,
    "isInVpc": false,
    "lastScanId": 1679594910265,
    "lastScannedAt": "2023-03-23T18:17:20.003Z",
    "imageId": "<string>",
    "platform": "<string>",
    "hasAdminPrivileges": false,
    "hasOverlyPermissivePrivileges": false,
    "hasAuthorizer": false,
    "hasTracingEnabled": false,
    "policy": {},
    "numberOfLowSecrets": 3,
    "numberOfMediumSecrets": 1,
    "numberOfHighSecrets": 0,
    "numberOfCriticalSecrets": 2,
    "lowSecrets": [
      {}
    ],
    "mediumSecrets": [
      {}
    ],
    "highSecrets": [
      {}
    ],
    "criticalSecrets": [
      {}
    ],
    "operatingSystem": [
      {
        "architecture": "x86_64",
        "name": "Ubuntu",
        "platform": "Linux/UNIX",
        "version": "24.04.2 LTS (Noble Numbat)",
        "versionId": 24.04,
        "activeKernel": "4.14.246-197.484.amzn2.x86_64",
        "buildNumber": "20348.fe_release.210507-1500",
        "lcuVersion": "10.0.20348.2762"
      }
    ],
    "riskScore": 9.36,
    "region": "us-east-1",
    "service": "AWS::EC2",
    "resourceId": "i-085a328dba59f229b",
    "resourceName": "test-instance",
    "resourceTags": [
      {
        "Key": "Public",
        "Value": true
      }
    ],
    "resourceType": "AWS::EC2::Instance",
    "fullResourceName": "arn:aws:iam::1111222233334444:policy/test-policy",
    "providerAccountId": 123456789012,
    "resourceURL": "https://us-east-1.console.aws.amazon.com/iam/home#/policies/arn:aws:iam::1111222233334444:policy/test-policy",
    "rawData": {}
  }
}

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

Path Parameters

assetId

string

required

The PRN (asset ID) to retrieve

Query Parameters

include

string

Comma-separated list of additional data to include in the response. Use 'rawData' to include the raw asset data.

Example:

"rawData"

Response

Success

data

object

Show child attributes

data.schemaVersion

string

Example:

"2022-06-09"

data.id

string

Example:

"prn:assets:afeb4e5f-0370-4b43-8e37-7e4efc719358:aws:ec2:instance:ap-southeast-2:i-085a328dba59f229b"

data.organizationId

string

Example:

"dc16d897-7f52-4b73-be57-96c7c9a853da"

data.tenantId

string

Example:

"42749bc1-c99b-4c2c-a081-a6cda9370081"

data.integrationId

string

Example:

"458511a1-9bc2-4fce-97a0-0e3139588e6e"

data.executionId

string

Example:

1675576960384

data.provider

string

Example:

"AWS"

data.type

string

Example:

"AWS::EC2::Instance"

data.name

string | null

Example:

"i-085a328dba59f229b"

data.createdAt

string | null

Example:

"2023-02-04T06:07:09.092Z"

data.firstObservedAt

string | null

Example:

"2023-02-04T06:02:40.594Z"

data.lastObservedAt

string | null

Example:

"2023-02-05T06:02:40.384Z"

data.updatedAt

string | null

Example:

"2023-02-05T06:07:02.959Z"

data.tags

object[] | null

Show child attributes

data.tags.Key

string

Name of the Tag's Key

Example:

"Department"

data.tags.Value

string

Value of the Tag's Key

Example:

"Finance"

data.isPubliclyExposed

boolean | null

Example:

false

data.isVulnerable

boolean | null

Example:

false

data.numberOfLowVulnerabilities

number | null

Example:

85

data.numberOfMediumVulnerabilities

number | null

Example:

60

data.numberOfHighVulnerabilities

number | null

Example:

15

data.numberOfCriticalVulnerabilities

number | null

Example:

5

data.vulnerabilityScore

string | null

Example:

9

data.hasKev

boolean | null

Example:

false

data.hasExploit

boolean | null

Example:

false

data.isExploitable

boolean | null

Example:

false

data.isInVpc

boolean | null

Example:

false

data.lastScanId

string | null

Example:

1679594910265

data.lastScannedAt

string | null

Example:

"2023-03-23T18:17:20.003Z"

data.imageId

string | null

data.platform

string | null

data.hasAdminPrivileges

boolean | null

Example:

false

data.hasOverlyPermissivePrivileges

boolean | null

Example:

false

data.hasAuthorizer

boolean | null

Example:

false

data.hasTracingEnabled

boolean | null

Example:

false

data.policy

object

Show child attributes

data.policy.{key}

string

data.numberOfLowSecrets

number | null

Example:

3

data.numberOfMediumSecrets

number | null

Example:

1

data.numberOfHighSecrets

number | null

Example:

0

data.numberOfCriticalSecrets

number | null

Example:

2

data.lowSecrets

object[] | null

Show child attributes

data.lowSecrets.{key}

string

data.mediumSecrets

object[] | null

Show child attributes

data.mediumSecrets.{key}

string

data.highSecrets

object[] | null

Show child attributes

data.highSecrets.{key}

string

data.criticalSecrets

object[] | null

Show child attributes

data.criticalSecrets.{key}

string

data.operatingSystem

object[] | null

Show child attributes

data.operatingSystem.architecture

string

The architecture of the operating system.

Example:

"x86_64"

data.operatingSystem.name

string

The name of the operating system.

Example:

"Ubuntu"

data.operatingSystem.platform

string

The OS platform.

Example:

"Linux/UNIX"

data.operatingSystem.version

string

The version of the operating system including version name.

Example:

"24.04.2 LTS (Noble Numbat)"

data.operatingSystem.versionId

string

The version of the operating system.

Example:

24.04

data.operatingSystem.activeKernel

string

The kernel version of the operating system.

Example:

"4.14.246-197.484.amzn2.x86_64"

data.operatingSystem.buildNumber

string

The build number of the windows operating system.

Example:

"20348.fe_release.210507-1500"

data.operatingSystem.lcuVersion

string

The latest cumulative update version of the windows operating.

Example:

"10.0.20348.2762"

data.riskScore

string | null

Example:

9.36

data.region

string

Example:

"us-east-1"

data.service

string

Example:

"AWS::EC2"

data.resourceId

string

Example:

"i-085a328dba59f229b"

data.resourceName

string

Example:

"test-instance"

data.resourceTags

object[] | null

Show child attributes

data.resourceTags.Key

string

Example:

"Public"

data.resourceTags.Value

string

Example:

true

data.resourceType

string

Example:

"AWS::EC2::Instance"

data.fullResourceName

string

Example:

"arn:aws:iam::1111222233334444:policy/test-policy"

data.providerAccountId

string

Example:

123456789012

data.resourceURL

string

Example:

"https://us-east-1.console.aws.amazon.com/iam/home#/policies/arn:aws:iam::1111222233334444:policy/test-policy"

data.rawData

object

The raw data for the asset from the provider

List assets in a tenant Get SBOM for a specific asset

⌘I

Overview

API documentation

Authorizations

Headers

Path Parameters

Query Parameters

Response