Update a query

UpdateAssessmentQuery updates an existing saved query by id, with the provided full body. Partial updates are not currently supported.

put
Authorizations
AuthorizationstringRequired

Bearer token authentication using a Veza Personal API key.

Header Format: Authorization: Bearer <your-api-key>

Creating an API Key:

  1. Log into your Veza tenant
  2. Navigate to Administration โ†’ API Keys
  3. Generate a new API key and save the value securely
Path parameters
idstringRequired
Body
idstringOptional
namestringOptional
descriptionstringOptional
no_relationbooleanOptionalDeprecated
visibilityinteger ยท enumOptional
node_relationship_typeinteger ยท enumOptional
labelsstring[]Optional
analysis_typeinteger ยท enumOptional

This is what view was used to create the assessment query

risk_explanationstringOptional
risk_remediationstringOptional
include_sub_permissionsbooleanOptional
save_modeinteger ยท enumOptional
vql_querystringOptional
risk_profilesinteger ยท enum[]Optional
optionalbooleanOptional
Responses
200

OK

application/json
put
/api/v1/assessments/queries/{id}

Sample request:

See create query and query parameters for more details on the saved query object.

  • {id} (path) - string - ID of the query to modify.

Sample response:

A successful response will include the query details within a value object:

Last updated

Was this helpful?