Upload Image

{
  "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "name": "<string>",
  "version": "<string>",
  "createTime": "2024-01-01T01:00:00Z",
  "author": {
    "userId": "<string>",
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "createTime": "2024-01-01T01:00:00Z",
    "email": "[email protected]",
    "status": "active",
    "resourceType": "Org"
  },
  "parent": "<string>",
  "files": [
    {
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "createTime": "2024-01-01T01:00:00Z",
      "author": {
        "userId": "<string>",
        "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "createTime": "2024-01-01T01:00:00Z",
        "email": "[email protected]",
        "status": "active",
        "resourceType": "Org"
      },
      "filename": "<string>",
      "isAttachment": false,
      "downloadUrl": "<string>",
      "parent": "<string>",
      "metadata": {}
    }
  ],
  "scans": [
    {
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "createTime": "2024-01-01T01:00:00Z",
      "author": {
        "userId": "<string>",
        "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "createTime": "2024-01-01T01:00:00Z",
        "email": "[email protected]",
        "status": "active",
        "resourceType": "Org"
      },
      "parent": "<string>",
      "latestScanState": {
        "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "type": "new",
        "createTime": "2024-01-01T01:00:00Z",
        "parent": "<string>",
        "author": {
          "userId": "<string>",
          "id": "<unknown>",
          "createTime": "2024-01-01T01:00:00Z",
          "email": "[email protected]",
          "status": "active",
          "resourceType": "Org"
        },
        "source": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
      }
    }
  ],
  "latestScan": {
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "createTime": "2024-01-01T01:00:00Z",
    "author": {
      "userId": "<string>",
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "createTime": "2024-01-01T01:00:00Z",
      "email": "[email protected]",
      "status": "active",
      "resourceType": "Org"
    },
    "parent": "<string>",
    "latestScanState": {
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "type": "new",
      "createTime": "2024-01-01T01:00:00Z",
      "parent": "<string>",
      "author": {
        "userId": "<string>",
        "id": "<unknown>",
        "createTime": "2024-01-01T01:00:00Z",
        "email": "[email protected]",
        "status": "active",
        "resourceType": "Org"
      },
      "source": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
    }
  },
  "isArchived": true,
  "counts": {
    "newEscalationsCount": 123,
    "dependenciesCount": 123,
    "cryptographicAssetsCount": 123,
    "findingTypeCounts": [
      {
        "type": "knownVulnerability",
        "count": 123
      }
    ],
    "kev": 123,
    "expiredCertificatesCount": 123,
    "unsafeFunctionsCount": 123
  }
}

POST

api

products

{productId}

images:upload

