Get query nodes

GetAssessmentQueryNodes returns node details for entities in the query results, with a paginated response.

Please note that the total number of the results is not provided . To get a result count, use GetAssessmentQueryResult.

get

/api/v1/assessments/queries/{id}:nodes

Authorizations

Path parameters

idstringrequired

Query parameters

snapshot_idstring · uint64

apply_risk_suppressed_constraintboolean

properties_to_getstring[]

page_sizestring · int64

The maximum number of results to be returned. Fewer results may be returned even when more pages exist.

page_tokenstring

The token specifying the specific page of results to retrieve.

order_bystring

destination_node_count ASC and destination_node_count DESC are valid values

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/assessments/queries/{id}:nodes' \
  --header 'Bearer: YOUR_API_KEY'

200

401

403

404

500

502

503

200

{
  "next_page_token": "text",
  "has_more": true,
  "values": [
    {
      "id": "text",
      "type": "text",
      "properties": {},
      "destination_node_count": 1,
      "engagement_access_stats": {
        "engagement_score": 1,
        "over_provisioned_score": 1,
        "total_count": "text",
        "accessed_count": "text"
      },
      "access_stats": {
        "last_used": "2025-02-20T19:03:39.969Z",
        "count": 1,
        "concrete_permissions": [
          "text"
        ],
        "canonical_permissions": [
          "text"
        ]
      },
      "risk_level": "NONE",
      "destination_node_percentage_of_total": 1,
      "permissions": [
        {
          "id": "text",
          "type": "text",
          "properties": {},
          "destination_node_count": 1,
          "engagement_access_stats": {
            "engagement_score": 1,
            "over_provisioned_score": 1,
            "total_count": "text",
            "accessed_count": "text"
          },
          "access_stats": {
            "last_used": "2025-02-20T19:03:39.969Z",
            "count": 1,
            "concrete_permissions": [
              "text"
            ],
            "canonical_permissions": [
              "text"
            ]
          },
          "risk_level": "NONE",
          "destination_node_percentage_of_total": 1,
          "permissions": [
            "[Circular Reference]"
          ],
          "destination_node_ids": [
            "text"
          ],
          "raw_permissions": [
            "text"
          ],
          "effective_permissions": [
            "text"
          ]
        }
      ],
      "destination_node_ids": [
        "text"
      ],
      "raw_permissions": [
        "text"
      ],
      "effective_permissions": [
        "text"
      ]
    }
  ],
  "path_values": [
    {
      "source": {
        "id": "text",
        "type": "text",
        "properties": {},
        "destination_node_count": 1,
        "engagement_access_stats": {
          "engagement_score": 1,
          "over_provisioned_score": 1,
          "total_count": "text",
          "accessed_count": "text"
        },
        "access_stats": {
          "last_used": "2025-02-20T19:03:39.969Z",
          "count": 1,
          "concrete_permissions": [
            "text"
          ],
          "canonical_permissions": [
            "text"
          ]
        },
        "risk_level": "NONE",
        "destination_node_percentage_of_total": 1,
        "permissions": [
          {
            "id": "text",
            "type": "text",
            "properties": {},
            "destination_node_count": 1,
            "engagement_access_stats": {
              "engagement_score": 1,
              "over_provisioned_score": 1,
              "total_count": "text",
              "accessed_count": "text"
            },
            "access_stats": {
              "last_used": "2025-02-20T19:03:39.969Z",
              "count": 1,
              "concrete_permissions": [
                "text"
              ],
              "canonical_permissions": [
                "text"
              ]
            },
            "risk_level": "NONE",
            "destination_node_percentage_of_total": 1,
            "permissions": [
              "[Circular Reference]"
            ],
            "destination_node_ids": [
              "text"
            ],
            "raw_permissions": [
              "text"
            ],
            "effective_permissions": [
              "text"
            ]
          }
        ],
        "destination_node_ids": [
          "text"
        ],
        "raw_permissions": [
          "text"
        ],
        "effective_permissions": [
          "text"
        ]
      },
      "destination": {
        "id": "text",
        "type": "text",
        "properties": {},
        "destination_node_count": 1,
        "engagement_access_stats": {
          "engagement_score": 1,
          "over_provisioned_score": 1,
          "total_count": "text",
          "accessed_count": "text"
        },
        "access_stats": {
          "last_used": "2025-02-20T19:03:39.969Z",
          "count": 1,
          "concrete_permissions": [
            "text"
          ],
          "canonical_permissions": [
            "text"
          ]
        },
        "risk_level": "NONE",
        "destination_node_percentage_of_total": 1,
        "permissions": [
          {
            "id": "text",
            "type": "text",
            "properties": {},
            "destination_node_count": 1,
            "engagement_access_stats": {
              "engagement_score": 1,
              "over_provisioned_score": 1,
              "total_count": "text",
              "accessed_count": "text"
            },
            "access_stats": {
              "last_used": "2025-02-20T19:03:39.969Z",
              "count": 1,
              "concrete_permissions": [
                "text"
              ],
              "canonical_permissions": [
                "text"
              ]
            },
            "risk_level": "NONE",
            "destination_node_percentage_of_total": 1,
            "permissions": [
              "[Circular Reference]"
            ],
            "destination_node_ids": [
              "text"
            ],
            "raw_permissions": [
              "text"
            ],
            "effective_permissions": [
              "text"
            ]
          }
        ],
        "destination_node_ids": [
          "text"
        ],
        "raw_permissions": [
          "text"
        ],
        "effective_permissions": [
          "text"
        ]
      },
      "results_truncated": true,
      "abstract_permissions": [
        "text"
      ],
      "concrete_permissions": [
        "text"
      ],
      "path_summary_nodes": [
        {
          "id": "text",
          "type": "text",
          "properties": {},
          "destination_node_count": 1,
          "engagement_access_stats": {
            "engagement_score": 1,
            "over_provisioned_score": 1,
            "total_count": "text",
            "accessed_count": "text"
          },
          "access_stats": {
            "last_used": "2025-02-20T19:03:39.969Z",
            "count": 1,
            "concrete_permissions": [
              "text"
            ],
            "canonical_permissions": [
              "text"
            ]
          },
          "risk_level": "NONE",
          "destination_node_percentage_of_total": 1,
          "permissions": [
            {
              "id": "text",
              "type": "text",
              "properties": {},
              "destination_node_count": 1,
              "engagement_access_stats": {
                "engagement_score": 1,
                "over_provisioned_score": 1,
                "total_count": "text",
                "accessed_count": "text"
              },
              "access_stats": {
                "last_used": "2025-02-20T19:03:39.969Z",
                "count": 1,
                "concrete_permissions": [
                  "text"
                ],
                "canonical_permissions": [
                  "text"
                ]
              },
              "risk_level": "NONE",
              "destination_node_percentage_of_total": 1,
              "permissions": [
                "[Circular Reference]"
              ],
              "destination_node_ids": [
                "text"
              ],
              "raw_permissions": [
                "text"
              ],
              "effective_permissions": [
                "text"
              ]
            }
          ],
          "destination_node_ids": [
            "text"
          ],
          "raw_permissions": [
            "text"
          ],
          "effective_permissions": [
            "text"
          ]
        }
      ]
    }
  ]
}

