Update Watch

put

https://jf.example.com/xray/api/v2/watches/{name}

Updates an existing Watch. This overwrites the previous Watch configuration and replaces it with the provided parameters. The Watch name in the path takes precedence over the name in the request body.

Notes:

You cannot update the project_key property.
A Watch can include both Global and Project Policies.
For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can update a Watch in the scope of a project by using the projectKey query parameter.

Requires the 'Manage Watches' role to be set on the User or Group level.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

name

string

required

Name of the Watch to update.

Query Params

projectKey

string

Project key for scoped updates of a project Watch.

Body Params

Request body for creating or updating a Watch in Xray.

general_data

object

required

General information about the Watch.

project_resources

object

Resources the Watch monitors and their filters.

assigned_policies

array of objects

Policies assigned to the Watch.

assigned_policies

watch_recipients

array of strings

Email addresses that will receive Watch notifications.

watch_recipients

create_ticket_enabled

boolean

Indicates whether Jira ticket creation is enabled for this Watch.

ticket_profile

string

Jira profile name for ticket generation.

ticket_generation

object

Ticket generation settings for the Watch.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success - Watch was successfully updated

400Failed to update watch: Watch name is empty

403Failed to update watch: no permissions

404Failed to update the watch. Watch not found

415Failed to parse request

500Failed to update Watch