Skip to content
SCA API 2.0
/
/
Get All Licenses

Get All Licenses

Request

Returns a list of all known licenses in the system.

Security
bearer-key
Query
pageSizestring, <= 10000
Default:"50"
pagestring
Default:"0"
searchany

Filter your search to return items whose property has a specific value. Use the syntax: property:operation:value where a colon (:) separates between property, operation and value.

  • Property: the name of the property of the item
  • Operation:
    • equals - true if the value is identical to this value.
    • like - true if the property's value is contained within this value
    • in - true if the value is identical to one of the items in this comma-separated list. E.g. in:value1,value2,value3
  • Value: the value of the property.

To combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2

This endpoint supports filtering on the following properties and its supported operators:

  • name:[equals | like | in]:value
  • spdxName:[equals | like | in]:value
  • uuid:[equals | in]:value
GET
/api/v2.0/licenses
curl -i -X GET \
  'https://api-saas.mend.io/api/v2.0/licenses?pageSize=50&page=0&search=%7Bsearch%7D' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
additionalDataobject(Provides insights into endpoint-supported pagination information.)
  • totalItems: The total count of data points returned in an API response.
  • isLastPage: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.
Example:
{
  "totalItems": "422",
  "isLastPage": "true"
}
supportTokenstring(Support Token)
Example:"1171c60d"
retValArray of objects(LicenseDTO)
Response
{
  "additionalData": {
    "totalItems": "422",
    "isLastPage": "true"
  },
  "supportToken": "1171c60d",
  "retVal": [
    { … }
  ]
}