🚀 Version 3.5 is now live! See our release notes for details.
curl --request POST \
--url https://api.example.com/api/v4/products/{productId}/images:upload \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'imageName=<string>' \
--form 'version=<string>' \
--form file='@example-file'{
"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
}
}curl --request POST \
--url https://api.example.com/api/v4/products/{productId}/images:upload \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'imageName=<string>' \
--form 'version=<string>' \
--form file='@example-file'{
"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
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Product ID
26"01ARZ3NDEKTSV4RRFFQ69G5FAV"
Create a Scan for the Image
Temporary File ID of uploaded file
26"01ARZ3NDEKTSV4RRFFQ69G5FAV"
Uploaded image name when body is empty
Uploaded image version when body is empty
Uploaded image filename when body is empty
success
26"01ARZ3NDEKTSV4RRFFQ69G5FAV"
"2024-01-01T01:00:00Z"
Show child attributes
URI path (path-noscheme) without the leading /
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?