Mend SAST API (24.9.2.5)

Mend Static Application Security Testing Solution Web API

Download OpenAPI description
Overview
Mend Support support@mend.io
Languages
Servers
https://api-docs.mend.io/sast/

Applications

Operations

Get a list of applications.

Request

Retrieve a list of all applications.

If summary is set to true then: <ul> <li><i>metrics.totalScans</i> is not set</li> <li><i>metrics.fixedVulnerabilities</i> is not set</li> <li><i>metrics.newVulnerabilities</i> is not set</li> <li><i>metrics.newCritical</i> is not set</li> <li><i>metrics.newHigh</i> is not set</li> <li><i>metrics.newMedium</i> is not set</li> <li><i>metrics.newLow</i> is not set</li> <li><i>metrics.dateCounts</i> only contains data for the latest scan</li> </ul>

Query
summaryboolean

Return only general information if this parameter is set to <em>true</em> (see description for details).

limitinteger

Number of applications to return. Can't be greater than 1000.

pageinteger

Page number, used in combination with <em>limit</em>.

querystring

Narrow down the query to applications with names matching the parameter value.

namestring

Find an application by name. <br>Response type changes to models.Application.</br>

listboolean

Return general information about all applications if this parameter is set. <br>Response type changes to an array of models.ApplicationEntry.</br>

sortstring

Field by which to sort the list. Supported values: <em>name</em>, <em>createdTime</em>, <em>lastScanTime</em> (default).

orderstring

Order direction. Supported values: <em>ascend</em>, <em>descend</em> (default).

No request payload

Responses

OK

Bodyapplication/jsonArray [
basePathstring
createdBystring
createdTimestring
groupVisibilityArray of strings
idstring
lastScanMessagestring
lastScanStatusstring
lastScanTimestring
metricsobject(models.AppMetrics)
namestringrequired
orgIdstring
parametersobject(models.ScanParameters)
policyIdstring
productIdstring
retentioninteger
]
Response
application/json
[ { "basePath": "string", "createdBy": "string", "createdTime": "string", "groupVisibility": [ … ], "id": "string", "lastScanMessage": "string", "lastScanStatus": "string", "lastScanTime": "string", "metrics": { … }, "name": "string", "orgId": "string", "parameters": { … }, "policyId": "string", "productId": "string", "retention": 0 } ]

Create an application.

Request

Create a new application.

Bodyapplication/jsonrequired

Application definition

basePathstring
createdBystring
createdTimestring
groupVisibilityArray of strings
idstring
lastScanMessagestring
lastScanStatusstring
lastScanTimestring
metricsobject(models.AppMetrics)
namestringrequired
orgIdstring
parametersobject(models.ScanParameters)
policyIdstring
productIdstring
retentioninteger
application/json
{ "basePath": "string", "createdBy": "string", "createdTime": "string", "groupVisibility": [ "string" ], "id": "string", "lastScanMessage": "string", "lastScanStatus": "string", "lastScanTime": "string", "metrics": { "dateCounts": [ … ], "fixedVulnerabilities": 0, "latestLanguages": [ … ], "latestScanId": "string", "latestStats": { … }, "newCritical": 0, "newHigh": 0, "newLow": 0, "newMedium": 0, "newVulnerabilities": 0, "totalScans": 0 }, "name": "string", "orgId": "string", "parameters": { "almTrigger": "string", "configurationId": "string", "configurationName": "string", "emailTrigger": "string", "engineParams": [ … ], "engines": [ … ], "exclusions": [ … ], "ignoreStoredFP": true, "incremental": true, "slackTrigger": "string", "target": { … } }, "policyId": "string", "productId": "string", "retention": 0 }

Responses

OK

Bodyapplication/json
idstring
namestring
Response
application/json
{ "id": "string", "name": "string" }

Delete an application

Request

Delete an application by ID.

Path
idstringrequired

Application ID

No request payload

Responses

