Set License Priority

Xray REST APIs

Products
JFrog Xray
Content Type
REST API

Description: Set a custom priority for a specific license for license conclusion.

Notes: Supported from Xray Version 3.123.0 and above

Security: Requires the "Manage Data" role to be set on the User or Group level.

Usage: POST /api/v1/licensesNames/priorities

Consumes: application/json

Produces: application/json

Query parameters: none

Request body:

Name

Type

Required/Optional

Description

key

string

Required

The license key to assign a custom priority

priority

integer

Required

The custom assigned priority

Response body:

Name

Type

Required/Optional

Description

info

string

Required

Info message about the operation result

Response codes:

Status code

Description

200

Success - Set license priority

400

Failed to set priority to license

403

Permission denied

Sample Request

{
  "key": "Apache-2.0",
  "priority": 198
}

Sample Response

{
  "info": "License priority have been set successfully to the license key 'Apache-2.0'. New priority:198."
}