Skip to main content
GET
/
v1
/
tenant
/
shiftleft
/
iac
/
scans
List scans
curl --request GET \
  --url https://{region}.api.plerion.com/v1/tenant/shiftleft/iac/scans \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "c056d03d-3f7a-4232-ace0-45403fe28340",
      "createdAt": "2023-05-05T11:06:19.859Z",
      "updatedAt": "2023-05-05T11:06:19.859Z",
      "organizationId": "ec17a309-6b0a-4911-8d1d-8a5aa0ac4742",
      "tenantId": "7934cf6d-fb34-4bda-adde-173a1fa30d9c",
      "summary": {
        "startedAt": 1683284776221,
        "stoppedAt": 1683284779523,
        "totalFileSize": 15187,
        "totalFindings": 232,
        "totalResources": 65,
        "totalParsingErrors": 0,
        "totalFailedFindings": 131,
        "totalPassedFindings": 101,
        "totalSkippedFindings": 0,
        "totalVulnerabilities": 123
      },
      "artifactName": "artifact.zip",
      "status": "SUCCESS",
      "types": [
        "terraform",
        "dockerfile"
      ]
    },
    {
      "id": "702de801-5f54-4bab-a504-0990f7b56830",
      "createdAt": "2023-05-05T11:06:19.500Z",
      "updatedAt": "2023-05-05T11:06:19.500Z",
      "organizationId": "ec17a309-6b0a-4911-8d1d-8a5aa0ac4742",
      "tenantId": "7934cf6d-fb34-4bda-adde-173a1fa30d9c",
      "summary": {
        "startedAt": 1683284775925,
        "stoppedAt": 1683284779187,
        "totalFileSize": 15187,
        "totalFindings": 232,
        "totalResources": 65,
        "totalParsingErrors": 0,
        "totalFailedFindings": 131,
        "totalPassedFindings": 101,
        "totalSkippedFindings": 0
      },
      "artifactName": "artifact.zip",
      "status": "SUCCESS",
      "types": [
        "terraform",
        "dockerfile"
      ]
    }
  ],
  "meta": {
    "page": 1,
    "perPage": 10,
    "total": 74964,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

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 scans based on ids. Accepts a comma-separated list of ids.

Example:
["uuid1,uuid2,uuid3"]
​
artifactNames
string

Filter scans based on artifact name. Accepts a comma-separated list of artifact names.

Example:

"my-iac.zip,my-iac2.zip"

​
statuses
enum<string>

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

Available options:
SUCCESS,
FAILURE
Example:

"SUCCESS"

​
sortBy
enum<string>

Sort results by the specified field.

Available options:
id,
createdAt,
updatedAt,
artifactName,
status
Example:

"createdAt"

​
sortOrder
enum<string>

Sort order for the results.

Available options:
asc,
desc
Example:

"asc"

​
page
integer

Page number for the results. Accepts a positive integer.

Example:

1

​
perPage
integer

Number of results per page. Accepts a positive integer.

Example:

10

Response

OK

​
data
object[]
​
meta
object