Update a query

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

Update Assessment Query

put

Updates an existing saved query by ID. Partial updates are not supported; the full query object must be provided.

Required fields:

  • name: Query name
  • description: Query description
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

Request body for updating an existing assessment query.

analysis_typeinteger ยท enumOptional

This is what view was used to create the assessment query

descriptionstringRequired

Query description. Required for all update operations.

idstringOptional
include_sub_permissionsbooleanOptional
labelsstring[]Optional
namestringRequired

Query name. Required for all update operations.

no_relationbooleanOptionalDeprecated
node_relationship_typeinteger ยท enumOptional
optionalbooleanOptional
risk_explanationstringOptional
risk_profilesinteger ยท enum[]Optional
risk_remediationstringOptional
save_modeinteger ยท enumOptional
visibilityinteger ยท enumOptional
vql_querystringOptional
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?