JFrog Updates API

openapi: 3.1.0
info:
  title: JFrog Access REST Access Tokens Updates API
  description: API for managing users, groups, permissions, projects, and access tokens across the JFrog Platform. JFrog Access handles identity management, role-based access control, federated identity, and scoped token creation for authentication and authorization across all JFrog services.
  version: 2.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/access
  description: JFrog Cloud
  variables:
    server:
      default: myserver
      description: Your JFrog server name
- url: https://{host}/access
  description: Self-hosted JFrog instance
  variables:
    host:
      default: localhost:8082
      description: Your self-hosted JFrog server host
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Updates
  description: OTA software update deployments
paths:
  /projects/{projectId}/updates:
    get:
      operationId: listUpdates
      summary: JFrog List Updates
      description: Returns a list of all OTA update deployments.
      tags:
      - Updates
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
        description: Project ID
      - name: status
        in: query
        schema:
          type: string
          enum:
          - pending
          - in_progress
          - completed
          - failed
          - cancelled
        description: Filter by update status
      responses:
        '200':
          description: Updates list
          content:
            application/json:
              schema:
                type: object
                properties:
                  updates:
                    type: array
                    items:
                      $ref: '#/components/schemas/Update'
    post:
      operationId: createUpdate
      summary: JFrog Create Update
      description: Creates a new OTA software update deployment.
      tags:
      - Updates
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
        description: Project ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRequest'
      responses:
        '201':
          description: Update created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Update'
  /projects/{projectId}/updates/{updateId}:
    get:
      operationId: getUpdate
      summary: JFrog Get Update
      description: Returns details and status for a specific update.
      tags:
      - Updates
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
        description: Project ID
      - name: updateId
        in: path
        required: true
        schema:
          type: string
        description: Update ID
      responses:
        '200':
          description: Update details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Update'
  /projects/{projectId}/updates/{updateId}/cancel:
    post:
      operationId: cancelUpdate
      summary: JFrog Cancel Update
      description: Cancels a pending or in-progress update.
      tags:
      - Updates
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
        description: Project ID
      - name: updateId
        in: path
        required: true
        schema:
          type: string
        description: Update ID
      responses:
        '200':
          description: Update cancelled
components:
  schemas:
    UpdateRequest:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        update_type:
          type: string
          enum:
          - file
          - script
          - package
          - docker_compose
        target_devices:
          type: array
          items:
            type: string
        target_groups:
          type: array
          items:
            type: string
        file_path:
          type: string
          description: Path to update file
        destination_path:
          type: string
          description: Destination path on device
        script_content:
          type: string
          description: Script content for script-type updates
        pre_install_script:
          type: string
        post_install_script:
          type: string
        rollback_on_failure:
          type: boolean
          default: false
        schedule:
          type: object
          properties:
            start_at:
              type: string
              format: date-time
            batch_size:
              type: integer
              description: Number of devices to update concurrently
      required:
      - name
      - update_type
    Update:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        status:
          type: string
          enum:
          - pending
          - in_progress
          - completed
          - failed
          - cancelled
        update_type:
          type: string
          enum:
          - file
          - script
          - package
          - docker_compose
        target_devices:
          type: array
          items:
            type: string
        target_groups:
          type: array
          items:
            type: string
        progress:
          type: object
          properties:
            total_devices:
              type: integer
            completed:
              type: integer
            failed:
              type: integer
            pending:
              type: integer
        created_at:
          type: string
          format: date-time
        completed_at:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token authentication
    basicAuth:
      type: http
      scheme: basic
      description: Basic username/password authentication
externalDocs:
  description: JFrog Access REST API Documentation
  url: https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-token-rest-api