OK

Bodyapplication/json
messagestring
Example: "Operation succeeded"
resultany
successboolean
Example: true
Response
application/json
{ "message": "Operation succeeded", "result": null, "success": true }

Get an application.

Request

Retrieve an application by ID.

Path
idstringrequired

Application ID

No request payload

Responses

OK

Bodyapplication/json
basePathstring
createdBystring
createdTimestring
groupVisibilityArray of strings
idstring
lastScanMessagestring
lastScanStatusstring
lastScanTimestring
metricsobject(models.AppMetrics)
namestringrequired
orgIdstring
parametersobject(models.ScanParameters)
policyIdstring
productIdstring
retentioninteger
Response
application/json
{ "basePath": "string", "createdBy": "string", "createdTime": "string", "groupVisibility": [ "string" ], "id": "string", "lastScanMessage": "string", "lastScanStatus": "string", "lastScanTime": "string", "metrics": { "dateCounts": [ … ], "fixedVulnerabilities": 0, "latestLanguages": [ … ], "latestScanId": "string", "latestStats": { … }, "newCritical": 0, "newHigh": 0, "newLow": 0, "newMedium": 0, "newVulnerabilities": 0, "totalScans": 0 }, "name": "string", "orgId": "string", "parameters": { "almTrigger": "string", "configurationId": "string", "configurationName": "string", "emailTrigger": "string", "engineParams": [ … ], "engines": [ … ], "exclusions": [ … ], "ignoreStoredFP": true, "incremental": true, "slackTrigger": "string", "target": { … } }, "policyId": "string", "productId": "string", "retention": 0 }

Update an application

Request

Update an application by ID.

Path
idstringrequired

Application ID

Bodyapplication/jsonrequired

Updated application definition

basePathstring
createdBystring
createdTimestring
groupVisibilityArray of strings
idstring
lastScanMessagestring
lastScanStatusstring
lastScanTimestring
metricsobject(models.AppMetrics)
namestringrequired
orgIdstring
parametersobject(models.ScanParameters)
policyIdstring
productIdstring
retentioninteger
application/json
{ "basePath": "string", "createdBy": "string", "createdTime": "string", "groupVisibility": [ "string" ], "id": "string", "lastScanMessage": "string", "lastScanStatus": "string", "lastScanTime": "string", "metrics": { "dateCounts": [ … ], "fixedVulnerabilities": 0, "latestLanguages": [ … ], "latestScanId": "string", "latestStats": { … }, "newCritical": 0, "newHigh": 0, "newLow": 0, "newMedium": 0, "newVulnerabilities": 0, "totalScans": 0 }, "name": "string", "orgId": "string", "parameters": { "almTrigger": "string", "configurationId": "string", "configurationName": "string", "emailTrigger": "string", "engineParams": [ … ], "engines": [ … ], "exclusions": [ … ], "ignoreStoredFP": true, "incremental": true, "slackTrigger": "string", "target": { … } }, "policyId": "string", "productId": "string", "retention": 0 }

Responses

OK

Bodyapplication/json
messagestring
Example: "Operation succeeded"
resultany
successboolean
Example: true
Response
application/json
{ "message": "Operation succeeded", "result": null, "success": true }

Get scans for an application

Request

Retrieve a list of application scans.

Path
idstringrequired

Application ID

Query
summaryboolean

Return only general information if this parameter is set to <em>true</em>.

limitinteger

Number of scans to return. Can't be greater than 1000.

pageinteger

Page number, used in combination with <em>limit</em>.

querystring

Narrow down the query to scans with names matching the parameter value.

filterstring

Filter the scans by status. Comma-separated list of values is accepted, e.g. <em>Finished,Running,Failed</em>.

sortstring

Field by which to sort the list. Supported values: <em>name</em>, <em>createdTime</em> (default).

orderstring

Order direction. Supported values: <em>ascend</em>, <em>descend</em> (default).