List saved queries

ListAssessmentQueries retrieves a list of all built-in and user-created queries.

By default, this endpoint returns only the queries that are currently enabled. When the risks_only parameter is set to true, it will only return queries with a risk level.

GET/api/v1/assessments/queries

Query parameters

Response

200default

OK

Body

application/json

valuesarray of AssessmentQuery (object)

next_page_tokenstring

The pagination token to retrieve the next page of results.

has_moreboolean

If true, more results are available.

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/assessments/queries', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "values": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "raw_permissions": {
        "values": [
          "text"
        ]
      },
      "effective_permissions": {
        "values": []
      },
      "variables": [
        "text"
      ],
      "source_node_types": {
        "nodes": [
          {
            "node_type": "text",
            "tags": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "condition_expression": {
              "specs": [
                {
                  "property": "text",
                  "not": false,
                  "value_property_name": "text",
                  "value_property_from_other_node": false
                }
              ],
              "child_expressions": [],
              "not": false
            },
            "node_id": "text",
            "excluded_tags": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "count_conditions": [
              {
                "value": "text"
              }
            ],
            "direct_relationship_only": false,
            "node_type_grouping_constraint": {
              "node_types": [
                "text"
              ]
            },
            "properties_to_get": [
              "text"
            ]
          }
        ]
      },
      "required_intermediate_node_types": {
        "nodes": [
          {
            "node_type": "text",
            "tags": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "condition_expression": {
              "specs": [
                {
                  "property": "text",
                  "not": false,
                  "value_property_name": "text",
                  "value_property_from_other_node": false
                }
              ],
              "child_expressions": [],
              "not": false
            },
            "node_id": "text",
            "excluded_tags": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "count_conditions": [
              {
                "value": "text"
              }
            ],
            "direct_relationship_only": false,
            "node_type_grouping_constraint": {
              "node_types": [
                "text"
              ]
            },
            "properties_to_get": [
              "text"
            ]
          }
        ]
      },
      "avoided_intermediate_node_types": {
        "nodes": [
          {
            "node_type": "text",
            "tags": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "condition_expression": {
              "specs": [
                {
                  "property": "text",
                  "not": false,
                  "value_property_name": "text",
                  "value_property_from_other_node": false
                }
              ],
              "child_expressions": [],
              "not": false
            },
            "node_id": "text",
            "excluded_tags": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "count_conditions": [
              {
                "value": "text"
              }
            ],
            "direct_relationship_only": false,
            "node_type_grouping_constraint": {
              "node_types": [
                "text"
              ]
            },
            "properties_to_get": [
              "text"
            ]
          }
        ]
      },
      "destination_node_types": {
        "nodes": [
          {
            "node_type": "text",
            "tags": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "condition_expression": {
              "specs": [
                {
                  "property": "text",
                  "not": false,
                  "value_property_name": "text",
                  "value_property_from_other_node": false
                }
              ],
              "child_expressions": [],
              "not": false
            },
            "node_id": "text",
            "excluded_tags": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "count_conditions": [
              {
                "value": "text"
              }
            ],
            "direct_relationship_only": false,
            "node_type_grouping_constraint": {
              "node_types": [
                "text"
              ]
            },
            "properties_to_get": [
              "text"
            ]
          }
        ]
      },
      "access_filter": {
        "engagement_score": {},
        "over_provisioned_score": {},
        "include_secondary_grantee": false,
        "include_indirect_resource": false
      },
      "created_by": "text",
      "owners": [
        "text"
      ],
      "integration_types": [
        "text"
      ],
      "labels": [
        "text"
      ],
      "created_at": "2024-11-18T06:00:19.243Z",
      "updated_at": "2024-11-18T06:00:19.243Z",
      "source_type": "text",
      "destination_types": [
        "text"
      ],
      "relates_to_exp": {
        "specs": [
          {
            "node_types": {
              "nodes": [
                {
                  "node_type": "text",
                  "tags": [
                    {
                      "key": "text",
                      "value": "text"
                    }
                  ],
                  "condition_expression": {
                    "specs": [
                      {
                        "property": "text",
                        "not": false,
                        "value_property_name": "text",
                        "value_property_from_other_node": false
                      }
                    ],
                    "child_expressions": [],
                    "not": false
                  },
                  "node_id": "text",
                  "excluded_tags": [
                    {
                      "key": "text",
                      "value": "text"
                    }
                  ],
                  "count_conditions": [
                    {
                      "value": "text"
                    }
                  ],
                  "direct_relationship_only": false,
                  "node_type_grouping_constraint": {
                    "node_types": [
                      "text"
                    ]
                  },
                  "properties_to_get": [
                    "text"
                  ]
                }
              ]
            },
            "required_intermediate_node_types": {
              "nodes": [
                {
                  "node_type": "text",
                  "tags": [
                    {
                      "key": "text",
                      "value": "text"
                    }
                  ],
                  "condition_expression": {
                    "specs": [
                      {
                        "property": "text",
                        "not": false,
                        "value_property_name": "text",
                        "value_property_from_other_node": false
                      }
                    ],
                    "child_expressions": [],
                    "not": false
                  },
                  "node_id": "text",
                  "excluded_tags": [
                    {
                      "key": "text",
                      "value": "text"
                    }
                  ],
                  "count_conditions": [
                    {
                      "value": "text"
                    }
                  ],
                  "direct_relationship_only": false,
                  "node_type_grouping_constraint": {
                    "node_types": [
                      "text"
                    ]
                  },
                  "properties_to_get": [
                    "text"
                  ]
                }
              ]
            },
            "avoided_intermediate_node_types": {
              "nodes": [
                {
                  "node_type": "text",
                  "tags": [
                    {
                      "key": "text",
                      "value": "text"
                    }
                  ],
                  "condition_expression": {
                    "specs": [
                      {
                        "property": "text",
                        "not": false,
                        "value_property_name": "text",
                        "value_property_from_other_node": false
                      }
                    ],
                    "child_expressions": [],
                    "not": false
                  },
                  "node_id": "text",
                  "excluded_tags": [
                    {
                      "key": "text",
                      "value": "text"
                    }
                  ],
                  "count_conditions": [
                    {
                      "value": "text"
                    }
                  ],
                  "direct_relationship_only": false,
                  "node_type_grouping_constraint": {
                    "node_types": [
                      "text"
                    ]
                  },
                  "properties_to_get": [
                    "text"
                  ]
                }
              ]
            },
            "raw_permissions": {
              "values": [
                "text"
              ]
            },
            "effective_permissions": {
              "values": []
            },
            "no_relation": false
          }
        ],
        "child_expressions": [],
        "not": false
      },
      "all_entity_condition": {
        "specs": [
          {
            "property": "text",
            "not": false,
            "value_property_name": "text",
            "value_property_from_other_node": false
          }
        ],
        "child_expressions": [],
        "not": false
      },
      "path_summary_node_types": {
        "nodes": [
          {
            "node_type": "text",
            "tags": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "condition_expression": {
              "specs": [
                {
                  "property": "text",
                  "not": false,
                  "value_property_name": "text",
                  "value_property_from_other_node": false
                }
              ],
              "child_expressions": [],
              "not": false
            },
            "node_id": "text",
            "excluded_tags": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "count_conditions": [
              {
                "value": "text"
              }
            ],
            "direct_relationship_only": false,
            "node_type_grouping_constraint": {
              "node_types": [
                "text"
              ]
            },
            "properties_to_get": [
              "text"
            ]
          }
        ]
      },
      "path_summary_count_conditions": {
        "conditions": [
          {
            "value": "text"
          }
        ]
      },
      "risk_suppressed_constraints": {
        "nodes": [
          {
            "node_type": "text",
            "tags": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "condition_expression": {
              "specs": [
                {
                  "property": "text",
                  "not": false,
                  "value_property_name": "text",
                  "value_property_from_other_node": false
                }
              ],
              "child_expressions": [],
              "not": false
            },
            "node_id": "text",
            "excluded_tags": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "count_conditions": [
              {
                "value": "text"
              }
            ],
            "direct_relationship_only": false,
            "node_type_grouping_constraint": {
              "node_types": [
                "text"
              ]
            },
            "properties_to_get": [
              "text"
            ]
          }
        ]
      },
      "result_evaluated_at": "2024-11-18T06:00:19.243Z",
      "result_evaluated": false,
      "risk_explanation": "text",
      "risk_remediation": "text"
    }
  ],
  "next_page_token": "text",
  "has_more": false
}

