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 with the provided full body. Partial updates are not supported - the complete query object must be provided.

Required fields:

  • name: Query name
  • description: Query description
Authorizations
AuthorizationstringRequired

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

Path parameters
idstringRequired
Body

Request body for updating an existing assessment query. Partial updates are not supported - provide the full query object.

idstringOptional
namestringRequired

Query name. Required for all update operations.

descriptionstringRequired

Query description. Required for all update operations.

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
chevron-right
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?