Get Watches

Description: Gets a list of all watches in the system.

Notes: For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can get a list of 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: GET /xray/api/v2/watches

Consumes: None

Produces: application/json

Path Parameters: None

Query Parameters:

Request Body: None

Response Body:

WatchObj:

WatchGeneralObj:

ProjectResourcesObj

ResourceObj:

FilterObj:

PatternObj

KeyValueObj:

AssignedPolicyObj:

TicketGenerationObj:

DuplicateTicketCreationObj:

VersionTicketSettingsObj:

ImpactPathProfileMappingObj:

IncludeObj:

Response Codes

Example Response

[
  {
    "general_data": {
      "id": "5bbe364b0fe4dc29f64c25aa",
      "name": "specific-build-watch",
      "description": "This is a new watch created using API V2",
      "active": true
    },
    "project_resources": {
      "resources": [
        {
          "type": "build",
          "name": "release-pipeline"
        }
      ]
    },
    "assigned_policies": [
      {
        "name": "critial_issues",
        "type": "security"
      },
      {
        "name": "block_policy",
        "type": "security"
      }
    ]
  },
  {
    "general_data": {
      "id": "6f2s864b0fe4dc29f64r5z9m",
      "name": "all-repositories",
      "description": "This is a new watch created using API V2",
      "active": true
    },
    "project_resources": {
      "resources": [
        {
          "type": "all-repos",
          "filters": [
            {
              "type": "package-type",
              "value": "Docker"
            },
            {
              "type": "package-type",
              "value": "Debian"
            }
          ]
        }
      ]
    },
    "assigned_policies": [
      {
        "name": "critial_issues",
        "type": "security"
      }
    ]
  },
  {
    "general_data": {
      "id": "56sdf564b0fe4dc29f64cdfs564",
      "name": "vuln-prod",
      "description": "This is a new watch created using API V2",
      "active": true
    },
    "project_resources": {
      "resources": [
        {
          "type": "repository",
          "name": "libs-release-local",
          "filters": [
            {
              "type": "regex",
              "value": ".*"
            }
          ]
        }
      ]
    },
    "assigned_policies": [
      {
        "name": "medium_policy",
        "type": "security"
      }
    ],
    "create_ticket_enabled": true,
    "ticket_profile": "Profile-example",
    "ticket_generation": {
      "create_duplicate_tickets": {
        "by_version": {
          "build": false,
          "package": false,
          "release_bundle": false
        }
      },
      "impact_path_profiles_mapping": {
        "include": [
          {
            "profile": "Profile-exampleA",
            "pattern": "**a*"
          },
          {
            "profile": "Profile-exampleB",
            "pattern": "**b*"
          }
        ]
      }
    }
  }
]

Example Response - Get Watches in the Project scope

GET /xray/api/v2/watches?projectKey=myproj
[
    {
        "general_data": {
            "id": "5bbe364b0fe4dc29f64c25aa",
            "name": "specific-build-watch",
            "description": "This is a new watch created using API V2",
            "active": true,
            "project_key": "myproj"
        },
        "project_resources": {
            "resources": [
                {
                    "type": "build",
                    "name": "release-pipeline"
                }
            ]
        },
        "assigned_policies": [
            {
                "name": "critial_issues",
                "type": "security"
            },
            {
                "name": "block_policy",
                "type": "security"
            }
        ],
    "ticket_generation": {
      "create_duplicate_tickets": {
        "by_version": {
          "build": false,
          "package": false,
          "release_bundle": false
        }
      },
      "impact_path_profiles_mapping": {}
    }
  }
]