{
"openapi": "3.0.1",
"info": {
"title": "Mend API",
"description": "Mend's enhanced API enables automation of workflows in a REST compliant format. The API features:\n+ Access for any user with Mend credentials, via a user key available in the user's profile page in the Mend Platform.\n+ Improved security with a JWT token per organization, which expires every 10 minutes.\n+ Added scalability with support for cursor pagination and limiting results size.\n+ Broader functionality available programmatically.\n+ New standard API documentation for easy navigation and search.\n\nIf you have a dedicated instance of Mend, contact your Mend representative to access this API on your instance.\n\n**Note:** To help you get started with the Mend API 3.0, we recommend reviewing our onboarding guide -> [Getting Started with API 3.0](https://docs.mend.io/platform/latest/getting-started-with-mend-api-3-0). This resource covers initial setup, authentication instructions, and helpful tips to help you successfully begin working with the Mend API 3.0.",
"version": "3.0"
},
"servers": [
{
"url": "https://baseUrl",
"description": "Generated server url"
}
],
"security": [
{
"bearer-key": []
}
],
"tags": [
{
"name": "Access Management"
},
{
"name": "Administration - Groups"
},
{
"name": "Administration - Users"
},
{
"name": "Administration - Labels"
},
{
"name": "Reports"
},
{
"name": "Scans"
},
{
"name": "Projects"
},
{
"name": "Applications"
},
{
"name": "Findings - Project"
},
{
"name": "Findings - Scan"
}
],
"paths": {
"/api/v3.0/applications/{applicationUuid}/ai/reports/findings": {
"post": {
"tags": [
"Reports"
],
"summary": "Export AI Application Findings report asynchronously",
"operationId": "exportAiFindingsReport_2",
"parameters": [
{
"name": "applicationUuid",
"in": "path",
"description": "application UUID.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportExportProcessDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/applications/{applicationUuid}/ai/reports/inventory": {
"post": {
"tags": [
"Reports"
],
"summary": "Export AI Application Inventory report asynchronously",
"operationId": "exportAiInventoryReport_2",
"parameters": [
{
"name": "applicationUuid",
"in": "path",
"description": "application UUID.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportExportProcessDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/applications/{applicationUuid}/code/reports/compliance": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Code Application Compliance report asynchronously (SAST)",
"operationId": "exportCodeComplianceReport_1",
"parameters": [
{
"name": "applicationUuid",
"in": "path",
"description": "Application UUID (Administration > Applications)",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CodeReportExportProcessDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/applications/{applicationUuid}/code/reports/findings": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Code Application Findings report asynchronously (SAST)",
"operationId": "exportCodeFindingsReport_1",
"parameters": [
{
"name": "applicationUuid",
"in": "path",
"description": "Application UUID (Administration > Applications)",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateReportDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/applications/{applicationUuid}/code/reports/resolved": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Code Application Resolved Findings report asynchronously",
"operationId": "exportCodeResolvedReport_1",
"parameters": [
{
"name": "applicationUuid",
"in": "path",
"description": "Application UUID (Administration > Applications)",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResolvedReportExportProcessDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/applications/{applicationUuid}/code/reports/suppressions": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Code Application Suppressions report asynchronously (SAST)",
"operationId": "exportCodeSuppressionsReport_1",
"parameters": [
{
"name": "applicationUuid",
"in": "path",
"description": "Application UUID (Administration > Applications)",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateReportDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/applications/{applicationUuid}/images/reports/SBOM": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Images Application SBOM report asynchronously (Containers)",
"operationId": "exportImgSbomReport_2",
"parameters": [
{
"name": "applicationUuid",
"in": "path",
"description": "application UUID.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportExportProcessDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/applications/{applicationUuid}/images/reports/attribution": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Images Application Attribution report asynchronously (Containers)",
"operationId": "exportImgAttributionReport_2",
"parameters": [
{
"name": "applicationUuid",
"in": "path",
"description": "application UUID.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttributionImgReportExportDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/applications/{applicationUuid}/images/reports/dueDiligence": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Images Application Due Diligence report asynchronously (Containers)",
"operationId": "exportImgFindingsReport_2",
"parameters": [
{
"name": "applicationUuid",
"in": "path",
"description": "application UUID.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportExportProcessDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/login": {
"post": {
"tags": [
"Access Management"
],
"summary": "Login",
"description": "Sign in a user with email and user key, returning a JWT token which is valid for 10 minutes.\nIf you omit the organization, it defaults to the last one you signed in to. ",
"operationId": "login",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginModelDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3LoginResponseDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/login/accessToken": {
"post": {
"tags": [
"Access Management"
],
"summary": "Generate / Refresh Access Token",
"description": "Generates a new access token from a refresh token",
"operationId": "refreshAccessToken",
"parameters": [
{
"name": "wss-refresh-token",
"in": "header",
"description": "Refresh token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "orgUuid",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**)."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessTokenRequestDTO"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3AccessTokenResponseDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/logout": {
"post": {
"tags": [
"Access Management"
],
"summary": "Logout (revokes the refresh token)",
"operationId": "logout",
"parameters": [
{
"name": "wss-refresh-token",
"in": "header",
"description": "Refresh token",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/ai/reports/findings": {
"post": {
"tags": [
"Reports"
],
"summary": "Export AI Organization Findings report asynchronously",
"operationId": "exportAiFindingsReport_1",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportExportProcessDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/ai/reports/inventory": {
"post": {
"tags": [
"Reports"
],
"summary": "Export AI Organization Inventory report asynchronously",
"operationId": "exportAiInventoryReport_1",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportExportProcessDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/applications": {
"get": {
"tags": [
"Applications"
],
"summary": "Get Organization Applications",
"description": "Returns a list of all applications accessible to the current user",
"operationId": "getOrganizationApplications",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3CollectionApplicationDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/applications/summaries": {
"post": {
"tags": [
"Applications"
],
"summary": "Get Application Statistics",
"description": "Returns the requested statistics for the given applications",
"operationId": "getApplicationSummaries",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MultiContextRequestDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3ListApplicationSummaryDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/applications/summaries/totals": {
"get": {
"tags": [
"Applications"
],
"summary": "Get Application totals",
"description": "Returns the requested statistics for the given applications",
"operationId": "getApplicationsTotals",
"parameters": [
{
"name": "fromDate",
"in": "query",
"description": "Enter the start date for the search. The date format is yyyy-MM-dd",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "toDate",
"in": "query",
"description": "Enter the end date for the search. The date format is yyyy-MM-dd",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3PeriodTotalsDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/applications/{applicationUuid}/labels": {
"get": {
"tags": [
"Applications"
],
"summary": "Get Application Labels",
"description": "Get application labels. A label can be a string or namespace:value pair that provide additional metadata to assist with project management.",
"operationId": "getProductLabels",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "applicationUuid",
"in": "path",
"description": "Application UUID (Administration > Applications)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ListEntityLabelDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
},
"put": {
"tags": [
"Applications"
],
"summary": "Add Application Label",
"description": "Adds a new label to a application. A label can be a string or namespace:value pair that provide additional metadata to assist with project management.",
"operationId": "addApplicationLabel",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "applicationUuid",
"in": "path",
"description": "Application UUID (Administration > Applications)",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LabelRequestDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3MessageDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/applications/{applicationUuid}/labels/{labelUuid}": {
"delete": {
"tags": [
"Applications"
],
"summary": "Remove Application Label",
"description": "Removes a label from an application",
"operationId": "removeProductLabel",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "applicationUuid",
"in": "path",
"description": "Application UUID (Administration > Applications)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "labelUuid",
"in": "path",
"description": "Label UUID (Administration > Labels)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3MessageDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/applications/{applicationUuid}/scans": {
"get": {
"tags": [
"Applications"
],
"summary": "Get Application Scans",
"description": "Returns the application related scans",
"operationId": "getScanSummaries_1",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "applicationUuid",
"in": "path",
"description": "Application UUID (Administration > Applications)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3ListScanSummaryDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/applications/{applicationUuid}/violations/sla": {
"put": {
"tags": [
"Applications"
],
"summary": "Update Multiple Violation SLA",
"description": "Updates the SLA of Multiple Application Violating Findings",
"operationId": "updateMultipleProjectViolationSla_1",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "applicationUuid",
"in": "path",
"description": "Application UUID (Administration > Applications)",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMultipleProjectViolationSlaRequestDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3Boolean"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/code/reports/compliance": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Code Organization Compliance report asynchronously (SAST)",
"operationId": "exportSastAnalyticsReport",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CodeReportExportProcessDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/groups": {
"get": {
"tags": [
"Administration - Groups"
],
"summary": "Get All Organization Groups",
"description": "Returns a list of all groups within an organization",
"operationId": "getAllOrganizationGroups",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3ListGroupSummaryDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
},
"post": {
"tags": [
"Administration - Groups"
],
"summary": "Create Group",
"description": "Creates a new group for an organization",
"operationId": "createGroup",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateGroupRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3GroupDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/groups/{groupUuid}": {
"get": {
"tags": [
"Administration - Groups"
],
"summary": "Get Group",
"description": "Returns the given group of an organization",
"operationId": "getGroup",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupUuid",
"in": "path",
"description": "Group UUID (Administration > Groups)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3GroupDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
},
"put": {
"tags": [
"Administration - Groups"
],
"summary": "Update Group",
"description": "Updates the properties of a given group",
"operationId": "updateGroup",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupUuid",
"in": "path",
"description": "Group UUID (Administration > Groups)",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateGroupRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3GroupDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
},
"delete": {
"tags": [
"Administration - Groups"
],
"summary": "Delete Group",
"description": "Deletes the given group",
"operationId": "deleteGroup",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupUuid",
"in": "path",
"description": "Group UUID (Administration > Groups)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3MessageDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/groups/{groupUuid}/roles": {
"get": {
"tags": [
"Administration - Groups"
],
"summary": "Get Group Roles",
"description": "Returns the list of roles associated with a given group",
"operationId": "getGroupRoles",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupUuid",
"in": "path",
"description": "The group UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3ListMultipleGroupRolesPerContextDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
},
"put": {
"tags": [
"Administration - Groups"
],
"summary": "Remove Group Roles",
"description": "Deletes a role from a group",
"operationId": "removeGroupRoles",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupUuid",
"in": "path",
"description": "Group UUID (Administration > Groups)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3MessageDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
},
"post": {
"tags": [
"Administration - Groups"
],
"summary": "Add Group Roles",
"description": "Creates a new group role for an organization",
"operationId": "addGroupRoles",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupUuid",
"in": "path",
"description": "Group UUID (Administration > Groups)",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupRoleRequestDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3GroupRoleDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/groups/{groupUuid}/users": {
"get": {
"tags": [
"Administration - Groups"
],
"summary": "Get Group Users",
"description": "Returns a list of users that belong to given group",
"operationId": "getGroupUsers",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupUuid",
"in": "path",
"description": "The group UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3ListUserInfoDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
},
"post": {
"tags": [
"Administration - Groups"
],
"summary": "Add User to Group",
"description": "Adds a user to an organization's group",
"operationId": "addUsersToGroup",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupUuid",
"in": "path",
"description": "Group UUID (Administration > Groups)",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserEmailsRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3MessageDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/groups/{groupUuid}/users/{userUuid}": {
"delete": {
"tags": [
"Administration - Groups"
],
"summary": "Remove User From Group",
"description": "Deletes a user from an organization's group",
"operationId": "deleteUserFromGroup",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupUuid",
"in": "path",
"description": "Group UUID (Administration > Groups)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "userUuid",
"in": "path",
"description": "User UUID (Administration > Users)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3MessageDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/images/reports/SBOM": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Images Organization SBOM report asynchronously (Containers)",
"operationId": "exportImgSbomReport_1",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportExportProcessDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/images/reports/attribution": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Images Organization Attribution report asynchronously (Containers)",
"operationId": "exportImgAttributionReport_1",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttributionImgReportExportDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/images/reports/dueDiligence": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Images Organization Due Diligence report asynchronously (Containers)",
"operationId": "exportImgFindingsReport_1",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportExportProcessDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/integrations": {
"get": {
"tags": [
"Integrations"
],
"summary": "Get All Integrations",
"description": "Returns all integrations for the given organization with optional filtering.",
"operationId": "getOrgIntegrations",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**)."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ListIntegrationDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/labels": {
"get": {
"tags": [
"Administration - Labels"
],
"summary": "Get All Organization Labels",
"description": "Returns a list of all labels in an organization (paginated)",
"operationId": "getLabels",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3ListOrganizationLabelDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
},
"post": {
"tags": [
"Administration - Labels"
],
"summary": "Add Label Definition",
"description": "Adds a new label definition",
"operationId": "createLabel",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationLabelRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3MessageDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/labels/{labelUuid}": {
"put": {
"tags": [
"Administration - Labels"
],
"summary": "Rename Label",
"description": "Renames an existing label",
"operationId": "renameLabel",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "labelUuid",
"in": "path",
"description": "Label UUID (Administration > Labels)",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainLabelRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3MessageDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
},
"delete": {
"tags": [
"Administration - Labels"
],
"summary": "Remove Label Definition",
"description": "Removes a label definition",
"operationId": "deleteLabel",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "labelUuid",
"in": "path",
"description": "Label UUID (Administration > Labels)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3MessageDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/projects": {
"get": {
"tags": [
"Projects"
],
"summary": "Get Organization Projects",
"description": "Returns a list of all projects accessible to the current user",
"operationId": "getOrganizationProjects",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "populateApplications",
"in": "query",
"description": "Add populateApplications=false to receive a slimmer response containing only the project UUID and name.",
"allowEmptyValue": true,
"schema": {
"type": "string",
"default": "true"
}
},
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3CollectionProjectDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/projects/summaries": {
"post": {
"tags": [
"Projects"
],
"summary": "Get Project Statistics",
"description": "Returns the requested statistics for the given projects that match at least one of the given identifiers.",
"operationId": "getProjectSummaries",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MultiContextRequestDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3ListProjectSummaryDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/projects/summaries/total/date": {
"get": {
"tags": [
"Projects"
],
"summary": "Get Project totals grouped by date",
"description": "Returns the requested statistics for the given projects that match at least one of the given identifiers.",
"operationId": "getProjectSummariesTotalsByDate",
"parameters": [
{
"name": "fromDate",
"in": "query",
"description": "Enter the start date for the search. The date format is yyyy-MM-dd",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "toDate",
"in": "query",
"description": "Enter the end date for the search. The date format is yyyy-MM-dd",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ListProjectTotalsGroupedByDateDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/projects/summaries/totals": {
"get": {
"tags": [
"Projects"
],
"summary": "Get Project totals",
"description": "Returns the requested statistics for the given projects that match at least one of the given identifiers.",
"operationId": "getProjectTotals",
"parameters": [
{
"name": "fromDate",
"in": "query",
"description": "Enter the start date for the search. The date format is yyyy-MM-dd",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "toDate",
"in": "query",
"description": "Enter the end date for the search. The date format is yyyy-MM-dd",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3PeriodTotalsDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/projects/{projectUuid}/labels": {
"get": {
"tags": [
"Projects"
],
"summary": "Get Project Labels",
"description": "Get project labels. A label can be a string or namespace:value pair that provide additional metadata to assist with project management.",
"operationId": "getProjectLabels",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ListEntityLabelDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
},
"put": {
"tags": [
"Projects"
],
"summary": "Add Project Label",
"description": "Adds a new label to a project. A label can be a string or namespace:value pair that provide additional metadata to assist with project management.",
"operationId": "addProjectLabel",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LabelRequestDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3MessageDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/projects/{projectUuid}/labels/{labelUuid}": {
"delete": {
"tags": [
"Projects"
],
"summary": "Remove Project Label",
"description": "Removes a label from a project",
"operationId": "removeProjectLabel",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "labelUuid",
"in": "path",
"description": "Label UUID (Administration > Labels)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3MessageDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/projects/{projectUuid}/scans": {
"get": {
"tags": [
"Scans"
],
"summary": "Get Project Scans",
"description": "Returns the project related scans",
"operationId": "getScanSummaries",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3ListScanSummaryDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/projects/{projectUuid}/scans/{scanUuid}": {
"get": {
"tags": [
"Scans"
],
"summary": "Get Scan",
"operationId": "getScan",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "scanUuid",
"in": "path",
"description": "Scan UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ScanDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/projects/{projectUuid}/scans/{scanUuid}/summary": {
"get": {
"tags": [
"Scans"
],
"summary": "Get Scan Summary",
"operationId": "getSummary",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "scanUuid",
"in": "path",
"description": "Scan UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ScanSummaryDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/projects/{projectUuid}/scans/{scanUuid}/tags": {
"get": {
"tags": [
"Scans"
],
"summary": "Get Scan Tags",
"operationId": "getTags",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "scanUuid",
"in": "path",
"description": "Scan UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3ListScanTagDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/projects/{projectUuid}/violations": {
"get": {
"tags": [
"Projects"
],
"summary": "Get Project Violating Findings",
"description": "Returns the violations relates to project",
"operationId": "getProjectViolations",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3ListProjectViolationDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/projects/{projectUuid}/violations/sla": {
"put": {
"tags": [
"Projects"
],
"summary": "Update Multiple Violation SLA",
"description": "Updates the SLA of Multiple Project Violating Findings",
"operationId": "updateMultipleProjectViolationSla",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMultipleProjectViolationSlaRequestDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3Boolean"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/reports": {
"get": {
"tags": [
"Reports"
],
"summary": "Get Reports",
"operationId": "getReportStatusesMultiContext",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3ListReportExportProcessDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/reports/download/{reportUuid}": {
"get": {
"tags": [
"Reports"
],
"summary": "Download Report",
"operationId": "downloadReport",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "reportUuid",
"in": "path",
"description": "Asynchronous Process Status UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/reports/{reportUuid}": {
"get": {
"tags": [
"Reports"
],
"summary": "Get Report Status",
"operationId": "getReportStatus",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "reportUuid",
"in": "path",
"description": "Asynchronous Process Status UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
},
"delete": {
"tags": [
"Reports"
],
"summary": "Delete Report",
"operationId": "deleteReport",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "reportUuid",
"in": "path",
"description": "Asynchronous Process Status UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3MessageDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/users": {
"get": {
"tags": [
"Administration - Users"
],
"summary": "Get Organization Users",
"description": "Returns a list of all users in an organization (paginated)",
"operationId": "getUsersPaginated",
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3ListUserInfoDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/users/invite": {
"post": {
"tags": [
"Administration - Users"
],
"summary": "Invite User",
"description": "Sends an email invitation to others to join an organization",
"operationId": "inviteUser",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InviteUserRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3UserInfoResponseDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/users/{userUuid}": {
"delete": {
"tags": [
"Administration - Users"
],
"summary": "Remove User From Organization",
"description": "Deletes a user from an organization",
"operationId": "removeUser",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "userUuid",
"in": "path",
"description": "User UUID (Administration > Users)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3MessageDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/users/{userUuid}/block": {
"put": {
"tags": [
"Administration - Users"
],
"summary": "Block User",
"description": "Blocks a user in the organization",
"operationId": "blockUser",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "userUuid",
"in": "path",
"description": "User UUID (Administration > Users)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3Boolean"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/orgs/{orgUuid}/users/{userUuid}/unblock": {
"put": {
"tags": [
"Administration - Users"
],
"summary": "Unblock User",
"description": "Unblocks a user in the organization",
"operationId": "unblockUser",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "userUuid",
"in": "path",
"description": "User UUID (Administration > Users)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3Boolean"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/ai/reports/findings": {
"post": {
"tags": [
"Reports"
],
"summary": "Export AI Project Findings report asynchronously",
"operationId": "exportAiFindingsReport",
"parameters": [
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportExportProcessDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/ai/reports/inventory": {
"post": {
"tags": [
"Reports"
],
"summary": "Export AI Project Inventory report asynchronously",
"operationId": "exportAiInventoryReport",
"parameters": [
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportExportProcessDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/code/reports/compliance": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Code Project Compliance report asynchronously (SAST)",
"operationId": "exportCodeComplianceReport",
"parameters": [
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CodeReportExportProcessDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/code/reports/findings": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Code Project Findings report asynchronously (SAST)",
"operationId": "exportCodeFindingsReport",
"parameters": [
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateReportDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/code/reports/resolved": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Code Project Resolved Findings report asynchronously",
"operationId": "exportCodeResolvedReport",
"parameters": [
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResolvedReportExportProcessDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/code/reports/suppressions": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Code Project Suppressions report asynchronously (SAST)",
"operationId": "exportCodeSuppressionsReport",
"parameters": [
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateReportDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/images/reports/SBOM": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Images Project SBOM report asynchronously (Containers)",
"operationId": "exportImgSbomReport",
"parameters": [
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportExportProcessDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/images/reports/attribution": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Images Project Attribution report asynchronously (Containers)",
"operationId": "exportImgAttributionReport",
"parameters": [
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttributionImgReportExportDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/images/reports/dueDiligence": {
"post": {
"tags": [
"Reports"
],
"summary": "Export Images Project Due Diligence report asynchronously (Containers)",
"operationId": "exportImgFindingsReport",
"parameters": [
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportExportProcessDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/dependencies/sourceFiles/inventory": {
"get": {
"tags": [
"Dependencies Source Files"
],
"summary": "Get project source files inventory",
"description": "Returns an inventory list of the source files associated with each library in a project. Supports filtering by library UUID using the search parameter. Example: ?search=libraryUuid==b366b0ef-b211-4c37-a47c-0077e4de709f",
"operationId": "getSourceFilesInventoryProject",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3CollectionSourceFileInventoryDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
},
"x-order": "1"
}
},
"/api/v3.0/projects/{projectUuid}/dependencies/sourceFiles/matchSuggestions": {
"post": {
"tags": [
"Dependencies Source Files"
],
"summary": "Get Mend library suggestions for source files",
"description": "Returns Mend library suggestions for the specified source file UUIDs. Request body requires: sourceFileUuids (array), recommendedForAllFiles (boolean). Supports same search filters as searchForMatch: date, license, name, owner, version. ",
"operationId": "getMatchSuggestionsProject",
"parameters": [
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Request body containing source file UUIDs and optional filters. Fields: sourceFileUuids (required, array of UUIDs), recommendedForAllFiles (required, boolean).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LibraryMatchSuggestionsRequestDTOV3_MatchSuggestions"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3CollectionSourceLibraryResponseDTO_MatchSuggestions"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
},
"x-order": "2"
}
},
"/api/v3.0/projects/{projectUuid}/dependencies/sourceFiles/searchForMatch": {
"get": {
"tags": [
"Dependencies Source Files"
],
"summary": "Search for library matches for source files",
"description": "Returns library match suggestions from Mend based on manual search criteria. Uses V3 MQL search format. Available search filters: date:between:date1,date2 (e.g., between:2019-05-01,2019-06-01), license:[like|regex]:value, name:[like|equals|regex]:value, owner:like:value, version:like:value. Example: ?search=name==openssl. ",
"operationId": "searchForMatchProject",
"parameters": [
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3CollectionSourceLibraryResponseDTO_SearchForMatch"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
},
"x-order": "3"
}
},
"/api/v3.0/applications/{applicationUuid}/dependencies/sourceFiles/inventory": {
"get": {
"tags": [
"Dependencies Source Files"
],
"summary": "Get application source files inventory",
"description": "Returns a list of libraries together with the location of their source files. Supports filtering by library UUID using the search parameter. Example: ?search=libraryUuid==b366b0ef-b211-4c37-a47c-0077e4de709f",
"operationId": "getSourceFilesInventoryApplication",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "applicationUuid",
"in": "path",
"description": "Application UUID (Administration > Applications)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3CollectionSourceFileInventoryDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
},
"x-order": "4"
}
},
"/api/v3.0/applications/{applicationUuid}/dependencies/sourceFiles/matchSuggestions": {
"post": {
"tags": [
"Dependencies Source Files"
],
"summary": "Get Mend library suggestions for source files",
"description": "Returns Mend library suggestions for the specified source file UUIDs. Request body requires: sourceFileUuids (array), recommendedForAllFiles (boolean). Supports same search filters as searchForMatch: date, license, name, owner, version. ",
"operationId": "getMatchSuggestionsApplication",
"parameters": [
{
"name": "applicationUuid",
"in": "path",
"description": "Application UUID (Administration > Applications)",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Request body containing source file UUIDs and optional filters. Fields: sourceFileUuids (required, array of UUIDs), recommendedForAllFiles (required, boolean).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LibraryMatchSuggestionsRequestDTOV3_MatchSuggestions"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3CollectionSourceLibraryResponseDTO_MatchSuggestions"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
},
"x-order": "5"
}
},
"/api/v3.0/applications/{applicationUuid}/dependencies/sourceFiles/searchForMatch": {
"get": {
"tags": [
"Dependencies Source Files"
],
"summary": "Search for library matches for source files",
"description": "Returns library match suggestions from Mend based on manual search criteria. Uses V3 MQL search format. Available search filters: date:between:date1,date2 (e.g., between:2019-05-01,2019-06-01), license:[like|regex]:value, name:[like|equals|regex]:value, owner:like:value, version:like:value. Example: ?search=name==openssl. ",
"operationId": "searchForMatchApplication",
"parameters": [
{
"name": "applicationUuid",
"in": "path",
"description": "Application UUID (Administration > Applications)",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3CollectionSourceLibraryResponseDTO_SearchForMatch"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
},
"x-order": "6"
}
},
"/api/v3.0/orgs/{orgUuid}/applications/dependencies/sourceFiles/remapping": {
"post": {
"tags": [
"Dependencies Source Files"
],
"summary": "Remap source files at application level",
"description": "Remaps the specified source files to a target library for the specified application(s). This operation runs asynchronously and returns 202 Accepted with async process status. Requires exactly one of: targetLibraryUuid OR matchSuggestionId (not both, not neither). Request body fields: applicationUuids (required, array), sourceFileUuids (required, array), targetLibraryUuid (conditional), matchSuggestionId (conditional), comment (optional), sendEmailNotification (optional, boolean).",
"operationId": "remapSourceFilesApplication",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Request body containing remapping details. Fields: applicationUuids (required, array), sourceFileUuids (required, array), targetLibraryUuid (conditional, UUID string - use if remapping from search for a match), matchSuggestionId (conditional, base64 string - use if remapping from match suggestion), comment (optional, string), sendEmailNotification (optional, boolean). IMPORTANT: Provide exactly one of targetLibraryUuid OR matchSuggestionId, not both.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SourceFileRemappingAppRequestDTOV3"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Remapping job accepted and initiated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SourceFilesRemappingAsyncStatusDtoV3"
}
}
}
},
"400": {
"description": "Invalid request parameters. Possible errors: 'Only one of targetLibraryUuid or matchSuggestionId must be provided, not both' OR 'Either targetLibraryUuid or matchSuggestionId must be provided'",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "User lacks required permissions or application does not belong to organization",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"404": {
"description": "Organization, application(s), or target library not found. Error: 'Target library not found'",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SourceFilesRemappingAsyncStatusDtoV3"
}
}
}
}
},
"x-order": "7"
}
},
"/api/v3.0/orgs/{orgUuid}/dependencies/sourceFiles/remapping": {
"post": {
"tags": [
"Dependencies Source Files"
],
"summary": "Remap source files at organization level",
"description": "Remaps the specified source files to a target library across the entire organization. This operation runs asynchronously and returns 202 Accepted with async process status. Requires exactly one of: targetLibraryUuid OR matchSuggestionId (not both, not neither). Request body fields: sourceFileUuids (required, array), targetLibraryUuid (conditional), matchSuggestionId (conditional), comment (optional), sendEmailNotification (optional, boolean).",
"operationId": "remapSourceFilesOrganization",
"parameters": [
{
"name": "orgUuid",
"in": "path",
"description": "org UUID (from the Mend App: **Administration** General > **Organization UUID**).",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Request body containing remapping details. Fields: sourceFileUuids (required, array), targetLibraryUuid (conditional, UUID string - use if remapping from search for a match), matchSuggestionId (conditional, base64 string - use if remapping from match suggestion), comment (optional, string), sendEmailNotification (optional, boolean). IMPORTANT: Provide exactly one of targetLibraryUuid OR matchSuggestionId, not both.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SourceFileRemappingOrgRequestDTOV3"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Remapping job accepted and initiated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SourceFilesRemappingAsyncStatusDtoV3"
}
}
}
},
"400": {
"description": "Invalid request parameters. Possible errors: 'Only one of targetLibraryUuid or matchSuggestionId must be provided, not both' OR 'Either targetLibraryUuid or matchSuggestionId must be provided'",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "User lacks required permissions",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"404": {
"description": "Organization or target library not found. Error: 'Target library not found'",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SourceFilesRemappingAsyncStatusDtoV3"
}
}
}
}
},
"x-order": "8"
}
},
"/api/v3.0/accounts/{accountUuid}/dependencies/reports/inventory": {
"post": {
"tags": [
"Reports"
],
"summary": "Export account inventory report asynchronously (Dependencies - SCA)",
"operationId": "exportAccountInventoryReport",
"parameters": [
{
"name": "accountUuid",
"in": "path",
"description": "Account UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateInventoryReportDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/accounts/{accountUuid}/dependencies/reports/securityFindings": {
"post": {
"tags": [
"Reports"
],
"summary": "Export account Dependency Security Findings report asynchronously (Dependencies - SCA)",
"operationId": "exportAccountDependencySecurityFindingsReport",
"parameters": [
{
"name": "accountUuid",
"in": "path",
"description": "Account UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSecurityFindingsReportDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/accounts/{accountUuid}/dependencies/reports/securityFindingsByLibrary": {
"post": {
"tags": [
"Reports"
],
"summary": "Export account Dependency Security Findings by Library report asynchronously (Dependencies - SCA)",
"operationId": "exportAccountDependencySecurityFindingsByLibraryReport",
"parameters": [
{
"name": "accountUuid",
"in": "path",
"description": "Account UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSecurityFindingsByLibraryReportDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/applications/{applicationUuid}/dependencies/projects/importSbom": {
"post": {
"tags": [
"Applications"
],
"summary": "Import SBOM and create a new project (Dependencies - SCA)",
"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).",
"operationId": "createProjectWithSbomScan",
"parameters": [
{
"name": "applicationUuid",
"in": "path",
"description": "Application UUID (Administration > Applications)",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"projectName",
"sbomFile"
],
"type": "object",
"properties": {
"projectName": {
"type": "string",
"description": "Name of the project to create under this application"
},
"projectDescription": {
"type": "string",
"description": "Optional project description"
},
"sbomFile": {
"type": "string",
"description": "The SBOM file to upload (SPDX or CycloneDX). Only one file per request.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"201": {
"description": "SBOM scan successfully created and queued",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SbomScanResponseDTO"
}
}
}
},
"400": {
"description": "Invalid SBOM file format or malformed request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Insufficient permissions to create project in this application",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"404": {
"description": "Application not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3SbomScanResponseDTO"
}
}
}
}
}
}
},
"/api/v3.0/applications/{applicationUuid}/dependencies/reports/SBOM": {
"post": {
"tags": [
"Reports"
],
"summary": "Export application SBOM report asynchronously (Dependencies - SCA)",
"operationId": "exportSbomReport_1",
"parameters": [
{
"name": "applicationUuid",
"in": "path",
"description": "Application UUID (Administration > Applications)",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateProductSbomReportDTOReport"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/applications/{applicationUuid}/dependencies/reports/dueDiligence": {
"post": {
"tags": [
"Reports"
],
"summary": "Export application due diligence report asynchronously (Dependencies - SCA)",
"operationId": "exportProductDueDiligenceReport",
"parameters": [
{
"name": "applicationUuid",
"in": "path",
"description": "Application UUID (Administration > Applications)",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateProductReportDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/dependencies/effective": {
"get": {
"tags": [
"Projects"
],
"summary": "Get Project vulnerabilities traces (Dependencies - SCA)",
"description": "Returns the traces of a given project. Note that this feature requires that Mend Prioritize be enabled in your Mend account.",
"operationId": "getProjectVulnerabilitiesTraces",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3ListProjectTraceDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/dependencies/findings/security": {
"get": {
"tags": [
"Findings - Project"
],
"summary": "Get project security findings (Dependencies - SCA)",
"description": "Returns all security findings for a given project",
"operationId": "getSecurityVulnerabilityFindings",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3CollectionSecurityFindingDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/dependencies/findings/security/groupBy/rootLibrary": {
"get": {
"tags": [
"Findings - Project"
],
"summary": "Get root libraries security findings (Dependencies - SCA)",
"description": "Get root libraries security findings for a given project",
"operationId": "getRootLibrarySecurityVulnerabilityFindings",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3CollectionRootLibrarySecurityFindingDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/dependencies/findings/security/rootLibrary/{rootLibraryUuid}": {
"put": {
"tags": [
"Findings - Project"
],
"summary": "Update root library security finding (Dependencies - SCA)",
"description": "Changes a given security finding's status and comments",
"operationId": "updateRootLibrarySecurityFinding",
"parameters": [
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "rootLibraryUuid",
"in": "path",
"description": "Alert UUID (by running the appropriate Get in Alerts - Project).",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFindingsRequestDTOV3"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "boolean"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/dependencies/importSbom": {
"post": {
"tags": [
"Projects"
],
"summary": "Update Project with SBOM (Dependencies - SCA)",
"description": "Upload a single SBOM file to update an existing project. The SBOM scan is queued for asynchronous processing. Supported formats: SPDX (JSON/XML), CycloneDX (JSON/XML).",
"operationId": "updateProjectWithSbom",
"parameters": [
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"sbomFile"
],
"type": "object",
"properties": {
"sbomFile": {
"type": "string",
"description": "The SBOM file to upload (SPDX or CycloneDX). Only one file per request.",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"description": "SBOM scan successfully queued for project update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SbomScanResponseDTO"
}
}
}
},
"400": {
"description": "Invalid SBOM file format or malformed request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Insufficient permissions to update this project",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"404": {
"description": "Project not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3SbomScanResponseDTO"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/dependencies/libraries": {
"get": {
"tags": [
"Findings - Project"
],
"summary": "Get project libraries (Dependencies - SCA)",
"description": "Returns the set of libraries used by a particular project",
"operationId": "getProjectLibraries",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3ListLibraryDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/dependencies/libraries/inHouse": {
"get": {
"tags": [
"Findings - Project"
],
"summary": "Get in-house libraries (Dependencies - SCA)",
"description": "Returns all libraries in a given project that have been designated as \"In-House\". They will not trigger any alerts or be included in license analysis.",
"operationId": "getProprietaryLibraries",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3ListLightLibraryDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/dependencies/libraries/licenses": {
"get": {
"tags": [
"Findings - Project"
],
"summary": "Get project due diligence information (Dependencies - SCA)",
"description": "Returns a due diligence report listing the source and license information for all libraries in a project",
"operationId": "getDueDiligenceInfoByMultipleContexts",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "Specifies the maximum number of items to be returned in the response.",
"allowEmptyValue": true,
"schema": {
"maximum": 10000,
"type": "string",
"default": "50"
}
},
{
"name": "cursor",
"in": "query",
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"allowEmptyValue": true,
"schema": {
"type": "string"
}
},
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponsePageableV3ListDueDiligenceDTOV3"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/dependencies/reports/SBOM": {
"post": {
"tags": [
"Reports"
],
"summary": "Export project SBOM report asynchronously (Dependencies - SCA)",
"operationId": "exportSbomReport",
"parameters": [
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateProjectSbomReportDTOReport"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/dependencies/reports/dueDiligence": {
"post": {
"tags": [
"Reports"
],
"summary": "Export project Due Diligence report asynchronously (Dependencies - SCA)",
"operationId": "exportProjectDueDiligenceReport",
"parameters": [
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateReportDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DWRResponseV3ReportExportProcessDTO"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/scans/{scanUuid}/dependencies/SBOM/logs": {
"get": {
"tags": [
"Scans"
],
"summary": "Download Scan Logs CSV",
"description": "Downloads the scan logs CSV file from storage. Only available when scan is not running.",
"operationId": "getScanLogsCsv",
"parameters": [
{
"name": "projectUuid",
"in": "path",
"description": "UUID of the project",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "scanUuid",
"in": "path",
"description": "Scan UUID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StreamingResponseBody"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DWRResponseBase"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/code/findings": {
"get": {
"description": "Get a list of findings for a specified project UUID.\n\nThis endpoint supports paging using cursor and limit parameters described in Parameters section below.",
"operationId": "listProjectFindingsV3.0",
"parameters": [
{
"description": "UUID of the project",
"in": "path",
"name": "projectUuid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Specifies the maximum number of items to be returned in the response.",
"in": "query",
"name": "limit",
"schema": {
"type": "integer"
}
},
{
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"in": "query",
"name": "cursor",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendCursoredResponse-array_dto_FindingV3"
}
}
}
},
"400": {
"description": "Invalid query definition",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
},
"403": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
},
"500": {
"description": "Error while processing the request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer-key": []
}
],
"summary": "Get a list of project findings (SAST)",
"tags": [
"Findings - Project"
]
},
"patch": {
"description": "Bulk update of project findings state (review and/or suppression) or severity",
"operationId": "bulkPatchProjectFindingV3.0",
"parameters": [
{
"description": "UUID of the project",
"in": "path",
"name": "projectUuid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.BulkPatchFinding"
}
}
},
"description": "Bulk patch operation to apply to the findings",
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendResponse-dto_SuccessResponse"
}
}
}
},
"400": {
"description": "Invalid query definition",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
},
"403": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
},
"500": {
"description": "Error while processing the request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer-key": []
}
],
"summary": "Bulk update of project findings state (review and/or suppression) or severity (SAST)",
"tags": [
"Findings - Project"
]
}
},
"/api/v3.0/projects/{projectUuid}/code/findings/{findingSnapshotId}": {
"patch": {
"description": "Update a project finding state (review and/or suppression) or severity",
"operationId": "patchProjectFindingV3.0",
"parameters": [
{
"description": "UUID of the project",
"in": "path",
"name": "projectUuid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "UUID of the finding snapshot",
"in": "path",
"name": "findingSnapshotId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.PatchFinding"
}
}
},
"description": "Patch operation to apply to the finding",
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/dto.MendResponse-dto_SuccessResponse"
}
}
}
},
"400": {
"description": "Invalid query definition",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
},
"403": {
"description": "Unauthorized",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
},
"500": {
"description": "Error while processing the request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer-key": []
}
],
"summary": "Update a project finding state (review and/or suppression) or severity (SAST)",
"tags": [
"Findings - Project"
]
}
},
"/api/v3.0/projects/{projectUuid}/code/findings/{findingUuid}": {
"get": {
"description": "Get a project finding for a specified project and finding UUID.\n",
"operationId": "getProjectFindingV3.0",
"parameters": [
{
"description": "UUID of the project",
"in": "path",
"name": "projectUuid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "UUID of the finding",
"in": "path",
"name": "findingUuid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendResponse-dto_FindingV3"
}
}
}
},
"400": {
"description": "Invalid query definition",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
},
"403": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
},
"500": {
"description": "Error while processing the request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer-key": []
}
],
"summary": "Get a project finding (SAST)",
"tags": [
"Findings - Project"
]
}
},
"/api/v3.0/projects/{projectUuid}/scans/{scanUuid}/code/findings": {
"get": {
"description": "Get a list of findings for a specified project scan UUID.\n\nThis endpoint supports paging using cursor and limit parameters described in Parameters section below.",
"operationId": "listProjectScanFindingsV3.0",
"parameters": [
{
"description": "UUID of the project",
"in": "path",
"name": "projectUuid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "UUID of the project scan for which to get findings",
"in": "path",
"name": "scanUuid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Specifies the maximum number of items to be returned in the response.",
"in": "query",
"name": "limit",
"schema": {
"type": "integer"
}
},
{
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"in": "query",
"name": "cursor",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendCursoredResponse-array_dto_FindingV3"
}
}
}
},
"400": {
"description": "Invalid query definition",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
},
"403": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
},
"500": {
"description": "Error while processing the request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer-key": []
}
],
"summary": "Get a list of project scan findings (SAST)",
"tags": [
"Findings - Scan"
]
}
},
"/api/v3.0/projects/{projectUuid}/scans/{scanUuid}/code/findings/{findingUuid}": {
"get": {
"description": "Get a project finding for a specified project, scan and finding UUID.\n",
"operationId": "getProjectScanFindingV3.0",
"parameters": [
{
"description": "UUID of the project",
"in": "path",
"name": "projectUuid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "UUID of the project for which to get findings",
"in": "path",
"name": "scanUuid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "UUID of the finding",
"in": "path",
"name": "findingUuid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendResponse-dto_FindingV3"
}
}
}
},
"400": {
"description": "Invalid query definition",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
},
"403": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
},
"500": {
"description": "Error while processing the request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/dto.MendErrorResponse-dto_ErrorResponse"
}
}
}
}
},
"security": [
{
"bearer-key": []
}
],
"summary": "Get a project scan finding (SAST)",
"tags": [
"Findings - Scan"
]
}
},
"/api/v3.0/projects/{projectuuid}/images/findings": {
"post": {
"security": [
{
"bearer-key": []
}
],
"description": "Update the status of multiple findings in bulk (e.g. suppress, review)",
"tags": [
"Findings - Project"
],
"summary": "Update multiple findings status (Containers)",
"operationId": "updateImgBulkStatus",
"parameters": [
{
"description": "UUID of the project",
"name": "projectuuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/inputs.FindingStatusInputV3"
}
}
}
},
"description": "Array of finding status update requests. Each item requires: status. For findings, either packageUUID or vulnerabilityName should be provided. For 'suppressed' status, reason is also required.",
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/common.BaseApiResponseV3"
},
{
"type": "object",
"properties": {
"response": {
"$ref": "#/components/schemas/model.BulkStatusUpdate"
}
}
}
]
}
}
}
},
"400": {
"description": "Bad request - missing required fields, invalid values, or empty array",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"additionalData": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"response": {
"type": "array",
"items": {}
},
"supportToken": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Project not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"additionalData": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"response": {
"type": "array",
"items": {}
},
"supportToken": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Failed updating findings status",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"additionalData": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"response": {
"type": "array",
"items": {}
},
"supportToken": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectuuid}/images/findings/packages/{packageuuid}": {
"put": {
"security": [
{
"bearer-key": []
}
],
"description": "Update the status of a package (e.g. suppress, review)",
"tags": [
"Findings - Project"
],
"summary": "Update package status (Containers)",
"operationId": "updateImgPackageStatus",
"parameters": [
{
"description": "UUID of the project",
"name": "projectuuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "package UUID",
"name": "packageuuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputs.FindingStatusInputV3"
}
}
},
"description": "Package status update request. Required fields: status. For 'suppressed' status, reason is also required.",
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/common.BaseApiResponseV3"
},
{
"type": "object",
"properties": {
"response": {
"$ref": "#/components/schemas/github_com_mend_cloud-native_modules_common_model.FindingStatus"
}
}
}
]
}
}
}
},
"400": {
"description": "Bad request - missing required fields or invalid values",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"additionalData": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"response": {
"type": "array",
"items": {}
},
"supportToken": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Project not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"additionalData": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"response": {
"type": "array",
"items": {}
},
"supportToken": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Failed updating package status",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"additionalData": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"response": {
"type": "array",
"items": {}
},
"supportToken": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectuuid}/images/findings/secrets": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "List the latest image scan secrets findings",
"tags": [
"Findings - Project"
],
"summary": "List latest image scan secrets findings (Containers)",
"operationId": "listLatestImgScanSecretsFindings",
"parameters": [
{
"description": "UUID of the project",
"name": "projectuuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Specifies the maximum number of items to be returned in the response.",
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/common.BaseApiResponseV3"
},
{
"type": "object",
"properties": {
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/github_com_mend_cloud-native_modules_scanner_model.SecretFinding"
}
}
}
}
]
}
}
}
},
"500": {
"description": "failed loading image secrets findings",
"content": {
"*/*": {
"schema": {
"type": "object",
"properties": {
"additionalData": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"response": {
"type": "array",
"items": {}
},
"supportToken": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectuuid}/images/findings/security": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "List the latest image scan security findings",
"tags": [
"Findings - Project"
],
"summary": "List latest image scan security findings (Containers)",
"operationId": "listLatestImgScanSecurityFindings",
"parameters": [
{
"description": "UUID of the project",
"name": "projectuuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Specifies the maximum number of items to be returned in the response.",
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/common.BaseApiResponseV3"
},
{
"type": "object",
"properties": {
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/model.SecurityFindingExternal"
}
}
}
}
]
}
}
}
},
"500": {
"description": "failed loading image security findings",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"additionalData": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"response": {
"type": "array",
"items": {}
},
"supportToken": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectuuid}/images/findings/security/{findingid}": {
"put": {
"security": [
{
"bearer-key": []
}
],
"description": "Update the status of a finding (e.g. suppress, review)",
"tags": [
"Findings - Project"
],
"summary": "Update finding status (Containers)",
"operationId": "updateImgFindingStatus",
"parameters": [
{
"description": "UUID of the project",
"name": "projectuuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "vulnerability ID (CVE)",
"name": "findingid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputs.FindingStatusInputV3"
}
}
},
"description": "Finding status update request. Required fields: status. For 'suppressed' status, reason is also required.",
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/common.BaseApiResponseV3"
},
{
"type": "object",
"properties": {
"response": {
"$ref": "#/components/schemas/github_com_mend_cloud-native_modules_common_model.FindingStatus"
}
}
}
]
}
}
}
},
"400": {
"description": "Bad request - missing required fields or invalid values",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"additionalData": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"response": {
"type": "array",
"items": {}
},
"supportToken": {
"type": "string"
}
}
}
}
}
},
"404": {
"description": "Project not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"additionalData": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"response": {
"type": "array",
"items": {}
},
"supportToken": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Failed updating finding status",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"additionalData": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"response": {
"type": "array",
"items": {}
},
"supportToken": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectuuid}/images/packages": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "List the latest image scan packages",
"tags": [
"Findings - Project"
],
"summary": "List latest image scan packages (Containers)",
"operationId": "listLatestImgScanPackages",
"parameters": [
{
"description": "UUID of the project",
"name": "projectuuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Specifies the maximum number of items to be returned in the response.",
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/common.BaseApiResponseV3"
},
{
"type": "object",
"properties": {
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/github_com_mend_cloud-native_modules_scanner_model.Package"
}
}
}
}
]
}
}
}
},
"500": {
"description": "failed loading image packages",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"additionalData": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"response": {
"type": "array",
"items": {}
},
"supportToken": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectuuid}/scans/{scanuuid}/images/findings/secrets": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "List the image scan secrets findings",
"tags": [
"Findings - Scan"
],
"summary": "List image scan secrets findings (Containers)",
"operationId": "listImgScanSecretsFindings",
"parameters": [
{
"description": "UUID of the project",
"name": "projectuuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "scan UUID",
"name": "scanuuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Specifies the maximum number of items to be returned in the response.",
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/common.BaseApiResponseV3"
},
{
"type": "object",
"properties": {
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/github_com_mend_cloud-native_modules_scanner_model.SecretFinding"
}
}
}
}
]
}
}
}
},
"500": {
"description": "failed loading image secrets findings",
"content": {
"*/*": {
"schema": {
"type": "object",
"properties": {
"additionalData": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"response": {
"type": "array",
"items": {}
},
"supportToken": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectuuid}/scans/{scanuuid}/images/findings/security": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "List the image scan security findings",
"tags": [
"Findings - Scan"
],
"summary": "List image scan security findings (Containers)",
"operationId": "listImgScanSecurityFindings",
"parameters": [
{
"description": "UUID of the project",
"name": "projectuuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "scan UUID",
"name": "scanuuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Specifies the maximum number of items to be returned in the response.",
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/common.BaseApiResponseV3"
},
{
"type": "object",
"properties": {
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/model.SecurityFindingExternal"
}
}
}
}
]
}
}
}
},
"500": {
"description": "failed loading image security findings",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"additionalData": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"response": {
"type": "array",
"items": {}
},
"supportToken": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectuuid}/scans/{scanuuid}/images/packages": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "List the image scan packages",
"tags": [
"Findings - Scan"
],
"summary": "List image scan packages (Containers)",
"operationId": "listImgScanPackages",
"parameters": [
{
"description": "UUID of the project",
"name": "projectuuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "scan UUID",
"name": "scanuuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Specifies the maximum number of items to be returned in the response.",
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/common.BaseApiResponseV3"
},
{
"type": "object",
"properties": {
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/github_com_mend_cloud-native_modules_scanner_model.Package"
}
}
}
}
]
}
}
}
},
"500": {
"description": "failed loading image scan packages",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"additionalData": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"response": {
"type": "array",
"items": {}
},
"supportToken": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/ai/findings/technologies": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "Returns a list of AI technologies used in a specific project",
"tags": [
"Findings - Project"
],
"summary": "Get project AI technologies (AI)",
"operationId": "getProjectAITechnologies",
"parameters": [
{
"description": "UUID of the project",
"name": "projectUuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Specifies the maximum number of items to be returned in the response.",
"name": "limit",
"in": "query",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v3.V3BaseResponse-array_v3_DTO_AIComponent"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/ai/findings/models": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "Returns a list of AI models used in a specific project",
"tags": [
"Findings - Project"
],
"summary": "Get project AI models (AI)",
"operationId": "getProjectAIModels",
"parameters": [
{
"description": "UUID of the project",
"name": "projectUuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Specifies the maximum number of items to be returned in the response.",
"name": "limit",
"in": "query",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v3.V3BaseResponse-array_v3_DTO_AIModel"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/ai/vulnerabilities": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "Returns a list of AI vulnerabilities found in a specific project",
"tags": [
"Findings - Project"
],
"summary": "Get project AI vulnerabilities",
"operationId": "getProjectAIVulnerabilities",
"parameters": [
{
"description": "UUID of the project",
"name": "projectUuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Specifies the maximum number of items to be returned in the response.",
"name": "limit",
"in": "query",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v3.DTO_AIVulnerabilitiesResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/ai/vulnerabilities/{vulnerabilityId}": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "Returns detailed information about a specific AI vulnerability",
"tags": [
"Findings - Project"
],
"summary": "Get AI vulnerability details",
"operationId": "getProjectAIVulnerabilityDetails",
"parameters": [
{
"description": "UUID of the project",
"name": "projectUuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Vulnerability ID (e.g., MAI-2023-0002)",
"name": "vulnerabilityId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v3.DTO_AIVulnerabilityDetailResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "Vulnerability not found",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/v3.0/applications/{applicationUuid}/ai/findings/models": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "Returns a list of AI models found in a specific application",
"tags": [
"Findings - Project"
],
"summary": "Get application AI models",
"operationId": "getApplicationAIModels",
"parameters": [
{
"description": "Application UUID",
"name": "applicationUuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Specifies the maximum number of items to be returned in the response.",
"name": "limit",
"in": "query",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v3.V3BaseResponse-array_v3_DTO_AIModel"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/v3.0/applications/{applicationUuid}/ai/vulnerabilities": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "Returns a list of AI vulnerabilities found in a specific application",
"tags": [
"Findings - Project"
],
"summary": "Get application AI vulnerabilities",
"operationId": "getApplicationAIVulnerabilities",
"parameters": [
{
"description": "Application UUID",
"name": "applicationUuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Specifies the maximum number of items to be returned in the response.",
"name": "limit",
"in": "query",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v3.DTO_AIVulnerabilitiesResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/ai/findings/implementation": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "Returns implementation findings for a project",
"tags": [
"Findings - Project"
],
"summary": "Get project implementation findings",
"operationId": "getProjectImplementationFindings",
"parameters": [
{
"description": "UUID of the project",
"name": "projectUuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Specifies the maximum number of items to be returned in the response.",
"name": "limit",
"in": "query",
"schema": {
"type": "integer"
}
},
{
"description": "Group findings by element",
"name": "grouped",
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v3.V3Response-array_v3_V3ImplementationFindingResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/ai/findings/implementation/snippet/{snippetUuid}": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "Returns the code snippet and finding details for a specific implementation finding",
"tags": [
"Findings - Project"
],
"summary": "Get implementation finding snippet",
"operationId": "getImplementationSnippet",
"parameters": [
{
"description": "UUID of the project",
"name": "projectUuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Snippet UUID",
"name": "snippetUuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Specifies the maximum number of items to be returned in the response.",
"name": "limit",
"in": "query",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v3.V3Response-array_v3_V3ImplementationFindingResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "Snippet not found",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/v3.0/applications/{applicationUuid}/ai/findings/implementation": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "Returns implementation findings aggregated across all projects in an application",
"tags": [
"Findings - Project"
],
"summary": "Get application implementation findings",
"operationId": "getApplicationImplementationFindings",
"parameters": [
{
"description": "Application UUID",
"name": "applicationUuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.",
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
},
{
"description": "Specifies the maximum number of items to be returned in the response.",
"name": "limit",
"in": "query",
"schema": {
"type": "integer"
}
},
{
"description": "Group findings by element",
"name": "grouped",
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v3.V3Response-array_v3_V3ImplementationFindingResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/v3.0/ai/implementationweakness": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "Returns a list of implementation weakness types and their details",
"tags": [
"AI"
],
"summary": "Get implementation weaknesses",
"operationId": "getImplementationWeaknesses",
"parameters": [
{
"description": "Filter by specific weakness ID",
"name": "weaknessID",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/v3.V3ImplementationWeaknessResponse"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/v3.0/applications/{applicationUuid}/ai/vulnerabilities/{vulnerabilityId}": {
"get": {
"security": [
{
"bearer-key": []
}
],
"description": "Returns detailed information about a specific AI vulnerability in an application",
"tags": [
"Findings - Project"
],
"summary": "Get application AI vulnerability details",
"operationId": "getApplicationAIVulnerabilityDetails",
"parameters": [
{
"description": "Application UUID",
"name": "applicationUuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Vulnerability ID (e.g., MAI-2023-0002)",
"name": "vulnerabilityId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v3.DTO_AIVulnerabilityDetailResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "Vulnerability not found",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/v3.0/projects/{projectUuid}/ai/redteam/trigger": {
"post": {
"security": [
{
"bearer-key": []
}
],
"description": "Triggers a test run.",
"tags": [
"Red Team"
],
"summary": "Trigger test run",
"operationId": "triggerTestRun",
"parameters": [
{
"description": "UUID of the project",
"name": "projectUuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v3.V3TestRunTriggerRequest"
}
}
},
"description": "Test run trigger configuration",
"required": true
},
"responses": {
"200": {
"description": "Test run triggered successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v3.V3BaseResponse-v3_V3TestRunTriggerResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"DWRResponseBase": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
}
}
},
"DWRResponseV3Boolean": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "boolean"
}
}
},
"ProjectViolationIdentifierDTOV3": {
"type": "object",
"properties": {
"findingUuid": {
"type": "string"
},
"originUuid": {
"type": "string"
},
"projectUuid": {
"type": "string"
}
}
},
"UpdateMultipleProjectViolationSlaRequestDTOV3": {
"type": "object",
"properties": {
"date": {
"title": "Date",
"pattern": "yyyy-MM-dd",
"type": "string",
"example": "2024/12/31"
},
"identifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectViolationIdentifierDTOV3"
}
}
}
},
"LabelRequestDTOV3": {
"required": [
"namespace",
"value"
],
"type": "object",
"properties": {
"namespace": {
"title": "Label Namespace",
"type": "string",
"example": "Label Namespace A"
},
"value": {
"title": "Label Value",
"type": "string",
"example": "Label Value A"
}
}
},
"DWRResponseV3MessageDTO": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"$ref": "#/components/schemas/MessageDTO"
}
}
},
"MessageDTO": {
"type": "object",
"properties": {
"message": {
"title": "message",
"type": "string",
"example": "Success!"
}
}
},
"DomainLabelRequestDTO": {
"required": [
"namespace",
"value"
],
"type": "object",
"properties": {
"namespace": {
"title": "Label Namespace",
"type": "string",
"example": "Label Namespace A"
},
"value": {
"title": "Label Value",
"type": "string",
"example": "Label Value A"
}
}
},
"UpdateGroupRequestDTO": {
"type": "object",
"properties": {
"name": {
"title": "Group Name",
"type": "string",
"example": "Group A"
},
"description": {
"title": "Group Description",
"type": "string",
"example": "Group description"
}
},
"description": "DTO for updating an existing group"
},
"DWRResponseV3GroupDTO": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"$ref": "#/components/schemas/GroupDTO"
}
}
},
"GroupDTO": {
"type": "object",
"properties": {
"uuid": {
"title": "Group UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "Group Name",
"type": "string",
"example": "Group A"
},
"description": {
"title": "Group Description",
"type": "string",
"example": "Group description"
},
"userCount": {
"title": "User Count",
"type": "integer",
"format": "int32",
"example": 22
}
}
},
"EntityTreeDTO": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"scopeUuid": {
"type": "string"
},
"scopeName": {
"type": "string"
}
}
},
"ReportExportProcessDTO": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"scopeUuid": {
"type": "string"
},
"scopeName": {
"type": "string"
},
"subScopes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityTreeDTO"
}
},
"title": {
"type": "string"
},
"reportType": {
"type": "string",
"enum": [
"attribution",
"inventory",
"vulnerabilities",
"securityAlerts",
"sbom",
"securityAlertsLibrary",
"Compliance",
"Findings",
"Suppressions",
"Resolved",
"spdx",
"spdx_2_3",
"cycloneDX",
"cycloneDX_1_5",
"cycloneDX_1_6",
"dueDiligence",
"unknown",
"imgAttribution",
"imgDueDiligence",
"imgSpdx",
"imgSpdx_2_3",
"imgCycloneDX",
"imgCycloneDX_1_5",
"aiInventory",
"aiFindings",
"imgCycloneDX_1_6",
"risk"
]
},
"format": {
"type": "string",
"enum": [
"json",
"html",
"unknown",
"xml",
"excel",
"yaml",
"pdf",
"tv",
"rdf",
"csv",
"sarif"
]
},
"scopeType": {
"type": "string",
"enum": [
"organization",
"product",
"project",
"unsupported",
"account"
]
},
"scopeUuidList": {
"type": "array",
"items": {
"type": "string"
}
},
"projectUuids": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string",
"enum": [
"PENDING",
"IN_PROGRESS",
"FAILED",
"FAILURE",
"SUCCESS"
]
},
"createdBy": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"sendEmailNotification": {
"type": "boolean"
},
"labelsUuidList": {
"type": "array",
"items": {
"type": "string"
}
},
"includeVulnerabilities": {
"type": "boolean"
},
"excludeInactiveProjects": {
"type": "boolean"
}
}
},
"DWRResponseV3ReportExportProcessDTO": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"$ref": "#/components/schemas/ReportExportProcessDTO"
}
}
},
"AttributionImgReportExportDTO": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"scopeUuid": {
"type": "string"
},
"scopeName": {
"type": "string"
},
"subScopes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityTreeDTO"
}
},
"title": {
"type": "string"
},
"reportType": {
"type": "string",
"enum": [
"attribution",
"inventory",
"vulnerabilities",
"securityAlerts",
"sbom",
"securityAlertsLibrary",
"Compliance",
"Findings",
"Suppressions",
"Resolved",
"spdx",
"spdx_2_3",
"cycloneDX",
"cycloneDX_1_5",
"cycloneDX_1_6",
"dueDiligence",
"unknown",
"imgAttribution",
"imgDueDiligence",
"imgSpdx",
"imgSpdx_2_3",
"imgCycloneDX",
"imgCycloneDX_1_5",
"aiInventory",
"aiFindings",
"imgCycloneDX_1_6",
"risk"
]
},
"format": {
"type": "string",
"enum": [
"json",
"html",
"unknown",
"xml",
"excel",
"yaml",
"pdf",
"tv",
"rdf",
"csv",
"sarif"
]
},
"scopeType": {
"type": "string",
"enum": [
"organization",
"product",
"project",
"unsupported",
"account"
]
},
"scopeUuidList": {
"type": "array",
"items": {
"type": "string"
}
},
"projectUuids": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string",
"enum": [
"PENDING",
"IN_PROGRESS",
"FAILED",
"FAILURE",
"SUCCESS"
]
},
"createdBy": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"sendEmailNotification": {
"type": "boolean"
},
"labelsUuidList": {
"type": "array",
"items": {
"type": "string"
}
},
"includeVulnerabilities": {
"type": "boolean"
},
"excludeInactiveProjects": {
"type": "boolean"
},
"groupBy": {
"type": "string",
"enum": [
"BY_COMPONENT",
"BY_PROJECT"
]
},
"header": {
"type": "string"
},
"footer": {
"type": "string"
},
"selectedColumns": {
"type": "array",
"items": {
"type": "string",
"enum": [
"SUMMARY",
"PROJECTS",
"PRODUCTS",
"LICENSES",
"NOTICES",
"COPYRIGHTS",
"PRIMARY_ATTRIBUTES",
"PACKAGE_NAME",
"PACKAGE_VERSION"
]
}
}
}
},
"CreateReportDTO": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"format": {
"type": "string",
"enum": [
"json",
"html",
"unknown",
"xml",
"excel",
"yaml",
"pdf",
"tv",
"rdf",
"csv",
"sarif"
]
},
"sendEmailNotification": {
"type": "boolean"
},
"labelsUuidList": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeInactiveProjects": {
"type": "boolean"
},
"additionalParams": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"ResolvedReportExportProcessDTOV3": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"format": {
"type": "string",
"enum": [
"json",
"html",
"unknown",
"xml",
"excel",
"yaml",
"pdf",
"tv",
"rdf",
"csv",
"sarif"
]
},
"sendEmailNotification": {
"type": "boolean"
},
"labelsUuidList": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeInactiveProjects": {
"type": "boolean"
},
"fromDate": {
"type": "string"
},
"toDate": {
"type": "string"
},
"additionalParams": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"CodeReportExportProcessDTOV3": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"format": {
"type": "string",
"enum": [
"json",
"html",
"unknown",
"xml",
"excel",
"yaml",
"pdf",
"tv",
"rdf",
"csv",
"sarif"
]
},
"sendEmailNotification": {
"type": "boolean"
},
"labelsUuidList": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeInactiveProjects": {
"type": "boolean"
},
"complianceStandard": {
"type": "string"
},
"reportLevel": {
"type": "string"
},
"description": {
"type": "string"
},
"additionalParams": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"InviteUserRequestDTO": {
"required": [
"email"
],
"type": "object",
"properties": {
"email": {
"title": "New User Email",
"type": "string",
"example": "jon.smith@mail.com"
}
}
},
"DWRResponseV3UserInfoResponseDTO": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"$ref": "#/components/schemas/UserInfoResponseDTO"
}
}
},
"UserInfoResponseDTO": {
"required": [
"uuid"
],
"type": "object",
"properties": {
"uuid": {
"title": "User UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "User Name",
"type": "string",
"example": "Jon Smith"
},
"email": {
"title": "User Email",
"type": "string",
"example": "jon.smith@mail.com"
},
"userType": {
"title": "Type Of User",
"type": "string",
"example": "REGULAR",
"enum": [
"REGULAR",
"SERVICE",
"SCAN_SUMMARY_RECEIVER"
]
},
"existsInOrg": {
"type": "boolean"
}
}
},
"MultiContextRequestDTOV3": {
"type": "object",
"properties": {
"applicationUuids": {
"type": "array",
"items": {
"title": "Application UUIDs",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"projectUuids": {
"type": "array",
"items": {
"title": "Project UUIDs",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
},
"description": "If projectUuids and applicationUuid are empty, action will apply to the whole organization"
},
"DWRResponsePageableV3ListProjectSummaryDTOV3": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectSummaryDTOV3"
}
}
}
},
"EntityLabelDTOV3": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"namespace": {
"type": "string"
},
"value": {
"type": "string"
},
"displayName": {
"type": "string"
},
"scopeType": {
"type": "string",
"enum": [
"organization",
"application",
"project",
"account",
"unsupported"
]
},
"system": {
"type": "boolean"
}
}
},
"EntityTagDTO": {
"type": "object",
"properties": {
"key": {
"title": "Entity Tag Key",
"type": "string",
"example": "key"
},
"value": {
"title": "Entity Tag value",
"type": "string",
"example": "value"
}
}
},
"ProjectSummaryDTOV3": {
"type": "object",
"properties": {
"uuid": {
"title": "Project UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "Project Name",
"type": "string",
"example": "My Project"
},
"path": {
"title": "Application Name",
"type": "string",
"example": "My Application"
},
"applicationName": {
"title": "Application Name",
"type": "string",
"example": "My Application"
},
"applicationUuid": {
"title": "Application Uuid",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"lastScanned": {
"type": "string",
"format": "date-time",
"deprecated": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityTagDTO"
}
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityLabelDTOV3"
}
},
"statistics": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
}
}
}
},
"OrganizationLabelRequestDTO": {
"required": [
"namespace",
"value"
],
"type": "object",
"properties": {
"namespace": {
"title": "Label Namespace",
"type": "string",
"example": "Label Namespace A"
},
"value": {
"title": "Label Value",
"type": "string",
"example": "Label Value A"
}
}
},
"UserEmailsRequestDTO": {
"required": [
"userEmails"
],
"type": "object",
"properties": {
"userEmails": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"example": "jon.smith@mail.com"
}
}
}
},
"GroupRoleRequestDTOV3": {
"required": [
"scopeType",
"scopeUuid"
],
"type": "object",
"properties": {
"scopeUuid": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"scopeType": {
"type": "string",
"example": "organization",
"enum": [
"organization",
"application",
"project",
"account",
"unsupported"
]
},
"role": {
"type": "string",
"enum": [
"ADMIN",
"SCAN_MANAGER",
"SECURITY_ANALYST",
"MEMBER"
]
}
}
},
"DWRResponseV3GroupRoleDTOV3": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"$ref": "#/components/schemas/GroupRoleDTOV3"
}
}
},
"GroupRoleDTOV3": {
"type": "object",
"properties": {
"scopeUuid": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"scopeName": {
"title": "Context Name",
"type": "string",
"example": "My Project"
},
"scopeType": {
"type": "string",
"description": "Type of entity the role will be associated with",
"example": "organization",
"enum": [
"organization",
"application",
"project",
"account",
"unsupported"
]
},
"role": {
"type": "string",
"enum": [
"ADMIN",
"SCAN_MANAGER",
"SECURITY_ANALYST",
"MEMBER"
]
}
}
},
"CreateGroupRequestDTO": {
"required": [
"description",
"name"
],
"type": "object",
"properties": {
"name": {
"title": "Group Name",
"type": "string",
"example": "Group A"
},
"description": {
"title": "Group Description",
"type": "string",
"example": "Group description"
}
}
},
"ApplicationSummaryDTOV3": {
"type": "object",
"properties": {
"uuid": {
"title": "Application Uuid",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "Application Name",
"type": "string",
"example": "Application A"
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityTagDTO"
}
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityLabelDTOV3"
}
},
"statistics": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
}
}
}
},
"DWRResponsePageableV3ListApplicationSummaryDTOV3": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationSummaryDTOV3"
}
}
}
},
"AccessTokenRequestDTO": {
"type": "object",
"properties": {
"accessToken": {
"type": "string"
}
},
"description": "The \"accessToken\" in the request body is used only when refreshing an existing token. Sending a valid JWT in the body allows the system to generate a new access token more efficiently. This method should not be used when initially calling the endpoint to generate a new access token."
},
"AccessTokenResponseDTO": {
"type": "object",
"properties": {
"userUuid": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"jwtToken": {
"type": "string"
},
"tokenType": {
"type": "string"
},
"orgName": {
"type": "string"
},
"orgUuid": {
"type": "string"
},
"accountName": {
"type": "string"
},
"accountUuid": {
"type": "string"
},
"tokenTTL": {
"type": "integer",
"format": "int64"
},
"systemAccess": {
"type": "boolean"
},
"serviceSystemAccess": {
"type": "boolean"
},
"sessionStartTime": {
"type": "integer",
"format": "int64"
},
"systemAccessStartTime": {
"type": "integer",
"format": "int64"
}
}
},
"DWRResponseV3AccessTokenResponseDTO": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"$ref": "#/components/schemas/AccessTokenResponseDTO"
}
}
},
"LoginModelDTOV3": {
"required": [
"email",
"userKey"
],
"type": "object",
"properties": {
"email": {
"title": "Email",
"type": "string",
"example": "jon.smith@mail.com"
},
"userKey": {
"title": "User Key",
"type": "string",
"description": "Equivalent to a personal access token. Avoid pasting as plain text where it might be compromised. For a service user (recommended), you can find the user key in the Mend SCA App in **Admin > Users**. [Learn more](https://docs.mend.io/bundle/mend_maintenance/page/managing_service_users.html). For local testing purposes, you could also use one of your own personal user keys from your user profile page in the Mend SCA App.",
"example": "***********"
}
},
"description": "Login Model that provides user name and password for the Login process."
},
"DWRResponseV3LoginResponseDTO": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"$ref": "#/components/schemas/LoginResponseDTO"
}
}
},
"LoginResponseDTO": {
"type": "object",
"properties": {
"userUuid": {
"type": "string"
},
"userName": {
"type": "string"
},
"email": {
"type": "string"
},
"refreshToken": {
"type": "string"
},
"jwtTTL": {
"type": "integer",
"format": "int64"
},
"systemAccess": {
"type": "boolean"
},
"serviceSystemAccess": {
"type": "boolean"
},
"sessionStartTime": {
"type": "integer",
"format": "int64"
},
"systemAccessStartTime": {
"type": "integer",
"format": "int64"
}
}
},
"DWRResponsePageableV3ListUserInfoDTOV3": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserInfoDTOV3"
}
}
}
},
"UserInfoDTOV3": {
"required": [
"uuid"
],
"type": "object",
"properties": {
"uuid": {
"title": "User UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "User Name",
"type": "string",
"example": "Jon Smith"
},
"email": {
"title": "User Email",
"type": "string",
"example": "jon.smith@mail.com"
},
"userType": {
"title": "Type Of User",
"type": "string",
"example": "REGULAR",
"enum": [
"REGULAR",
"SERVICE",
"SCAN_SUMMARY_RECEIVER"
]
},
"accountStatus": {
"title": "User Account Status",
"type": "string",
"example": "ACTIVE",
"enum": [
"ACTIVE",
"INVITED",
"DISABLED"
]
}
}
},
"DWRResponseV3ReportExportProcessDTOV3": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"$ref": "#/components/schemas/ReportExportProcessDTOV3"
}
}
},
"ReportExportProcessDTOV3": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"scopeUuid": {
"type": "string"
},
"scopeName": {
"type": "string"
},
"subScopes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityTreeDTO"
}
},
"title": {
"type": "string"
},
"reportType": {
"type": "string",
"enum": [
"attribution",
"inventory",
"vulnerabilities",
"securityAlerts",
"sbom",
"securityAlertsLibrary",
"Compliance",
"Findings",
"Suppressions",
"Resolved",
"spdx",
"spdx_2_3",
"cycloneDX",
"cycloneDX_1_5",
"cycloneDX_1_6",
"dueDiligence",
"unknown",
"imgAttribution",
"imgDueDiligence",
"imgSpdx",
"imgSpdx_2_3",
"imgCycloneDX",
"imgCycloneDX_1_5",
"aiInventory",
"aiFindings",
"imgCycloneDX_1_6",
"risk"
]
},
"format": {
"type": "string",
"enum": [
"json",
"html",
"unknown",
"xml",
"excel",
"yaml",
"pdf",
"tv",
"rdf",
"csv",
"sarif"
]
},
"scopeType": {
"type": "string",
"enum": [
"organization",
"application",
"project",
"account",
"unsupported"
]
},
"status": {
"type": "string",
"enum": [
"PENDING",
"IN_PROGRESS",
"FAILED",
"FAILURE",
"SUCCESS"
]
},
"createdBy": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"DWRResponsePageableV3ListReportExportProcessDTOV3": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReportExportProcessDTOV3"
}
}
}
},
"DWRResponsePageableV3ListProjectViolationDTOV3": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectViolationDTOV3"
}
}
}
},
"ProjectViolationDTOV3": {
"required": [
"engine",
"findingType"
],
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"projectUuid": {
"type": "string"
},
"projectName": {
"type": "string"
},
"engine": {
"type": "string",
"description": "Type of engine the violation relates to",
"example": "SCA",
"enum": [
"UNIFIED",
"SCA",
"SAST",
"IAC",
"IMG",
"AI",
"DAST"
]
},
"findingType": {
"type": "string",
"description": "Type of finding",
"example": "SECURITY",
"enum": [
"SECURITY",
"LEGAL",
"LIBRARY"
]
},
"originUuid": {
"type": "string"
},
"originName": {
"type": "string"
},
"risk": {
"type": "string",
"description": "Risk of the violation. Can be one of: LOW, MEDIUM, HIGH, CRITICAL",
"example": "HIGH",
"enum": [
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
]
},
"sla": {
"type": "string"
},
"workflowData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowData"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"refId": {
"type": "string"
},
"violationType": {
"type": "string"
},
"isProjectActive": {
"type": "boolean"
}
}
},
"WorkflowData": {
"type": "object",
"properties": {
"workflowUuid": {
"type": "string"
},
"workflowName": {
"type": "string"
},
"entityUuid": {
"type": "string"
}
}
},
"DWRResponsePageableV3ListScanTagDTO": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScanTagDTO"
}
}
}
},
"ScanTagDTO": {
"type": "object",
"properties": {
"key": {
"title": "Scan Tag Key",
"type": "string",
"example": "commit"
},
"value": {
"title": "Scan Tag Value",
"type": "string",
"example": "123abc"
},
"displayName": {
"title": "Scan Tag Display Name",
"type": "string",
"example": "commit:123abc"
},
"createdAt": {
"title": "Scan Tag Creation Date",
"type": "string",
"format": "date-time"
}
}
},
"DWRResponseV3ScanSummaryDTOV3": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"$ref": "#/components/schemas/ScanSummaryDTOV3"
}
}
},
"ScanSummaryDTOV3": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"processUuid": {
"type": "string"
},
"scanTime": {
"type": "string",
"format": "date-time"
},
"scanStatus": {
"type": "string"
},
"engine": {
"type": "string",
"enum": [
"UNIFIED",
"SCA",
"SAST",
"IAC",
"IMG",
"AI",
"DAST"
]
},
"scanDuration": {
"type": "string"
},
"configurationName": {
"type": "string"
},
"reference": {
"type": "string"
},
"triggeredBy": {
"type": "string"
},
"agentName": {
"type": "string"
},
"agentVersion": {
"type": "string"
},
"supportToken": {
"type": "string"
},
"projectName": {
"type": "string"
},
"projectUuid": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScanTagDTO"
}
},
"applicationName": {
"type": "string"
},
"applicationUuid": {
"type": "string"
},
"workflowUuids": {
"type": "array",
"items": {
"type": "string"
}
},
"workflowNames": {
"type": "array",
"items": {
"type": "string"
}
},
"statistics": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
}
}
}
},
"DWRResponseV3ScanDTOV3": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"$ref": "#/components/schemas/ScanDTOV3"
}
}
},
"ScanAgentInfo": {
"type": "object",
"properties": {
"agentName": {
"type": "string"
},
"agentVersion": {
"type": "string"
},
"errorMessage": {
"type": "string"
}
}
},
"ScanDTOV3": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"engine": {
"type": "string",
"enum": [
"UNIFIED",
"SCA",
"SAST",
"IAC",
"IMG",
"AI",
"DAST"
]
},
"status": {
"type": "string",
"enum": [
"RUNNING",
"PARTIAL",
"PROCESSING",
"FINISHED",
"FAILED"
]
},
"projectId": {
"type": "integer",
"format": "int32"
},
"productId": {
"type": "integer",
"format": "int32"
},
"domainId": {
"type": "integer",
"format": "int32"
},
"projectUuid": {
"type": "string"
},
"processUuid": {
"type": "string"
},
"hasViolations": {
"type": "boolean"
},
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
},
"lastModified": {
"type": "string",
"format": "date-time"
},
"configurationName": {
"type": "string"
},
"reference": {
"type": "string"
},
"triggeredBy": {
"type": "string"
},
"agentInfo": {
"$ref": "#/components/schemas/ScanAgentInfo"
}
}
},
"DWRResponsePageableV3ListScanSummaryDTOV3": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScanSummaryDTOV3"
}
}
}
},
"DWRResponseV3ListEntityLabelDTO": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityLabelDTO"
}
}
}
},
"EntityLabelDTO": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"namespace": {
"type": "string"
},
"value": {
"type": "string"
},
"displayName": {
"type": "string"
},
"contextType": {
"type": "string"
},
"system": {
"type": "boolean"
}
}
},
"DWRResponseV3PeriodTotalsDTO": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"$ref": "#/components/schemas/PeriodTotalsDTO"
}
}
},
"PeriodTotalsDTO": {
"type": "object",
"properties": {
"currentCount": {
"type": "integer"
},
"totalInCurrPeriod": {
"type": "integer"
},
"totalInPrevPeriod": {
"type": "integer"
}
}
},
"DWRResponseV3ListProjectTotalsGroupedByDateDTO": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectTotalsGroupedByDateDTO"
}
}
}
},
"ProjectTotalsGroupedByDateDTO": {
"type": "object",
"properties": {
"creationDate": {
"type": "string",
"format": "date-time"
},
"totals": {
"type": "integer"
}
}
},
"DWRResponsePageableV3CollectionProjectDTOV3": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectDTOV3"
}
}
}
},
"ProjectDTOV3": {
"type": "object",
"properties": {
"uuid": {
"title": "Project UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "Project Name",
"type": "string",
"example": "My Project"
},
"path": {
"title": "Application Name",
"type": "string",
"example": "My Application"
},
"applicationName": {
"title": "Application Name",
"type": "string",
"example": "My Application"
},
"applicationUuid": {
"title": "Application Uuid",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"description": "Project information"
},
"DWRResponsePageableV3ListOrganizationLabelDTOV3": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationLabelDTOV3"
}
}
}
},
"OrganizationLabelDTOV3": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"namespace": {
"type": "string"
},
"value": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"system": {
"type": "boolean"
},
"applications": {
"type": "integer",
"format": "int64"
},
"projects": {
"type": "integer",
"format": "int64"
},
"id": {
"type": "integer",
"format": "int64"
}
}
},
"DWRResponseV3ListIntegrationDTOV3": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntegrationDTOV3"
}
}
}
},
"IntegrationDTOV3": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"orgUuid": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"SUSPENDED",
"DELETED"
]
},
"type": {
"type": "string",
"enum": [
"JIRA",
"GITHUB",
"INVICTI",
"WIZ"
]
},
"variant": {
"type": "string",
"enum": [
"JIRA_CLOUD",
"JIRA_CLOUD_SECURITY",
"JIRA_DC",
"WIZ_COMMERCIAL",
"WIZ_GOV",
"WIZ_COMM_ON_GOV",
"WIZ_DEMO"
]
},
"extraData": {
"type": "object"
},
"createdBy": {
"type": "string"
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"lastUpdate": {
"type": "string",
"format": "date-time"
}
}
},
"DWRResponsePageableV3ListUserInfoDTO": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserInfoDTO"
}
}
}
},
"UserInfoDTO": {
"required": [
"uuid"
],
"type": "object",
"properties": {
"uuid": {
"title": "User UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "User Name",
"type": "string",
"example": "Jon Smith"
},
"email": {
"title": "User Email",
"type": "string",
"example": "jon.smith@mail.com"
},
"userType": {
"title": "Type Of User",
"type": "string",
"example": "REGULAR",
"enum": [
"REGULAR",
"SERVICE",
"SCAN_SUMMARY_RECEIVER"
]
},
"accountStatus": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE",
"LOCKOUT"
]
}
}
},
"DWRResponsePageableV3ListMultipleGroupRolesPerContextDTOV3": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MultipleGroupRolesPerContextDTOV3"
}
}
}
},
"MultipleGroupRolesPerContextDTOV3": {
"required": [
"scopeType",
"scopeUuid"
],
"type": "object",
"properties": {
"scopeUuid": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"scopeName": {
"title": "Scope Name",
"type": "string",
"example": "My Product"
},
"scopeType": {
"type": "string",
"description": "Type of entity the role will be associated with",
"example": "organization",
"enum": [
"organization",
"application",
"project",
"account",
"unsupported"
]
},
"roles": {
"type": "array",
"items": {
"title": "Role",
"type": "string",
"example": "ADMIN",
"enum": [
"ADMIN",
"SCAN_MANAGER",
"SECURITY_ANALYST",
"MEMBER"
]
}
}
}
},
"DWRResponsePageableV3ListGroupSummaryDTOV3": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupSummaryDTOV3"
}
}
}
},
"GroupSummaryDTOV3": {
"type": "object",
"properties": {
"uuid": {
"title": "Group UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "Group Name",
"type": "string",
"example": "Group A"
},
"description": {
"title": "Group Description",
"type": "string",
"example": "Group description"
},
"users": {
"title": "User Count",
"type": "integer",
"description": "The amount of users in that group",
"format": "int32",
"example": 22
},
"affectedApplications": {
"title": "Affected Applications",
"type": "integer",
"format": "int32",
"example": 5
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupRoleDTOV3"
}
}
}
},
"ApplicationDTOV3": {
"type": "object",
"properties": {
"uuid": {
"title": "Application Uuid",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "Application Name",
"type": "string",
"example": "Application A"
}
}
},
"DWRResponsePageableV3CollectionApplicationDTOV3": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationDTOV3"
}
}
}
},
"UpdateFindingsRequestDTOV3": {
"type": "object",
"properties": {
"status": {
"title": "Finding Status",
"type": "string",
"enum": [
"MARK_AS_UNREVIEWED",
"MARK_AS_IN_REVIEW",
"SUPPRESS",
"UNSUPPRESS"
]
},
"comment": {
"title": "Finding Comment",
"maxLength": 255,
"type": "string",
"example": "This Finding is not important"
},
"isViolating": {
"type": "boolean"
}
}
},
"LibraryMatchSuggestionsRequestDTOV3_MatchSuggestions": {
"required": [
"recommendedForAllFiles",
"sourceFileUuids"
],
"type": "object",
"properties": {
"sourceFileUuids": {
"type": "array",
"items": {
"title": "Source File UUIDs",
"type": "string",
"description": "List of source file UUIDs for which to get Mend library suggestions. Required field.",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"recommendedForAllFiles": {
"title": "Recommended For All Files",
"type": "boolean",
"description": "Flag indicating whether to get recommendations that apply to all specified files. Required field.",
"example": false
}
},
"description": "Request payload for retrieving Mend library suggestions for source files. Requires sourceFileUuids and recommendedForAllFiles. Medium privilege users can optionally specify repository and version fields for more targeted suggestions."
},
"DWRResponseV3CollectionSourceLibraryResponseDTO_MatchSuggestions": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SourceLibraryResponseDTO_MatchSuggestions"
}
}
}
},
"LiteLicenseDTO_MatchSuggestions": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"title": "Licenses",
"type": "string",
"example": "MIT"
},
"severity": {
"title": "License Risk",
"type": "string",
"example": "High"
}
},
"description": "Collection of licenses associated with this library"
},
"SourceLibraryResponseDTO_MatchSuggestions": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the library",
"example": "openssl"
},
"sha1": {
"type": "string",
"description": "SHA-1 hash of the library",
"example": "49f6cb968ff63793f6671d9026fb2a7034dad79a"
},
"licenses": {
"type": "array",
"description": "Collection of licenses associated with this library",
"items": {
"$ref": "#/components/schemas/LiteLicenseDTO_MatchSuggestions"
}
},
"version": {
"type": "string",
"description": "Version of the library",
"example": "OpenSSL_1_0_1"
},
"owner": {
"type": "string",
"description": "Owner/organization of the library",
"example": "openssl"
},
"url": {
"type": "string",
"description": "URL to the library source",
"example": "https://github.com/openssl/openssl.git"
},
"date": {
"type": "string",
"description": "Release date of the library",
"format": "date-time",
"example": "2012-03-14T12:39:00Z"
},
"nonOfficialRelease": {
"type": "boolean",
"description": "Indicates whether this is a non-official release",
"example": false
},
"matchSuggestionId": {
"type": "string",
"description": "Base64 encoded match suggestion ID used for remapping operations.",
"nullable": true,
"example": "ZWJlMTZhZjYtMmE2YS00MWQ1LWFiNTQtYWQ3YWE3OWZhNzFl"
}
},
"description": "Library match suggestion response containing library details and match metadata"
},
"CreateProjectSbomReportDTOReport": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"format": {
"type": "string",
"enum": [
"json",
"html",
"unknown",
"xml",
"excel",
"yaml",
"pdf",
"tv",
"rdf",
"csv",
"sarif"
]
},
"sendEmailNotification": {
"type": "boolean"
},
"labelsUuidList": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeInactiveProjects": {
"type": "boolean"
},
"reportType": {
"type": "string",
"enum": [
"attribution",
"inventory",
"vulnerabilities",
"securityAlerts",
"sbom",
"securityAlertsLibrary",
"Compliance",
"Findings",
"Suppressions",
"Resolved",
"spdx",
"spdx_2_3",
"cycloneDX",
"cycloneDX_1_5",
"cycloneDX_1_6",
"dueDiligence",
"unknown",
"imgAttribution",
"imgDueDiligence",
"imgSpdx",
"imgSpdx_2_3",
"imgCycloneDX",
"imgCycloneDX_1_5",
"aiInventory",
"aiFindings",
"imgCycloneDX_1_6",
"risk"
]
},
"maxDepthLevel": {
"type": "integer",
"format": "int32"
},
"includeVulnerabilities": {
"type": "boolean"
},
"isMlBomReport": {
"type": "boolean"
},
"additionalParams": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"SbomScanInfoDTO": {
"type": "object",
"properties": {
"scanUuid": {
"type": "string",
"description": "Scan identifier",
"example": "45e0c7f0-2a64-4a1c-bb2b-22e1c4f02126"
},
"createdAt": {
"type": "string",
"description": "Scan creation timestamp",
"example": "2025-10-27T18:50:05Z"
}
},
"description": "Scan information"
},
"SbomScanLinksDTO": {
"type": "object",
"properties": {
"logs": {
"type": "string",
"description": "Link to scan logs",
"example": "/api/v3.0/projects/{projectUuid}/scans/{scanUuid}/dependencies/SBOM/logs"
}
},
"description": "Log Link"
},
"SbomScanResponseDTO": {
"type": "object",
"properties": {
"supportToken": {
"type": "string",
"description": "Support token for tracking",
"example": "1171c60d"
},
"project": {
"$ref": "#/components/schemas/ProjectDTOV3"
},
"scan": {
"$ref": "#/components/schemas/SbomScanInfoDTO"
},
"link": {
"$ref": "#/components/schemas/SbomScanLinksDTO"
}
}
},
"DWRResponseV3SbomScanResponseDTO": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"$ref": "#/components/schemas/SbomScanResponseDTO"
}
}
},
"SourceFileRemappingOrgRequestDTOV3": {
"type": "object",
"properties": {
"targetLibraryUuid": {
"title": "Target Library UUID",
"type": "string",
"description": "The UUID of the library to which source files should be remapped. Exactly one of targetLibraryUuid or matchSuggestionId must be provided",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"matchSuggestionId": {
"title": "Target Library Id",
"type": "string",
"description": "The Id of the library to which source files should be remapped. Exactly one of targetLibraryUuid or matchSuggestionId must be provided",
"example": "ZWJlMTZhZjYtMmE2YS00MWQ1LWFiNTQtYWQ3YWE3OWZhNzFl"
},
"sourceFileUuids": {
"type": "array",
"items": {
"title": "Source File UUIDs",
"type": "string",
"description": "List of source file UUIDs to be remapped",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"comment": {
"title": "Comment",
"type": "string",
"description": "Optional user comment explaining the reason for this remapping action"
},
"sendEmailNotification": {
"title": "Send Email Notification",
"type": "boolean",
"description": "Whether to send email notification upon completion of the remapping operation",
"example": true
}
},
"description": "Request payload for remapping source files at organization level"
},
"SourceFilesRemappingAsyncStatusDtoV3": {
"type": "object",
"properties": {
"uuid": {
"title": "Process UUID",
"type": "string",
"description": "The unique identifier of the async process",
"example": "caf69794-9882-4b55-82db-6b6da4fe2a92"
},
"status": {
"title": "Process Status",
"type": "string",
"description": "The current status of the async process",
"example": "PENDING",
"enum": [
"PENDING",
"IN_PROGRESS",
"FAILED",
"FAILURE",
"SUCCESS"
]
},
"userEmail": {
"title": "User Email",
"type": "string",
"description": "Email of the user who initiated the process",
"example": "user@example.com"
},
"requestToken": {
"title": "Request Token",
"type": "string",
"description": "Short token for tracking the request",
"example": "2cd6a43b"
}
},
"description": "Async process status for source file remapping operations"
},
"SourceFileRemappingAppRequestDTOV3": {
"type": "object",
"properties": {
"applicationUuids": {
"type": "array",
"items": {
"title": "Application UUIDs",
"type": "string",
"description": "List of application UUIDs for which the remapping applies",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"targetLibraryUuid": {
"title": "Target Library UUID",
"type": "string",
"description": "The UUID of the library to which source files should be remapped. Exactly one of targetLibraryUuid or matchSuggestionId must be provided",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"matchSuggestionId": {
"title": "Target Library Id",
"type": "string",
"description": "The Id of the library to which source files should be remapped. Exactly one of targetLibraryUuid or matchSuggestionId must be provided",
"example": "ZWJlMTZhZjYtMmE2YS00MWQ1LWFiNTQtYWQ3YWE3OWZhNzFl"
},
"sourceFileUuids": {
"type": "array",
"items": {
"title": "Source File UUIDs",
"type": "string",
"description": "List of source file UUIDs to be remapped",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"comment": {
"title": "Comment",
"type": "string",
"description": "Optional user comment explaining the reason for this remapping action"
},
"sendEmailNotification": {
"title": "Send Email Notification",
"type": "boolean",
"description": "Whether to send email notification upon completion of the remapping operation",
"example": true
}
},
"description": "Request payload for remapping source files at application level"
},
"CreateProductReportDTO": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"format": {
"type": "string",
"enum": [
"json",
"html",
"unknown",
"xml",
"excel",
"yaml",
"pdf",
"tv",
"rdf",
"csv",
"sarif"
]
},
"sendEmailNotification": {
"type": "boolean"
},
"labelsUuidList": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeInactiveProjects": {
"type": "boolean"
},
"projectUuids": {
"type": "array",
"items": {
"type": "string"
}
},
"additionalParams": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"CreateProductSbomReportDTOReport": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"format": {
"type": "string",
"enum": [
"json",
"html",
"unknown",
"xml",
"excel",
"yaml",
"pdf",
"tv",
"rdf",
"csv",
"sarif"
]
},
"sendEmailNotification": {
"type": "boolean"
},
"labelsUuidList": {
"type": "array",
"items": {
"type": "string"
}
},
"excludeInactiveProjects": {
"type": "boolean"
},
"projectUuids": {
"type": "array",
"items": {
"type": "string"
}
},
"reportType": {
"type": "string",
"enum": [
"attribution",
"inventory",
"vulnerabilities",
"securityAlerts",
"sbom",
"securityAlertsLibrary",
"Compliance",
"Findings",
"Suppressions",
"Resolved",
"spdx",
"spdx_2_3",
"cycloneDX",
"cycloneDX_1_5",
"cycloneDX_1_6",
"dueDiligence",
"unknown",
"imgAttribution",
"imgDueDiligence",
"imgSpdx",
"imgSpdx_2_3",
"imgCycloneDX",
"imgCycloneDX_1_5",
"aiInventory",
"aiFindings",
"imgCycloneDX_1_6",
"risk"
]
},
"maxDepthLevel": {
"type": "integer",
"format": "int32"
},
"includeVulnerabilities": {
"type": "boolean"
},
"isMlBomReport": {
"type": "boolean"
},
"additionalParams": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"CreateSecurityFindingsByLibraryReportDTOV3": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"sendEmailNotification": {
"type": "boolean"
},
"format": {
"type": "string",
"enum": [
"excel"
]
},
"search": {
"title": "Search Query",
"type": "string",
"description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **[property][operator][value]**\n+ **Property**: the name of the property of the item\n+ **Operator**:\n + **equals (==)** - Returns true if the value exactly matches this one. If the value contains a * character, it behaves like a wildcard (similar to the LIKE operator).\nExample: entity==abc* — will return true for entities like \"abcd\" and \"abc_123\".\n+ **Value**: the value of the property.\n\nLogical operators AND (;) and OR (,) are supported in filters — param1=in=(val1,val2) and (param2==val3 or param3==val4), can also be written as — param1=in=(val1,val2);(param2==val3,param3==val4)\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ libraryName: equals",
"example": "libraryName==*log4j*"
}
}
},
"CreateSecurityFindingsReportDTOV3": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"sendEmailNotification": {
"type": "boolean"
},
"format": {
"type": "string",
"enum": [
"excel"
]
},
"search": {
"title": "Search Query",
"type": "string",
"description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **[property][operator][value]**\n+ **Property**: the name of the property of the item\n+ **Operator**:\n + **equals (==)** - Returns true if the value exactly matches this one. If the value contains a * character, it behaves like a wildcard (similar to the LIKE operator).\nExample: entity==abc* — will return true for entities like \"abcd\" and \"abc_123\".\n+ **Value**: the value of the property.\n\nLogical operators AND (;) and OR (,) are supported in filters — param1=in=(val1,val2) and (param2==val3 or param3==val4), can also be written as — param1=in=(val1,val2);(param2==val3,param3==val4)\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ findingId: equals",
"example": "findingId==CVE-2020-8908"
}
}
},
"CreateInventoryReportDTOV3": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"sendEmailNotification": {
"type": "boolean"
},
"format": {
"type": "string",
"enum": [
"excel"
]
},
"search": {
"title": "Search Query",
"type": "string",
"description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **[property][operator][value]**\n+ **Property**: the name of the property of the item\n+ **Operator**:\n + **equals (==)** - Returns true if the value exactly matches this one. If the value contains a * character, it behaves like a wildcard (similar to the LIKE operator).\nExample: entity==abc* — will return true for entities like \"abcd\" and \"abc_123\".\n+ **Value**: the value of the property.\n\nLogical operators AND (;) and OR (,) are supported in filters — param1=in=(val1,val2) and (param2==val3 or param3==val4), can also be written as — param1=in=(val1,val2);(param2==val3,param3==val4)\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ libraryName: equals",
"example": "libraryName==*log4j*"
}
}
},
"StreamingResponseBody": {
"type": "object"
},
"DWRResponseV3CollectionSourceLibraryResponseDTO_SearchForMatch": {
"type": "object",
"properties": {
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SourceLibraryResponseDTO_SearchForMatch"
}
}
}
},
"LiteLicenseDTO_SearchForMatch": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"title": "Licenses",
"type": "string",
"example": "MIT"
},
"severity": {
"title": "License Risk",
"type": "string",
"example": "High"
}
},
"description": "Collection of licenses associated with this library"
},
"SourceLibraryResponseDTO_SearchForMatch": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "Unique identifier of the library. Only available in searchForMatch endpoint.",
"example": "b366b0ef-b211-4c37-a47c-0077e4de709f"
},
"name": {
"type": "string",
"description": "Name of the library",
"example": "openssl"
},
"sha1": {
"type": "string",
"description": "SHA-1 hash of the library",
"example": "49f6cb968ff63793f6671d9026fb2a7034dad79a"
},
"licenses": {
"type": "array",
"description": "Collection of licenses associated with this library",
"items": {
"$ref": "#/components/schemas/LiteLicenseDTO_SearchForMatch"
}
},
"version": {
"type": "string",
"description": "Version of the library",
"example": "OpenSSL_1_0_1"
},
"owner": {
"type": "string",
"description": "Owner/organization of the library",
"example": "openssl"
},
"url": {
"type": "string",
"description": "URL to the library source",
"example": "https://github.com/openssl/openssl.git"
},
"date": {
"type": "string",
"description": "Release date of the library",
"format": "date-time",
"example": "2012-03-14T12:39:00Z"
},
"nonOfficialRelease": {
"type": "boolean",
"description": "Indicates whether this is a non-official release",
"example": false
}
},
"description": "Library match suggestion response containing library details and match metadata"
},
"DWRResponsePageableV3CollectionSourceFileInventoryDTOV3": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SourceFileInventoryDTOV3"
}
}
}
},
"DescriptionAndExplanationDTO": {
"type": "object",
"properties": {
"explanation": {
"title": "Explanation Link",
"type": "string",
"example": "http://en.wikipedia.org/wiki/Academic_Free_License"
},
"indicatingText": {
"title": "Indicating Text",
"type": "string",
"example": "1) Grant of Copyright License..."
},
"description": {
"title": "Description",
"type": "string",
"example": "Not a CopyLeft license."
},
"displayText": {
"title": "Display Text",
"type": "string",
"example": "No"
}
}
},
"LicenseDTO": {
"required": [
"name"
],
"type": "object",
"properties": {
"uuid": {
"title": "License Uuid",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "Licenses",
"type": "string",
"example": "MIT"
},
"spdxName": {
"title": "Spdx Name",
"type": "string",
"example": "Glide"
},
"type": {
"title": "Type",
"type": "string",
"example": "OPEN_SOURCE"
},
"suspected": {
"title": "Suspected License",
"type": "boolean"
},
"osiApproved": {
"title": "Approved Osi",
"type": "boolean"
},
"profile": {
"$ref": "#/components/schemas/LicenseProfileDTO"
}
}
},
"LicenseProfileDTO": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"links": {
"uniqueItems": true,
"type": "array",
"items": {
"title": "Links",
"type": "string",
"example": "http://www.opensource.org/licenses/AFL-3.0"
}
},
"copyrightRiskScore": {
"$ref": "#/components/schemas/RiskScoreExplanationDTO"
},
"patentAndRoyaltyRisk": {
"$ref": "#/components/schemas/RiskScoreExplanationDTO"
},
"royaltyFree": {
"title": "Royalty Free",
"type": "string",
"example": "Conditional"
},
"copyleft": {
"$ref": "#/components/schemas/DescriptionAndExplanationDTO"
},
"linking": {
"$ref": "#/components/schemas/DescriptionAndExplanationDTO"
},
"requiredNotices": {
"type": "array",
"items": {
"title": "Required Notices",
"type": "string",
"example": "Must identify specific modifications"
}
}
}
},
"RiskScoreExplanationDTO": {
"type": "object",
"properties": {
"explanation": {
"title": "Explanation Link",
"type": "string",
"example": "http://en.wikipedia.org/wiki/Academic_Free_License"
},
"indicatingText": {
"title": "Indicating Text",
"type": "string",
"example": "1) Grant of Copyright License..."
},
"riskScore": {
"title": "Risk Score",
"type": "integer",
"format": "int32",
"example": 39
}
}
},
"SourceFileInventoryDTOV3": {
"type": "object",
"properties": {
"uuid": {
"title": "Source File UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "Source File Name",
"type": "string",
"example": "common.js"
},
"matchType": {
"title": "Match Type",
"type": "string",
"example": "MANUAL",
"enum": [
"MANUAL",
"AUTOMATIC"
]
},
"sha1": {
"title": "SourceFileSha1",
"type": "string",
"example": "e9537a5384f5a7569997e87fe639961e31b38887",
"enum": [
"MANUAL",
"AUTOMATIC"
]
},
"localPath": {
"title": "Local Path",
"type": "string",
"example": "C:\\Users\\"
},
"lastModified": {
"title": "Source File Last Modification Date",
"type": "string",
"format": "date-time"
},
"library": {
"$ref": "#/components/schemas/SourceFileLibraryDTO"
},
"comment": {
"title": "Source File Comment",
"type": "string"
},
"contextType": {
"title": "Context Type",
"type": "string",
"example": "Organization",
"enum": [
"SYSTEM",
"GLOBAL_ACCOUNT",
"DOMAIN",
"PRODUCT",
"PROJECT",
"SCAN",
"UNSUPPORTED_TYPE"
]
},
"project": {
"$ref": "#/components/schemas/ProjectDTOV3"
}
}
},
"SourceFileLibraryDTO": {
"type": "object",
"properties": {
"uuid": {
"title": "Source Library UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "Source Library Name",
"type": "string",
"example": " actionview-v0.0.1"
},
"licenses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicenseDTO"
}
},
"description": {
"type": "string"
}
}
},
"ComponentReferencesDTO": {
"title": "Component References",
"type": "object",
"properties": {
"url": {
"title": "Reference Url",
"type": "string",
"example": "https://www.gnupg.org/related_software/pinentry/98"
},
"homePage": {
"title": "Reference Home Page",
"type": "string",
"example": "https://www.gnupg.org/related_software/pinentry/89"
},
"downloadLink": {
"title": "Reference Download Link",
"type": "string",
"example": "https://www.gnupg.org/related_software/pinentry/09"
},
"issueUrl": {
"title": "Reference Issue Url",
"type": "string",
"example": "https://www.gnupg.org/related_software/pinentry/87"
},
"pomUrl": {
"title": "Reference Pom Url",
"type": "string",
"example": "https://www.gnupg.org/related_software/pinentry/76"
},
"scmUrl": {
"title": "Reference Scm Url",
"type": "string",
"example": "https://www.gnupg.org/related_software/pinentry/65"
},
"genericPackageIndex": {
"title": "Reference Generic Package Index",
"type": "string",
"example": "5"
},
"nugetGallery": {
"title": "Reference Nugget Gallery",
"type": "string"
},
"tags": {
"title": "Reference Tags",
"type": "string",
"example": "Important"
},
"copyright": {
"title": "Reference Copyright",
"type": "string",
"example": "Copyright 2002-2015 g10 Code GmbH"
},
"hasNotice": {
"title": "Reference Has Notice",
"type": "boolean",
"example": false
}
}
},
"DWRResponsePageableV3ListDueDiligenceDTOV3": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DueDiligenceDTOV3"
}
}
}
},
"DueDiligenceDTOV3": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"component": {
"$ref": "#/components/schemas/LibraryComponentDTOV3"
},
"license": {
"$ref": "#/components/schemas/LicenseReferenceDTO"
},
"riskScore": {
"$ref": "#/components/schemas/RiskScoreExplanationDTO"
},
"copyrights": {
"type": "array",
"items": {
"title": "Copyright",
"type": "string",
"example": "Copyright 2010 Cloud Conscious, LLC"
}
},
"extraData": {
"$ref": "#/components/schemas/ResourceExtraDataDTO"
},
"project": {
"$ref": "#/components/schemas/ProjectDTOV3"
}
}
},
"LibraryComponentDTOV3": {
"type": "object",
"properties": {
"uuid": {
"title": "Component UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "Component Name",
"type": "string",
"example": "dbus-1.10.24-13.el7_6.x86_64.rpm"
},
"description": {
"title": "Component Description",
"type": "string",
"example": "Component description"
},
"componentType": {
"title": "Component Type",
"type": "string",
"example": "Library",
"enum": [
"Library"
]
},
"libraryType": {
"title": "Library Type",
"type": "string",
"example": "REDHAT_PACKAGE_MODULE",
"deprecated": true
},
"language": {
"title": "Language",
"type": "string",
"example": "REDHAT_PACKAGE_MODULE"
},
"directDependency": {
"type": "boolean"
},
"rootLibrary": {
"title": "Root Library",
"type": "boolean"
},
"references": {
"$ref": "#/components/schemas/ComponentReferencesDTO"
},
"groupId": {
"title": "Component Name",
"type": "string",
"example": "org.springframework.boot"
},
"artifactId": {
"title": "Component Artifact",
"type": "string",
"example": "spring-boot"
},
"version": {
"title": "Component Version",
"type": "string",
"example": "3.0.5"
},
"path": {
"title": "path",
"type": "string",
"example": "pom.xml"
},
"dependencyFile": {
"type": "string"
},
"localPath": {
"type": "string"
},
"dependencyType": {
"title": "Dependency Type",
"type": "string",
"example": "Direct / Transitive"
}
}
},
"LicenseReferenceDTO": {
"type": "object",
"properties": {
"uuid": {
"title": "License Reference UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"type": {
"title": "License Reference Type",
"type": "string",
"example": "ARTIFACT_DESCRIPTOR"
},
"liabilityReference": {
"title": "License Liability Reference",
"type": "string",
"example": "https://repo.maven.apache.org/maven2/org/jruby/ext/posix/jna-posix/1.0.3/jna-posix-1.0.3.pom"
},
"assignedBy": {
"$ref": "#/components/schemas/UserInfoDTO"
},
"textUrl": {
"title": "License Reference Text URL",
"type": "string"
},
"customDisclaimer": {
"title": "License Reference Custom Disclaimer",
"type": "string"
},
"information": {
"title": "License Reference information",
"type": "string",
"example": "distribution=repo&remoteUrl=https://repo.maven.apache.org/maven2/org/jruby/ext/posix/jna-posix/1.0.3/jna-posix-1.0.3.pom"
}
}
},
"ResourceAuthorDTO": {
"type": "object",
"properties": {
"author": {
"title": "Resource Author",
"type": "string",
"example": "The Apache Software Foundation"
},
"authorUrl": {
"title": "Author URL",
"type": "string",
"example": "http://www.apache.org/"
}
}
},
"ResourceExtraDataDTO": {
"type": "object",
"properties": {
"homepage": {
"title": "Home Page",
"type": "string",
"example": "https://api.github.com/repos/SR-dude/AvP-Wine/zipball/original"
},
"authors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceAuthorDTO"
}
}
}
},
"AttributionReportLibrarySettingRuleDTO": {
"title": "Attribution report library settings ",
"type": "object",
"properties": {
"excluded": {
"type": "boolean"
}
},
"example": "{excluded: true}"
},
"DWRResponsePageableV3ListLightLibraryDTO": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LightLibraryDTO"
}
}
}
},
"EntityDTO": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"LibraryExtraInfoDTO": {
"type": "object",
"properties": {
"distributionUrl": {
"type": "string"
},
"downloadUrl": {
"type": "string"
},
"releaseDate": {
"type": "string",
"format": "date-time"
},
"packageManagerRepository": {
"type": "string"
},
"homePage": {
"type": "string"
},
"repositoryUrl": {
"type": "string"
},
"author": {
"type": "string"
}
}
},
"LibraryLocationDTO": {
"type": "object",
"properties": {
"localPath": {
"title": "Local Path",
"type": "string",
"example": "C:\\\\Users\\\\user\\\\.m2\\\\repository\\\\commons-io-1.4.jar"
},
"dependencyFile": {
"title": "Dependency File",
"type": "string",
"example": "C:\\\\GitHubRepos\\\\Pipline\\\\EUA\\\\plugins-automation\\\\fsa\\\\tests\\\\EUA\\\\Java\\\\bigProjectsMaven\\\\WST_417\\\\Data\\\\ksa\\\\ksa-web-core\\\\pom.xml"
}
}
},
"LightLibraryDTO": {
"type": "object",
"properties": {
"uuid": {
"title": "Library UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "Library Name",
"type": "string",
"example": "dbus-1.10.24-13.el7_6.x86_64.rpm"
},
"artifactId": {
"title": "Artifact Id",
"type": "string",
"example": "kind-of-6.0.2.tgz"
},
"groupId": {
"title": "Group Id",
"type": "string",
"example": "kind-of"
},
"version": {
"type": "string"
},
"architecture": {
"title": "Architecture",
"type": "string"
},
"languageVersion": {
"title": "Language Version",
"type": "string"
},
"classifier": {
"type": "string"
},
"extension": {
"type": "string"
},
"sha1": {
"title": "Sha1",
"type": "string",
"example": "01146b36a6218e64e58f3a8d66de5d7fc6f6d051"
},
"description": {
"title": "Description",
"type": "string",
"example": "Get the native type of a value."
},
"type": {
"title": "Type",
"type": "string",
"example": "javascript/Node.js"
},
"libraryType": {
"type": "string"
},
"directDependency": {
"title": "Direct Dependency",
"type": "boolean"
},
"purl": {
"title": "Package Url",
"type": "string",
"example": "pkg:maven/commons-beanutils/commons-beanutils@1.8.0?type=jar"
},
"extraInfo": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"extraInformation": {
"$ref": "#/components/schemas/LibraryExtraInfoDTO"
},
"securityRisks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SecurityRiskDTO"
}
},
"noticeReference": {
"$ref": "#/components/schemas/NoticeDTO"
},
"proprietaryInfo": {
"$ref": "#/components/schemas/ProprietaryInfoDTO"
},
"locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LibraryLocationDTO"
}
},
"attributionReportSettings": {
"$ref": "#/components/schemas/AttributionReportLibrarySettingRuleDTO"
},
"dependencyType": {
"type": "string"
},
"violations": {
"title": "Number Of Violations",
"type": "integer",
"format": "int32",
"example": 22
},
"workflowUuids": {
"title": "Number Of Violated Workflows",
"type": "array",
"example": 2,
"items": {
"title": "Number Of Violated Workflows",
"type": "string",
"example": "2"
}
},
"violatingFindings": {
"title": "Number Of Violating Findings",
"type": "integer",
"format": "int32",
"example": 2
},
"trackedIssue": {
"$ref": "#/components/schemas/TrackedIssueDTO"
}
}
},
"NoticeDTO": {
"required": [
"text"
],
"type": "object",
"properties": {
"text": {
"title": "Notice Text",
"type": "string",
"example": "Developed internally"
},
"reference": {
"title": "Notice REFERENCE",
"type": "string",
"example": "https://github.com/..."
}
}
},
"ProprietaryInfoDTO": {
"type": "object",
"properties": {
"ruleDescription": {
"type": "string"
},
"rulePattern": {
"type": "string"
},
"comment": {
"type": "string"
},
"userInfo": {
"$ref": "#/components/schemas/UserInfoDTO"
},
"proprietaryMarkType": {
"type": "string",
"enum": [
"BY_RULE",
"BY_USER"
]
}
}
},
"SecurityRiskDTO": {
"type": "object",
"properties": {
"sourceUrl": {
"type": "string"
},
"riskFactor": {
"type": "string",
"enum": [
"NO_FINDINGS",
"UNCONFIRMED_UNSAFE",
"CONFIRMED_UNSAFE",
"KNOWN_FALSE_POSITIVE"
]
}
}
},
"TrackedIssueDTO": {
"title": "Tracked Issue Information",
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"issueId": {
"type": "string"
},
"origin": {
"type": "string"
},
"issueKey": {
"type": "string"
},
"account": {
"$ref": "#/components/schemas/EntityDTO"
},
"domain": {
"$ref": "#/components/schemas/EntityDTO"
},
"application": {
"$ref": "#/components/schemas/EntityDTO"
},
"project": {
"$ref": "#/components/schemas/EntityDTO"
},
"status": {
"type": "string",
"enum": [
"PENDING",
"IN_PROGRESS",
"SUCCESS",
"FAILED",
"DELETED"
]
},
"issueStatus": {
"type": "string"
},
"failureReason": {
"type": "string"
},
"errorMessage": {
"type": "string"
},
"publicLink": {
"type": "string"
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"$ref": "#/components/schemas/EntityDTO"
},
"ticketType": {
"type": "string",
"enum": [
"SECURITY",
"LEGAL"
]
}
}
},
"CopyrightReferenceDTO": {
"required": [
"copyright"
],
"type": "object",
"properties": {
"type": {
"title": "Copy Reference Type",
"type": "string",
"example": "PROJECT_HOMEPAGE",
"enum": [
"TEXT_IN_FILE",
"ARTIFACT_DESCRIPTOR",
"PROJECT_HOMEPAGE",
"USER",
"UNSPECIFIED"
]
},
"copyright": {
"title": "Copyright",
"type": "string",
"example": "Copyright 2021 x greater by the end of"
},
"customDisclaimer": {
"title": "Copyright Custom Disclaimer",
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"textUrl": {
"title": "Copyright Text Url",
"type": "string"
},
"startYear": {
"title": "Copyright Start Year",
"type": "string",
"example": "2021"
},
"endYear": {
"title": "Copyright End Year",
"type": "string",
"example": "2022"
},
"author": {
"title": "Copyright Author",
"type": "string",
"example": "x greater by the end of"
},
"referenceInfo": {
"title": "Copyright Reference Info",
"type": "string",
"example": "x greater by the end of"
}
}
},
"DWRResponsePageableV3ListLibraryDTO": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LibraryDTO"
}
}
}
},
"LibraryDTO": {
"type": "object",
"properties": {
"uuid": {
"title": "Library UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "Library Name",
"type": "string",
"example": "dbus-1.10.24-13.el7_6.x86_64.rpm"
},
"artifactId": {
"title": "Artifact Id",
"type": "string",
"example": "kind-of-6.0.2.tgz"
},
"groupId": {
"title": "Group Id",
"type": "string",
"example": "kind-of"
},
"version": {
"type": "string"
},
"architecture": {
"title": "Architecture",
"type": "string"
},
"languageVersion": {
"title": "Language Version",
"type": "string"
},
"classifier": {
"type": "string"
},
"extension": {
"type": "string"
},
"sha1": {
"title": "Sha1",
"type": "string",
"example": "01146b36a6218e64e58f3a8d66de5d7fc6f6d051"
},
"description": {
"title": "Description",
"type": "string",
"example": "Get the native type of a value."
},
"type": {
"title": "Type",
"type": "string",
"example": "javascript/Node.js"
},
"libraryType": {
"type": "string"
},
"directDependency": {
"title": "Direct Dependency",
"type": "boolean"
},
"purl": {
"title": "Package Url",
"type": "string",
"example": "pkg:maven/commons-beanutils/commons-beanutils@1.8.0?type=jar"
},
"extraInfo": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"extraInformation": {
"$ref": "#/components/schemas/LibraryExtraInfoDTO"
},
"licenses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LibraryLicenseDTO"
}
},
"copyrightReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CopyrightReferenceDTO"
}
},
"securityRisks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SecurityRiskDTO"
}
},
"noticeReference": {
"$ref": "#/components/schemas/NoticeDTO"
},
"proprietaryInfo": {
"$ref": "#/components/schemas/ProprietaryInfoDTO"
},
"locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LibraryLocationDTO"
}
},
"attributionReportSettings": {
"$ref": "#/components/schemas/AttributionReportLibrarySettingRuleDTO"
},
"dependencyType": {
"type": "string"
},
"violations": {
"title": "Number Of Violations",
"type": "integer",
"format": "int32",
"example": 22
},
"workflowUuids": {
"title": "Number Of Violated Workflows",
"type": "array",
"example": 2,
"items": {
"title": "Number Of Violated Workflows",
"type": "string",
"example": "2"
}
},
"violatingFindings": {
"title": "Number Of Violating Findings",
"type": "integer",
"format": "int32",
"example": 2
},
"trackedIssue": {
"$ref": "#/components/schemas/TrackedIssueDTO"
}
}
},
"LibraryLicenseDTO": {
"type": "object",
"properties": {
"uuid": {
"title": "License UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "License Name",
"type": "string",
"example": "MIT"
},
"assignedByUser": {
"title": "Assigned By User",
"type": "boolean"
},
"licenseReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicenseReferenceDTO"
}
}
}
},
"DWRResponsePageableV3CollectionRootLibrarySecurityFindingDTOV3": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RootLibrarySecurityFindingDTOV3"
}
}
}
},
"RootLibrarySecurityFindingDTOV3": {
"type": "object",
"properties": {
"rootLibraryName": {
"title": "Root Library Name",
"type": "string",
"example": "com.google.guava:guava"
},
"rootLibraryUuid": {
"title": "Root Library UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"project": {
"$ref": "#/components/schemas/ProjectDTOV3"
},
"criticalNum": {
"title": "Critical Vulnerabilities",
"type": "integer",
"format": "int32",
"example": 2
},
"highNum": {
"title": "High Vulnerabilities",
"type": "integer",
"format": "int32",
"example": 1
},
"mediumNum": {
"title": "Medium Vulnerabilities",
"type": "integer",
"format": "int32",
"example": 1
},
"lowNum": {
"title": "Low Vulnerabilities",
"type": "integer",
"format": "int32",
"example": 1
},
"total": {
"title": "Total Vulnerabilities",
"type": "integer",
"format": "int32",
"example": 5
},
"violations": {
"type": "integer",
"format": "int32"
},
"workflowUuids": {
"type": "array",
"items": {
"type": "string"
}
},
"violatingFindings": {
"type": "integer",
"format": "int32"
},
"language": {
"title": "Language",
"type": "string",
"example": "Java"
},
"lastScan": {
"title": "Last Scan Date",
"type": "string",
"format": "date-time"
},
"introducedDate": {
"title": "Introduced Date",
"type": "string",
"format": "date-time"
},
"lastModifiedDate": {
"title": "Last Modified Date",
"type": "string",
"format": "date-time"
},
"recommendedFix": {
"title": "Recommended Fix",
"type": "string",
"example": "1.0.1"
},
"fixForMajorVersion": {
"type": "string"
},
"rootLibraryVersion": {
"title": "Root Library Version",
"type": "string",
"example": "1.0.0"
},
"suggestedFixFailed": {
"title": "Suggested Fix Failed",
"type": "boolean",
"example": false
},
"groupId": {
"title": "Group ID",
"type": "string",
"example": "com.google.guava"
},
"artifactId": {
"title": "Artifact ID",
"type": "string",
"example": "guava"
},
"path": {
"title": "Path",
"type": "string",
"example": "pom.xml"
},
"dependencyFile": {
"type": "string"
},
"localPath": {
"type": "string"
},
"fromResourceUsages": {
"type": "boolean"
},
"severity": {
"title": "Severity",
"type": "string",
"example": "CRITICAL"
},
"rootStatus": {
"title": "Root Status",
"type": "string",
"example": "OPEN"
},
"rootComment": {
"title": "Root Comment",
"type": "string",
"example": "This is a comment"
},
"rootNodeId": {
"title": "Root Node ID",
"type": "integer",
"format": "int64",
"example": 1
},
"rootInstancesCount": {
"title": "Root Library Instances Count",
"type": "integer",
"format": "int32",
"example": 2
},
"reachability": {
"title": "Reachability",
"type": "string",
"example": "REACHABLE",
"enum": [
"REACHABLE",
"POTENTIALLY_REACHABLE",
"UNREACHABLE",
"REACHABILITY_UNAVAILABLE"
]
},
"maliciousPackage": {
"title": "Malicious Package",
"type": "boolean",
"example": false
},
"exploitable": {
"title": "Is Root Library Exploitable",
"type": "boolean",
"example": true
},
"exploitCodeMaturity": {
"title": "Exploit Code Maturity",
"type": "array",
"example": "POC_CODE, HIGH",
"items": {
"title": "Exploit Code Maturity",
"type": "string",
"example": "POC_CODE, HIGH",
"enum": [
"UNPROVEN",
"POC_CODE",
"FUNCTIONAL",
"HIGH",
"NOT_DEFINED"
]
}
},
"numOfReachable": {
"title": "Number of Reachable Vulnerabilities",
"type": "integer",
"format": "int32",
"example": 1
},
"numOfPotentiallyReachable": {
"title": "Number of Potentially Reachable Vulnerabilities",
"type": "integer",
"format": "int32",
"example": 1
},
"numOfUnreachable": {
"title": "Number of Unreachable Vulnerabilities",
"type": "integer",
"format": "int32",
"example": 1
},
"numOfMalicious": {
"title": "Number of Malicious Vulnerabilities",
"type": "integer",
"format": "int32",
"example": 1
},
"malicious": {
"title": "Is Root Library Malicious",
"type": "boolean",
"example": true
},
"linkedIssue": {
"$ref": "#/components/schemas/TrackedIssueDTO"
}
}
},
"BaseLocationComponentDTOV3": {
"type": "object",
"properties": {
"uuid": {
"title": "Component UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "Component Name",
"type": "string",
"example": "dbus-1.10.24-13.el7_6.x86_64.rpm"
},
"description": {
"title": "Component Description",
"type": "string",
"example": "Component description"
},
"componentType": {
"type": "string"
},
"libraryType": {
"title": "Library Type",
"type": "string",
"example": "REDHAT_PACKAGE_MODULE",
"deprecated": true
},
"language": {
"title": "Language",
"type": "string",
"example": "REDHAT_PACKAGE_MODULE"
},
"directDependency": {
"type": "boolean"
},
"rootLibrary": {
"title": "Root Library",
"type": "boolean"
},
"references": {
"$ref": "#/components/schemas/ComponentReferencesDTO"
},
"groupId": {
"title": "Component Name",
"type": "string",
"example": "org.springframework.boot"
},
"artifactId": {
"title": "Component Artifact",
"type": "string",
"example": "spring-boot"
},
"version": {
"title": "Component Version",
"type": "string",
"example": "3.0.5"
},
"path": {
"title": "path",
"type": "string",
"example": "pom.xml"
},
"dependencyFile": {
"type": "string"
},
"localPath": {
"type": "string"
},
"dependencyType": {
"title": "Dependency Type",
"type": "string",
"example": "Direct / Transitive"
},
"libraryLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LibraryLocationDTO"
}
}
},
"anyOf": [
{
"$ref": "#/components/schemas/LibraryLocationComponentDTOV3"
},
{
"$ref": "#/components/schemas/SourceFileLocationComponentDTOV3"
}
]
},
"DWRResponsePageableV3CollectionSecurityFindingDTOV3": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SecurityFindingDTOV3"
}
}
}
},
"DependencyContextDTOV3": {
"type": "object",
"properties": {
"dependencyType": {
"title": "Dependency Type",
"type": "string",
"example": "DIRECT",
"enum": [
"DIRECT",
"TRANSITIVE"
]
},
"isDirect": {
"title": "Is Direct Dependency",
"type": "boolean",
"example": true
},
"isTransitive": {
"title": "Is Transitive Dependency",
"type": "boolean",
"example": false
},
"directRoots": {
"title": "Direct Root Libraries",
"type": "array",
"items": {
"$ref": "#/components/schemas/DirectRootDTOV3"
}
}
}
},
"DirectRootDTOV3": {
"title": "Direct Root Libraries",
"type": "object",
"properties": {
"rootLibraryUuid": {
"title": "Root Library UUID",
"type": "string"
},
"rootLibraryName": {
"title": "Root Library Name",
"type": "string",
"example": "com.google.guava:guava"
},
"rootLibraryVersion": {
"title": "Root Library Version",
"type": "string",
"example": "30.1-jre"
}
}
},
"EffectiveVulnerabilityInfoDTO": {
"type": "object",
"properties": {
"referenceCount": {
"title": "Vulnerability Reference Count",
"type": "integer",
"format": "int32"
},
"shieldValue": {
"title": "Shield Value",
"type": "integer",
"description": "RED(15), YELLOW(10), GREY(8), NO_SHIELD(6), GREEN(5)",
"format": "int32"
}
}
},
"FindingInfoDTOV3": {
"type": "object",
"properties": {
"findingStatus": {
"title": "Finding Status",
"type": "string",
"enum": [
"UNREVIEWED",
"IN_REVIEW",
"SUPPRESSED",
"ISSUE_CREATED",
"REMEDIATED"
]
},
"status": {
"title": "Deprecated Finding Status",
"type": "string",
"deprecated": true,
"enum": [
"ACTIVE",
"IGNORED",
"LIBRARY_REMOVED",
"LIBRARY_IN_HOUSE",
"LIBRARY_WHITELIST"
]
},
"comment": {
"$ref": "#/components/schemas/UserCommentDTO"
},
"detectedAt": {
"title": "Finding Detection Date",
"type": "string",
"format": "date-time"
},
"modifiedAt": {
"title": "Finding Modification Date",
"type": "string",
"format": "date-time"
}
}
},
"FindingIntegrationDTO": {
"type": "object",
"properties": {
"status": {
"title": "Risk Integration Status",
"type": "string",
"example": "SUCCESS",
"enum": [
"SUCCESS",
"FAILURE",
"PROCESSING"
]
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTrackerDTO"
}
}
}
},
"IssueTrackerDTO": {
"type": "object",
"properties": {
"issueStatus": {
"title": "Issue Status",
"type": "string",
"example": "Open"
},
"url": {
"title": "Issue URL",
"type": "string",
"example": "www.jira.com/projectA-22"
},
"issueTrackerType": {
"title": "Issue Integration Type",
"type": "string",
"example": "Jira-cloud"
},
"issueIdentifier": {
"title": "Issue Identifier",
"type": "string",
"example": "projectA-22"
}
}
},
"LibraryLocationComponentDTOV3": {
"type": "object",
"properties": {
"uuid": {
"title": "Component UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "Component Name",
"type": "string",
"example": "dbus-1.10.24-13.el7_6.x86_64.rpm"
},
"description": {
"title": "Component Description",
"type": "string",
"example": "Component description"
},
"componentType": {
"title": "Component Type",
"type": "string",
"example": "Library",
"enum": [
"Library"
]
},
"libraryType": {
"title": "Library Type",
"type": "string",
"example": "REDHAT_PACKAGE_MODULE",
"deprecated": true
},
"language": {
"title": "Language",
"type": "string",
"example": "REDHAT_PACKAGE_MODULE"
},
"directDependency": {
"type": "boolean"
},
"rootLibrary": {
"title": "Root Library",
"type": "boolean"
},
"references": {
"$ref": "#/components/schemas/ComponentReferencesDTO"
},
"groupId": {
"title": "Component Name",
"type": "string",
"example": "org.springframework.boot"
},
"artifactId": {
"title": "Component Artifact",
"type": "string",
"example": "spring-boot"
},
"version": {
"title": "Component Version",
"type": "string",
"example": "3.0.5"
},
"path": {
"title": "path",
"type": "string",
"example": "pom.xml"
},
"dependencyFile": {
"type": "string"
},
"localPath": {
"type": "string"
},
"dependencyType": {
"title": "Dependency Type",
"type": "string",
"example": "Direct / Transitive"
},
"libraryLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LibraryLocationDTO"
}
}
}
},
"SecurityFindingDTOV3": {
"type": "object",
"properties": {
"uuid": {
"title": "Finding Uuid",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "Finding Name",
"type": "string",
"description": "Identifier of the finding, changes based on finding type",
"example": "CVE-2021-42392"
},
"type": {
"type": "string",
"example": "SECURITY_VULNERABILITY",
"enum": [
"SECURITY_VULNERABILITY"
]
},
"findingInfo": {
"$ref": "#/components/schemas/FindingInfoDTOV3"
},
"project": {
"$ref": "#/components/schemas/ProjectDTOV3"
},
"application": {
"$ref": "#/components/schemas/ApplicationDTOV3"
},
"component": {
"$ref": "#/components/schemas/BaseLocationComponentDTOV3"
},
"vulnerability": {
"$ref": "#/components/schemas/VulnerabilityProfileDTO"
},
"topFix": {
"$ref": "#/components/schemas/VulnerabilityFixInfoDTO"
},
"reachability": {
"type": "string",
"enum": [
"REACHABLE",
"POTENTIALLY_REACHABLE",
"UNREACHABLE",
"REACHABILITY_UNAVAILABLE"
]
},
"findingIntegration": {
"$ref": "#/components/schemas/FindingIntegrationDTO"
},
"threatAssessment": {
"$ref": "#/components/schemas/ThreatAssessmentDTO"
},
"exploitable": {
"title": "Is Vulnerability Exploitable",
"type": "boolean",
"example": true
},
"malicious": {
"title": "Is Vulnerability Malicious",
"type": "boolean",
"example": true
},
"scoreMetadataVector": {
"type": "string"
},
"violations": {
"title": "Number Of Violations",
"type": "integer",
"format": "int32",
"example": 22
},
"workflowUuids": {
"type": "array",
"items": {
"type": "string"
}
},
"dependencyContexts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DependencyContextDTOV3"
}
}
}
},
"SourceFileLocationComponentDTOV3": {
"type": "object",
"properties": {
"uuid": {
"title": "Component UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"name": {
"title": "Component Name",
"type": "string",
"example": "dbus-1.10.24-13.el7_6.x86_64.rpm"
},
"description": {
"title": "Component Description",
"type": "string",
"example": "Component description"
},
"componentType": {
"title": "Component Type",
"type": "string",
"example": "Source File",
"enum": [
"Source File"
]
},
"libraryType": {
"title": "Library Type",
"type": "string",
"example": "REDHAT_PACKAGE_MODULE",
"deprecated": true
},
"language": {
"title": "Language",
"type": "string",
"example": "REDHAT_PACKAGE_MODULE"
},
"directDependency": {
"type": "boolean"
},
"rootLibrary": {
"title": "Root Library",
"type": "boolean"
},
"references": {
"$ref": "#/components/schemas/ComponentReferencesDTO"
},
"groupId": {
"title": "Component Name",
"type": "string",
"example": "org.springframework.boot"
},
"artifactId": {
"title": "Component Artifact",
"type": "string",
"example": "spring-boot"
},
"version": {
"title": "Component Version",
"type": "string",
"example": "3.0.5"
},
"path": {
"title": "path",
"type": "string",
"example": "pom.xml"
},
"dependencyFile": {
"type": "string"
},
"localPath": {
"type": "string"
},
"dependencyType": {
"title": "Dependency Type",
"type": "string",
"example": "Direct / Transitive"
},
"libraryLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LibraryLocationDTO"
}
},
"sourceFile": {
"title": "Source File Name",
"type": "string",
"example": "DocXMLRPCServer.py"
},
"sourceFileUuid": {
"title": "Source File UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
},
"ThreatAssessmentDTO": {
"type": "object",
"properties": {
"exploitCodeMaturity": {
"title": "Exploit Code Maturity",
"type": "string",
"example": "HIGH",
"enum": [
"UNPROVEN",
"POC_CODE",
"FUNCTIONAL",
"HIGH",
"NOT_DEFINED"
]
},
"epssPercentage": {
"title": "Epss Percentage",
"type": "number",
"format": "float",
"example": 0.8
}
}
},
"UserCommentDTO": {
"type": "object",
"properties": {
"comment": {
"title": "Comment",
"type": "string",
"example": "a comment"
},
"date": {
"title": "comment date",
"type": "string",
"format": "date-time"
},
"userEmail": {
"title": "User Email",
"type": "string",
"example": "jon.smith@mail.com"
},
"username": {
"title": "User Email",
"type": "string",
"example": "jon"
}
}
},
"VulnerabilityFixInfoDTO": {
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer",
"format": "int32",
"example": 49422
},
"vulnerability": {
"title": "Vulnerability Name",
"type": "string",
"example": "CVE-2021-42392"
},
"type": {
"title": "Type",
"type": "string",
"example": "UPGRADE_VERSION",
"enum": [
"CHANGE_FILES",
"PATCH",
"UPGRADE_VERSION"
]
},
"origin": {
"title": "Origin",
"type": "string",
"example": "WHITESOURCE_EXPERT"
},
"url": {
"title": "Url",
"type": "string",
"example": "https://github.com/codehaus-plexus/plexus-utils/commit/f933e5e78dc2637e485447ed821fe14904f110de"
},
"fixResolution": {
"title": "Fix Resolution",
"type": "string",
"example": "3.0.24"
},
"date": {
"title": "Date",
"type": "string",
"format": "date-time"
},
"message": {
"title": "Message",
"type": "string",
"example": "Upgrade to version"
},
"extraData": {
"type": "string"
},
"minimalFixVersionFromExtraData": {
"type": "string"
},
"minimalAffectedVersionFromExtraData": {
"type": "string"
}
}
},
"VulnerabilityProfileDTO": {
"type": "object",
"properties": {
"name": {
"title": "Vulnerability Name",
"type": "string",
"example": "CVE-2021-42392"
},
"type": {
"title": "VulnerabilityType",
"type": "string",
"example": "WS",
"enum": [
"CVE",
"WS"
]
},
"description": {
"title": "Vulnerability Description",
"type": "string",
"example": "Security vulnerability found in plexus-utils before 3.0.24. XML injection found in XmlWriterUtil.java"
},
"score": {
"title": "Vulnerability Score",
"type": "number",
"format": "float",
"example": 5
},
"severity": {
"title": "Vulnerability Severity",
"type": "string",
"example": "MEDIUM",
"enum": [
"HIGH",
"MEDIUM",
"LOW"
]
},
"publishDate": {
"title": "Vulnerability Publish Date",
"type": "string",
"format": "date-time"
},
"modifiedDate": {
"title": "Vulnerability Modified Date",
"type": "string",
"format": "date-time"
},
"vulnerabilityScoring": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VulnerabilityScoringDTO"
}
},
"references": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VulnerabilityReferenceDTO"
}
},
"effectiveInfo": {
"$ref": "#/components/schemas/EffectiveVulnerabilityInfoDTO"
},
"threatAssessment": {
"$ref": "#/components/schemas/ThreatAssessmentDTO"
}
}
},
"VulnerabilityReferenceDTO": {
"type": "object",
"properties": {
"value": {
"title": "Vulnerability Reference Value",
"type": "string",
"example": "https://github.com/codehaus-plexus/plexus-utils/commit/f933e5e78dc2637e485447ed821fe14904f110de"
},
"source": {
"title": "vulnerability reference source",
"type": "string",
"example": "CERT"
},
"url": {
"title": "Vulnerability Reference Url",
"type": "string",
"example": "https://github.com/codehaus-plexus/plexus-utils/commit/f933e5e78dc2637e485447ed821fe14904f110de"
},
"signature": {
"title": "Vulnerability Reference Signature",
"type": "boolean"
},
"advisory": {
"title": "Vulnerability Reference Advisory",
"type": "boolean"
},
"patch": {
"title": "Vulnerability Reference Patch",
"type": "boolean"
}
}
},
"VulnerabilityScoringDTO": {
"type": "object",
"properties": {
"score": {
"title": "Vulnerability Score",
"type": "number",
"format": "float",
"example": 5
},
"severity": {
"title": "Vulnerability Severity",
"type": "string",
"example": "MEDIUM",
"enum": [
"LOW",
"HIGH",
"MEDIUM"
]
},
"type": {
"title": "Vulnerability Score Type",
"type": "string",
"example": "CVSS_2",
"enum": [
"CVSS_2",
"CVSS_3"
]
},
"scoreMetadataVector": {
"title": "Score Metadata Vector",
"type": "string",
"example": "CVSS:3.1/AV:N/AC:L/PR:N/UI:R/S:U/C:H/I:H/A:H"
},
"extraData": {
"title": "Vulnerability Extra Data",
"type": "object",
"additionalProperties": {
"title": "Vulnerability Extra Data",
"type": "string"
}
}
}
},
"CodeInvocationDTO": {
"type": "object",
"properties": {
"invocationType": {
"type": "string",
"enum": [
"APPLICATION",
"EXTENSION",
"NATIVE",
"FRAMEWORK"
]
},
"methodName": {
"title": "Method Name",
"type": "string",
"example": "org.springframework.util.StringUtils:cleanPath"
},
"order": {
"title": "Order",
"type": "integer",
"format": "int32",
"example": 0
},
"lineNumber": {
"title": "Line Number",
"type": "integer",
"format": "int32",
"example": 522
},
"fileName": {
"title": "File Name",
"type": "string",
"example": "org\\springframework\\util\\StringUtils.class"
}
}
},
"DWRResponsePageableV3ListProjectTraceDTOV3": {
"type": "object",
"properties": {
"additionalData": {
"title": "Provides insights into endpoint-supported pagination information.",
"type": "object",
"description": "+ **totalItems**: The total count of data points returned in an API response.\n",
"example": {
"totalItems": "422",
"next": "http://someUrl?cursor=3",
"cursor": 3
}
},
"supportToken": {
"title": "Support Token",
"type": "string",
"example": "1171c60d"
},
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectTraceDTOV3"
}
}
}
},
"ProjectTraceDTOV3": {
"type": "object",
"properties": {
"referenceEntityId": {
"title": "Reference Entity Id",
"type": "string",
"example": "org.springframework.util.StringUtils:cleanPath ()"
},
"projectName": {
"title": "Project Name",
"type": "string",
"example": "Project A"
},
"orgName": {
"title": "Org Name",
"type": "string",
"example": "Organization A"
},
"traces": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VulnerabilityTraceDTO"
}
},
"shieldValue": {
"type": "integer",
"format": "int32"
},
"applicationName": {
"title": "Application Name",
"type": "string",
"example": "Product A"
},
"vulnerabilityId": {
"title": "Vulnerability Id",
"type": "string",
"example": "CVE-2021-42392"
},
"libraryUuid": {
"title": "Library Uuid",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"projectUuid": {
"title": "Project UUID",
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
},
"VulnerabilityTraceDTO": {
"type": "object",
"properties": {
"codeInvocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeInvocationDTO"
}
}
}
},
"dto.AzureDevOpsWorkItem": {
"properties": {
"project": {
"type": "string"
},
"workItemId": {
"type": "integer"
}
},
"type": "object"
},
"dto.BulkPatchFinding": {
"properties": {
"findings": {
"description": "IDs of findings to modify.",
"items": {
"type": "string"
},
"type": "array"
},
"patchOperation": {
"$ref": "#/components/schemas/dto.PatchFinding"
}
},
"type": "object"
},
"dto.CallStackItem": {
"properties": {
"endLine": {
"type": "integer"
},
"file": {
"type": "string"
},
"kind": {
"type": "string"
},
"line": {
"type": "integer"
},
"name": {
"type": "string"
},
"snippet": {
"type": "string"
},
"startLine": {
"type": "integer"
}
},
"type": "object"
},
"dto.CapecInfo": {
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"dto.CweInfo": {
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"dto.DataFlow": {
"properties": {
"ageRating": {
"description": "Between 0 and 10",
"type": "number"
},
"confidenceRating": {
"description": "Between 0 and 10",
"type": "number"
},
"createdTime": {
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/dto.Filter"
},
"functionCalls": {
"items": {
"$ref": "#/components/schemas/dto.CallStackItem"
},
"type": "array"
},
"id": {
"type": "string"
},
"inputFlow": {
"items": {
"$ref": "#/components/schemas/dto.CallStackItem"
},
"type": "array"
},
"inputKind": {
"type": "string"
},
"inputSource": {
"type": "string"
},
"isNew": {
"type": "boolean"
},
"rating": {
"description": "Between 0 and 10",
"type": "number"
},
"sink": {
"type": "string"
},
"sinkFile": {
"type": "string"
},
"sinkKind": {
"type": "string"
},
"sinkLine": {
"type": "integer"
},
"sinkSnippet": {
"type": "string"
}
},
"type": "object"
},
"dto.ErrorResponse": {
"properties": {
"message": {
"example": "Something went wrong",
"type": "string"
},
"result": {
"example": "error",
"type": "string"
},
"success": {
"example": false,
"type": "boolean"
}
},
"type": "object"
},
"dto.Filter": {
"properties": {
"filterTypes": {
"items": {
"$ref": "#/components/schemas/dto.FilterType"
},
"type": "array"
},
"isFiltered": {
"type": "boolean"
}
},
"type": "object"
},
"dto.FilterType": {
"properties": {
"code": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"dto.FindingAlmIssues": {
"properties": {
"azure": {
"$ref": "#/components/schemas/dto.AzureDevOpsWorkItem"
},
"jira": {
"$ref": "#/components/schemas/dto.JiraIssue"
},
"jiraPlatform": {
"$ref": "#/components/schemas/dto.JiraPlatformIssue"
}
},
"type": "object"
},
"dto.FindingComment": {
"properties": {
"body": {
"type": "string"
},
"createdBy": {
"type": "string"
},
"createdTime": {
"type": "string"
}
},
"type": "object"
},
"dto.FindingSharedStep": {
"properties": {
"endLine": {
"type": "integer"
},
"file": {
"type": "string"
},
"kind": {
"type": "string"
},
"line": {
"type": "integer"
},
"lineBlame": {
"$ref": "#/components/schemas/dto.LineBlame"
},
"name": {
"type": "string"
},
"snippet": {
"type": "string"
},
"startLine": {
"type": "integer"
}
},
"type": "object"
},
"dto.FindingV3": {
"properties": {
"ageRating": {
"description": "Between 0 and 10",
"type": "number"
},
"almIssues": {
"$ref": "#/components/schemas/dto.FindingAlmIssues"
},
"appId": {
"type": "string"
},
"baseline": {
"type": "boolean"
},
"comments": {
"items": {
"$ref": "#/components/schemas/dto.FindingComment"
},
"type": "array"
},
"confidenceRating": {
"description": "Between 0 and 10",
"type": "number"
},
"correlatedDastFindingUuids": {
"items": {
"type": "string"
},
"type": "array"
},
"createdTime": {
"type": "string"
},
"dataFlows": {
"items": {
"$ref": "#/components/schemas/dto.DataFlow"
},
"type": "array"
},
"description": {
"type": "string"
},
"hasRemediation": {
"type": "boolean"
},
"id": {
"description": "Uniquely identifies the finding across multiple scans",
"type": "string"
},
"isNew": {
"type": "boolean"
},
"issueStatus": {
"type": "integer"
},
"projectId": {
"type": "string"
},
"rating": {
"description": "Between 0 and 10",
"type": "number"
},
"refId": {
"description": "Uniquely identifies the finding across multiple scans",
"type": "string"
},
"reviewed": {
"type": "boolean"
},
"riskFactors": {
"$ref": "#/components/schemas/dto.RiskFactors"
},
"scanId": {
"description": "Uniquely identifies the scan this finding was loaded from",
"type": "string"
},
"severity": {
"type": "string"
},
"severityRating": {
"description": "Between 0 and 10",
"type": "number"
},
"sharedStep": {
"$ref": "#/components/schemas/dto.FindingSharedStep"
},
"snapshotId": {
"description": "Uniquely identifies the finding within a scan, it's equivalent to the pair of id and scanId",
"type": "string"
},
"suppressed": {
"type": "boolean"
},
"suppressedBy": {
"type": "string"
},
"suppressionMessage": {
"description": "Always empty if suppressed is not set",
"type": "string"
},
"suppressionRejected": {
"type": "boolean"
},
"suppressionRequestComment": {
"type": "string"
},
"suppressionRequested": {
"type": "boolean"
},
"suppressionTime": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/dto.VulnerabilityTypeDefinition"
},
"workflowViolations": {
"items": {
"$ref": "#/components/schemas/dto.Workflow"
},
"type": "array"
},
"workflowViolationsCount": {
"type": "integer"
}
},
"type": "object"
},
"dto.HipaaInfo": {
"properties": {
"control": {
"type": "string"
},
"title": {
"type": "string"
}
},
"type": "object"
},
"dto.HitrustInfo": {
"properties": {
"control": {
"type": "string"
},
"title": {
"type": "string"
}
},
"type": "object"
},
"dto.JiraIssue": {
"properties": {
"issueId": {
"type": "string"
},
"project": {
"type": "string"
}
},
"type": "object"
},
"dto.JiraPlatformIssue": {
"properties": {
"createdBy": {
"type": "string"
},
"createdByName": {
"type": "string"
},
"createdTime": {
"type": "string"
},
"errorMessage": {
"type": "string"
},
"internalStatus": {
"type": "string"
},
"issueKey": {
"type": "string"
},
"issueStatus": {
"type": "string"
},
"publicLink": {
"type": "string"
}
},
"type": "object"
},
"dto.LineBlame": {
"properties": {
"commitId": {
"type": "string"
},
"file": {
"type": "string"
},
"line": {
"type": "integer"
}
},
"type": "object"
},
"dto.MendCursoredResponse-array_dto_FindingV3": {
"properties": {
"additionalData": {
"properties": {
"cursor": {
"example": 1,
"type": "integer"
},
"next": {
"example": "https://domain.com/api/v3.0/resources?cursor=1",
"type": "string"
}
},
"type": "object"
},
"response": {
"items": {
"$ref": "#/components/schemas/dto.FindingV3"
},
"type": "array"
},
"supportToken": {
"type": "string"
}
},
"type": "object"
},
"dto.MendErrorResponse-dto_ErrorResponse": {
"properties": {
"additionalData": {
"$ref": "#/components/schemas/dto.ErrorResponse"
},
"response": {},
"supportToken": {
"type": "string"
}
},
"type": "object"
},
"dto.MendResponse-dto_FindingV3": {
"properties": {
"additionalData": {
"additionalProperties": true,
"type": "object"
},
"response": {
"$ref": "#/components/schemas/dto.FindingV3"
},
"supportToken": {
"type": "string"
}
},
"type": "object"
},
"dto.MendResponse-dto_SuccessResponse": {
"properties": {
"additionalData": {
"additionalProperties": true,
"type": "object"
},
"response": {
"$ref": "#/components/schemas/dto.SuccessResponse"
},
"supportToken": {
"type": "string"
}
},
"type": "object"
},
"dto.NistInfo": {
"properties": {
"control": {
"type": "string"
},
"priority": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"dto.Owasp2021Info": {
"properties": {
"index": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"dto.OwaspInfo": {
"properties": {
"index": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"dto.PatchFinding": {
"properties": {
"customSeverity": {
"description": "If set, it has to be either High, Medium or Low.\nCase insensitive, all values are converted to have the first letter uppercase and others lowercase, e.g. High.",
"type": "string"
},
"origin": {
"description": "Optional, origin used for telemetry.",
"type": "string"
},
"reviewed": {
"type": "boolean"
},
"suppressed": {
"type": "boolean"
},
"suppressionReason": {
"description": "Has to be unset or empty if suppressed is not set or if it's false.",
"type": "string"
}
},
"type": "object"
},
"dto.PcidssInfo": {
"properties": {
"section": {
"type": "string"
},
"title": {
"type": "string"
}
},
"type": "object"
},
"dto.RiskFactorEndpoint": {
"properties": {
"endpoint": {
"type": "string"
},
"method": {
"type": "string"
}
},
"type": "object"
},
"dto.RiskFactors": {
"properties": {
"endpoints": {
"items": {
"$ref": "#/components/schemas/dto.RiskFactorEndpoint"
},
"type": "array"
},
"hasEndpoints": {
"type": "boolean"
},
"isExploitable": {
"type": "boolean"
},
"probability": {
"type": "string"
}
},
"type": "object"
},
"dto.SansTop25Info": {
"properties": {
"rank": {
"type": "integer"
},
"title": {
"type": "string"
}
},
"type": "object"
},
"dto.SuccessResponse": {
"properties": {
"message": {
"example": "Operation succeeded",
"type": "string"
},
"result": {},
"success": {
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"dto.VulnerabilityTypeDefinition": {
"properties": {
"capec": {
"$ref": "#/components/schemas/dto.CapecInfo"
},
"commonId": {
"type": "string"
},
"cwe": {
"$ref": "#/components/schemas/dto.CweInfo"
},
"description": {
"type": "string"
},
"driver": {
"type": "string"
},
"engineId": {
"type": "integer"
},
"hipaa": {
"$ref": "#/components/schemas/dto.HipaaInfo"
},
"hitrust": {
"$ref": "#/components/schemas/dto.HitrustInfo"
},
"id": {
"type": "integer"
},
"language": {
"type": "string"
},
"name": {
"type": "string"
},
"nist": {
"$ref": "#/components/schemas/dto.NistInfo"
},
"order": {
"type": "integer"
},
"owasp": {
"$ref": "#/components/schemas/dto.OwaspInfo"
},
"owasp2021": {
"$ref": "#/components/schemas/dto.Owasp2021Info"
},
"pcidss": {
"$ref": "#/components/schemas/dto.PcidssInfo"
},
"recommendations": {
"items": {
"type": "string"
},
"type": "array"
},
"references": {
"items": {
"type": "string"
},
"type": "array"
},
"sansTop25": {
"$ref": "#/components/schemas/dto.SansTop25Info"
},
"sarif": {
"type": "string"
},
"sarifLevel": {
"type": "string"
},
"severity": {
"type": "string"
},
"severityRating": {
"type": "number"
}
},
"type": "object"
},
"dto.Workflow": {
"properties": {
"name": {
"type": "string"
},
"uuid": {
"type": "string"
}
},
"type": "object"
},
"common.AdditionalData": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"paging": {
"$ref": "#/components/schemas/common.Paging"
},
"totalItems": {
"type": "integer",
"example": 100
}
}
},
"common.BaseApiResponseV3": {
"type": "object",
"properties": {
"additionalData": {
"$ref": "#/components/schemas/common.AdditionalData"
},
"response": {},
"supportToken": {
"type": "string",
"example": "659C0A4730"
}
}
},
"common.Paging": {
"type": "object",
"properties": {
"cursor": {
"type": "integer",
"example": 5
},
"next": {
"type": "string",
"example": "https://api-saas.mend.io/api/v3.0/projects/>/images/deployments?cursor=6"
}
}
},
"github_com_mend_cloud-native_modules_common_model.FindingStatus": {
"type": "object",
"properties": {
"applicationuuid": {
"type": "string"
},
"comment": {
"type": "string"
},
"createdAt": {
"type": "string",
"example": "2020-01-01T00:00:00Z"
},
"detectTime": {
"type": "string"
},
"distribution": {
"type": "string"
},
"distributionVersion": {
"type": "string"
},
"email": {
"type": "string"
},
"orguuid": {
"type": "string"
},
"packageDistroID": {
"type": "integer"
},
"packageName": {
"type": "string"
},
"packageUUID": {
"type": "string"
},
"packageVersion": {
"type": "string"
},
"projectuuid": {
"type": "string"
},
"reason": {
"type": "string"
},
"scanuuid": {
"type": "string"
},
"secretUUID": {
"type": "string"
},
"severity": {
"type": "string"
},
"status": {
"type": "string"
},
"updatedAt": {
"type": "string",
"example": "2020-01-01T00:00:00Z"
},
"uuid": {
"type": "string",
"example": "c4f93b6d-8236-4d0c-a67b-3978def476a3"
},
"vulnerabilityID": {
"type": "string"
}
}
},
"github_com_mend_cloud-native_modules_scanner_model.Package": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"reachable": {
"type": "boolean"
},
"type": {
"type": "string"
},
"version": {
"type": "string"
}
}
},
"github_com_mend_cloud-native_modules_scanner_model.SecretFinding": {
"type": "object",
"properties": {
"category": {
"type": "string",
"example": "AWS"
},
"createdAt": {
"type": "string",
"example": "2020-01-01T00:00:00Z"
},
"description": {
"type": "string",
"example": "AWS Access Key"
},
"endLine": {
"type": "integer",
"example": 35
},
"filePath": {
"type": "string",
"example": "/home/ubuntu/.aws/credentials"
},
"isFromBaseLayer": {
"type": "integer",
"example": 0
},
"layerId": {
"type": "integer",
"example": 123456
},
"layerNumber": {
"type": "integer",
"example": 1
},
"projectName": {
"type": "string"
},
"ruleId": {
"type": "string",
"example": "123456"
},
"severity": {
"type": "string",
"example": "HIGH"
},
"startLine": {
"type": "integer",
"example": 15
},
"updatedAt": {
"type": "string",
"example": "2020-01-01T00:00:00Z"
},
"uuid": {
"type": "string",
"example": "c4f93b6d-8236-4d0c-a67b-3978def476a3"
}
}
},
"inputs.FindingStatusInputV3": {
"type": "object",
"required": [
"status"
],
"properties": {
"comment": {
"type": "string"
},
"packageUUID": {
"type": "string"
},
"reason": {
"$ref": "#/components/schemas/model.FindingSuppressionReason"
},
"status": {
"$ref": "#/components/schemas/model.FindingStatusType"
},
"vulnerabilityName": {
"type": "string"
}
}
},
"model.BulkStatusUpdate": {
"type": "object",
"properties": {
"failedPackageUUID": {
"type": "array",
"items": {
"type": "string"
}
},
"updatedStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/github_com_mend_cloud-native_modules_common_model.FindingStatus"
}
}
}
},
"model.FindingStatusType": {
"type": "string",
"enum": [
"suppressed",
"unreviewed",
"reviewed",
"suppress",
"Issue Created"
],
"x-enum-varnames": [
"FindingStatusSuppressed",
"FindingStatusUnreviewed",
"FindingStatusReviewed",
"FindingStatusSuppress",
"FindingStatusIssueCreated"
]
},
"model.FindingSuppressionReason": {
"type": "string",
"enum": [
"Acceptable risk",
"No fix available",
"No risk",
"Ignore"
],
"x-enum-varnames": [
"FindingSuppressionReasonAcceptableRisk",
"FindingSuppressionReasonNoFixAvailable",
"FindingSuppressionReasonNoRisk",
"FindingSuppressionReasonIgnore"
]
},
"model.SecurityFindingExternal": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"example": "2019-12-18 16:15:26.963000"
},
"cvss": {
"type": "number",
"example": 6.5
},
"cvssDetails": {
"type": "string",
"example": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H"
},
"description": {
"type": "string",
"example": "A vulnerability in the foo subsystem of bar could allow an unauthenticated, remote attacker to cause a denial of service (DoS) condition on an affected device."
},
"detectionDate": {
"type": "string",
"example": "2019-12-18 16:15:26.963000"
},
"epss": {
"type": "number",
"example": 5.1
},
"fixVersion": {
"type": "string",
"example": "1.2.4"
},
"hasFix": {
"type": "boolean",
"example": true
},
"imageName": {
"type": "string",
"example": "foo:1.2.3"
},
"lastModifiedDate": {
"type": "string",
"example": "2019-12-18 16:15:26.963000"
},
"packageName": {
"type": "string",
"example": "foo"
},
"packageVersion": {
"type": "string",
"example": "1.2.3"
},
"projectUUID": {
"type": "string",
"example": "edcd08f7-0688-4a30-932b-541256072846"
},
"publishedDate": {
"type": "string"
},
"reachabilityConfidence": {
"type": "number"
},
"reachabilityGraph": {
"type": "string"
},
"reachabilityStatus": {
"type": "string"
},
"severity": {
"type": "string",
"example": "HIGH"
},
"uuid": {
"type": "string",
"example": "edcd08f7-0688-4a30-932b-541256072846"
},
"vulnerabilityID": {
"type": "string",
"example": "CVE-2019-1234"
}
}
},
"v3.DTO_AIComponent": {
"type": "object",
"properties": {
"componentId": {
"type": "string"
},
"componentName": {
"type": "string"
},
"componentType": {
"type": "string"
},
"componentVersion": {
"type": "string"
}
}
},
"v3.DTO_AIModel": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"modelName": {
"type": "string"
},
"provider": {
"type": "string"
},
"category": {
"type": "string"
},
"originType": {
"type": "string"
},
"modelUuid": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"version": {
"type": "string"
},
"description": {
"type": "string"
},
"author": {
"type": "string"
},
"homePage": {
"type": "string"
},
"tos": {
"type": "string"
},
"projectName": {
"type": "string"
},
"projectUuid": {
"type": "string"
},
"origins": {
"type": "array",
"items": {
"type": "string"
}
},
"violations": {
"type": "integer"
},
"violatingFindings": {
"type": "integer"
},
"licenses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/v3.DTO_AIModelLicense"
}
},
"licenseRisk": {
"$ref": "#/components/schemas/v3.DTO_AILicenseRisk"
},
"securityRiskFactors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/v3.DTO_AISecurityRiskFactors"
}
},
"securityFindings": {
"type": "object",
"additionalProperties": {
"type": "integer"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"v3.DTO_AIModelLicense": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"score": {
"type": "number",
"format": "double"
},
"severity": {
"type": "string"
}
}
},
"v3.DTO_AILicenseRisk": {
"type": "object",
"properties": {
"severity": {
"type": "string"
}
}
},
"v3.DTO_AISecurityRiskFactors": {
"type": "object",
"properties": {
"sourceUrl": {
"type": "string"
},
"riskFactor": {
"type": "string"
}
}
},
"v3.DTO_AIVulnerabilitiesResponse": {
"type": "object",
"properties": {
"vulnerabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/v3.DTO_AIVulnerabilityListItem"
}
},
"totalCount": {
"type": "integer"
},
"projectUuid": {
"type": "string"
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
}
}
},
"v3.DTO_AIVulnerabilityListItem": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"scanUuid": {
"type": "string"
},
"scanTime": {
"type": "string",
"format": "date-time"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"v3.DTO_AIVulnerabilityDetailResponse": {
"type": "object",
"properties": {
"additionalData": {
"$ref": "#/components/schemas/v3.DTO_AdditionalData"
},
"response": {
"$ref": "#/components/schemas/v3.DTO_VulnerabilityDetail"
},
"supportToken": {
"type": "string"
}
}
},
"v3.DTO_AdditionalData": {
"type": "object",
"properties": {
"paging": {
"$ref": "#/components/schemas/v3.DTO_Paging"
},
"totalItems": {
"type": "integer"
}
}
},
"v3.DTO_Paging": {
"type": "object",
"properties": {
"cursor": {
"type": "integer"
},
"next": {
"type": "string"
},
"limit": {
"type": "integer"
}
}
},
"v3.DTO_VulnerabilityDetail": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"publishDate": {
"type": "integer",
"format": "int64"
},
"lastUpdated": {
"type": "integer",
"format": "int64"
},
"sequenceId": {
"type": "string"
},
"vulnerabilityReference": {
"type": "array",
"items": {
"$ref": "#/components/schemas/v3.DTO_VulnerabilityReference"
}
},
"vulnerabilityScoring": {
"type": "array",
"items": {
"$ref": "#/components/schemas/v3.DTO_VulnerabilityScoring"
}
}
}
},
"v3.DTO_VulnerabilityReference": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"profileId": {
"type": "string"
},
"url": {
"type": "string"
},
"sourceName": {
"type": "string"
},
"signature": {
"type": "boolean"
},
"advisory": {
"type": "boolean"
},
"patch": {
"type": "boolean"
},
"value": {
"type": "string"
}
}
},
"v3.DTO_VulnerabilityScoring": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"profileId": {
"type": "string"
},
"score": {
"type": "number",
"format": "double"
},
"severity": {
"type": "string"
},
"type": {
"type": "string"
},
"extraData": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"v3.V3BaseResponse-array_v3_DTO_AIComponent": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/v3.DTO_AIComponent"
}
},
"pagination": {
"$ref": "#/components/schemas/v3.V3Pagination"
}
}
},
"v3.V3BaseResponse-array_v3_DTO_AIModel": {
"type": "object",
"properties": {
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/v3.DTO_AIModel"
}
},
"supportToken": {
"type": "string"
},
"additionalData": {
"$ref": "#/components/schemas/v3.DTO_AdditionalData"
}
}
},
"v3.V3Pagination": {
"type": "object",
"properties": {
"cursor": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"limit": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"v3.V3Response-array_v3_V3ImplementationFindingResponse": {
"type": "object",
"properties": {
"response": {
"type": "array",
"items": {
"$ref": "#/components/schemas/v3.V3ImplementationFindingResponse"
}
},
"supportToken": {
"type": "string"
},
"additionalData": {
"$ref": "#/components/schemas/v3.DTO_AdditionalData"
}
}
},
"v3.V3ImplementationFindingResponse": {
"type": "object",
"properties": {
"snippetUuid": {
"type": "string"
},
"origin": {
"type": "string"
},
"implementationType": {
"type": "string"
},
"snippet": {
"type": "string"
},
"severity": {
"type": "string"
},
"totalSeverity": {
"type": "integer"
},
"criticalSeverity": {
"type": "integer"
},
"highSeverity": {
"type": "integer"
},
"mediumSeverity": {
"type": "integer"
},
"lowSeverity": {
"type": "integer"
},
"riskFactors": {
"type": "array",
"items": {
"type": "string"
}
},
"project": {
"$ref": "#/components/schemas/v3.V3ProjectInfo"
},
"scanUuid": {
"type": "string"
},
"findings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/v3.V3FindingResponse"
}
}
}
},
"v3.V3ProjectInfo": {
"type": "object",
"properties": {
"projectUuid": {
"type": "string"
},
"projectName": {
"type": "string"
}
}
},
"v3.V3FindingResponse": {
"type": "object",
"properties": {
"findingId": {
"type": "string"
},
"findingName": {
"type": "string"
},
"severity": {
"type": "string"
},
"element": {
"type": "string"
},
"elementUuid": {
"type": "string"
}
}
},
"v3.V3ImplementationWeaknessResponse": {
"type": "object",
"properties": {
"weaknessID": {
"type": "string"
},
"weaknessCategory": {
"type": "string"
},
"weaknessSeverity": {
"type": "string"
},
"weaknessScore": {
"type": "string"
},
"weaknessTitle": {
"type": "string"
},
"owaspCategory": {
"type": "string"
},
"weaknessDescription": {
"type": "string"
},
"weaknessPotentialImpact": {
"type": "string"
},
"weaknessBestPractices": {
"type": "string"
},
"weaknessReferences": {
"type": "string"
}
}
},
"v3.V3TestRunTriggerRequest": {
"type": "object",
"required": [
"name",
"targetId",
"probeIds"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the test run"
},
"targetId": {
"type": "integer",
"description": "Target ID for the test run"
},
"probeIds": {
"type": "array",
"description": "List of probe IDs to run",
"minItems": 1,
"items": {
"type": "integer"
}
}
}
},
"v3.V3TestRunTriggerResponse": {
"type": "object",
"properties": {
"testRunId": {
"type": "integer",
"description": "ID of the triggered test run"
}
}
},
"v3.V3BaseResponse-v3_V3TestRunTriggerResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/v3.V3TestRunTriggerResponse"
},
"supportToken": {
"type": "string"
}
}
}
},
"securitySchemes": {
"bearer-key": {
"type": "http",
"description": "JWT token Bearer",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
}
}