Skip to main content
POST
Request

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

Body

application/json

Provide assetId alone, or resourceType, resourceRegion, and resourceId together.

integrationId
string<uuid>
required

The integration the workload belongs to.

assetId
string

The Plerion asset ID of the workload, as returned by the list assets API.

Example:

"prn:assets:06b6fb23-faa4-45d0-8809-45958c991990:aws:ec2:instance:ap-southeast-2:i-0123456789abcdef0"

resourceType
enum<string>

The provider resource type, when assetId is not given.

Available options:
ec2:instance,
ec2:image
resourceRegion
string

The provider region of the resource, when assetId is not given.

Example:

"ap-southeast-2"

resourceId
string

The provider resource ID, when assetId is not given.

Example:

"i-0123456789abcdef0"

Response

Scan requested

scanId
string

The scan ID to pass to the get workload scan API.

status
string
Example:

"PENDING"

executionId
string