{
  "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "name": "<string>",
  "version": "<string>",
  "createTime": "2024-01-01T01:00:00Z",
  "author": {
    "userId": "<string>",
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "createTime": "2024-01-01T01:00:00Z",
    "email": "[email protected]",
    "status": "active",
    "resourceType": "Org"
  },
  "parent": "<string>",
  "files": [
    {
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "createTime": "2024-01-01T01:00:00Z",
      "author": {
        "userId": "<string>",
        "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "createTime": "2024-01-01T01:00:00Z",
        "email": "[email protected]",
        "status": "active",
        "resourceType": "Org"
      },
      "filename": "<string>",
      "isAttachment": false,
      "downloadUrl": "<string>",
      "parent": "<string>",
      "metadata": {}
    }
  ],
  "scans": [
    {
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "createTime": "2024-01-01T01:00:00Z",
      "author": {
        "userId": "<string>",
        "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "createTime": "2024-01-01T01:00:00Z",
        "email": "[email protected]",
        "status": "active",
        "resourceType": "Org"
      },
      "parent": "<string>",
      "latestScanState": {
        "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "type": "new",
        "createTime": "2024-01-01T01:00:00Z",
        "parent": "<string>",
        "author": {
          "userId": "<string>",
          "id": "<unknown>",
          "createTime": "2024-01-01T01:00:00Z",
          "email": "[email protected]",
          "status": "active",
          "resourceType": "Org"
        },
        "source": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
      }
    }
  ],
  "latestScan": {
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "createTime": "2024-01-01T01:00:00Z",
    "author": {
      "userId": "<string>",
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "createTime": "2024-01-01T01:00:00Z",
      "email": "[email protected]",
      "status": "active",
      "resourceType": "Org"
    },
    "parent": "<string>",
    "latestScanState": {
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "type": "new",
      "createTime": "2024-01-01T01:00:00Z",
      "parent": "<string>",
      "author": {
        "userId": "<string>",
        "id": "<unknown>",
        "createTime": "2024-01-01T01:00:00Z",
        "email": "[email protected]",
        "status": "active",
        "resourceType": "Org"
      },
      "source": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
    }
  },
  "isArchived": true,
  "counts": {
    "newEscalationsCount": 123,
    "dependenciesCount": 123,
    "cryptographicAssetsCount": 123,
    "findingTypeCounts": [
      {
        "type": "knownVulnerability",
        "count": 123
      }
    ],
    "kev": 123,
    "expiredCertificatesCount": 123,
    "unsafeFunctionsCount": 123
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

productId

string<ulid>

required

Product ID

Required string length: 26

Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

Query Parameters

createScan

boolean

default:true

Create a Scan for the Image

tempFileId

string<ulid>

Temporary File ID of uploaded file

Required string length: 26

Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

imageName

string

Uploaded image name when body is empty

version

string

Uploaded image version when body is empty

filename

string

Uploaded image filename when body is empty

Body

multipart/form-data

imageName

string

version

string

file

Response

success

string<ulid>

required

Required string length: 26

Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

name

string

required

version

string

required

createTime

string

required

Example:

"2024-01-01T01:00:00Z"

author

object

required

Show child attributes

author.userId

string

required

author.id

string<ulid>

Required string length: 26

Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

author.createTime

string

Example:

"2024-01-01T01:00:00Z"

author.email

string

Example:

"[email protected]"

author.status

enum<string>

Available options:

active,

archived

author.resourceType

enum<string>

Available options:

Org,

Group,

Product,

User,

Image,

Finding,

Occurrence

parent

string<path>

URI path (path-noscheme) without the leading /

files

object[]

Show child attributes

files.id

string<ulid>

required

Required string length: 26

Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

files.createTime

string

required

Example:

"2024-01-01T01:00:00Z"

files.author

object

required

Show child attributes

files.author.userId

string

required

files.author.id

string<ulid>

Required string length: 26

Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

files.author.createTime

string

Example:

"2024-01-01T01:00:00Z"

files.author.email

string

Example:

"[email protected]"

files.author.status

enum<string>

Available options:

active,

archived

files.author.resourceType

enum<string>

Available options:

Org,

Group,

Product,

User,

Image,

Finding,

Occurrence

files.filename

string

required

files.isAttachment

boolean

default:false

required

files.downloadUrl

string

required

files.parent

string<path>

URI path (path-noscheme) without the leading /

files.metadata

object

Show child attributes

files.metadata.{key}

string

scans

object[]

Show child attributes

scans.id

string<ulid>

required

Required string length: 26

Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

scans.createTime

string

required

Example:

"2024-01-01T01:00:00Z"

scans.author

object

required

Show child attributes

scans.author.userId

string

required

scans.author.id

string<ulid>

Required string length: 26

Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

scans.author.createTime

string

Example:

"2024-01-01T01:00:00Z"

scans.author.email

string

Example:

"[email protected]"

scans.author.status

enum<string>

Available options:

active,

archived

scans.author.resourceType

enum<string>

Available options:

Org,

Group,

Product,

User,

Image,

Finding,

Occurrence

scans.parent

string<path>

URI path (path-noscheme) without the leading /

scans.latestScanState

object

Show child attributes

scans.latestScanState.id

string<ulid>

required

Required string length: 26

Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

scans.latestScanState.type

enum<string>

required

Available options:

new,

running,

failed,

done,

cancelled

scans.latestScanState.createTime

string

required

Example:

"2024-01-01T01:00:00Z"

scans.latestScanState.parent

string<path>

URI path (path-noscheme) without the leading /

scans.latestScanState.author

object

Show child attributes

scans.latestScanState.author.userId

string

required

scans.latestScanState.author.id

any

scans.latestScanState.author.createTime

string

Example:

"2024-01-01T01:00:00Z"

scans.latestScanState.author.email

string

Example:

"[email protected]"

scans.latestScanState.author.status

enum<string>

Available options:

active,

archived

scans.latestScanState.author.resourceType

enum<string>

Available options:

Org,

Group,

Product,

User,

Image,

Finding,

Occurrence

scans.latestScanState.source

string<ulid>

Required string length: 26

Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

latestScan

object

Show child attributes

latestScan.id

string<ulid>

required

Required string length: 26

Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

latestScan.createTime

string

required

Example:

"2024-01-01T01:00:00Z"

latestScan.author

object

required

Show child attributes

latestScan.author.userId

string

required

latestScan.author.id

string<ulid>

Required string length: 26

Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

latestScan.author.createTime

string

Example:

"2024-01-01T01:00:00Z"

latestScan.author.email

string

Example:

"[email protected]"

latestScan.author.status

enum<string>

Available options:

active,

archived

latestScan.author.resourceType

enum<string>

Available options:

Org,

Group,

Product,

User,

Image,

Finding,

Occurrence

latestScan.parent

string<path>

URI path (path-noscheme) without the leading /

latestScan.latestScanState

object

Show child attributes

latestScan.latestScanState.id

string<ulid>

required

Required string length: 26

Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

latestScan.latestScanState.type

enum<string>

required

Available options:

new,

running,

failed,

done,

cancelled

latestScan.latestScanState.createTime

string

required

Example:

"2024-01-01T01:00:00Z"

latestScan.latestScanState.parent

string<path>

URI path (path-noscheme) without the leading /

latestScan.latestScanState.author

object

Show child attributes

latestScan.latestScanState.author.userId

string

required

latestScan.latestScanState.author.id

any

latestScan.latestScanState.author.createTime

string

Example:

"2024-01-01T01:00:00Z"

latestScan.latestScanState.author.email

string

Example:

"[email protected]"

latestScan.latestScanState.author.status

enum<string>

Available options:

active,

archived

latestScan.latestScanState.author.resourceType

enum<string>

Available options:

Org,

Group,

Product,

User,

Image,

Finding,

Occurrence

latestScan.latestScanState.source

string<ulid>

Required string length: 26

Example:

"01ARZ3NDEKTSV4RRFFQ69G5FAV"

isArchived

boolean

counts

object

Show child attributes

counts.newEscalationsCount

integer

required

counts.dependenciesCount

integer

required

counts.cryptographicAssetsCount

integer

required

counts.findingTypeCounts

object[]

required

Show child attributes

counts.findingTypeCounts.type

enum<string>

required

Available options:

knownVulnerability,

unknownVulnerability,

maliciousCode,

suspiciousCode,

dependencyVulnerability,

cryptographicAsset,

mitigation,

weakness,

supplyChainFailure,

secret,

leakedSecret,

uncategorized

counts.findingTypeCounts.count

integer

required

counts.kev

integer

required

counts.expiredCertificatesCount

integer

required

counts.unsafeFunctionsCount

integer

required

Get Image by ID List Scans

⌘I

Get Started

API | Image Reports

API | Products

API | Images

API | Scans

Authorizations

Path Parameters

Query Parameters

Body

Response