Update Application Version

JFrog REST APIs

Content Type
REST API

Description: Updates the tag and/or properties of the specified application version. You can set or replace values for specific property keys.

Since: AppTrust 1.16.4

Usage: PATCH https://{{artifactory-host}}/apptrust/api/v1/applications/{{application_key}}/versions/{{version}}

Request Body:

Parameter

Type

Description

tag

string

The new tag to associate with the application version. Max length 128 characters. The tag is commonly used to represent the Git branch.

If an empty string ("") is provided, the existing tag will be removed. If the field is omitted, the tag remains unchanged.

The maximum length is 128 characters.The tag must adhere to defined format rules (alphanumeric start/end, with dashes, underscores, dots).

properties

object

An object where each key is a property name (string) and its value is an array of strings representing the values for that property.

Providing a key with an array of strings replaces any existing values for that specific key.

Providing a key with an empty array ([]) clears all values for that key, but the key itself remains. Property keys not included in this object are not affected.

delete_properties

array:string

A list of property keys (strings) to completely remove from the application version. These keys and their associated values will be deleted.

Consumes: application/json

Response Body:

Property

Type

Description

application_key

string

The unique application key.

version

string

The application version.

tag

string

The updated tag of the application version. Will be null or absent if removed.

properties

object

The update key-value map of custom properties, where each value is an array of strings. Will be an empty object if all properties were removed or never existed. Keys will cleared values are shown as an empty array [ ].

modified_by

string

The user who performed the update.

modified_at

string

The date and time when the update occurred (ISO 8601 format).

status

string

The current status of the application version.

Sample Request:

PATCH 'https://{host}.jfrog.io/apptrust/api/v1/applications/my-app/versions/1.2.3'
Content-Type: application/json
Authorization: ••••••

{
  "tag": "release/1.2.3",
  "properties": {
    "status": ["rc", "validated"],
    "deployed_to": ["staging-A", "staging-B"],
    "old_feature_flag": []
  },
  "delete_properties": ["legacy_param", "toBeDeleted"] 
}

Sample Response:

{
  "application_key": "my-app",
  "version": "1.2.3",
  "tag": "release",
  "properties": {
    "status": ["rc", "validated"],
    "tested_on": ["ubuntu20.04"],
    "old_feature_flag": [],
    "deployed_to": ["staging-A", "staging-B"]
  },
  "modified_by": "user@example.com",
  "modified_at": "2025-06-04T10:06:00Z"
}

Status Codes:

Code

Description

202

Success

400

Bad Request

401

Bad Credentials

403

Permission Denied

404

Not Found