Returns an inventory list of the source files associated with each library in a project
Mend API (3.0.1)
Mend's enhanced SCA API enables automation of workflows in a REST compliant format. The API features:
- Access for any user with Mend credentials, via a user key available in the user's profile page in the Mend App.
- Improved security with a JWT token per organization, which expires every 30 minutes.
- Added scalability with support for pagination, filtering and sorting search results.
- Broader functionality available programmatically.
- New standard API documentation for easy navigation and search.
If you have a dedicated instance of Mend, contact your Mend representative to access this API on your instance.
Query
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:
- between - true if the value is inside a range. Syntax: lowest value comma (,) highest value. E.g. between:2019-05-01,2019-06-01
- equals - true if the value is identical to this value.
- like - true if the property's value is contained within this value
- regex - true if this regular expression resolves as true. The regex is not case sensitive, and special characters must be escaped with a backslash. Special characters include space, double quote ("), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'. To pass an escaped character in a URL in Postman, encode it first. E.g. to return all items whose value begins with a or A, use regex:^a
- 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:
- lastModified:between:date1,date2. E.g. between:2019-05-01,2019-06-01
- libraryName:[like | equals | regex]:value
- license:[like | regex]:value
- matchType:equals:value
- name:[like | equals | regex]:value
- sha1:[like | equals | regex]:value
Sort search results alphabetically on an item's property by entering sort= followed by the property name. E.g. enter sort=email to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. sort=-email.
You can sort by the following properties:
- lastModified
- libraryName
- license
- matchType
- name
- sha1
- Generated server url
https://api-saas.mend.io/api/v2.0/projects/{projectToken}/sourceFiles/inventory
- Payload
- cURL
- JS
- Go
- Ruby
- Java 8
No request payloadOK
- 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"}
Response
application/json
{ "additionalData": { "totalItems": "422", "isLastPage": "true" }, "supportToken": "1171c60d", "retVal": [ { … } ] }
Query
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:
- between - true if the value is inside a range. Syntax: lowest value comma (,) highest value. E.g. between:2019-05-01,2019-06-01
- equals - true if the value is identical to this value.
- like - true if the property's value is contained within this value
- regex - true if this regular expression resolves as true. The regex is not case sensitive, and special characters must be escaped with a backslash. Special characters include space, double quote ("), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'. To pass an escaped character in a URL in Postman, encode it first. E.g. to return all items whose value begins with a or A, use regex:^a
- 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:
- lastModified:between:date1,date2. E.g. between:2019-05-01,2019-06-01
- libraryName:[like | equals | regex]:value
- license:[like | regex]:value
- matchType:equals:value
- name:[like | equals | regex]:value
- projectName:[like | equals | regex]:value
- sha1:[like | equals | regex]:value
Sort search results alphabetically on an item's property by entering sort= followed by the property name. E.g. enter sort=email to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. sort=-email.
You can sort by the following properties:
- lastModified
- libraryName
- license
- matchType
- name
- path
- projectName
- sha1
- Generated server url
https://api-saas.mend.io/api/v2.0/products/{productToken}/sourceFiles/inventory
- Payload
- cURL
- JS
- Go
- Ruby
- Java 8
No request payloadOK
- 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"}
Response
application/json
{ "additionalData": { "totalItems": "422", "isLastPage": "true" }, "supportToken": "1171c60d", "retVal": [ { … } ] }