A successful response.

Sample request:

curl -X 'GET' "$BASE_URL/api/v1/assessments/queries/06799e24-cd93-4509-94bc-f00b27ed5e3c:nodes" \
-H "authorization: Bearer $VEZA_TOKEN"

Sample response:

{
  "values": [
    {
      "id": "arn:aws:iam::877042069677:user/j.smith",
      "type": "AwsIamUser",
      "properties": {
        "aws_account_id": "877042069677",
        "datasource_id": "877042069677:awsiam",
        "name": "j.smith",
        "provider_id": "877042069677"
      },
      "destination_node_count": 1,
      "permissions": [],
      "engagement_access_stats": null,
      "access_stats": null,
      "destination_node_ids": [],
      "risk_level": "CRITICAL",
      "raw_permissions": [],
      "effective_permissions": []
    },
    {
      "id": "arn:aws:iam::877042069677:user/jsmith-lab-01",
      "type": "AwsIamUser",
      "properties": {
        "aws_account_id": "877042069677",
        "datasource_id": "877042069677:awsiam",
        "name": "jsmith-lab-01",
        "provider_id": "877042069677"
      },
      "destination_node_count": 1,
      "permissions": [],
      "engagement_access_stats": null,
      "access_stats": null,
      "destination_node_ids": [],
      "risk_level": "CRITICAL",
      "raw_permissions": [],
      "effective_permissions": []
    }
  ],
  "path_values": [],
  "next_page_token": "",
  "has_more": false
}