Description: Deletes a Watch
Notes: For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can delete Watches using this REST API in the scope of a project, by using the additional query parameter projectKey. A Watch can include both Global and Project Policies.
Security: Requires the "Manage Watches" role to be set on the User or Group level.
Usage: DELETE /xray/api/v2/watches/{name}
Produces: application/json
Path Parameters:
Name | Type | Required/Optional | Description |
|---|---|---|---|
name | string | required | Name of the watch to be deleted |
Query Parameters:
Name | Type | Required/Optional | Description |
|---|---|---|---|
projectKey | string | optional | Project key for scoped deletion of a project watch |
Response Codes:
Status Code | Description |
|---|---|
200 | Success - Watch deleted |
403 | Failed to delete Watch |
404 | Watch not found |
500 | Failed to get Watch for delete |
500 | Failed to update block download cache |
Example Request:
DELETE /xray/api/v2/watches/my-example-watch?projectKey=myproject