arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

Get a saved query

GetAssessmentQuery retrieves a single saved query object based on the query ID.

Sample request:

curl -X 'GET' \
"$BASE_URL/api/v1/assessments/queries/0827c158-9973-444c-9ca4-b941b73528c9" \
-H "authorization: Bearer $VEZA_TOKEN"
get
Authorizations
AuthorizationstringRequired

Veza API key for authentication. Generate keys in Administration > API Keys.

Path parameters
idstringRequired
Query parameters
include_natural_languagebooleanOptional
Responses
chevron-right
200

OK

application/json
chevron-right
default

Default error response

application/json
get
/api/v1/assessments/queries/{id}
GET /api/v1/assessments/queries/{id} HTTP/1.1
Host: your-tenant.vezacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "value": {
    "id": "text",
    "name": "text",
    "description": "text",
    "result_type": 0,
    "query_type": 1,
    "raw_permissions": {
      "values": [
        "text"
      ],
      "operator": 1
    },
    "effective_permissions": {
      "values": [
        1
      ],
      "operator": 1
    },
    "variables": [
      "text"
    ],
    "source_node_types": {
      "nodes": [
        {
          "node_type": "text",
          "condition_expression": {
            "specs": [
              {
                "fn": 0,
                "property": "email",
                "value": null,
                "not": false,
                "value_property_name": "text",
                "value_property_from_other_node": true,
                "source_property": "text"
              }
            ],
            "tag_specs": [
              {
                "tag": {
                  "type": "text",
                  "key": "text",
                  "value": "text",
                  "properties": {
                    "ANY_ADDITIONAL_PROPERTY": null
                  }
                },
                "exclude": true,
                "fn": 1,
                "source_query_id": "text",
                "source_tag_key": "text"
              }
            ],
            "child_expressions": "[Circular Reference]",
            "operator": 0,
            "not": true
          },
          "node_id": "text",
          "count_condition_expression": "[Circular Reference]",
          "direct_relationship_only": true,
          "node_type_grouping_constraint": {
            "node_types": [
              "text"
            ],
            "constraint_type": 1
          },
          "properties_to_get": [
            "text"
          ],
          "tags_to_get": [
            {
              "type": 1,
              "key": "text"
            }
          ],
          "integration_types": [
            "text"
          ]
        }
      ],
      "nodes_operator": 0
    },
    "required_intermediate_node_types": {
      "nodes": [
        {
          "node_type": "text",
          "condition_expression": {
            "specs": [
              {
                "fn": 0,
                "property": "email",
                "value": null,
                "not": false,
                "value_property_name": "text",
                "value_property_from_other_node": true,
                "source_property": "text"
              }
            ],
            "tag_specs": [
              {
                "tag": {
                  "type": "text",
                  "key": "text",
                  "value": "text",
                  "properties": {
                    "ANY_ADDITIONAL_PROPERTY": null
                  }
                },
                "exclude": true,
                "fn": 1,
                "source_query_id": "text",
                "source_tag_key": "text"
              }
            ],
            "child_expressions": "[Circular Reference]",
            "operator": 0,
            "not": true
          },
          "node_id": "text",
          "count_condition_expression": "[Circular Reference]",
          "direct_relationship_only": true,
          "node_type_grouping_constraint": {
            "node_types": [
              "text"
            ],
            "constraint_type": 1
          },
          "properties_to_get": [
            "text"
          ],
          "tags_to_get": [
            {
              "type": 1,
              "key": "text"
            }
          ],
          "integration_types": [
            "text"
          ]
        }
      ],
      "nodes_operator": 0
    },
    "avoided_intermediate_node_types": {
      "nodes": [
        {
          "node_type": "text",
          "condition_expression": {
            "specs": [
              {
                "fn": 0,
                "property": "email",
                "value": null,
                "not": false,
                "value_property_name": "text",
                "value_property_from_other_node": true,
                "source_property": "text"
              }
            ],
            "tag_specs": [
              {
                "tag": {
                  "type": "text",
                  "key": "text",
                  "value": "text",
                  "properties": {
                    "ANY_ADDITIONAL_PROPERTY": null
                  }
                },
                "exclude": true,
                "fn": 1,
                "source_query_id": "text",
                "source_tag_key": "text"
              }
            ],
            "child_expressions": "[Circular Reference]",
            "operator": 0,
            "not": true
          },
          "node_id": "text",
          "count_condition_expression": "[Circular Reference]",
          "direct_relationship_only": true,
          "node_type_grouping_constraint": {
            "node_types": [
              "text"
            ],
            "constraint_type": 1
          },
          "properties_to_get": [
            "text"
          ],
          "tags_to_get": [
            {
              "type": 1,
              "key": "text"
            }
          ],
          "integration_types": [
            "text"
          ]
        }
      ],
      "nodes_operator": 0
    },
    "destination_node_types": {
      "nodes": [
        {
          "node_type": "text",
          "condition_expression": {
            "specs": [
              {
                "fn": 0,
                "property": "email",
                "value": null,
                "not": false,
                "value_property_name": "text",
                "value_property_from_other_node": true,
                "source_property": "text"
              }
            ],
            "tag_specs": [
              {
                "tag": {
                  "type": "text",
                  "key": "text",
                  "value": "text",
                  "properties": {
                    "ANY_ADDITIONAL_PROPERTY": null
                  }
                },
                "exclude": true,
                "fn": 1,
                "source_query_id": "text",
                "source_tag_key": "text"
              }
            ],
            "child_expressions": "[Circular Reference]",
            "operator": 0,
            "not": true
          },
          "node_id": "text",
          "count_condition_expression": "[Circular Reference]",
          "direct_relationship_only": true,
          "node_type_grouping_constraint": {
            "node_types": [
              "text"
            ],
            "constraint_type": 1
          },
          "properties_to_get": [
            "text"
          ],
          "tags_to_get": [
            {
              "type": 1,
              "key": "text"
            }
          ],
          "integration_types": [
            "text"
          ]
        }
      ],
      "nodes_operator": 0
    },
    "access_filter": {
      "engagement_score": {
        "op": 1,
        "value": 1
      },
      "over_provisioned_score": {
        "op": 1,
        "value": 1
      },
      "include_secondary_grantee": true,
      "include_indirect_resource": true,
      "exclude_indirect_grantee": true,
      "anomaly_detection_history_days": "text",
      "last_used": {
        "op": 1,
        "value": "2026-02-06T16:49:05.766Z",
        "target": 1,
        "relative_timevar_value": "text"
      }
    },
    "created_by": "text",
    "visibility": 1,
    "owners": [
      "text"
    ],
    "node_relationship_type": 0,
    "integration_types": [
      "text"
    ],
    "labels": [
      "text"
    ],
    "created_at": "2026-02-06T16:49:05.766Z",
    "updated_at": "2026-02-06T16:49:05.766Z",
    "source_type": "text",
    "destination_types": [
      "text"
    ],
    "relates_to_exp": {
      "specs": [
        {
          "node_types": "[Circular Reference]",
          "required_intermediate_node_types": "[Circular Reference]",
          "avoided_intermediate_node_types": "[Circular Reference]",
          "raw_permissions": {
            "values": [
              "text"
            ],
            "operator": 1
          },
          "effective_permissions": {
            "values": [
              1
            ],
            "operator": 1
          },
          "unsupported_condition_mode": 1,
          "no_relation": true,
          "direction": 1,
          "path_type": 1
        }
      ],
      "child_expressions": [
        {
          "specs": "[Circular Reference]",
          "child_expressions": "[Circular Reference]",
          "operator": 1,
          "not": true,
          "and_op_type": 1
        }
      ],
      "operator": 1,
      "not": true,
      "and_op_type": 1
    },
    "all_entity_condition": {
      "specs": [
        {
          "fn": 0,
          "property": "email",
          "value": null,
          "not": false,
          "value_property_name": "text",
          "value_property_from_other_node": true,
          "source_property": "text"
        }
      ],
      "tag_specs": [
        {
          "tag": {
            "type": "text",
            "key": "text",
            "value": "text",
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": null
            }
          },
          "exclude": true,
          "fn": 1,
          "source_query_id": "text",
          "source_tag_key": "text"
        }
      ],
      "child_expressions": [
        {
          "specs": [
            {
              "fn": 0,
              "property": "email",
              "value": null,
              "not": false,
              "value_property_name": "text",
              "value_property_from_other_node": true,
              "source_property": "text"
            }
          ],
          "tag_specs": [
            {
              "tag": {
                "type": "text",
                "key": "text",
                "value": "text",
                "properties": {
                  "ANY_ADDITIONAL_PROPERTY": null
                }
              },
              "exclude": true,
              "fn": 1,
              "source_query_id": "text",
              "source_tag_key": "text"
            }
          ],
          "child_expressions": [
            "[Circular Reference]"
          ],
          "operator": 0,
          "not": true
        }
      ],
      "operator": 0,
      "not": true
    },
    "path_summary_node_types": {
      "nodes": [
        {
          "node_type": "text",
          "condition_expression": {
            "specs": [
              {
                "fn": 0,
                "property": "email",
                "value": null,
                "not": false,
                "value_property_name": "text",
                "value_property_from_other_node": true,
                "source_property": "text"
              }
            ],
            "tag_specs": [
              {
                "tag": {
                  "type": "text",
                  "key": "text",
                  "value": "text",
                  "properties": {
                    "ANY_ADDITIONAL_PROPERTY": null
                  }
                },
                "exclude": true,
                "fn": 1,
                "source_query_id": "text",
                "source_tag_key": "text"
              }
            ],
            "child_expressions": "[Circular Reference]",
            "operator": 0,
            "not": true
          },
          "node_id": "text",
          "count_condition_expression": "[Circular Reference]",
          "direct_relationship_only": true,
          "node_type_grouping_constraint": {
            "node_types": [
              "text"
            ],
            "constraint_type": 1
          },
          "properties_to_get": [
            "text"
          ],
          "tags_to_get": [
            {
              "type": 1,
              "key": "text"
            }
          ],
          "integration_types": [
            "text"
          ]
        }
      ],
      "nodes_operator": 0
    },
    "path_summary_count_conditions": {
      "conditions": [
        {
          "fn": 1,
          "value": "text",
          "value_as": 1
        }
      ]
    },
    "risk_level": 0,
    "risk_suppressed_constraints": {
      "nodes": [
        {
          "node_type": "text",
          "condition_expression": {
            "specs": [
              {
                "fn": 0,
                "property": "email",
                "value": null,
                "not": false,
                "value_property_name": "text",
                "value_property_from_other_node": true,
                "source_property": "text"
              }
            ],
            "tag_specs": [
              {
                "tag": {
                  "type": "text",
                  "key": "text",
                  "value": "text",
                  "properties": {
                    "ANY_ADDITIONAL_PROPERTY": null
                  }
                },
                "exclude": true,
                "fn": 1,
                "source_query_id": "text",
                "source_tag_key": "text"
              }
            ],
            "child_expressions": "[Circular Reference]",
            "operator": 0,
            "not": true
          },
          "node_id": "text",
          "count_condition_expression": "[Circular Reference]",
          "direct_relationship_only": true,
          "node_type_grouping_constraint": {
            "node_types": [
              "text"
            ],
            "constraint_type": 1
          },
          "properties_to_get": [
            "text"
          ],
          "tags_to_get": [
            {
              "type": 1,
              "key": "text"
            }
          ],
          "integration_types": [
            "text"
          ]
        }
      ]
    },
    "analysis_type": 1,
    "result": 1,
    "result_evaluated_at": "2026-02-06T16:49:05.766Z",
    "result_evaluated": true,
    "risk_explanation": "text",
    "risk_remediation": "text",
    "updated_by": "text",
    "natural_language": "text",
    "result_enrichment": {
      "join_node_specs": [
        {
          "with": "text",
          "node_spec": "[Circular Reference]",
          "as": "text"
        }
      ],
      "outlier_detection": {
        "type": 1,
        "manager_centric_config": {
          "grouping_properties": [
            {
              "property_name": "text",
              "node_type": "text",
              "target": 1,
              "joined_node_alias": "text"
            }
          ],
          "threshold": 1
        }
      },
      "include_associated_risks": true,
      "risks_filter": "text"
    },
    "change_source": 1,
    "uneditable": true,
    "approx_total_source_nodes_count": "text",
    "include_sub_permissions": true,
    "save_mode": 1,
    "vql_query": "text",
    "source_type_integration": "text",
    "shared": true,
    "team_id": "text",
    "include_permissions_summary": true,
    "risk_statistics": {
      "affected_node_count": "text",
      "suppressed_node_count": "text",
      "last_occurred_at": "2026-02-06T16:49:05.766Z",
      "status": 1
    },
    "risk_profiles": [
      0
    ],
    "internal_id": "text",
    "waypoint_nodes": {
      "nodes": [
        {
          "node_type": "text",
          "condition_expression": {
            "specs": [
              {
                "fn": 0,
                "property": "email",
                "value": null,
                "not": false,
                "value_property_name": "text",
                "value_property_from_other_node": true,
                "source_property": "text"
              }
            ],
            "tag_specs": [
              {
                "tag": {
                  "type": "text",
                  "key": "text",
                  "value": "text",
                  "properties": {
                    "ANY_ADDITIONAL_PROPERTY": null
                  }
                },
                "exclude": true,
                "fn": 1,
                "source_query_id": "text",
                "source_tag_key": "text"
              }
            ],
            "child_expressions": "[Circular Reference]",
            "operator": 0,
            "not": true
          },
          "node_id": "text",
          "count_condition_expression": "[Circular Reference]",
          "direct_relationship_only": true,
          "node_type_grouping_constraint": {
            "node_types": [
              "text"
            ],
            "constraint_type": 1
          },
          "properties_to_get": [
            "text"
          ],
          "tags_to_get": [
            {
              "type": 1,
              "key": "text"
            }
          ],
          "integration_types": [
            "text"
          ]
        }
      ],
      "nodes_operator": 0
    },
    "optional": true,
    "union_specs": [
      {
        "query_type": 1,
        "source_node_types": {
          "nodes": [
            {
              "node_type": "text",
              "condition_expression": {
                "specs": [
                  {
                    "fn": 0,
                    "property": "email",
                    "value": null,
                    "not": false,
                    "value_property_name": "text",
                    "value_property_from_other_node": true,
                    "source_property": "text"
                  }
                ],
                "tag_specs": [
                  {
                    "tag": {
                      "type": "text",
                      "key": "text",
                      "value": "text",
                      "properties": {
                        "ANY_ADDITIONAL_PROPERTY": null
                      }
                    },
                    "exclude": true,
                    "fn": 1,
                    "source_query_id": "text",
                    "source_tag_key": "text"
                  }
                ],
                "child_expressions": "[Circular Reference]",
                "operator": 0,
                "not": true
              },
              "node_id": "text",
              "count_condition_expression": "[Circular Reference]",
              "direct_relationship_only": true,
              "node_type_grouping_constraint": {
                "node_types": [
                  "text"
                ],
                "constraint_type": 1
              },
              "properties_to_get": [
                "text"
              ],
              "tags_to_get": [
                {
                  "type": 1,
                  "key": "text"
                }
              ],
              "integration_types": [
                "text"
              ]
            }
          ],
          "nodes_operator": 0
        },
        "customized_variables": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "access_filter": {
          "engagement_score": {
            "op": 1,
            "value": 1
          },
          "over_provisioned_score": {
            "op": 1,
            "value": 1
          },
          "include_secondary_grantee": true,
          "include_indirect_resource": true,
          "exclude_indirect_grantee": true,
          "anomaly_detection_history_days": "text",
          "last_used": {
            "op": 1,
            "value": "2026-02-06T16:49:05.766Z",
            "target": 1,
            "relative_timevar_value": "text"
          }
        },
        "node_relationship_type": 1,
        "relates_to_exp": {
          "specs": "[Circular Reference]",
          "child_expressions": "[Circular Reference]",
          "operator": 1,
          "not": true,
          "and_op_type": 1
        },
        "path_summary_node_types": {
          "nodes": [
            {
              "node_type": "text",
              "condition_expression": {
                "specs": [
                  {
                    "fn": 0,
                    "property": "email",
                    "value": null,
                    "not": false,
                    "value_property_name": "text",
                    "value_property_from_other_node": true,
                    "source_property": "text"
                  }
                ],
                "tag_specs": [
                  {
                    "tag": {
                      "type": "text",
                      "key": "text",
                      "value": "text",
                      "properties": {
                        "ANY_ADDITIONAL_PROPERTY": null
                      }
                    },
                    "exclude": true,
                    "fn": 1,
                    "source_query_id": "text",
                    "source_tag_key": "text"
                  }
                ],
                "child_expressions": "[Circular Reference]",
                "operator": 0,
                "not": true
              },
              "node_id": "text",
              "count_condition_expression": "[Circular Reference]",
              "direct_relationship_only": true,
              "node_type_grouping_constraint": {
                "node_types": [
                  "text"
                ],
                "constraint_type": 1
              },
              "properties_to_get": [
                "text"
              ],
              "tags_to_get": [
                {
                  "type": 1,
                  "key": "text"
                }
              ],
              "integration_types": [
                "text"
              ]
            }
          ],
          "nodes_operator": 0
        },
        "all_entity_condition": {
          "specs": [
            {
              "fn": 0,
              "property": "email",
              "value": null,
              "not": false,
              "value_property_name": "text",
              "value_property_from_other_node": true,
              "source_property": "text"
            }
          ],
          "tag_specs": [
            {
              "tag": {
                "type": "text",
                "key": "text",
                "value": "text",
                "properties": {
                  "ANY_ADDITIONAL_PROPERTY": null
                }
              },
              "exclude": true,
              "fn": 1,
              "source_query_id": "text",
              "source_tag_key": "text"
            }
          ],
          "child_expressions": [
            {
              "specs": [
                {
                  "fn": 0,
                  "property": "email",
                  "value": null,
                  "not": false,
                  "value_property_name": "text",
                  "value_property_from_other_node": true,
                  "source_property": "text"
                }
              ],
              "tag_specs": [
                {
                  "tag": {
                    "type": "text",
                    "key": "text",
                    "value": "text",
                    "properties": {
                      "ANY_ADDITIONAL_PROPERTY": null
                    }
                  },
                  "exclude": true,
                  "fn": 1,
                  "source_query_id": "text",
                  "source_tag_key": "text"
                }
              ],
              "child_expressions": [
                "[Circular Reference]"
              ],
              "operator": 0,
              "not": true
            }
          ],
          "operator": 0,
          "not": true
        },
        "path_summary_count_conditions": {
          "conditions": [
            {
              "fn": 1,
              "value": "text",
              "value_as": 1
            }
          ]
        },
        "waypoint_nodes": {
          "nodes": [
            {
              "node_type": "text",
              "condition_expression": {
                "specs": [
                  {
                    "fn": 0,
                    "property": "email",
                    "value": null,
                    "not": false,
                    "value_property_name": "text",
                    "value_property_from_other_node": true,
                    "source_property": "text"
                  }
                ],
                "tag_specs": [
                  {
                    "tag": {
                      "type": "text",
                      "key": "text",
                      "value": "text",
                      "properties": {
                        "ANY_ADDITIONAL_PROPERTY": null
                      }
                    },
                    "exclude": true,
                    "fn": 1,
                    "source_query_id": "text",
                    "source_tag_key": "text"
                  }
                ],
                "child_expressions": "[Circular Reference]",
                "operator": 0,
                "not": true
              },
              "node_id": "text",
              "count_condition_expression": "[Circular Reference]",
              "direct_relationship_only": true,
              "node_type_grouping_constraint": {
                "node_types": [
                  "text"
                ],
                "constraint_type": 1
              },
              "properties_to_get": [
                "text"
              ],
              "tags_to_get": [
                {
                  "type": 1,
                  "key": "text"
                }
              ],
              "integration_types": [
                "text"
              ]
            }
          ],
          "nodes_operator": 0
        },
        "additional_spec_properties": {}
      }
    ]
  }
}