JFrog Properties API

openapi: 3.1.0
info:
  title: JFrog Access REST Access Tokens Properties 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: Properties
  description: Set, update, and delete artifact properties
paths:
  /api/storage/{repoKey}/{itemPath}?properties:
    get:
      operationId: getItemProperties
      summary: JFrog Get Item Properties
      description: Returns properties set on an artifact or folder.
      tags:
      - Properties
      parameters:
      - name: repoKey
        in: path
        required: true
        schema:
          type: string
        description: Repository key
      - name: itemPath
        in: path
        required: true
        schema:
          type: string
        description: Item path
      responses:
        '200':
          description: Properties retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemProperties'
    put:
      operationId: setItemProperties
      summary: JFrog Set Item Properties
      description: Sets properties on an artifact or folder.
      tags:
      - Properties
      parameters:
      - name: repoKey
        in: path
        required: true
        schema:
          type: string
        description: Repository key
      - name: itemPath
        in: path
        required: true
        schema:
          type: string
        description: Item path
      - name: properties
        in: query
        required: true
        schema:
          type: string
        description: 'Properties in format: key1=value1;key2=value2'
      - name: recursive
        in: query
        schema:
          type: integer
          enum:
          - 0
          - 1
          default: 0
        description: Apply recursively to sub-paths
      responses:
        '204':
          description: Properties set successfully
    delete:
      operationId: deleteItemProperties
      summary: JFrog Delete Item Properties
      description: Removes properties from an artifact or folder.
      tags:
      - Properties
      parameters:
      - name: repoKey
        in: path
        required: true
        schema:
          type: string
        description: Repository key
      - name: itemPath
        in: path
        required: true
        schema:
          type: string
        description: Item path
      - name: properties
        in: query
        required: true
        schema:
          type: string
        description: Comma-separated list of property keys to remove
      responses:
        '204':
          description: Properties deleted
components:
  schemas:
    ItemProperties:
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        uri:
          type: string
          format: uri
  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