Sample request

curl -X 'GET' \
"$BASE_URL/api/v1/assessments/queries?page_size=1&risks_only=true&filter=name+co+%22User%22" \
-H "authorization: Bearer $VEZA_TOKEN"

Sample response:

{
  "values": [
    {
      "id": "95ccaca3-c9f6-4711-9219-887e5c102701",
      "name": "AWS IAM Groups with iam:CreateAccessKey permission",
      "description": "AWS IAM Groups with iam:CreateAccessKey permission",
      "result_type": "NUMBER",
      "query_type": "SYSTEM_CREATED",
      "raw_permissions": {
        "values": [],
        "operator": "AND"
      },
      "effective_permissions": {
        "values": [],
        "operator": "AND"
      },
      "variables": [
        "AWS_ACCOUNT_LIST"
      ],
      "source_node_types": {
        "nodes": [
          {
            "node_type": "AwsIamGroup",
            "tags": [],
            "conditions": [],
            "condition_expression": {
              "specs": [
                {
                  "fn": "IN",
                  "property": "aws_account_id",
                  "value": [
                    "527398259632",
                    "877042069677",
                    "340069577982",
                    "241721837758",
                    "998048473876",
                    "973979857296"
                  ],
                  "not": false,
                  "value_property_name": "",
                  "value_property_from_other_node": false
                }
              ],
              "child_expressions": [],
              "operator": "AND",
              "not": false
            },
            "node_id": "",
            "excluded_tags": [],
            "count_conditions": [],
            "direct_relationship_only": false,
            "node_type_grouping_constraint": null
          }
        ],
        "nodes_operator": "AND"
      },
      "required_intermediate_node_types": {
        "nodes": [],
        "nodes_operator": "AND"
      },
      "avoided_intermediate_node_types": {
        "nodes": [],
        "nodes_operator": "AND"
      },
      "destination_node_types": {
        "nodes": [],
        "nodes_operator": "AND"
      },
      "no_relation": false,
      "access_filter": null,
      "created_by": "",
      "visibility": "PUBLIC",
      "owners": [],
      "node_relationship_type": "CONFIGURED",
      "integration_types": [
        "aws"
      ],
      "labels": [],
      "created_at": "2023-02-01T04:32:18.126875729Z",
      "updated_at": "2023-04-07T16:00:52.761867936Z",
      "source_type": "AwsIamGroup",
      "destination_types": [],
      "relates_to_exp": {
        "specs": [
          {
            "node_types": {
              "nodes": [
                {
                  "node_type": "AwsIamGroupedPermission",
                  "tags": [],
                  "conditions": [],
                  "condition_expression": {
                    "specs": [
                      {
                        "fn": "LIST_CONTAINS",
                        "property": "permissions",
                        "value": "iam:CreateAccessKey",
                        "not": false,
                        "value_property_name": "",
                        "value_property_from_other_node": false
                      },
                      {
                        "fn": "EXISTS",
                        "property": "deny",
                        "value": null,
                        "not": true,
                        "value_property_name": "",
                        "value_property_from_other_node": false
                      }
                    ],
                    "child_expressions": [],
                    "operator": "AND",
                    "not": false
                  },
                  "node_id": "",
                  "excluded_tags": [],
                  "count_conditions": [],
                  "direct_relationship_only": false,
                  "node_type_grouping_constraint": null
                }
              ],
              "nodes_operator": "AND"
            },
            "required_intermediate_node_types": null,
            "avoided_intermediate_node_types": null,
            "raw_permissions": null,
            "effective_permissions": null,
            "no_relation": false,
            "direction": "ANY_DIRECTION"
          }
        ],
        "child_expressions": [],
        "operator": "AND",
        "not": false,
        "and_op_type": "INFERRED"
      },
      "all_entity_condition": {
        "specs": [],
        "child_expressions": [],
        "operator": "AND",
        "not": false
      },
      "risk_level": "WARNING",
      "risk_suppressed_constraints": null,
      "analysis_type": "UNSET",
      "result": 0,
      "result_evaluated_at": null,
      "result_evaluated": false
    }
  ],
  "next_page_token": "eyJOZXh0Q3Vy==",
  "has_more": true
}

See Parameters for more information about the saved query object.