Get nodes
This API provides an easy access to any node on any level on the Supply Chain tree sorted by the number of errors.
errorCount
is available for iacFile, buildtimeResource, runtimeResource, packageFile, and package types.
The types hierarchy built as the following:
| org - (Request Example 1)
| --- repo (Request Example 2)
| --- |--- iacFile (Request Example 3)
| --- |--- |--- buildtimeResource (Request Example 4)
| --- |--- |--- |--- runtimeResource (Request Example 5)
| --- |--- packageFile (Request Example 3)
| --- |--- |--- package (Request Example 6)
| --- |--- dockerFile (Request Example 3)
| --- |--- |--- package (Request Example 7)
- application/json
Request Body required
- edgeDirection EdgeDirection
Possible values: [
parent
,sibling
,children
] filters object
extensions string[]fileType string[]repositoryId stringstatus StatusFilter[]Possible values: [
OPEN
,SUPPRESS
,PASS
]- limit double
- nodeId string
- nodeType NodeType
Possible values: [
org
,repo
,iacFile
,packageFile
,package
,dockerFile
,buildtimeResource
,runtimeResource
,buildtimeJob
,image
,file
] - offset double
- 200
- 422
Get nodes
- application/json
- Schema
- Example (from schema)
- Example 1
- Example 2
Schema
- anyOf
- GetNodesResponse
- SupplyChainError
hasNext boolean requirednodeId string requirednodes object[] required
Array [- anyOf
- BaseNode
- IacFileNode
- BuildtimeResourceNode
- RuntimeResourceNode
- PackageNode
errorCount doublenodeId string requirednodeName string requirednodeType NodeType requiredPossible values: [
org
,repo
,iacFile
,packageFile
,package
,dockerFile
,buildtimeResource
,runtimeResource
,buildtimeJob
,image
,file
]parentId stringerrorCount doublefilePath string requiredfileType string requiredframeworkType FrameworkType requiredPossible values: [
Terraform
,CloudFormation
,Kubernetes
,TerraformPlan
,Helm
,Kustomize
,Serverless
,ARM
,Bicep
,Git
,AWS
,GCP
,Azure
,DockerImage
,Docker
,Vulnerabilities
,VCS
,OpenAPI
,GithubAction
,SCA
]nodeId string requirednodeName string requirednodeType NodeType requiredPossible values: [
org
,repo
,iacFile
,packageFile
,package
,dockerFile
,buildtimeResource
,runtimeResource
,buildtimeJob
,image
,file
]parentId stringcloudProvider CloudProvider requiredPossible values: [
Kubernetes
,Licenses
,Git
,AWS
,GCP
,Azure
,Docker
,AlibabaCloud
,OCI
,OpenStack
,Packages
,Prisma Cloud Code Security
,Linode
,DigitalOcean
,PANOS
]errorCount doubleframeworkType FrameworkType requiredPossible values: [
Terraform
,CloudFormation
,Kubernetes
,TerraformPlan
,Helm
,Kustomize
,Serverless
,ARM
,Bicep
,Git
,AWS
,GCP
,Azure
,DockerImage
,Docker
,Vulnerabilities
,VCS
,OpenAPI
,GithubAction
,SCA
]nodeId string requirednodeName string requirednodeType NodeType requiredPossible values: [
org
,repo
,iacFile
,packageFile
,package
,dockerFile
,buildtimeResource
,runtimeResource
,buildtimeJob
,image
,file
]parentId string requiredresourceId string requiredresourceType string requiredsourceId string requiredbuildtimeLink object required
buildtimeResourceId string requiredbuildtimeSourceId string requiredbuildtimeSourceType string requiredcreatedByBuildtime string requiredruntimeResourceId string requiredruntimeSourceId string requiredbuildtimeResourceId string requiredcreatedByBuildtime string requirederrorCount doublenodeId string requirednodeName string requirednodeType NodeType requiredPossible values: [
org
,repo
,iacFile
,packageFile
,package
,dockerFile
,buildtimeResource
,runtimeResource
,buildtimeJob
,image
,file
]parentId stringresourceType string requiredsourceId string requirederrorCount doubleisRoot booleannodeId string requirednodeName string requirednodeType NodeType requiredPossible values: [
org
,repo
,iacFile
,packageFile
,package
,dockerFile
,buildtimeResource
,runtimeResource
,buildtimeJob
,image
,file
]packageLicenses string[] requiredpackageVersion string requiredparentId stringparentPackageIds string[]]details object[] required
Array [message string required]message string required
{
"hasNext": true,
"nodeId": "string",
"nodes": [
{
"errorCount": 0,
"nodeId": "string",
"nodeName": "string",
"nodeType": "org",
"parentId": "string"
},
{
"errorCount": 0,
"filePath": "string",
"fileType": "string",
"frameworkType": "Terraform",
"nodeId": "string",
"nodeName": "string",
"nodeType": "org",
"parentId": "string"
},
{
"cloudProvider": "Kubernetes",
"errorCount": 0,
"frameworkType": "Terraform",
"nodeId": "string",
"nodeName": "string",
"nodeType": "org",
"parentId": "string",
"resourceId": "string",
"resourceType": "string",
"sourceId": "string"
},
{
"buildtimeLink": {
"buildtimeResourceId": "string",
"buildtimeSourceId": "string",
"buildtimeSourceType": "string",
"createdByBuildtime": "string",
"runtimeResourceId": "string",
"runtimeSourceId": "string"
},
"buildtimeResourceId": "string",
"createdByBuildtime": "string",
"errorCount": 0,
"nodeId": "string",
"nodeName": "string",
"nodeType": "org",
"parentId": "string",
"resourceType": "string",
"sourceId": "string"
},
{
"errorCount": 0,
"isRoot": true,
"nodeId": "string",
"nodeName": "string",
"nodeType": "org",
"packageLicenses": [
"string"
],
"packageVersion": "string",
"parentId": "string",
"parentPackageIds": [
"string"
]
}
]
}
{
"hasNext": true,
"nodeId": "b8712a2e-cc6f-43b1-b5t1-95a70087et44",
"nodes": [
{
"errorCount": 5,
"extensions": [
"yaml"
],
"filePath": "cfn/s3.yaml",
"fileType": [
"yaml"
],
"frameworkType": "CloudFormation",
"nodeId": "55dedfed-ab0b-4fbc-9e2f-9a73c99c00a4",
"nodeName": "s3.yaml",
"nodeType": "iacFile",
"parentId": "b8712a2e-cc6f-43b1-b5t1-95a70087et44"
},
{
"errorCount": 4,
"extensions": [
"Dockerfile"
],
"filePath": "dockerfile/failed_2/Dockerfile",
"fileType": [
"Dockerfile"
],
"frameworkType": "Docker",
"nodeId": "c27f8aff-6ac6-4c3d-abb8-4b3544488bb6",
"nodeName": "Dockerfile",
"nodeType": "dockerFile",
"parentId": "b8712a2e-cc6f-43b1-b5t1-95a70087et44"
},
{
"errorCount": 3,
"extensions": [
"tf"
],
"filePath": "terraform/aws/db-app.tf",
"fileType": [
"tf"
],
"frameworkType": "Terraform",
"nodeId": "b85c65a6-b505-4369-9393-c6fd230e7c21",
"nodeName": "db-app.tf",
"nodeType": "iacFile",
"parentId": "b8712a2e-cc6f-43b1-b5t1-95a70087et44"
}
]
}
{
"hasNext": true,
"nodeId": "b85c65a6-b505-4369-9393-c6fd230e7c21",
"nodes": [
{
"cloudProvider": "AWS",
"errorCount": 8,
"frameworkType": "Terraform",
"nodeId": "80579aa1-c45c-4599-b10a-3c8d6f92ce26",
"nodeName": "aws_db_instance.default",
"nodeType": "buildtimeResource",
"parentId": "b85c65a6-b505-4369-9393-c6fd230e7c21",
"resourceId": "/terraform/aws/db-app.tf:aws_db_instance.default",
"resourceType": "aws_db_instance"
},
{
"cloudProvider": "AWS",
"errorCount": 5,
"frameworkType": "Terraform",
"nodeId": "845fee5b-2291-4eee-949a-da784aa04acd",
"nodeName": "aws_instance.db_app",
"nodeType": "buildtimeResource",
"parentId": "b85c65a6-b505-4369-9393-c6fd230e7c21",
"resourceId": "/terraform/aws/db-app.tf:aws_instance.db_app",
"resourceType": "aws_instance"
},
{
"cloudProvider": "AWS",
"errorCount": 3,
"frameworkType": "Terraform",
"nodeId": "26819830-0805-4cab-93ff-f5443e26d50e",
"nodeName": "aws_security_group_rule.ingress",
"nodeType": "buildtimeResource",
"parentId": "b85c65a6-b505-4369-9393-c6fd230e7c21",
"resourceId": "/terraform/aws/db-app.tf:aws_security_group_rule.ingress",
"resourceType": "aws_security_group_rule"
}
]
}
Request arguments validation error