JFrog Watches API

Watch policies for monitoring artifacts

Operations 5

GET /v2/watches JFrog List Watches #
POST /v2/watches JFrog Create Watch #
GET /v2/watches/{watchName} JFrog Get Watch #
PUT /v2/watches/{watchName} JFrog Update Watch #
DELETE /v2/watches/{watchName} JFrog Delete Watch #

Documentation

📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/Artifactory+REST+API
📖
Authentication
https://www.jfrog.com/confluence/display/JFROG/Access+Tokens
📖
GettingStarted
https://jfrog.com/help/r/jfrog-artifactory-documentation/use-the-rest-api
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/artifactory-rest-api-v2
📖
Authentication
https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-tokens
📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/Xray+REST+API
📖
GettingStarted
https://jfrog.com/help/r/xray-rest-apis/introduction-to-the-xray-rest-apis
📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/Distribution+REST+API
📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/Pipelines+REST+API
📖
GettingStarted
https://jfrog.com/help/r/jfrog-rest-apis/introduction-to-the-pipelines-rest-apis
📖
Documentation
https://www.jfrog.com/confluence/display/JFROG/JFrog+Platform+REST+API
📖
GettingStarted
https://jfrog.com/help/r/jfrog-rest-apis/introduction-to-the-jfrog-platform-rest-apis
📖
Documentation
https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-token-rest-api
📖
GettingStarted
https://jfrog.com/help/r/jfrog-platform-administration-documentation/introduction-to-access-tokens
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/jfrog-curation-rest-apis
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/mission-control-rest-apis
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/release-lifecycle-management
📖
Documentation
https://jfrog.com/help/r/jfrog-rest-apis/workers-rest-apis
📖
Documentation
https://jfrog.com/help/r/jfrog-ml-documentation/jfrog-ml-rest-api
📖
Documentation
https://docs.connect.jfrog.io/rest-api-v2/connect-api-reference
📖
Authentication
https://docs.connect.jfrog.io/developers
📖
Documentation
https://jfrog.com/help/r/jfrog-security-user-guide/products/catalog
📖
Documentation
https://jfrog.com/help/r/jfrog-artifactory-documentation/create-evidence-using-rest-apis

Specifications

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/jfrog-watches-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

jfrog-watches-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: JFrog Xray REST Watches API
  description: API for vulnerability scanning, license compliance, and impact analysis. JFrog Xray provides universal software composition analysis (SCA) that natively integrates with Artifactory to scan artifacts for known vulnerabilities, license compliance violations, and operational risks.
  version: 3.x
  contact:
    name: JFrog
    url: https://jfrog.com
  license:
    name: Proprietary
    url: https://jfrog.com/terms-of-service/
  termsOfService: https://jfrog.com/terms-of-service/
servers:
- url: https://{server}.jfrog.io/xray/api
  description: JFrog Cloud
  variables:
    server:
      default: myserver
      description: Your JFrog server name
- url: https://{host}/xray/api
  description: Self-hosted JFrog instance
  variables:
    host:
      default: localhost:8082
      description: Your self-hosted JFrog server host
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Watches
  description: Watch policies for monitoring artifacts
paths:
  /v2/watches:
    get:
      operationId: listWatches
      summary: JFrog List Watches
      description: Returns a list of all configured watches.
      tags:
      - Watches
      responses:
        '200':
          description: Watches list retrieved
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Watch'
    post:
      operationId: createWatch
      summary: JFrog Create Watch
      description: Creates a new watch for monitoring artifacts.
      tags:
      - Watches
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Watch'
      responses:
        '201':
          description: Watch created
        '400':
          description: Invalid watch configuration
  /v2/watches/{watchName}:
    get:
      operationId: getWatch
      summary: JFrog Get Watch
      description: Returns configuration for a specific watch.
      tags:
      - Watches
      parameters:
      - name: watchName
        in: path
        required: true
        schema:
          type: string
        description: Watch name
      responses:
        '200':
          description: Watch details retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Watch'
    put:
      operationId: updateWatch
      summary: JFrog Update Watch
      description: Updates an existing watch configuration.
      tags:
      - Watches
      parameters:
      - name: watchName
        in: path
        required: true
        schema:
          type: string
        description: Watch name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Watch'
      responses:
        '200':
          description: Watch updated
    delete:
      operationId: deleteWatch
      summary: JFrog Delete Watch
      description: Removes a watch configuration.
      tags:
      - Watches
      parameters:
      - name: watchName
        in: path
        required: true
        schema:
          type: string
        description: Watch name
      responses:
        '200':
          description: Watch deleted
components:
  schemas:
    Watch:
      type: object
      properties:
        general_data:
          type: object
          properties:
            name:
              type: string
            description:
              type: string
            active:
              type: boolean
        project_resources:
          type: object
          properties:
            resources:
              type: array
              items:
                type: object
                properties:
                  type:
                    type: string
                    enum:
                    - repository
                    - build
                    - all-repos
                    - all-builds
                  name:
                    type: string
                  bin_mgr_id:
                    type: string
                  filters:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - regex
                          - package-type
                          - path-regex
                          - mime-type
                        value:
                          type: string
        assigned_policies:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
                enum:
                - security
                - license
                - operational_risk
      required:
      - general_data
      - project_resources
      - assigned_policies
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token authentication
    basicAuth:
      type: http
      scheme: basic
      description: Basic username/password authentication
externalDocs:
  description: JFrog Xray REST API Documentation
  url: https://www.jfrog.com/confluence/display/JFROG/Xray+REST+API