Get Licenses

Xray REST APIs

Products
JFrog Xray
Content Type
REST API

Description: Returns all compliance licenses with their respective category

Since: 3.123.x

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

Usage: GET /api/v1/licensesNames

Produces: application/JSON

Response Body:

Name

Type

Description

name

string

Name of the license

full_name

string

The full name of the license

aliases

array

The aliases of the license

category

string

Category: Empty value is uncategorized

priority

int

default_priority

int

references

array

The references to the license

isCustom

bool

This property explains whether it's a custom license or not

Response codes:

Status code

Description

200

Success - Licenses Data Returned

400

Failed to retrieve Licenses

403

Permission denied

Sample Response

[
{
"name": "Afmparse",
       "full_name": "Afmparse License",
       "references": [
"https://fedoraproject.org/wiki/Licensing/Afmparse",
"https://spdx.org/licenses/Afmparse"
       ],
       "category": "Permissive",
       "priority": -1,
       "default_priority": 200,
       "isCustom": false
},
{
"name": "AGPL-1.0",
       "full_name": "Affero General Public License v1.0",
       "references": [
           "https://spdx.org/licenses/AGPL-1.0"
       ],
       "category": "Copyleft",
       "priority": -1,
       "default_priority": 500,
       "isCustom": false
}
]