### Example Response for Get Reports Source: https://api-docs.mend.io/platform/3.0/reports/exportaccountdependencysecurityfindingsbylibraryreport This JSON response provides a list of available reports for an organization, including pagination details like total items and a cursor for fetching subsequent results. ```json { "additionalData": { "totalItems": "422", "next": "http://someUrl?cursor=3", "cursor": 3 }, "supportToken": "1171c60d", "response": [ { … } ] } ``` -------------------------------- ### Example Report Export Response Source: https://api-docs.mend.io/platform/3.0/reports/exportaccountdependencysecurityfindingsbylibraryreport This is an example of the response structure when requesting a report export. It includes a support token and details about the initiated report process. ```json { "supportToken": "1171c60d", "response": { "uuid": "string", "name": "string", "scopeUuid": "string", "scopeName": "string", "subScopes": [ … ], "title": "string", "reportType": "attribution", "format": "json", "scopeType": "organization", "status": "PENDING", "createdBy": "string", "createdAt": "2019-08-24T14:15:22Z" } } ``` -------------------------------- ### Get Product Libraries Source: https://api-docs.mend.io/sca/2.0/library-product Retrieves all libraries included in a given product. ```APIDOC ## GET /api/v2.0/products/{productToken}/libraries ### Description Returns all libraries that are included in a given product. ### Method GET ### Endpoint /api/v2.0/products/{productToken}/libraries ### Parameters #### Path Parameters - **productToken** (string) - Required - The unique identifier for the product. ### Response #### Success Response (200) (The source does not specify the response body structure.) ``` -------------------------------- ### Get Project Labels Source: https://api-docs.mend.io/platform/3.0/projects/getprojectlabels Fetches the labels for a given project. ```APIDOC ## GET /api/v3.0/orgs/{orgUuid}/projects/{projectUuid}/labels ### Description Get project labels. A label can be a string or namespace:value pair that provide additional metadata to assist with project management. ### Method GET ### Endpoint /api/v3.0/orgs/{orgUuid}/projects/{projectUuid}/labels ### Parameters #### Path Parameters - **orgUuid** (string, required) - org UUID (from the Mend App: Administration General > Organization UUID). - **projectUuid** (string, required) - UUID of the project ### Response #### Success Response (200) - **supportToken** (string) - Example: "1171c60d" - **response** (array) - **response.uuid** (string) - **response.namespace** (string) - **response.value** (string) - **response.displayName** (string) - **response.contextType** (string) - **response.system** (boolean) #### Response Example { "supportToken": "1171c60d", "response": [ { "uuid": "example-uuid", "namespace": "example-namespace", "value": "example-value", "displayName": "Example Display Name", "contextType": "example-context-type", "system": false } ] } #### Error Response (400) - **supportToken** (string) - Example: "1171c60d" ``` -------------------------------- ### Get All Licenses Source: https://api-docs.mend.io/sca/2.0/general-info-licenses Retrieves a list of all known licenses within the system. ```APIDOC ## GET /api/v2.0/licenses ### Description Returns a list of all known licenses in the system. ### Method GET ### Endpoint /api/v2.0/licenses ``` -------------------------------- ### Get Image Packages Source: https://api-docs.mend.io/container-image/2.0 Retrieves the packages installed in a specific project's images. ```APIDOC ## Get Image Packages ### Description Retrieves the packages of an image within a project. ### Method GET ### Endpoint /orguuid/{orguuid}/projects/{projectuuid}/images/packages ### Parameters #### Path Parameters - **orguuid** (string) - Required - The unique identifier for the organization. - **projectuuid** (string) - Required - The unique identifier for the project. ### Response #### Success Response (200) (Schema not provided in source) #### Error Response (Schema not provided in source) ``` -------------------------------- ### Create an application Source: https://api-docs.mend.io/sast/sast-api/applications Create a new application. ```APIDOC ## POST /api/applications ### Description Create a new application. ### Method POST ### Endpoint /api/applications ``` -------------------------------- ### Import SBOM and Create Project Source: https://api-docs.mend.io/platform/3.0/applications/createprojectwithsbomscan Imports an SBOM and creates a new project as part of the process. The SBOM scan is queued for asynchronous processing. Supported formats: SPDX (JSON/XML), CycloneDX (JSON/XML). ```APIDOC ## POST /api/v3.0/applications/{applicationUuid}/dependencies/projects/importSbom ### Description Imports an SBOM and creates a new project as part of the process. The SBOM scan is queued for asynchronous processing. Supported formats: SPDX (JSON/XML), CycloneDX (JSON/XML). ### Method POST ### Endpoint /api/v3.0/applications/{applicationUuid}/dependencies/projects/importSbom ### Parameters #### Path Parameters - **applicationUuid** (string, required) - Application UUID (Administration > Applications) #### Request Body - **projectName** (string, required) - Name of the project to create under this application - **projectDescription** (string) - Optional project description - **sbomFile** (string, required) - The SBOM file to upload (SPDX or CycloneDX). Only one file per request. ### Response #### Success Response (201) - **supportToken** (string) - Support token for tracking. Example: "1171c60d" - **project** (object) - Project information - **project.uuid** (string) - Example: "123e4567-e89b-12d3-a456-426655440000" - **project.name** (string) - Example: "My Project" - **project.path** (string) - Example: "My Application" - **project.applicationName** (string) - Example: "My Application" - **project.applicationUuid** (string) - Example: "123e4567-e89b-12d3-a456-426655440000" - **scan** (object) - Scan information - **scan.scanUuid** (string) - Scan identifier. Example: "45e0c7f0-2a64-4a1c-bb2b-22e1c4f02126" - **scan.createdAt** (string) - Scan creation timestamp. Example: "2025-10-27T18:50:05Z" - **link** (object) - Log Link - **link.logs** (string) - Link to scan logs. Example: "/api/v3.0/projects/{projectUuid}/scans/{scanUuid}/dependencies/SBOM/logs" #### Error Response (400) - **supportToken** (string) - Example: "1171c60d" #### Error Response (404) - **supportToken** (string) - Example: "1171c60d" - **response** (object) ``` -------------------------------- ### Import SBOM and create a new project (Dependencies - SCA) Source: https://api-docs.mend.io/platform/3.0/applications Imports a Software Bill of Materials (SBOM) to create a new project and initiate a Software Composition Analysis (SCA) scan. ```APIDOC ## POST /api/v3.0/applications/{applicationUuid}/dependencies/projects/importSbom ### Description Imports an SBOM and creates a new project as part of the process. The SBOM scan is queued for asynchronous processing. Supported formats: SPDX (JSON/XML), CycloneDX (JSON/XML). ### Method POST ### Endpoint /api/v3.0/applications/{applicationUuid}/dependencies/projects/importSbom ### Parameters #### Path Parameters - **applicationUuid** (string) - Required - The unique identifier of the application. #### Request Body - **sbomContent** (string) - Required - The content of the SBOM file. - **sbomFormat** (string) - Required - The format of the SBOM (e.g., SPDX, CycloneDX). - **projectName** (string) - Optional - The name for the new project. ``` -------------------------------- ### Get Organization Scan Count Per Agent Source: https://api-docs.mend.io/sca/2.0/summary-organization Returns the total number of scans in a selected period and a breakdown per agent. The selected period cannot have a start date older than 30 days before the current date, nor can it be greater than 30 days. ```APIDOC ## GET /api/v2.0/orgs/{orgToken}/summary/scanCountPerAgent ### Description Returns the total number of scans in selected period and a breakdown per agent. The selected period cannot have start date older 30 days before the current date. Also selected period cannot be greater than 30 days ### Method GET ### Endpoint /api/v2.0/orgs/{orgToken}/summary/scanCountPerAgent ### Parameters #### Path Parameters - **orgToken** (string) - Required - The unique token identifying the organization. ``` -------------------------------- ### Get a scan Source: https://api-docs.mend.io/sast/sast-api.md Get a scan by ID. ```APIDOC ## GET /api/v2/scans/{scanId} ### Description Get a scan by ID. ### Method GET ### Endpoint /api/v2/scans/{scanId} ``` -------------------------------- ### Create Project Source: https://api-docs.mend.io/sca/2.0/entities-product Creates a new project within a specified product. If the project already exists, the existing project details are returned. ```APIDOC ## POST /api/v2.0/products/{productToken}/projects ### Description Creates a new project within a given product. If the project already exists it returns the existing project. ### Method POST ### Endpoint /api/v2.0/products/{productToken}/projects ### Parameters #### Path Parameters - **productToken** (string) - Required - The unique token of the product in which to create the project. ``` -------------------------------- ### Create Project Source: https://api-docs.mend.io/sca/2.0/entities-organization/createproject_1 Creates a new project within a new product. If project name exists will return existing project. ```APIDOC ## POST /api/v2.0/orgs/{orgToken}/projects ### Description Creates a new project within a new product. If project name exists will return existing project. ### Method POST ### Endpoint /api/v2.0/orgs/{orgToken}/projects ### Parameters #### Path Parameters - **orgToken** (string, required) - org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: Integrate tab > API Key). #### Request Body - **projectName** (string, required) - Example: "Project A" - **projectDescription** (string, optional) - Example: "Description for project" - **productName** (string, optional) - Example: "Product A" ### Response #### Success Response (200) - **additionalData** (object) - Indicates whether the requested project was successfully created or if it already exists. When “true”, this signifies the project was successfully created. When “false”, this indicates the project already exists. Example: {"created":"true"} - **supportToken** (string) - Example: "1171c60d" - **retVal** (object) - **retVal.project** (object) - **retVal.project.uuid** (string) - Example: "123e4567-e89b-12d3-a456-426655440000" - **retVal.project.name** (string) - Example: "My Project" - **retVal.project.path** (string) - Example: "My Product" - **retVal.project.productName** (string) - Example: "My Product" - **retVal.project.productUuid** (string) - Example: "123e4567-e89b-12d3-a456-426655440000" - **retVal.product** (object) - **retVal.product.uuid** (string) - Example: "123e4567-e89b-12d3-a456-426655440000" - **retVal.product.name** (string) - Example: "Product A" #### Response Example { "additionalData": { "created": "true" }, "supportToken": "1171c60d", "retVal": { "project": { "uuid": "123e4567-e89b-12d3-a456-426655440000", "name": "My Project", "path": "My Product", "productName": "My Product", "productUuid": "123e4567-e89b-12d3-a456-426655440000" }, "product": { "uuid": "123e4567-e89b-12d3-a456-426655440000", "name": "Product A" } } } #### Error Response (400) - **supportToken** (string) - Example: "1171c60d" ``` -------------------------------- ### Get configuration of a scan Source: https://api-docs.mend.io/sast/sast-api.md Get configuration of a scan with an ID. ```APIDOC ## GET /api/v2/scans/{scanId}/config ### Description Get configuration of a scan with an ID. ### Method GET ### Endpoint /api/v2/scans/{scanId}/config ``` -------------------------------- ### Get Scans Response Fields Source: https://api-docs.mend.io/sast/sast-api/scans/getscans.md This snippet details the fields available in the JSON response for a successful Get Scans request. ```APIDOC ## Get Scans Response (200 OK) ### Description Details the fields returned for a successful scan retrieval. ### Response Body (application/json) - **stats** (object) - **engines** (object) - **status** (string) - Status of the scanning engine. - **statusMessage** (string) - Message providing more details about the engine status. - **terminatedByWatchDog** (boolean) - Indicates if the engine was terminated by a watchdog process. - **testedFiles** (integer) - Number of files tested by the engine. - **testedLines** (integer) - Number of lines tested by the engine. - **timeoutFiles** (array) - List of files that timed out during testing. - **totalFiles** (integer) - Total number of files processed by the engine. - **totalLines** (integer) - Total number of lines processed by the engine. - **high** (integer) - Count of high severity issues. - **low** (integer) - Count of low severity issues. - **medium** (integer) - Count of medium severity issues. - **repoDerivedTimeout** (boolean) - Indicates if a repository-derived timeout occurred. - **resources** (object) - **cpu** (integer) - CPU usage statistics. - **memory** (integer) - Memory usage statistics. - **os** (string) - Operating system information. - **testedFiles** (integer) - Total number of files tested across all engines. - **testedLines** (integer) - Total number of lines tested across all engines. - **timeoutExceeded** (boolean) - Indicates if any timeout was exceeded during the scan. - **totalFiles** (integer) - Total files in the repository. - **totalLines** (integer) - Total lines in the repository. - **totalVulnerabilities** (integer) - Total number of vulnerabilities found. - **status** (string) - Overall status of the scan. - **versionFlag** (string) - Flag indicating the version of the scanning tool. ``` -------------------------------- ### Create Product Source: https://api-docs.mend.io/sca/2.0/entities-organization/createproduct Creates a new product. If the product already exists, it returns the existing product. ```APIDOC ## POST /api/v2.0/orgs/{orgToken}/products ### Description Creates a new product. If the product already exists, it returns the existing product. ### Method POST ### Endpoint /api/v2.0/orgs/{orgToken}/products ### Parameters #### Path Parameters - **orgToken** (string, required) - org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: Integrate tab > API Key). #### Request Body - **productName** (string, required) - Example: "Product A" ### Response #### Success Response (200) - **additionalData** (object) - Example: {"created":"true"} - created: Indicates whether the requested project was successfully created or if it already exists. When “true”, this signifies the project was successfully created. When “false”, this indicates the project already exists - **supportToken** (string) - Example: "1171c60d" - **retVal** (object) - retVal.uuid (string) - Example: "123e4567-e89b-12d3-a456-426655440000" - retVal.name (string) - Example: "Product A" #### Error Response (400) - **supportToken** (string) - Example: "1171c60d" ``` -------------------------------- ### Get Application Labels Source: https://api-docs.mend.io/platform/3.0 Get application labels. A label can be a string or namespace:value pair that provide additional metadata to assist with project management. ```APIDOC ## GET /api/v3.0/orgs/{orgUuid}/applications/{applicationUuid}/labels ### Description Get application labels. A label can be a string or namespace:value pair that provide additional metadata to assist with project management. ### Method GET ### Endpoint /api/v3.0/orgs/{orgUuid}/applications/{applicationUuid}/labels ``` -------------------------------- ### Get product source files inventory Source: https://api-docs.mend.io/sca/2.0 Returns a list of libraries together with the location of their source files. ```APIDOC ## GET /api/v2.0/products/{productToken}/sourceFiles/inventory ### Description Returns a list of libraries together with the location of their source files. ### Method GET ### Endpoint /api/v2.0/products/{productToken}/sourceFiles/inventory ### Parameters #### Path Parameters - **productToken** (string) - Required - The unique identifier for the product. ``` -------------------------------- ### Get Product Projects Source: https://api-docs.mend.io/sca/2.0/entities-product/getprojects Fetches a paginated list of projects for a given product token. Supports filtering by page size and page number. ```APIDOC ## Get Product Projects ### Description Returns a list of the projects and their tokens for a given product. ### Method GET ### Endpoint /api/v2.0/products/{productToken}/projects ### Query Parameters - `pageSize` (string) - Optional - The number of items to return per page. - `page` (string) - Optional - The page number to retrieve. ### Path Parameters - `productToken` (string) - Required - The unique identifier (UUID or Token) of the product. ### Response 200 Fields (application/json) - `additionalData` (object) + `totalItems` (string) - The total count of data points returned in an API response. + `isLastPage` (string) - Defines whether the current page represents the conclusion of the API response. - `supportToken` (string) - An identifier for the support team. - `retVal` (array) - An array of project objects. - `retVal.uuid` (string) - The unique identifier of the project. - `retVal.name` (string) - The name of the project. - `retVal.path` (string) - The path of the project. - `retVal.productName` (string) - The name of the product the project belongs to. - `retVal.productUuid` (string) - The UUID of the product the project belongs to. ### Response Example (200 OK) ```json { "additionalData": { "totalItems": "422", "isLastPage": "true" }, "supportToken": "1171c60d", "retVal": [ { "uuid": "123e4567-e89b-12d3-a456-426655440000", "name": "My Project", "path": "My Product", "productName": "My Product", "productUuid": "123e4567-e89b-12d3-a456-426655440000" } ] } ``` ### Response 400 Fields (*/*) - `supportToken` (string) - An identifier for the support team. ### Response Example (400 Bad Request) ```json { "supportToken": "1171c60d" } ``` ``` -------------------------------- ### Get Project Labels Source: https://api-docs.mend.io/platform/3.0 Get project labels. A label can be a string or namespace:value pair that provide additional metadata to assist with project management. ```APIDOC ## GET /api/v3.0/orgs/{orgUuid}/projects/{projectUuid}/labels ### Description Get project labels. A label can be a string or namespace:value pair that provide additional metadata to assist with project management. ### Method GET ### Endpoint /api/v3.0/orgs/{orgUuid}/projects/{projectUuid}/labels ``` -------------------------------- ### Get Product Source Files Inventory Source: https://api-docs.mend.io/sca/2.0/library-source-files/getsourcefiles_1 Fetches a list of libraries and their source file locations for a specified product. Supports filtering, sorting, and pagination. ```APIDOC ## GET /api/v2.0/products/{productToken}/sourceFiles/inventory ### Description Returns a list of libraries together with the location of their source files. ### Method GET ### Endpoint /api/v2.0/products/{productToken}/sourceFiles/inventory ### Security bearer-key ### Parameters #### Path Parameters - **productToken** (string, required) - product UUID or Product Token. #### Query Parameters - **pageSize** (string) - Enter the number of items to return in each page of the result. - **page** (string) - Enter the page number to display in the result. Page numbers start at 0. - **search** (any) - Filter your search to return items whose property has a specific value. Use the syntax: property:operation:value. Supported properties and operators include: + lastModified:between:date1,date2 + 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** (any) - Sort search results alphabetically on an item's property. E.g. sort=libraryName or sort=-lastModified for descending order. Supported properties: lastModified, libraryName, license, matchType, name, path, projectName, sha1. ### Response #### Success Response (200) - **inventory** (array) - List of source files inventory. - **lastModified** (string) - The date the source file was last modified. - **libraryName** (string) - The name of the library. - **license** (string) - The license of the library. - **matchType** (string) - The type of match. - **name** (string) - The name of the source file. - **path** (string) - The path to the source file. - **projectName** (string) - The name of the project. - **sha1** (string) - The SHA1 hash of the source file. ``` -------------------------------- ### Get Libraries Response Source: https://api-docs.mend.io/sca/2.0/library-project/getlibraries This snippet details the structure of a successful response (200 OK) from the Get Libraries API, outlining the fields available for library information. ```APIDOC ## Response 200 (application/json) ### Description Details about the libraries, including their locations, dependency information, and workflow status. ### Fields - `retVal.locations` (array) - An array of library locations. - `retVal.locations.localPath` (string) - The local file path of the library. Example: "C:\\Users\\user\\.m2\\repository\\commons-io-1.4.jar" - `retVal.locations.dependencyFile` (string) - The path to the dependency file (e.g., pom.xml). Example: "C:\\GitHubRepos\\Pipline\\EUA\\plugins-automation\\fsa\\tests\\EUA\\Java\\bigProjectsMaven\\WST_417\\Data\\ksa\\ksa-web-core\\pom.xml" - `retVal.attributionReportSettings` (object) - Settings related to attribution reports. - `retVal.attributionReportSettings.excluded` (boolean) - Indicates if attribution reports are excluded. - `retVal.dependencyType` (string) - The type of the dependency. - `retVal.violations` (integer) - The number of violations found. Example: 22 - `retVal.workflowUuids` (array) - A list of workflow UUIDs associated with the libraries. Example: 2 - `retVal.violatingFindings` (integer) - The number of findings that are violating. Example: 2 - `retVal.trackedIssue` (object) - Information about a tracked issue. - `retVal.trackedIssue.uuid` (string) - The unique identifier for the tracked issue. - `retVal.trackedIssue.issueId` (string) - The ID of the issue. - `retVal.trackedIssue.origin` (string) - The origin of the issue. - `retVal.trackedIssue.issueKey` (string) - The key of the issue. - `retVal.trackedIssue.account` (object) - Details about the account associated with the issue. - `retVal.trackedIssue.account.uuid` (string) - The UUID of the account. - `retVal.trackedIssue.account.name` (string) - The name of the account. - `retVal.trackedIssue.domain` (object) - Details about the domain associated with the issue. - `retVal.trackedIssue.application` (object) - Details about the application associated with the issue. - `retVal.trackedIssue.project` (object) - Details about the project associated with the issue. - `retVal.trackedIssue.status` (string) - The current status of the tracked issue. Enum: "PENDING", "IN_PROGRESS", "SUCCESS", "FAILED", "DELETED" - `retVal.trackedIssue.issueStatus` (string) - The status of the issue. - `retVal.trackedIssue.failureReason` (string) - The reason for failure, if applicable. - `retVal.trackedIssue.errorMessage` (string) - An error message, if applicable. - `retVal.trackedIssue.publicLink` (string) - A public link to the issue. - `retVal.trackedIssue.creationDate` (string) - The date the issue was created. - `retVal.trackedIssue.updatedAt` (string) - The date the issue was last updated. - `retVal.trackedIssue.createdBy` (object) - Information about who created the issue. - `retVal.trackedIssue.ticketType` (string) - The type of the ticket. Enum: "SECURITY", "LEGAL" ``` -------------------------------- ### Create Application Source: https://api-docs.mend.io/sast/sast-api/applications/createapplication Creates a new application by sending a POST request to the /api/applications endpoint with the application details in the request body. ```APIDOC ## POST /api/applications ### Description Create a new application. ### Method POST ### Endpoint /api/applications ### Parameters #### Request Body (application/json) - `basePath` (string) - Description - `createdBy` (string) - Description - `createdTime` (string) - Description - `groupVisibility` (array) - Description - `id` (string) - Description - `lastScanMessage` (string) - Description - `lastScanStatus` (string) - Description - `lastScanTime` (string) - Description - `metrics` (object) - Description - `metrics.dateCounts` (array) - Description - `metrics.dateCounts.counts` (object) - Description - `metrics.dateCounts.counts.capec` (integer) - Description - `metrics.dateCounts.counts.critical` (integer) - Description - `metrics.dateCounts.counts.high` (integer) - Description - `metrics.dateCounts.counts.hipaa` (integer) - Description - `metrics.dateCounts.counts.hitrust` (integer) - Description - `metrics.dateCounts.counts.locPerIssue` (integer) - Description - `metrics.dateCounts.counts.low` (integer) - Description - `metrics.dateCounts.counts.medium` (integer) - Description - `metrics.dateCounts.counts.nist` (integer) - Description - `metrics.dateCounts.counts.owasp` (integer) - Description - `metrics.dateCounts.counts.owasp2021` (integer) - Description - `metrics.dateCounts.counts.pcidss` (integer) - Description - `metrics.dateCounts.counts.sansTop25` (integer) - Description - `metrics.dateCounts.counts.totalVulnerabilities` (integer) - Description - `metrics.dateCounts.counts.vulnTypeCount` (integer) - Description - `metrics.dateCounts.date` (string) - Description - `metrics.fixedVulnerabilities` (integer) - Description - `metrics.latestLanguages` (array) - Description - `metrics.latestScanId` (string) - Description - `metrics.latestStats` (object) - Description - `metrics.latestStats.duration` (string) - Description - `metrics.latestStats.message` (string) - Description - `metrics.latestStats.status` (string) - Description - `metrics.latestStats.testedFiles` (integer) - Description - `metrics.latestStats.testedLines` (integer) - Description - `metrics.latestStats.totalDataFlows` (integer) - Description - `metrics.latestStats.totalFiles` (integer) - Description - `metrics.latestStats.totalLines` (integer) - Description - `metrics.latestStats.totalVulnerabilities` (integer) - Description - `metrics.newCritical` (integer) - Description - `metrics.newHigh` (integer) - Description - `metrics.newLow` (integer) - Description - `metrics.newMedium` (integer) - Description - `metrics.newVulnerabilities` (integer) - Description - `metrics.totalScans` (integer) - Description - `name` (string, required) - The name of the application. - `orgId` (string) - Description - `parameters` (object) - Description - `parameters.almTrigger` (string) - Description - `parameters.configurationId` (string) - Description - `parameters.configurationName` (string) - Description - `parameters.emailTrigger` (string) - Description - `parameters.engineParams` (array) - Description - `parameters.engineParams.customFilters` (array) - Description - `parameters.engineParams.customFilters.filterId` (string) - Description - `parameters.engineParams.customFilters.functionName` (string) - Description - `parameters.engineParams.customFilters.paramIndex` (integer) - Description - `parameters.engineParams.customFilters.parameterCount` (integer) - Description - `parameters.engineParams.customRules` (array) - Description - `parameters.engineParams.customRules.description` (string) - Description - `parameters.engineParams.customRules.functionName` (string) - Description - `parameters.engineParams.customRules.parameterCount` (integer) - Description - `parameters.engineParams.customRules.vulnParamIndex` (integer) - Description - `parameters.engineParams.customRules.vulnTypeIndex` (integer) - Description - `parameters.engineParams.depth` (object) - Description - `parameters.engineParams.depth.maxFunctionDepth` (integer) - Description - `parameters.engineParams.depth.maxVariableTrack` (integer) - Description - `parameters.engineParams.engineId` (integer) - Description - `parameters.engineParams.excludedVulnTypes` (array) - Description - `parameters.engineParams.severityLevels` (array) - Description - `parameters.engineParams.severityLevels.severity` (string) - Description - `parameters.engineParams.severityLevels.vulnTypeId` (integer) - Description - `parameters.engineParams.trackedInputs` (array) - Description - `parameters.engines` (array) - Description - `parameters.exclusions` (array) - Description - `parameters.ignoreStoredFP` (boolean) - Description - `parameters.incremental` (boolean) - Description - `parameters.slackTrigger` (string) - Description - `parameters.target` (object) - Description - `parameters.target.path` (string) - Description - `parameters.target.source` (string) - Description - `parameters.target.type` (string) - Description - `policyId` (string) - Description - `productId` (string) - Description - `retention` (integer) - Description ### Request Example ```json { "name": "Example Application", "basePath": "/app/example", "createdBy": "user@example.com", "parameters": { "target": { "type": "git", "source": "https://github.com/example/repo.git" } } } ``` ### Response #### Success Response (200) - `id` (string) - The unique identifier of the created application. - `name` (string) - The name of the created application. #### Response Example ```json { "id": "app-12345", "name": "Example Application" } ``` #### Error Response (400) - `message` (string) - A message describing the error. - `result` (string) - Indicates the result status, typically "error". - `success` (boolean) - False if an error occurred. #### Error Response Example ```json { "message": "Invalid input provided.", "result": "error", "success": false } ``` ``` -------------------------------- ### Get all libraries for a product Source: https://api-docs.mend.io/sca/2.0/library-product/getlibraries_1 Retrieves all libraries associated with a given product, with support for pagination, searching, and sorting. ```APIDOC ## GET /api/v2.0/products/{productToken}/libraries ### Description Returns all libraries that are included in a given product. ### Method GET ### Endpoint /api/v2.0/products/{productToken}/libraries ### Query Parameters - **pageSize** (string) - Optional - Specifies the number of results to return per page. - **page** (string) - Optional - Specifies the page number for pagination. - **search** (any) - Optional - Filters search results based on property values. Supports operators like 'equals', 'in', 'like', and 'regex'. Example: `name:like:log4j;version:equals:2.17.1` - **sort** (any) - Optional - Sorts search results alphabetically by a specified property. Use a minus sign for descending order. Example: `sort=name` or `sort=-name` - **optionalColumns** (string) - Optional - Used to include additional information, such as 'locations'. Enum: "locations" - **includeNotices** (boolean) - Optional - A flag to indicate whether to include notices in the response. - **extraInformation** (boolean) - Optional - A flag to indicate whether to include extra information in the response. ### Path Parameters - **productToken** (string, required) - The unique identifier for the product. This can be a product UUID or a Product Token obtained from the Mend SCA App. ``` -------------------------------- ### Get Legal and Compliance Alerts Error Response Source: https://api-docs.mend.io/sca/2.0/alerts-product/getlegalandcompliancealerts_1 This snippet details the structure of an error response (400 Bad Request) from the Get Legal and Compliance Alerts API. ```APIDOC ## Response 400 fields (*/*): - `supportToken` (string) Example: "1171c60d" ``` -------------------------------- ### Get Product Projects Source: https://api-docs.mend.io/sca/2.0/entities-product Retrieves a list of projects and their tokens associated with a specific product. ```APIDOC ## GET /api/v2.0/products/{productToken}/projects ### Description Returns a list of the projects and their tokens for a given product. ### Method GET ### Endpoint /api/v2.0/products/{productToken}/projects ### Parameters #### Path Parameters - **productToken** (string) - Required - The unique token of the product whose projects are to be retrieved. ``` -------------------------------- ### Get Legal and Compliance Alerts Response Source: https://api-docs.mend.io/sca/2.0/alerts-product/getlegalandcompliancealerts_1 This snippet details the structure of a successful response (200 OK) from the Get Legal and Compliance Alerts API, outlining the fields and their types. ```APIDOC ## Response 200 fields (application/json): - `additionalData` (object) + 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"} - `supportToken` (string) Example: "1171c60d" - `retVal` (array) - `retVal.uuid` (string) Example: "123e4567-e89b-12d3-a456-426655440000" - `retVal.name` (string) Identifier of the alert, changes based on alert type Example: "CVE-2021-42392" - `retVal.type` (string) - `retVal.alertInfo` (object) - `retVal.alertInfo.status` (string) Enum: "ACTIVE", "IGNORED", "LIBRARY_REMOVED", "LIBRARY_IN_HOUSE", "LIBRARY_WHITELIST" - `retVal.alertInfo.comment` (object) - `retVal.alertInfo.comment.comment` (string) Example: "a comment" - `retVal.alertInfo.comment.date` (string) - `retVal.alertInfo.comment.userEmail` (string) Example: "jon.smith@mail.com" - `retVal.alertInfo.comment.username` (string) Example: "jon" - `retVal.alertInfo.detectedAt` (string) - `retVal.alertInfo.modifiedAt` (string) - `retVal.project` (object) - `retVal.project.uuid` (string) Example: "123e4567-e89b-12d3-a456-426655440000" - `retVal.project.name` (string) Example: "My Project" - `retVal.project.path` (string) Example: "My Product" - `retVal.project.productName` (string) Example: "My Product" - `retVal.project.productUuid` (string) Example: "123e4567-e89b-12d3-a456-426655440000" - `retVal.product` (object) - `retVal.product.uuid` (string) Example: "123e4567-e89b-12d3-a456-426655440000" - `retVal.product.name` (string) Example: "Product A" - `retVal.component` (object) - `retVal.component.uuid` (string) Example: "123e4567-e89b-12d3-a456-426655440000" - `retVal.component.name` (string) Example: "dbus-1.10.24-13.el7_6.x86_64.rpm" - `retVal.component.description` (string) Example: "Component description" - `retVal.component.componentType` (string) - `retVal.component.type` (string) - `retVal.component.libraryType` (string) Example: "REDHAT_PACKAGE_MODULE" - `retVal.component.directDependency` (boolean) - `retVal.component.dependencyType` (string) Example: "Direct / Transitive" - `retVal.component.references` (object) - `retVal.component.references.url` (string) Example: "https://www.gnupg.org/related_software/pinentry/98" - `retVal.component.references.homePage` (string) Example: "https://www.gnupg.org/related_software/pinentry/89" - `retVal.component.references.downloadLink` (string) Example: "https://www.gnupg.org/related_software/pinentry/09" - `retVal.component.references.issueUrl` (string) Example: "https://www.gnupg.org/related_software/pinentry/87" - `retVal.component.references.pomUrl` (string) Example: "https://www.gnupg.org/related_software/pinentry/76" - `retVal.component.references.scmUrl` (string) Example: "https://www.gnupg.org/related_software/pinentry/65" - `retVal.component.references.genericPackageIndex` (string) Example: "5" - `retVal.component.references.nugetGallery` (string) - `retVal.component.references.tags` (string) Example: "Important" - `retVal.component.references.copyright` (string) Example: "Copyright 2002-2015 g10 Code GmbH" - `retVal.component.references.hasNotice` (boolean) - `retVal.component.groupId` (string) Example: "org.springframework.boot" - `retVal.component.artifactId` (string) Example: "spring-boot" - `retVal.component.version` (string) Example: "3.0.5" - `retVal.component.dependencyFile` (string) - `retVal.component.localPath` (string) ``` -------------------------------- ### Get a user Source: https://api-docs.mend.io/sast/sast-api.md Find a user by ID. ```APIDOC ## GET /api/users/{id} ### Description Find a user by ID. ### Method GET ### Endpoint /api/users/{id} ``` -------------------------------- ### Get Reports Source: https://api-docs.mend.io/platform/3.0 Retrieves the status of reports for an organization. ```APIDOC ## GET /api/v3.0/orgs/{orgUuid}/reports ### Description Retrieves the status of reports for an organization. ### Method GET ### Endpoint /api/v3.0/orgs/{orgUuid}/reports ``` -------------------------------- ### Create Project With A New Product Source: https://api-docs.mend.io/sca/2.0 Creates a new project within a new product. If a project with the same name already exists, the existing project is returned. ```APIDOC ## Create Project With A New Product ### Description Creates a new project within a new product. If a project with the same name already exists, the existing project is returned. ### Method POST ### Endpoint /api/v2.0/orgs/{orgToken}/projects ### Parameters #### Path Parameters - **orgToken** (string) - Required - The unique token of the organization. ``` -------------------------------- ### Get a group Source: https://api-docs.mend.io/sast/sast-api/groups Finds a user group by its ID. ```APIDOC ## GET /api/groups/{id} ### Description Find a user group by ID. ### Method GET ### Endpoint /api/groups/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the group to retrieve. ``` -------------------------------- ### Get All Users Source: https://api-docs.mend.io/sast/sast-api/users Retrieves a list of all users in the system. ```APIDOC ## GET /api/users ### Description Get a list of users. ### Method GET ### Endpoint /api/users ``` -------------------------------- ### Get Product Source Files Inventory Source: https://api-docs.mend.io/sca/2.0/library-source-files Retrieves a list of libraries along with the location of their source files for a specified product. ```APIDOC ## GET /api/v2.0/products/{productToken}/sourceFiles/inventory ### Description Returns a list of libraries together with the location of their source files. ### Method GET ### Endpoint /api/v2.0/products/{productToken}/sourceFiles/inventory ### Parameters #### Path Parameters - **productToken** (string) - Required - The unique token identifying the product. ```