Views

Update a view

Update a saved view of the organization. Only the provided fields are changed.

put/views/{viewId}

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Path parameters

viewIdstring uuid required

The view ID

Example:00000000-0000-0000-0000-000000000000

Request body

namestring

The new name of the view

filtersobject nullable

The new filters of the view. Pass null to clear them.

widgetsstring[] nullable

The new widget IDs of the view. Pass null to clear them.

columnsstring[] nullable

The new column IDs of the view. Pass null to clear them.

groupBystring[] nullable

The new group-by keys of the view. Pass null to clear them.

Response

OK

idstring uuid required

The view ID.

namestring required

The name of the view.

keystring nullable required

The managed view key, or null for user-created views.

target'ASSETS' | 'EVENTS' | 'INTEGRATIONS' | 'ISSUES' | 'LOCATIONS' | 'PROFILES' | 'SCANS' | 'TARGETS' required

The resource the view applies to.

orderinteger required

The position of the view in the list.

filtersobject nullable required

The stored filters of the view.

widgetsstring[] required

The stored widget IDs.

columnsstring[] required

The stored column IDs.

groupBystring[] required

The stored group-by keys.

Changes

No recorded changes to this operation across all 1 revision of this API.