Get Nodes

POST 
/code/api/v1/supply-chain/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)

Request

application/json

Body

required

edgeDirection EdgeDirection (string)

Possible values: [parent, sibling, children]

filters object

extensions string[]

fileType string[]

repositoryId string

status StatusFilter (string)[]

Possible values: [OPEN, SUPPRESS, PASS]

limit double
nodeId string
nodeType NodeType (string)

Possible values: [org, repo, iacFile, packageFile, package, dockerFile, buildtimeResource, runtimeResource, buildtimeJob, image, file]

offset double

Responses

200

Get nodes

application/json

Schema

Schema

anyOf
GetNodesResponse
hasNext booleanrequired
nodeId stringrequired
nodes object[]required
Array [
anyOf
BaseNode
errorCount double
nodeId stringrequired
nodeName stringrequired
nodeType NodeType (string)required
Possible values: [org, repo, iacFile, packageFile, package, dockerFile, buildtimeResource, runtimeResource, buildtimeJob, image, file]
parentId string
IacFileNode
errorCount double
filePath stringrequired
fileType stringrequired
frameworkType FrameworkType (string)required
Possible values: [Terraform, CloudFormation, Kubernetes, TerraformPlan, Helm, Kustomize, Serverless, ARM, Bicep, Git, AWS, GCP, Azure, DockerImage, Docker, Vulnerabilities, VCS, OpenAPI, GithubAction, SCA]
nodeId stringrequired
nodeName stringrequired
nodeType NodeType (string)required
Possible values: [org, repo, iacFile, packageFile, package, dockerFile, buildtimeResource, runtimeResource, buildtimeJob, image, file]
parentId string
BuildtimeResourceNode
cloudProvider CloudProvider (string)required
Possible values: [Kubernetes, Licenses, Git, AWS, GCP, Azure, Docker, AlibabaCloud, OCI, OpenStack, Packages, Prisma Cloud Application Security, Linode, DigitalOcean, PANOS]
errorCount double
frameworkType FrameworkType (string)required
Possible values: [Terraform, CloudFormation, Kubernetes, TerraformPlan, Helm, Kustomize, Serverless, ARM, Bicep, Git, AWS, GCP, Azure, DockerImage, Docker, Vulnerabilities, VCS, OpenAPI, GithubAction, SCA]
nodeId stringrequired
nodeName stringrequired
nodeType NodeType (string)required
Possible values: [org, repo, iacFile, packageFile, package, dockerFile, buildtimeResource, runtimeResource, buildtimeJob, image, file]
parentId stringrequired
resourceId stringrequired
resourceType stringrequired
sourceId stringrequired
RuntimeResourceNode
buildtimeLink objectrequired
buildtimeResourceId stringrequired
buildtimeSourceId stringrequired
buildtimeSourceType stringrequired
createdByBuildtime stringrequired
runtimeResourceId stringrequired
runtimeSourceId stringrequired
buildtimeResourceId stringrequired
createdByBuildtime stringrequired
errorCount double
nodeId stringrequired
nodeName stringrequired
nodeType NodeType (string)required
Possible values: [org, repo, iacFile, packageFile, package, dockerFile, buildtimeResource, runtimeResource, buildtimeJob, image, file]
parentId string
resourceType stringrequired
sourceId stringrequired
PackageNode
errorCount double
isRoot boolean
nodeId stringrequired
nodeName stringrequired
nodeType NodeType (string)required
Possible values: [org, repo, iacFile, packageFile, package, dockerFile, buildtimeResource, runtimeResource, buildtimeJob, image, file]
packageLicenses string[]required
packageVersion stringrequired
parentId string
parentPackageIds string[]
]
SupplyChainError
details object[]required
Array [
message stringrequired
]
message stringrequired

Example (from schema)

{}

Example 1

{
  "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"
    }
  ]
}

Example 2

{
  "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"
    }
  ]
}

422

Request arguments validation error

Loading...