{ "swagger": "2.0", "info": { "version": "latest", "title": "Checkmarx REST API", "description": "Login is required for exploring the CxREST API through Swagger. Click the login indicator ![login logo](loginLogo) and you will be redirected to the relevant Login page.
CxREST API uses the OpenID Connect standard. In order to authenticate the CxREST API from a custom application, use OAuth2 according to the discovery document and Checkmarx documentation. " }, "host": "desktop-rmvpboc", "basePath": "/cxrestapi/help", "schemes": [ "https" ], "paths": { "/osa/scans": { "get": { "tags": [ "OSA" ], "summary": "Returns basic scan details for all scans associated with a specified project id", "operationId": "OsaScanRequests_GetV2ByprojectIdpageitemsPerPage", "consumes": [ "application/json;v=2.0" ], "produces": [ "application/json;v=2.0" ], "parameters": [ { "name": "projectId", "in": "query", "description": "Unique Id of the specific project", "required": true, "type": "integer", "format": "int64" }, { "name": "page", "in": "query", "description": "Page number (default 1)", "required": false, "type": "integer", "format": "int32" }, { "name": "itemsPerPage", "in": "query", "description": "Number of items per page (default 100)", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.Osa.Application.DTOs.Responses.ScanDtoV2" } } } } }, "post": { "tags": [ "OSA" ], "summary": "Creates a new scan request", "operationId": "OsaScanRequests_PostByscanRequestInfo.projectIdscanRequestInfo.originscanRequestInfo.hashedFilesList", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "parameters": [ { "name": "projectId", "in": "formData", "description": "The Project Id associated with requested scan", "required": false, "type": "integer" }, { "name": "origin", "in": "formData", "description": "The location from which scan was requested (if not specified (Portal) will be selected)", "required": false, "type": "string" }, { "name": "zippedSource", "in": "formData", "description": "Zipped source code to scan", "required": false, "type": "file" } ], "responses": { "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/Cx.Osa.Presentation.DTOs.NewDTOs.NewScanResponseDTO" } }, "400": { "description": "Bad Request" } } } }, "/customTasks": { "get": { "tags": [ "GENERAL" ], "summary": "Gets a collection of Custom Tasks (Scan Actions)", "operationId": "CustomTasks_Get", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "responses": { "200": { "description": "Ok", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.CustomTasks.Presentation.Dtos.GetCustomTaskDto" } } } } } }, "/customTasks/{id}": { "get": { "tags": [ "GENERAL" ], "summary": "Gets a Custom Task (Scan Action) by id", "operationId": "CustomTasks_GetByid", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique ID of a specific Custom task", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/Cx.CustomTasks.Presentation.Dtos.GetCustomTaskDto" } }, "404": { "description": "Not Found" } } } }, "/issueTrackingSystems": { "get": { "tags": [ "GENERAL" ], "summary": "Gets details of all issue tracking systems", "operationId": "IssueTrackingSystems_GetAll", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.IssueTrackingSystems.Presentation.Dtos.GetIssueTrackingSystemDto" } }, "examples": [ { "id": 1, "name": "Test Server", "type": "Jira", "url": "http://10.61.1.72:8080/" }, { "id": 2, "name": "Other Test Server", "type": "Jira", "url": "http://18.91.5.72" } ] } } } }, "/reports/sastScan/{id}": { "get": { "tags": [ "GENERAL" ], "summary": "Gets the report when ready", "operationId": "Reports_GetByid", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific report", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } }, "404": { "description": "Not Found" }, "204": { "description": "No Content", "schema": { "type": "object" } } } } }, "/customTasks/name/{name}": { "get": { "tags": [ "GENERAL" ], "summary": "Gets a Custom Task (Scan Action) by name", "operationId": "CustomTasks_GetByname", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "name", "in": "path", "description": "Name of a specific Custom task", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.CustomTasks.Presentation.Dtos.GetCustomTaskDto" } } } } } }, "/projects/precheck/teams/{id}": { "get": { "tags": [ "GENERAL" ], "summary": "Verification of team existence\r\nUsed to verify before creating a new project for a team", "operationId": "ProjectPrecheck_GetTeamByIdByid", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.PrecheckTeamDto" } }, "404": { "description": "Not found" }, "403": { "description": "Forbidden" } } } }, "/reports/sastScan/{id}/status": { "get": { "tags": [ "GENERAL" ], "summary": "Gets the status of a specific report in the queue", "operationId": "Reports_GetStatusByid", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific report", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" }, "examples": { "link": { "rel": "content", "uri": "/reports/sastScan/1" }, "contentType": "application/pdf", "status": { "id": 2, "value": "Created" } } }, "404": { "description": "Not found" } } } }, "/configurationsExtended/{group}": { "get": { "tags": [ "GENERAL" ], "summary": "Retrieves CxComponentConfiguration settings", "operationId": "Configurations_GetExtendedBygroup", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "group", "in": "path", "description": "Configuration group name associated with the settings to be retrieved", "required": true, "type": "string", "enum": [ "None", "AppSecCoach", "AuthorizationService", "Portal", "Scanning", "SystemSettings", "QueueSettings", "Audit", "Logging", "DataRetention", "Reports" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.CrossCutting.Configuration.DTOs.ComponentConfiguration" } } } } }, "put": { "tags": [ "GENERAL" ], "summary": "Updates CxComponentConfiguration settings", "operationId": "Configurations_PutExtendedBygroupconfigurationsList", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "group", "in": "path", "description": "Configuration group name associated with the settings to be updated", "required": true, "type": "string", "enum": [ "None", "AppSecCoach", "AuthorizationService", "Portal", "Scanning", "SystemSettings", "QueueSettings", "Audit", "Logging", "DataRetention", "Reports" ] }, { "name": "configurationsList", "in": "body", "description": "Array of configuration settings in JSON format to be updated", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.CrossCutting.Configuration.Swagger.ComponentConfigurationUpdate" } } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/issueTrackingSystems/{id}/metadata": { "get": { "tags": [ "GENERAL" ], "summary": "Gets the metadata of specific issue tracking system", "operationId": "IssueTrackingSystems_GetMetadataByid", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "The Id of issue tracking system the metadata to retrieve for", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingSystemMetadata" }, "examples": { "projects": [ { "id": "10000", "name": "Example project", "issueTypes": [ { "subtask": false, "id": "1", "name": "Example issue", "fields": [ { "id": "1", "name": "Example field 1", "multiple": false, "required": false, "supported": true, "allowedValues": [ { "id": "1", "name": "v1" }, { "id": "2", "name": "v2" }, { "id": "3", "name": "v3" } ] }, { "id": "1", "name": "Example Field 1", "multiple": false, "required": false, "supported": true, "allowedValues": [] }, { "id": "1", "name": "Example Field 2", "multiple": true, "required": false, "supported": true, "allowedValues": [ { "id": "100", "name": "option 1" }, { "id": "298", "name": "option 2" } ] } ] } ] } ] } } } } }, "/projects/{id}/sourceCode/excludeSettings": { "get": { "tags": [ "GENERAL" ], "summary": "Get project's exclude folders/files patterns", "operationId": "ExcludeSettings_GetByid", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique ID of a specific project", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.GetExcludeSettingsDto" } }, "404": { "description": "Not Found" }, "501": { "description": "Not Implemented" } } }, "put": { "tags": [ "GENERAL" ], "summary": "Set project's exclude folders/files patterns", "operationId": "ExcludeSettings_PutByidexcludeSettings", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique ID of a specific project", "required": true, "type": "integer", "format": "int64" }, { "name": "excludeSettings", "in": "body", "description": "Exclude folders/files pattern settings", "required": true, "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.ExcludeSettingsDto" } } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } }, "404": { "description": "Not Found" } } } }, "/projects/{id}/sourceCode/remoteSettings/tfs": { "get": { "tags": [ "GENERAL" ], "summary": "Gets details of TFS source settings", "operationId": "TfsSourceSettings_GetTfsSettingsByid", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific project", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.GetTfsSourceSettingsDto" } } } }, "post": { "tags": [ "GENERAL" ], "summary": "Set project's remote source settings as TFS", "operationId": "TfsSourceSettings_UpdateTfsSettingsByidtfsSettings", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific project", "required": true, "type": "integer", "format": "int64" }, { "name": "tfsSettings", "in": "body", "description": "TFS settings details", "required": true, "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.TfsSourceSettingsDto" } } ], "responses": { "204": { "description": "No Content", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } } }, "/projects/{id}/sourceCode/remoteSettings/custom": { "get": { "tags": [ "GENERAL" ], "summary": "Gets details of Source Pulling parameters", "operationId": "CustomSourceSettings_GetCustomSettingsByid", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific project", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.GetCustomSourceSettingsDto" } } } }, "post": { "tags": [ "GENERAL" ], "summary": "Set project's remote source settings as Source Pulling", "operationId": "CustomSourceSettings_UpdateCustomSettingsByidcustomSourceSettings", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific project", "required": true, "type": "integer", "format": "int64" }, { "name": "customSourceSettings", "in": "body", "description": "Custom settings details", "required": true, "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.CustomSourceSettingsDto" } } ], "responses": { "204": { "description": "No Content", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } } }, "/projects/{id}/sourceCode/remoteSettings/shared": { "get": { "tags": [ "GENERAL" ], "summary": "Gets details of Shared source settings", "operationId": "SharedSourceSettings_GetSharedSettingsByid", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific project", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.GetSharedSourceSettingsDto" } } } }, "post": { "tags": [ "GENERAL" ], "summary": "Set project's remote source settings as shared", "operationId": "SharedSourceSettings_UpdateSharedSettingsByidsharedSettings", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific project", "required": true, "type": "integer", "format": "int64" }, { "name": "sharedSettings", "in": "body", "description": "Shared settings details", "required": true, "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.SharedSourceSettingsDto" } } ], "responses": { "204": { "description": "No Content", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } } }, "/projects/{id}/sourceCode/remoteSettings/perforce": { "get": { "tags": [ "GENERAL" ], "summary": "Gets details of Perforce source settings", "operationId": "PerforceSourceSettings_GetPerforceSettingsByid", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific project", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.GetPerforceSourceSettingsDto" } } } }, "post": { "tags": [ "GENERAL" ], "summary": "Set project's remote source settings as perforce", "operationId": "PerforceSourceSettings_UpdatePerforceSettingsByidperforceSettings", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific project", "required": true, "type": "integer", "format": "int64" }, { "name": "perforceSettings", "in": "body", "description": "Perforce settings details", "required": true, "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.PerforceSourceSettingDto" } } ], "responses": { "204": { "description": "No Content", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } } }, "/reports/sastScan": { "post": { "tags": [ "GENERAL" ], "summary": "Register a new scan report", "operationId": "Reports_PostByreportRequest", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "reportRequest", "in": "body", "description": "Report type options: PDF, RTF, CSV, XML", "required": true, "schema": { "$ref": "#/definitions/Cx.Reports.SastScan.Presentation.Dtos.SastReportRequestDTO" } } ], "responses": { "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/Cx.Reports.SastScan.Presentation.Dtos.CreateReportResponseDto" } }, "400": { "description": "Bad Request" } } } }, "/projects/{id}/branch": { "post": { "tags": [ "GENERAL" ], "summary": "Branch an existing project", "operationId": "BranchProjects_BranchByidproject", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique ID of a specific project", "required": true, "type": "integer", "format": "int64" }, { "name": "project", "in": "body", "description": "Branched Project details", "required": true, "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.BranchProjectDto" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource" } }, "400": { "description": "Bad Request" } } } }, "/projects/{id}/dataRetentionSettings": { "post": { "tags": [ "GENERAL" ], "summary": "Set project's data retention settings", "operationId": "DataRetentionSettings_UpdateDataRetentionSettingsByiddataRetentionSettingsDto", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific project", "required": true, "type": "integer", "format": "int64" }, { "name": "dataRetentionSettingsDto", "in": "body", "description": "Data retention settings", "required": true, "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.DataRetentionSettingsDto" } } ], "responses": { "204": { "description": "No Content", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } } }, "/projects/{id}/issueTrackingSettings/jira": { "post": { "tags": [ "GENERAL" ], "summary": "Set project's issue tracking system as JIRA", "operationId": "JiraIssueTrackingSettings_UpdateJiraSettingsByidjiraSettings", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific project", "required": true, "type": "integer", "format": "int64" }, { "name": "jiraSettings", "in": "body", "description": "JIRA issue tracking details", "required": true, "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.JiraIssueTrackingSettingsDto" } } ], "responses": { "204": { "description": "No Content", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } } }, "/system/version": { "get": { "tags": [ "GENERAL" ], "summary": "Returns version, hotfix number and engine pack version", "operationId": "System_VersionV1_1", "consumes": [ "application/json;v=1.1" ], "produces": [ "application/json;v=1.1" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/Cx.CrossCutting.WebAPIHost.ValueObjects.VersionResponseV1_1" } } } } }, "/projects/{id}/sourceCode/remoteSettings/git": { "get": { "tags": [ "GENERAL" ], "summary": "Gets details of GIT source settings", "operationId": "GitSourceSettings_GetGitSettingsByid", "consumes": [ "application/json;v=1.3" ], "produces": [ "application/json;v=1.3" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific project", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.GetGitSourceSettingsDto" } } } }, "post": { "tags": [ "GENERAL" ], "summary": "Set project's remote source settings as GIT", "operationId": "GitSourceSettings_UpdateGitSettingsByidgitSettings", "consumes": [ "application/json;v=1.3" ], "produces": [ "application/json;v=1.3" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific project", "required": true, "type": "integer", "format": "int64" }, { "name": "gitSettings", "in": "body", "description": "GIT settings details", "required": true, "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.GitSourceSettingsDtoV1_3" } } ], "responses": { "204": { "description": "No Content", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } } }, "/projects/{id}/sourceCode/remoteSettings/git/ssh": { "post": { "tags": [ "GENERAL" ], "summary": "Set project's remote source settings as GIT which uses SSH protocol", "operationId": "GitSourceSettings_UpdateGitSettingsByidgitSshSettings.urlgitSshSettings.branch", "consumes": [ "application/json;v=1.3" ], "produces": [ "application/json;v=1.3" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific project", "required": true, "type": "integer" }, { "name": "url", "in": "formData", "description": "The URL which is used to connect to GIT repository", "required": true, "type": "string" }, { "name": "branch", "in": "formData", "description": "The branch of a GIT repository", "required": true, "type": "string" }, { "name": "privateKey", "in": "formData", "description": "Private key which is used to connect to GIT repository using SSH protocol", "required": false, "type": "file" } ], "responses": { "204": { "description": "No Content", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } } }, "/queries/{queryid}/cxDescription": { "get": { "tags": [ "GENERAL" ], "summary": "Gets the full description of the query", "operationId": "CxDescription_GetByqueryid", "consumes": [ "application/json;v=3.0" ], "produces": [ "application/json;v=3.0" ], "parameters": [ { "name": "queryid", "in": "path", "description": "Unique Id of the query", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/serverLicenseData": { "get": { "tags": [ "GENERAL" ], "summary": "Gets a server license data", "operationId": "ServerLicense_LicenseDetails", "consumes": [ "application/json;v=4.0" ], "produces": [ "application/json;v=4.0" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/Cx.CrossCutting.WebAPIHost.ValueObjects.LicenseDetailsResponse" } } } } }, "/projects/branch/{id}": { "get": { "tags": [ "GENERAL" ], "summary": "Gets project branching status", "operationId": "BranchProjectsV_GetProjectBranchingStatusByid", "consumes": [ "application/json;v=4.0" ], "produces": [ "application/json;v=4.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the branched project", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.ProjectBranchDto" } } } } }, "/queries/queryVersionCode": { "get": { "tags": [ "GENERAL" ], "summary": "Get the query id and query version code", "operationId": "QueryVersionCode_GetBylanguageseverityqueryName", "consumes": [ "application/json;v=4.0" ], "produces": [ "application/json;v=4.0" ], "parameters": [ { "name": "language", "in": "query", "description": "Language of the query", "required": true, "type": "string" }, { "name": "severity", "in": "query", "description": "Severity of the query, default value is \"Info\"", "required": true, "type": "string", "enum": [ "Info", "Low", "Medium", "High", "Critical" ] }, { "name": "queryName", "in": "query", "description": "Query name of the query", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/Cx.QueryManagement.Presentation.Queries.Responses.QueryVersionCodeResponse" } }, "404": { "description": "Not Found" } } } }, "/projects/{id}/sourceCode/attachments": { "post": { "tags": [ "GENERAL" ], "summary": "Upload a zipped source code", "operationId": "LocalSourceSettings_UploadSourceCode4Byid", "consumes": [ "application/json;v=4.0" ], "produces": [ "application/json;v=4.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific project", "required": true, "type": "integer" }, { "name": "zippedSource", "in": "formData", "description": "Zipped source code to scan", "required": false, "type": "file" } ], "responses": { "204": { "description": "No Content", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } } }, "/projects/{id}/forceScanOnNoCodeChanges": { "post": { "tags": [ "GENERAL" ], "summary": "Set project's next scheduled scan to be excluded from \"no code changes\" detection", "operationId": "ProjectsManagementV_PostByid", "consumes": [ "application/json;v=4.0" ], "produces": [ "application/json;v=4.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Id of the project", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/customFields": { "get": { "tags": [ "GENERAL" ], "summary": "Get all CustomFields", "operationId": "CustomFields_GetV5", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.CustomFields.Api.ViewModels.CustomFieldViewModelV5" } } } } } }, "/projects/{id}": { "get": { "tags": [ "GENERAL" ], "summary": "Gets details of a specific project", "operationId": "ProjectsManagement_GetV5Byid", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique ID of a specific project", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.ProjectBaseDtoV5" } }, "400": { "description": "Bad Request" } } }, "put": { "tags": [ "GENERAL" ], "summary": "Updates an existing project", "operationId": "ProjectsManagement_PutV5Byidproject", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique ID of a project to update", "required": true, "type": "integer", "format": "int64" }, { "name": "project", "in": "body", "description": "Project details", "required": true, "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.UpdateFullProjectDto" } } ], "responses": { "204": { "description": "No Content", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } }, "delete": { "tags": [ "GENERAL" ], "summary": "Deletes an existing project with all related scans", "operationId": "ProjectsManagement_DeleteByiddeleteProjectDto", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique ID of a project to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "deleteProjectDto", "in": "body", "description": "A set of rules that specifies how the project should be deleted", "required": true, "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.DeleteProjectDto" } } ], "responses": { "202": { "description": "Accepted", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } }, "patch": { "tags": [ "GENERAL" ], "summary": "Updates an existing project's name or team Id", "operationId": "ProjectsManagement_PatchByidproject", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique ID of a project to update", "required": true, "type": "integer", "format": "int64" }, { "name": "project", "in": "body", "description": "Project details", "required": true, "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.UpdateProjectDto" } } ], "responses": { "204": { "description": "No Content", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } } }, "/projects/{projectId}/sourceCode/pathFilter": { "get": { "tags": [ "GENERAL" ], "summary": "Get project's source code files/folders filter", "operationId": "PathFilter_GetByprojectId", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "projectId", "in": "path", "description": "Unique ID of a specific project", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.GetPathFilterDto" } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "GENERAL" ], "summary": "Set project's source code files/folders filter", "operationId": "PathFilter_PutByprojectIdpathFilter", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "projectId", "in": "path", "description": "Unique ID of a specific project", "required": true, "type": "integer", "format": "int64" }, { "name": "pathFilter", "in": "body", "description": "Filter for source code files/folder", "required": true, "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.PathFilterDto" } } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/projects/{id}/incrementalScanValidityStatus": { "get": { "tags": [ "GENERAL" ], "summary": "Get the project's validity for running Incremental scan", "operationId": "ProjectsManagement_GetIncrementalScanValidityStatusByid", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Id of the project", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.ProjectIncementalScanValidityStatusDto" } }, "404": { "description": "Not Found" } } } }, "/userPersistence": { "get": { "tags": [ "GENERAL" ], "summary": "Gets user persistence data for current user", "operationId": "UserPersistenceV_GetBypersistenceKeys", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "persistenceKeys", "in": "query", "description": "persistence keys", "required": true, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/definitions/Cx.CrossCutting.Configuration.DTOs.UserPersistenceDto" } } } }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "GENERAL" ], "summary": "Updates an existing user persistence data for current user", "operationId": "UserPersistenceV_PatchBypersistenceItems", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "persistenceItems", "in": "body", "description": "List of keys and values to update", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.CrossCutting.Configuration.DTOs.UserPersistenceDto" } } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } } }, "/projects": { "get": { "tags": [ "GENERAL" ], "summary": "Gets details of all existing projects", "operationId": "ProjectsManagementV5__Get_PagedByprojectNameteamIdshowAlsoDeletedProjectsoffsetlimit", "consumes": [ "application/json;v=5.3" ], "produces": [ "application/json;v=5.3" ], "parameters": [ { "name": "projectName", "in": "query", "description": "Name of a specific project (allows % syntax to 'like' functionality)", "required": false, "type": "string" }, { "name": "teamId", "in": "query", "description": "Unique ID of a specific team (empty value allowed)", "required": false, "type": "string" }, { "name": "showAlsoDeletedProjects", "in": "query", "description": "Expose deleted project information, default value is \"false\"", "required": false, "type": "boolean" }, { "name": "offset", "in": "query", "description": "Get records starting at (limit*offset)", "required": false, "type": "integer", "format": "int32" }, { "name": "limit", "in": "query", "description": "Number of projects to return", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.ProjectBaseDtoV5" } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "GENERAL" ], "summary": "Creates a new project with default preset and configuration settings", "operationId": "ProjectsManagement_PostByproject", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "project", "in": "body", "description": "Project details", "required": true, "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.SaveProjectDto" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource" } }, "400": { "description": "Bad Request" } } } }, "/osa/fileextensions": { "get": { "tags": [ "OSA" ], "summary": "Get all supported Open Source file extensions", "operationId": "OsaFileExtensions_Get", "consumes": [ "application/json;v=1.0" ], "produces": [ "text/plain;v=1.0" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/osa/reports": { "get": { "tags": [ "OSA" ], "summary": "Returns a Json summary report for the specified scan Id", "operationId": "OsaScanReports_GetByscanId", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "scanId", "in": "query", "description": "Unique Id of the specific scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/System.Net.Http.ByteArrayContent" } } } } }, "/osa/licenses": { "get": { "tags": [ "OSA" ], "summary": "Returns the licenses associated with the given scan request", "operationId": "OsaLicenses_GetLicensesByscanId", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "scanId", "in": "query", "description": "Unique ID of the specific scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.Osa.Application.DTOs.OsaLicenseDto" } } } } } }, "/osa/vulnerabilities/{vulnerabilityId}/comments": { "get": { "tags": [ "OSA" ], "summary": "Returns a list of comments associated with the instances of the given vulnerability", "operationId": "OsaVulnerabilities_GetVulnerabilityCommentsByvulnerabilityIdprojectId", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Unique Id of the specific scanned vulnerability", "required": true, "type": "string" }, { "name": "projectId", "in": "query", "description": "Unique Id of the specific project", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/Cx.Osa.Application.DTOs.Responses.VulnerabilityCommentDto" } } } } }, "/osa/scans/{scanId}": { "get": { "tags": [ "OSA" ], "summary": "Returns basic scan details for a specified scan", "operationId": "OsaScanRequests_GetV2ByscanId", "consumes": [ "application/json;v=2.0" ], "produces": [ "application/json;v=2.0" ], "parameters": [ { "name": "scanId", "in": "path", "description": "Unique ID of the specific scan", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.Osa.Application.DTOs.Responses.ScanDtoV2" } } } } }, "/osa/vulnerabilities": { "get": { "tags": [ "OSA" ], "summary": "Returns all the vulnerabilities for the specified scan Id. Each vulnerability returned is unique to its library or file.", "operationId": "OsaVulnerabilities_GetByscanIdpageitemsPerPagelibraryIdstateIdcommentsinceuntil", "consumes": [ "application/json;v=2.0" ], "produces": [ "application/json;v=2.0" ], "parameters": [ { "name": "scanId", "in": "query", "description": "Unique Id of the specific scan", "required": true, "type": "string", "format": "uuid" }, { "name": "page", "in": "query", "description": "Page number", "required": false, "type": "integer", "format": "int32" }, { "name": "itemsPerPage", "in": "query", "description": "Amount of items returned by the request", "required": false, "type": "integer", "format": "int32" }, { "name": "libraryId", "in": "query", "description": "Filter by library Ids", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "stateId", "in": "query", "description": "Filter by state Ids", "required": false, "type": "array", "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi" }, { "name": "comment", "in": "query", "description": "Filter by a comment containing the text", "required": false, "type": "string" }, { "name": "since", "in": "query", "description": "Filter not erlier that the given unix-timestamp value", "required": false, "type": "integer", "format": "int64" }, { "name": "until", "in": "query", "description": "Filter not after the given unix-timestamp value", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.Osa.Application.DTOs.Responses.V2.VulnerabilityDto" } } } } } }, "/osa/libraries": { "get": { "tags": [ "OSA" ], "summary": "Returns all the used libraries for the specified scan Id", "operationId": "OsaLibraries_GetByscanIdpageitemsPerPage", "consumes": [ "application/json;v=3.0" ], "produces": [ "application/json;v=3.0" ], "parameters": [ { "name": "scanId", "in": "query", "description": "Unique Id of the specific scan", "required": true, "type": "string", "format": "uuid" }, { "name": "page", "in": "query", "description": "Page number (default 1)", "required": false, "type": "integer", "format": "int32" }, { "name": "itemsPerPage", "in": "query", "description": "Number of items per page (default 100)", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.Osa.Application.DTOs.Responses.V3.ScannedLibraryDTO" } } } } } }, "/sast/presets": { "get": { "tags": [ "SAST" ], "summary": "Get details of all presets", "operationId": "Presets_GetAllPresets", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/sast/presets/{id}": { "get": { "tags": [ "SAST" ], "summary": "Get details of specific preset", "operationId": "Presets_GetByid", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific preset", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/sast/engineConfigurations": { "get": { "tags": [ "SAST" ], "summary": "Gets engine configurations list", "operationId": "EngineConfigurations_Get", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.ScanSettings.Application.Dtos.EngineConfigurationDto" } } } } } }, "/sast/engineConfigurations/{id}": { "get": { "tags": [ "SAST" ], "summary": "Gets a specific engine configuration by id", "operationId": "EngineConfigurations_GetByid", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific Engine Configuration", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.Sast.ScanSettings.Application.Dtos.EngineConfigurationDto" } }, "400": { "description": "Not Found" } } } }, "/sast/scans/{scanId}/results/{pathId}/labels": { "get": { "tags": [ "SAST" ], "summary": "Get scan result labels fields", "operationId": "SastResultLabels_GetByscanIdpathId", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "scanId", "in": "path", "description": "Unique Id of a scan", "required": true, "type": "integer", "format": "int64" }, { "name": "pathId", "in": "path", "description": "Unique Id of the result path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Labels are changes made on the results' properties by the user. If no changes were made to the result's properties by the user - the state is \"null\"", "schema": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Models.ResultLabelGetModel" }, "examples": { "state": 0, "severity": 0, "userAssignment": "admin", "comment": "string" } } } }, "patch": { "tags": [ "SAST" ], "summary": "Update scan result labels fields", "operationId": "SastResultLabels_PatchLabelByscanIdpathIdresultData", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "scanId", "in": "path", "description": "Unique Id of a scan", "required": true, "type": "integer", "format": "int64" }, { "name": "pathId", "in": "path", "description": "Unique Id of the result path", "required": true, "type": "integer", "format": "int64" }, { "name": "resultData", "in": "body", "description": "Result label details", "required": true, "schema": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Models.ResultLabelPatchModel" } } ], "responses": { "200": { "description": "No Content", "schema": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Models.ResultLabelPatchModel" } } } } }, "/sast/scans/{id}/results/{pathId}/shortDescription": { "get": { "tags": [ "SAST" ], "summary": "Gets a scan result’s short vulnerability description", "operationId": "SastResultDescription_GetShortDescriptionByidpathId", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the scan", "required": true, "type": "integer", "format": "int64" }, { "name": "pathId", "in": "path", "description": "Unique Id of the result path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "No Content", "schema": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Models.GetResultShortDescriptionModel" } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/sast/projects/{id}/publisher/policyFindings/status": { "get": { "tags": [ "SAST" ], "summary": "Get the project status of the scan results publishing process", "operationId": "ScansPublisher_GetStatusByid", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific project", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.ScansPublisher.Presentation.DTOs.StatusDto" } } } } }, "/sast/results/attack-vectors": { "get": { "tags": [ "SAST" ], "summary": "Get the scan results for a specific query in Attack Vector format. This format includes all nodes.", "operationId": "SastResults_GetAttackVectorsByscanIdqueryVersion", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "scanId", "in": "query", "description": "Unique ID of a scan", "required": true, "type": "integer", "format": "int64" }, { "name": "queryVersion", "in": "query", "description": "Query version code", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Models.GetAttackVectorsModel" } } } } }, "/sast/results/attack-vectors-by-bfl": { "get": { "tags": [ "SAST" ], "summary": "Get the scan results for a specific query in Attack Vector format grouped by BFL (Best Fix Location node).", "operationId": "SastResults_GetAttackVectorsBFLByscanIdqueryVersion", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "scanId", "in": "query", "description": "Unique ID of a scan", "required": true, "type": "integer", "format": "int64" }, { "name": "queryVersion", "in": "query", "description": "Query version code", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Models.GetAttackVectorsByBFLModel" } } } } }, "/sast/project/{projectId}/scheduling": { "put": { "tags": [ "SAST" ], "summary": "Define the project's scans scheduling", "operationId": "ProjectScheduler_PutByprojectIdscansScheduling", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "type": "integer", "format": "int32" }, { "name": "scansScheduling", "in": "body", "description": "Scan scheduling details", "required": true, "schema": { "$ref": "#/definitions/Scheduler.Api.ViewModels.ProjectScansSchedulingViewModel" } } ], "responses": { "204": { "description": "NoContent", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } } }, "/sast/results/tickets": { "post": { "tags": [ "SAST" ], "summary": "Attach ticket id to scan results", "operationId": "SastResultTickets_SaveByresultsTicket", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "resultsTicket", "in": "body", "description": "Result ticket details", "required": true, "schema": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Dtos.SaveResultsTicketDto" } } ], "responses": { "204": { "description": "No Content", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } } }, "/sast/projects/{id}/publisher/policyFindings": { "post": { "tags": [ "SAST" ], "summary": "Publish project’s last scan results", "operationId": "ScansPublisher_PublishByid", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific project", "required": true, "type": "integer", "format": "int64" } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource" } } } } }, "/sast/results": { "get": { "tags": [ "SAST" ], "summary": "Gets scan results in paged mode.", "operationId": "SastResultsV5__GetPagedResultsByscanIdoffsetlimitLCIDseverity", "consumes": [ "application/json;v=5.2" ], "produces": [ "application/json;v=5.2" ], "parameters": [ { "name": "scanId", "in": "query", "description": "Unique ID of a scan", "required": true, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "Get records starting at (limit*offset)", "required": true, "type": "integer", "format": "int64" }, { "name": "limit", "in": "query", "description": "Number of results to return", "required": true, "type": "integer", "format": "int64" }, { "name": "LCID", "in": "query", "description": "Language Id", "required": false, "type": "integer", "format": "int32" }, { "name": "severity", "in": "query", "description": "Filter results per severity", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Checkmarx.DataTypes.ScanInfo" } } } }, "patch": { "tags": [ "SAST" ], "summary": "Update the Iast Correlation score between IAST and SAST scan results.", "operationId": "SastResults_UpdateResultsCorrelationByiastResultsCorrelationUpdateModels", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "iastResultsCorrelationUpdateModels", "in": "body", "description": "", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Models.IastResultsCorrelationUpdateModel" } } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "500": { "description": "Internal Server Error" } } } }, "/sast/scans/{id}": { "get": { "tags": [ "SAST" ], "summary": "Gets details of a specific Scan", "operationId": "SastScansV1__GetByid", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique ID of a specific scan", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.SastScansDtoV5" } } } }, "delete": { "tags": [ "SAST" ], "summary": "Delete a specific Scan", "operationId": "SastScans_DeleteByid", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique ID of a specific scan", "required": true, "type": "integer", "format": "int64" } ], "responses": { "202": { "description": "Accepted", "schema": { "type": "object" } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "SAST" ], "summary": "Creates or overrides comment of existing scan", "operationId": "SastScans_PatchByidupdatedScanDto", "consumes": [ "application/json;v=1.0" ], "produces": [ "application/json;v=1.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique ID of a scan the comment to add for", "required": true, "type": "integer", "format": "int64" }, { "name": "updatedScanDto", "in": "body", "description": "Comment's content", "required": true, "schema": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.SaveScanCommentDto" } } ], "responses": { "204": { "description": "No Content", "schema": { "type": "object" } } } } }, "/sast/dataRetention/{requestId}/status": { "get": { "tags": [ "SAST" ], "summary": "Gets details of a specific data retention request", "operationId": "DataRetentionV1_1__GetStatusByrequestId", "consumes": [ "application/json;v=1.1" ], "produces": [ "application/json;v=1.1" ], "parameters": [ { "name": "requestId", "in": "path", "description": "Request id returned by sast\\dataRetention\\byNumberOfScans or byDateRange", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/DataRetention.Presentation.Dto.DataRetentionRequestViewModel" }, "examples": { "id": 1, "stage": { "id": 8, "value": "Finished" }, "link": { "rel": "string", "uri": "string" } } } } } }, "/sast/scanSettings": { "get": { "tags": [ "SAST" ], "summary": "Gets the scan settings", "operationId": "ScanSettingsV1_1__GetByprojectId", "consumes": [ "application/json;v=1.1" ], "produces": [ "application/json;v=1.1" ], "parameters": [ { "name": "projectId", "in": "query", "description": "Unique Id of the specific Project", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.Sast.ScanSettings.Presentation.Dtos.ScanSettingsResponseDto" } }, "400": { "description": "Bad Request" } } }, "put": { "tags": [ "SAST" ], "summary": "Update the scan settings", "operationId": "ScanSettingsV_PutByscanSettings", "consumes": [ "application/json;v=4.0" ], "produces": [ "application/json;v=4.0" ], "parameters": [ { "name": "scanSettings", "in": "body", "description": "Scan settings details", "required": true, "schema": { "$ref": "#/definitions/Cx.Sast.ScanSettings.Presentation.Dtos.ScanSettingsRequestDtoV4" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource" } }, "400": { "description": "Bad Request" } } }, "post": { "tags": [ "SAST" ], "summary": "Define the scan settings", "operationId": "ScanSettingsV_PostByscanSettings", "consumes": [ "application/json;v=4.0" ], "produces": [ "application/json;v=4.0" ], "parameters": [ { "name": "scanSettings", "in": "body", "description": "Scan settings details", "required": true, "schema": { "$ref": "#/definitions/Cx.Sast.ScanSettings.Presentation.Dtos.ScanSettingsRequestDtoV4" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource" } }, "400": { "description": "Bad Request" } } } }, "/sast/dataRetention/stop": { "post": { "tags": [ "SAST" ], "summary": "Stops data retention execution", "operationId": "DataRetentionV1_1__Post", "consumes": [ "application/json;v=1.1" ], "produces": [ "application/json;v=1.1" ], "responses": { "202": { "description": "Accepted", "schema": { "type": "object" } } } } }, "/sast/dataRetention/byDateRange": { "post": { "tags": [ "SAST" ], "summary": "Starts data retention execution, by given date range", "operationId": "DataRetentionV1_1__PostBydataRetentionByDates", "consumes": [ "application/json;v=1.1" ], "produces": [ "application/json;v=1.1" ], "parameters": [ { "name": "dataRetentionByDates", "in": "body", "description": "Specify the data retention by dates range settings", "required": true, "schema": { "$ref": "#/definitions/DataRetention.Presentation.Dto.DataRetentionByDatesDto" } } ], "responses": { "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource" } } } } }, "/sast/dataRetention/byNumberOfScans": { "post": { "tags": [ "SAST" ], "summary": "Starts data retention execution, by given number of last successful scans", "operationId": "DataRetentionV1_1__PostBydataRetentionByNumberOfScans", "consumes": [ "application/json;v=1.1" ], "produces": [ "application/json;v=1.1" ], "parameters": [ { "name": "dataRetentionByNumberOfScans", "in": "body", "description": "Specify the data retention by number of last successful scans settings", "required": true, "schema": { "$ref": "#/definitions/DataRetention.Presentation.Dto.DataRetentionByAmountDto" } } ], "responses": { "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource" } } } } }, "/sast/scansQueue/{id}": { "get": { "tags": [ "SAST" ], "summary": "Gets details of a scan in queue", "operationId": "ScansQueue_GetScanQueueByid", "consumes": [ "application/json;v=1.2" ], "produces": [ "application/json;v=1.2" ], "parameters": [ { "name": "id", "in": "path", "description": "Filters the Scans Queue by an unique ID of a specific scan", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "", "schema": { "type": "object" }, "examples": { "id": 1, "stage": { "id": 7, "value": "Finished" }, "stageDetails": "Stage # 23 of 33", "stepDetails": "Stage # 23 of 33", "project": { "id": 1, "name": "LocalProject", "link": { "rel": "project", "uri": "/projects/2" } }, "engine": { "id": 1, "link": { "rel": "engine-server", "uri": "/sast/engineServers/1" } }, "languages": [ { "id": 2, "name": "Java" }, { "id": 8, "name": "JavaScript" } ], "teamId": "00000000-3333-1111-b111-989c9070eb11", "dateCreated": "2018-01-08T12:16:38.293", "queuedOn": "2018-01-08T12:16:55.587", "engineStartedOn": "2018-01-08T12:17:13.73", "completedOn": "2018-01-08T12:19:13.73", "loc": 2700, "isIncremental": false, "isPublic": true, "origin": "Web Portal", "originURL": "http://mydomain.com", "queuePosition": 1, "totalPercent": 2, "stagePercent": 31, "initiator": "userName" } } } }, "patch": { "tags": [ "SAST" ], "summary": "Update status of a scan in queue", "operationId": "ScansQueue_PatchScansQueueByidscanRequest", "consumes": [ "application/json;v=1.2" ], "produces": [ "application/json;v=1.2" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique ID of a specific scan in the queue", "required": true, "type": "integer", "format": "int64" }, { "name": "scanRequest", "in": "body", "description": "ScanRequest data that is needed to be updated, Status options: Canceled", "required": true, "schema": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.PatchScansQueue" } } ], "responses": { "200": { "description": "", "schema": { "type": "object" } } } } }, "/sast/scansQueue": { "get": { "tags": [ "SAST" ], "summary": "Gets scans in queue list", "operationId": "ScansQueue_GetScansQueueV1_2ByprojectId", "consumes": [ "application/json;v=1.2" ], "produces": [ "application/json;v=1.2" ], "parameters": [ { "name": "projectId", "in": "query", "description": "Filters the Scans Queue by an unique ID of a specific project", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.SastScanRequestV1_2DTO" } } } } } }, "/sast/project/{id}/queueSettings": { "put": { "tags": [ "SAST" ], "summary": "Update an existing project's queue settings", "operationId": "ProjectQueueSettings_PutByidprojectQueueSettings", "consumes": [ "application/json;v=2.1" ], "produces": [ "application/json;v=2.1" ], "parameters": [ { "name": "id", "in": "path", "description": "Project ID", "required": true, "type": "integer", "format": "int64" }, { "name": "projectQueueSettings", "in": "body", "description": "Specifies the project's scans behavior in the queue.\r\n
QueueKeepMode Options: KeepAll, KeepNew, KeepOld.

ScansType Options: All, OnlyIncremental, OnlyFull
\r\n Note: •\tThe automatic cancellation of parallel scans affects only public scans and the selected scan type (Full / Incremental / All).", "required": true, "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.ProjectQueueSettingsDto" } } ], "responses": { "204": { "description": "No Content", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } }, "post": { "tags": [ "SAST" ], "summary": "Set project's queue settings", "operationId": "ProjectQueueSettings_PostByidprojectQueueSettings", "consumes": [ "application/json;v=2.1" ], "produces": [ "application/json;v=2.1" ], "parameters": [ { "name": "id", "in": "path", "description": "Project ID", "required": true, "type": "integer", "format": "int64" }, { "name": "projectQueueSettings", "in": "body", "description": "Specifies the project's scans behavior in the queue.\r\n
QueueKeepMode Options: KeepAll, KeepNew, KeepOld.

ScansType Options: All, OnlyIncremental, OnlyFull
\r\n Note: •\tThe automatic cancellation of parallel scans affects only public scans and the selected scan type (Full / Incremental / All).", "required": true, "schema": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.ProjectQueueSettingsDto" } } ], "responses": { "204": { "description": "No Content", "schema": { "type": "object" } }, "400": { "description": "Bad Request" } } } }, "/sast/scans/{id}/parsedFiles": { "get": { "tags": [ "SAST" ], "summary": "Gets parsed files metrics of a scan", "operationId": "ScanMetrics_GetScanParsedFilesByid", "consumes": [ "application/json;v=3.0" ], "produces": [ "application/json;v=3.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific Scan", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ScanMetrics.Presentation.DTOs.Api.ScanParsedFilesDTO" } }, "400": { "description": "Bad Request" } } } }, "/sast/scans/{id}/failedQueries": { "get": { "tags": [ "SAST" ], "summary": "Gets failed queries metrics of a scan", "operationId": "ScanMetrics_GetScanFailedQueriesByid", "consumes": [ "application/json;v=3.0" ], "produces": [ "application/json;v=3.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific Scan", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ScanMetrics.Presentation.DTOs.Api.ScanFailedQueriesDTO" } }, "400": { "description": "Bad Request" } } } }, "/sast/scans/{id}/failedGeneralQueries": { "get": { "tags": [ "SAST" ], "summary": "Gets failed general queries metrics of a scan", "operationId": "ScanMetrics_GetScanFailedGeneralQueriesByid", "consumes": [ "application/json;v=3.0" ], "produces": [ "application/json;v=3.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific Scan", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ScanMetrics.Presentation.DTOs.Api.ScanFailedGeneralQueriesDTO" } }, "400": { "description": "Bad Request" } } } }, "/sast/scans/{id}/succeededGeneralQueries": { "get": { "tags": [ "SAST" ], "summary": "Gets succeeded general queries metrics of a scan", "operationId": "ScanMetrics_GetScanSucceededGeneralQueriesByid", "consumes": [ "application/json;v=3.0" ], "produces": [ "application/json;v=3.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific Scan", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ScanMetrics.Presentation.DTOs.Api.ScanSucceededGeneralQueriesDTO" } }, "400": { "description": "Bad Request" } } } }, "/sast/resultStates": { "get": { "tags": [ "SAST" ], "summary": "Gets details of all Result States", "operationId": "SastResultStates_Get", "consumes": [ "application/json;v=4.0" ], "produces": [ "application/json;v=4.0" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Dtos.ResultStateOutputDto" } }, "examples": [ { "id": 0, "names": [ { "languageId": 1033, "name": "To Verify", "isConstant": true }, { "languageId": 1034, "name": "Para verificar", "isConstant": true } ], "permission": "set-result-state-toverify" }, { "id": 1, "names": [ { "languageId": 1033, "name": "Not Exploitable", "isConstant": true }, { "languageId": 1034, "name": "No explotable", "isConstant": true } ], "permission": "set-result-state-notexploitable" } ] } } }, "post": { "tags": [ "SAST" ], "summary": "Creates a Result State", "operationId": "SastResultStates_PostByresultState", "consumes": [ "application/json;v=4.0" ], "produces": [ "application/json;v=4.0" ], "parameters": [ { "name": "resultState", "in": "body", "description": "Result State details", "required": true, "schema": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Dtos.ResultStatePostInputDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Dtos.PostResultStateOutputDto" }, "examples": { "id": 0 } }, "400": { "description": "Bad Request" } } } }, "/sast/scheduledJobs": { "get": { "tags": [ "SAST" ], "summary": "Get all scheduled jobs", "operationId": "ScheduledJobs_Get", "consumes": [ "application/json;v=4.0" ], "produces": [ "application/json;v=4.0" ], "responses": { "200": { "description": "Ok", "schema": { "type": "array", "items": { "$ref": "#/definitions/Scheduler.Api.Responses.ScheduledJobsResponse" } } }, "400": { "description": "Bad Request" } } } }, "/sast/scanSettings/{projectId}": { "get": { "tags": [ "SAST" ], "summary": "Gets the scan settings", "operationId": "ScanSettingsV_GetV4ByprojectId", "consumes": [ "application/json;v=4.0" ], "produces": [ "application/json;v=4.0" ], "parameters": [ { "name": "projectId", "in": "path", "description": "Unique Id of the specific Project", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.Sast.ScanSettings.Presentation.Dtos.ScanSettingsResponseDtoV4" } }, "400": { "description": "Bad Request" } } } }, "/sast/resultPathCommentsHistory": { "get": { "tags": [ "SAST" ], "summary": "Get comment and timestamp for result update", "operationId": "SastResultPathComment_GetByidpathIdcommentToDisplay", "consumes": [ "application/json;v=4.0" ], "produces": [ "application/json;v=4.0" ], "parameters": [ { "name": "id", "in": "query", "description": "Unique ID of a specific scan", "required": true, "type": "integer", "format": "int64" }, { "name": "pathId", "in": "query", "description": "Unique Id of the result path", "required": true, "type": "integer", "format": "int64" }, { "name": "commentToDisplay", "in": "query", "description": "Comment to display (All or latest) , default value is \"All\"", "required": true, "type": "string", "enum": [ "All", "Latest" ] } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Dtos.ResultPathCommentResponse" } }, "404": { "description": "Not Found" } } } }, "/sast/lockScan": { "put": { "tags": [ "SAST" ], "summary": "Update scan as locked", "operationId": "ScanActions_LockScanByid", "consumes": [ "application/json;v=4.0" ], "produces": [ "application/json;v=4.0" ], "parameters": [ { "name": "id", "in": "query", "description": "Unique ID of a specific scan", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } }, "400": { "description": "Bad Request" } } } }, "/sast/unLockScan": { "put": { "tags": [ "SAST" ], "summary": "Update scan as unLocked", "operationId": "ScanActions_UnLockScanByid", "consumes": [ "application/json;v=4.0" ], "produces": [ "application/json;v=4.0" ], "parameters": [ { "name": "id", "in": "query", "description": "Unique ID of a specific scan", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } }, "400": { "description": "Bad Request" } } } }, "/sast/resultStates/{id}": { "delete": { "tags": [ "SAST" ], "summary": "Sets a Result State to Deprecated status", "operationId": "SastResultStates_DeleteByid", "consumes": [ "application/json;v=4.0" ], "produces": [ "application/json;v=4.0" ], "parameters": [ { "name": "id", "in": "path", "description": "The Id of the Result State", "required": true, "type": "integer", "format": "int32" } ], "responses": { "202": { "description": "Accepted", "schema": { "type": "object" } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "SAST" ], "summary": "Updates a Result State", "operationId": "SastResultStates_PatchByidresultState", "consumes": [ "application/json;v=4.0" ], "produces": [ "application/json;v=4.0" ], "parameters": [ { "name": "id", "in": "path", "description": "The Id of the Result State", "required": true, "type": "integer", "format": "int32" }, { "name": "resultState", "in": "body", "description": "The Result State details", "required": true, "schema": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Dtos.ResultStatePatchInputDto" } } ], "responses": { "204": { "description": "No Content", "schema": { "type": "object" } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/sast/engineServers": { "get": { "tags": [ "SAST" ], "summary": "Gets details of all Engine Servers", "operationId": "EngineServers_GetV5", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerResponse5Dto" } }, "examples": [ { "id": 1, "name": "string", "uri": "string", "minLoc": 0, "maxLoc": 1, "maxScans": 1, "cxVersion": "string", "operatingSystem": "string", "status": { "id": 0, "value": "string" }, "link": { "rel": "string", "uri": "string" }, "offlineReasonCode": "Online", "offlineReasonMessage": "", "offlineReasonMessageParameters": "Comma-separated parameters in the context of the OfflineReasonMessage", "dedications": [ { "itemType": "Project", "itemId": "5", "itemName": "Project Name" } ] } ] } } }, "post": { "tags": [ "SAST" ], "summary": "Registers an Engine Server", "operationId": "EngineServers_PostV5ByengineServer", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "engineServer", "in": "body", "description": "Engine Server details", "required": true, "schema": { "$ref": "#/definitions/Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerV5DTO" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/Cx.Sast.EngineServers.Presentation.Dtos.CreateEngineServerDto" } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/sast/scans/{id}/logs": { "get": { "tags": [ "SAST" ], "summary": "Gets Scan logs.", "operationId": "SastScansV1__GetScanLogsByid", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/sast/engineServers/{id}": { "get": { "tags": [ "SAST" ], "summary": "Gets details of a specific Engine Server", "operationId": "EngineServers_GetV5Byid", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific Engine Server", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerResponse5Dto" }, "examples": { "id": 1, "name": "string", "uri": "string", "minLoc": 0, "maxLoc": 1, "maxScans": 1, "cxVersion": "string", "operatingSystem": "string", "status": { "id": 0, "value": "string" }, "link": { "rel": "string", "uri": "string" }, "offlineReasonCode": "Online", "offlineReasonMessage": "", "offlineReasonMessageParameters": "Comma-separated parameters in the context of the OfflineReasonMessage", "dedications": [ { "itemType": "Project", "itemId": "5", "itemName": "Project Name" } ] } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "SAST" ], "summary": "Updates an Engine Server", "operationId": "EngineServers_PutV5ByidengineServer", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific Engine Server", "required": true, "type": "integer", "format": "int64" }, { "name": "engineServer", "in": "body", "description": "Engine Server details", "required": true, "schema": { "$ref": "#/definitions/Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerV5DTO" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource" } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "SAST" ], "summary": "Unregisters an Engine Server", "operationId": "EngineServers_DeleteByid", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific Engine Server", "required": true, "type": "integer", "format": "int64" } ], "responses": { "204": { "description": "Deleted", "schema": { "type": "object" } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "SAST" ], "summary": "Updates an Engine Server by edit single field", "operationId": "EngineServers_PatchV5ByidengineServer", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific Engine Server", "required": true, "type": "integer", "format": "int64" }, { "name": "engineServer", "in": "body", "description": "Engine Server details", "required": true, "schema": { "$ref": "#/definitions/Cx.Sast.EngineServers.ApplicationContracts.Models.EngineServerPatchModelV5" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource" } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/sast/presetDetails/{id}": { "get": { "tags": [ "SAST" ], "summary": "Gets query information of specific preset", "operationId": "PresetsV_GetPresetDetailsByid", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific preset", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.QueryManagement.Application.DTOs.PresetsQueryInfoDTO" } } }, "404": { "description": "Not Found" } } } }, "/sast/scans/{id}/statistics": { "get": { "tags": [ "SAST" ], "summary": "Gets basic metrics of a scan", "operationId": "ScanMetricsV_GetScanStatisticsByid", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "id", "in": "path", "description": "Unique Id of the specific Scan", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ScanMetrics.Presentation.DTOs.Api.ScanStatisticsDTO2" } }, "400": { "description": "Bad Request" } } } }, "/sast/scans/{scanId}/actionResults/{pathId}/labels": { "get": { "tags": [ "SAST" ], "summary": "Get scan result labels action fields", "operationId": "SastResultLabelsAction_GetByscanIdpathId", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "scanId", "in": "path", "description": "Unique Id of a scan", "required": true, "type": "integer", "format": "int64" }, { "name": "pathId", "in": "path", "description": "Unique Id of the result path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Labels are changes made on the results' properties by the user.", "schema": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Models.ResultActionLabelModel" }, "examples": [ { "user": "tod-cyber", "comment": "Changed status to Urgent", "createdDate": "2026-05-10T10:33:52.0997638" }, { "user": "jim-developer", "comment": "Changed severity to Medium", "createdDate": "2026-05-10T10:33:52.0997638" } ] } } } }, "/sast/roles/auditTrail": { "get": { "tags": [ "SAST" ], "summary": "Gets Audit Trail for Roles", "operationId": "RolesAuditTrail_GetByfromDatetoDate", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "fromDate", "in": "query", "description": "From Date (Input Format: yyyy-mm-dd)", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "To Date (Input Format: yyyy-mm-dd)", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.RolesAuditTrailDto" } } }, "404": { "description": "Not Found" } } } }, "/sast/teams/auditTrail": { "get": { "tags": [ "SAST" ], "summary": "Gets Audit Trail for Teams", "operationId": "TeamsAuditTrail_GetByfromDatetoDate", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "fromDate", "in": "query", "description": "From Date (Input Format: yyyy-mm-dd)", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "To Date (Input Format: yyyy-mm-dd)", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.TeamsAuditTrailDto" } } }, "404": { "description": "Not Found" } } } }, "/sast/presets/auditTrail": { "get": { "tags": [ "SAST" ], "summary": "Gets Audit Trail for Presets", "operationId": "PresetsAuditTrail_GetPresetsAuditTrailByfromDatetoDate", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "fromDate", "in": "query", "description": "From Date (Input Format: yyyy-mm-dd)", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "To Date (Input Format: yyyy-mm-dd)", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.QueryManagement.Presentation.PresetAuditTrail.DTO.PresetsAuditTrailDTO" } } }, "404": { "description": "Not Found" } } } }, "/sast/scans": { "get": { "tags": [ "SAST" ], "summary": "Gets a collection of scans By Project", "operationId": "SastScansV1__GetScansBylastscanStatusprojectId", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "last", "in": "query", "description": "Amount of the latest scans", "required": false, "type": "integer", "format": "int32" }, { "name": "scanStatus", "in": "query", "description": "Specifies the scan stage", "required": false, "type": "string", "enum": [ "Scanning", "Finished", "Canceled", "Failed" ] }, { "name": "projectId", "in": "query", "description": "Unique ID of a specific project", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.SastScansDtoV1_2" } } } } }, "post": { "tags": [ "SAST" ], "summary": "Creates a new scan", "operationId": "SastScansV1__PostByscan", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "scan", "in": "body", "description": "Scan details", "required": true, "schema": { "$ref": "#/definitions/Cx.Sast.ScanExecution.ApplicationContracts.DTOs.SastScanRequestWriteDTO" } } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource" } }, "400": { "description": "Bad Request" } } } }, "/sast/results/auditTrail": { "get": { "tags": [ "SAST" ], "summary": "Gets Audit Trail for SAST Results", "operationId": "SastResultsAuditTrail_GetByupdateTypefromDatetoDate", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "updateType", "in": "query", "description": "Update Type (ALL, ASSIGN, RESULT_COMMENT, RESULT_SEVERITY, RESULT_STATE) , default value is \"ALL\"", "required": true, "type": "string", "enum": [ "ALL", "ASSIGN", "RESULT_COMMENT", "RESULT_SEVERITY", "RESULT_STATE" ] }, { "name": "fromDate", "in": "query", "description": "From Date (Input Format: yyyy-mm-dd)", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "description": "To Date (Input Format: yyyy-mm-dd)", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Dtos.SastResultsAuditTrailDto" } } }, "404": { "description": "Not Found" } } } }, "/sast/scanWithSettings": { "post": { "tags": [ "SAST" ], "summary": "Creates a new scan", "operationId": "ScanWithSettingsV_StartScanByscanSettingsExtRequestDto.projectIdscanSettingsExtRequestDto.overrideProjectSettingscanSettingsExtRequestDto.isIncrementalscanSettingsExtRequestDto.isPublicscanSettingsExtRequestDto.forceScanscanSettingsExtRequestDto.commentscanSettingsExtRequestDto.presetIdscanSettingsExtRequestDto.engineConfigurationIdscanSettingsExtRequestDto.customFieldsscanSettingsExtRequestDto.postScanActionIdscanSettingsExtRequestDto.runPostScanOnlyWhenNewResultsscanSettingsExtRequestDto.runPostScanMinSeverityscanSettingsExtRequestDto.postScanActionArguments", "consumes": [ "application/json;v=5.0" ], "produces": [ "application/json;v=5.0" ], "parameters": [ { "name": "projectId", "in": "formData", "description": "Specifies the Unique Id of the specific project to be scanned", "required": true, "type": "integer" }, { "name": "overrideProjectSetting", "in": "formData", "description": "Specifies whether to overwrite project settings to be the default for the next scans .If set to false or empty - do not overwrite project settings. If set to true - overwrite project settings", "required": false, "type": "boolean", "default": "false" }, { "name": "isIncremental", "in": "formData", "description": "Specifies whether the scan is incremental of full", "required": false, "type": "boolean", "default": "false" }, { "name": "isPublic", "in": "formData", "description": "Specifies whether the requested scan is public or private", "required": false, "type": "boolean", "default": "true" }, { "name": "forceScan", "in": "formData", "description": "Specifies whether the code should be scanned regardless of unchanged code", "required": false, "type": "boolean", "default": "true" }, { "name": "comment", "in": "formData", "description": "Specifies the scan comment", "required": false, "type": "string" }, { "name": "presetId", "in": "formData", "description": "Specify the preset id to use during the scan, 0 = use project's default", "required": false, "type": "integer" }, { "name": "engineConfigurationId", "in": "formData", "description": "Specify the engine-configuration to use during the scan, 0 = use project's default", "required": false, "type": "integer" }, { "name": "customFields", "in": "formData", "description": "Any custom fields used to tag the scan. Example: {\"key1\":\"val1\",\"key2\":\"val2\"}", "required": false, "type": "string" }, { "name": "postScanActionId", "in": "formData", "description": "Specify post action to be executed after scan is completed", "required": false, "type": "integer" }, { "name": "runPostScanOnlyWhenNewResults", "in": "formData", "description": "Specify if the configured post scan action will be executed only if new results are found, compared to the previous scan. Used in conjunction with PostScanActionId.", "required": false, "type": "boolean", "default": "false" }, { "name": "runPostScanMinSeverity", "in": "formData", "description": "Specify the minimal severity value when evaluating new results compared to the previous scan. Used in conjunction with RunPostScanOnlyWhenNewResults.", "required": false, "type": "integer", "default": "0" }, { "name": "postScanActionArguments", "in": "formData", "description": "Specify the additional arguments to add to the post scan action. Used in conjunction with PostScanActionId.", "required": false, "type": "string" }, { "name": "zippedSource", "in": "formData", "description": "source Zip", "required": false, "type": "file" } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource" } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } }, "/sast/scans/{id}/resultsStatistics": { "get": { "tags": [ "SAST" ], "summary": "Get the results statistics of a specific scan", "operationId": "SastScansV6__GetResultsStatisticsByid", "consumes": [ "application/json;v=6.0" ], "produces": [ "application/json;v=6.0" ], "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ResultsStatisticsDto2" } } } } }, "/sast/scans/{oldScanId}/compareSummaryTo/{newScanId}": { "get": { "tags": [ "SAST" ], "summary": "Gets compare results summary of two scans", "operationId": "SastScansV6__GetScanCompareSummaryByoldScanIdnewScanId", "consumes": [ "application/json;v=6.0" ], "produces": [ "application/json;v=6.0" ], "parameters": [ { "name": "oldScanId", "in": "path", "description": "Old scan id", "required": true, "type": "integer", "format": "int64" }, { "name": "newScanId", "in": "path", "description": "New scan id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ScanCompareSummaryDto2" } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } }, "/sast/scans/{oldScanId}/compareResultsTo/{newScanId}": { "get": { "tags": [ "SAST" ], "summary": "Gets compare results of two scans", "operationId": "SastScansV6__GetCompareScanResultsByoldScanIdnewScanIdIncludeQueriesData", "consumes": [ "application/json;v=6.0" ], "produces": [ "application/json;v=6.0" ], "parameters": [ { "name": "oldScanId", "in": "path", "description": "Old scan id", "required": true, "type": "integer", "format": "int64" }, { "name": "newScanId", "in": "path", "description": "New scan id", "required": true, "type": "integer", "format": "int64" }, { "name": "IncludeQueriesData", "in": "query", "description": "will include the query categories information, default value is \"false\"", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ExtendedScanCompareResultsDtoV6" } }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } } } } }, "definitions": { "Cx.CustomTasks.Presentation.Dtos.GetCustomTaskDto": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string" }, "data": { "type": "string" }, "link": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase" } } }, "Cx.SuperTypes.API.Dtos.LinkDtoBase": { "type": "object", "properties": { "rel": { "type": "string", "readOnly": true }, "uri": { "type": "string", "readOnly": true } } }, "Cx.IssueTrackingSystems.Presentation.Dtos.GetIssueTrackingSystemDto": { "type": "object", "properties": { "id": { "format": "int64", "description": "The specific Id of issue tracking system", "type": "integer", "readOnly": true }, "name": { "description": "The name of issue tracking system", "type": "string", "readOnly": true }, "type": { "description": "The type of issue tracking system (Jira)", "type": "string", "readOnly": true }, "url": { "description": "The URL of issue tracking system", "type": "string", "readOnly": true } } }, "Cx.ProjectManagement.Presentation.Dtos.PrecheckTeamDto": { "type": "object", "properties": { "id": { "format": "int32", "type": "integer" }, "name": { "type": "string" }, "fullName": { "type": "string" }, "parentId": { "format": "int32", "type": "integer" } } }, "Cx.CrossCutting.Configuration.DTOs.ComponentConfiguration": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" } } }, "Cx.CrossCutting.Configuration.Swagger.ComponentConfigurationUpdate": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "example": { "key": "MAXIMUM_CONCURRENT_SCAN_EXECUTERS", "value": "5" } }, "Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingSystemMetadata": { "type": "object", "properties": { "projects": { "type": "array", "items": { "$ref": "#/definitions/Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingProjectMetadata" }, "readOnly": true } } }, "Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingProjectMetadata": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "issueTypes": { "type": "array", "items": { "$ref": "#/definitions/Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingIssueTypeMetadata" }, "readOnly": true } } }, "Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingIssueTypeMetadata": { "type": "object", "properties": { "subtask": { "type": "boolean" }, "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "fields": { "type": "array", "items": { "$ref": "#/definitions/Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingFieldMetadata" }, "readOnly": true } } }, "Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingFieldMetadata": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "multiple": { "type": "boolean" }, "required": { "type": "boolean" }, "supported": { "type": "boolean" }, "allowedValues": { "type": "array", "items": { "$ref": "#/definitions/Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingFieldValue" } } } }, "Cx.IssueTrackingSystems.Application.Dtos.IssueTrackingFieldValue": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true } } }, "Cx.ProjectManagement.Presentation.Dtos.GetExcludeSettingsDto": { "type": "object", "properties": { "projectId": { "format": "int64", "type": "integer" }, "excludeFoldersPattern": { "type": "string" }, "excludeFilesPattern": { "type": "string" }, "link": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase" } } }, "Cx.ProjectManagement.Presentation.Dtos.ExcludeSettingsDto": { "type": "object", "properties": { "excludeFoldersPattern": { "type": "string" }, "excludeFilesPattern": { "type": "string" } } }, "Cx.ProjectManagement.Presentation.Dtos.GetTfsSourceSettingsDto": { "type": "object", "properties": { "uri": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.UriDto", "description": "Specifies the Uri of TFS repository", "readOnly": true }, "paths": { "description": "Specifies the list of paths to scan at TFS repository", "type": "array", "items": { "type": "string" }, "readOnly": true }, "link": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase", "description": "Link to the resource", "readOnly": true } } }, "Cx.ProjectManagement.Presentation.Dtos.UriDto": { "required": [ "absoluteUrl", "port" ], "type": "object", "properties": { "absoluteUrl": { "description": "Specifies the absolute url", "type": "string" }, "port": { "format": "int32", "description": "Specifies the port number of this Uri", "maximum": 65535, "minimum": 1, "type": "integer" } } }, "Cx.ProjectManagement.Presentation.Dtos.TfsSourceSettingsDto": { "required": [ "uri", "paths" ], "type": "object", "properties": { "credentials": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.CredentialsDto", "description": "Specifies credentials for password-based authentication against TFS repository" }, "uri": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.UriDto", "description": "Specifies the Uri of TFS repository" }, "paths": { "description": "Specifies the list of paths to scan at TFS repository", "type": "array", "items": { "type": "string" } } } }, "Cx.ProjectManagement.Presentation.Dtos.CredentialsDto": { "required": [ "userName", "password" ], "type": "object", "properties": { "userName": { "type": "string" }, "password": { "type": "string" } } }, "Cx.ProjectManagement.Presentation.Dtos.GetCustomSourceSettingsDto": { "type": "object", "properties": { "path": { "type": "string", "readOnly": true }, "pullingCommandId": { "format": "int64", "type": "integer", "readOnly": true }, "link": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase", "description": "Link to the resource", "readOnly": true } } }, "Cx.ProjectManagement.Presentation.Dtos.CustomSourceSettingsDto": { "required": [ "credentials" ], "type": "object", "properties": { "path": { "type": "string", "readOnly": true }, "preScanCommandId": { "format": "int64", "type": "integer", "readOnly": true }, "credentials": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.CredentialsDto" } } }, "Cx.ProjectManagement.Presentation.Dtos.GetSharedSourceSettingsDto": { "type": "object", "properties": { "paths": { "type": "array", "items": { "type": "string" }, "readOnly": true }, "link": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase", "description": "Link to the resource", "readOnly": true } } }, "Cx.ProjectManagement.Presentation.Dtos.SharedSourceSettingsDto": { "required": [ "paths", "credentials" ], "type": "object", "properties": { "paths": { "type": "array", "items": { "type": "string" } }, "credentials": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.CredentialsDto" } } }, "Cx.ProjectManagement.Presentation.Dtos.GetPerforceSourceSettingsDto": { "type": "object", "properties": { "uri": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.UriDto", "description": "Specifies the Uri of Perforce repository", "readOnly": true }, "paths": { "description": "Specifies the list of paths to scan at Perforce repository", "type": "array", "items": { "type": "string" }, "readOnly": true }, "browseMode": { "description": "Specifies the browse mode of Perforce repository", "type": "string", "readOnly": true }, "link": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase", "description": "Link to the resource", "readOnly": true } } }, "Cx.ProjectManagement.Presentation.Dtos.PerforceSourceSettingDto": { "required": [ "paths", "browseMode" ], "type": "object", "properties": { "credentials": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.CredentialsDto", "description": "Specifies credentials for password-based authentication against Perforce repository" }, "uri": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.UriDto", "description": "Specifies the Uri of Perforce repository" }, "paths": { "description": "Specifies the list of paths to scan at Perforce repository", "type": "array", "items": { "type": "string" } }, "browseMode": { "description": "Specifies the browse mode of Perforce repository", "type": "string" } } }, "Cx.Reports.SastScan.Presentation.Dtos.SastReportRequestDTO": { "required": [ "reportType", "scanId" ], "type": "object", "properties": { "reportType": { "type": "string" }, "scanId": { "format": "int64", "type": "integer" } } }, "Cx.Reports.SastScan.Presentation.Dtos.CreateReportResponseDto": { "type": "object", "properties": { "reportId": { "format": "int64", "type": "integer", "readOnly": true }, "links": { "$ref": "#/definitions/Cx.Reports.SastScan.Presentation.Dtos.ReportLinksDto", "readOnly": true } } }, "Cx.Reports.SastScan.Presentation.Dtos.ReportLinksDto": { "type": "object", "properties": { "report": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase", "readOnly": true }, "status": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase", "readOnly": true } } }, "Cx.ProjectManagement.Presentation.Dtos.BranchProjectDto": { "required": [ "name" ], "type": "object", "properties": { "name": { "description": "Specifies the name of the project", "type": "string" } } }, "Cx.SuperTypes.API.Dtos.LinkedResource": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase" } } }, "Cx.ProjectManagement.Presentation.Dtos.DataRetentionSettingsDto": { "type": "object", "properties": { "scansToKeep": { "format": "int32", "description": "The amount of scans to keep before they are deleted (set null back to default)", "type": "integer" } }, "example": { "scansToKeep": 10 } }, "Cx.ProjectManagement.Presentation.Dtos.JiraIssueTrackingSettingsDto": { "required": [ "jiraProjectId", "issueType" ], "type": "object", "properties": { "issueTrackingSystemId": { "format": "int64", "description": "The issue tracking system Id", "minimum": 1, "type": "integer" }, "jiraProjectId": { "description": "The specific Id of JIRA project", "type": "string" }, "issueType": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.JiraIssueType", "description": "The JIRA project's issue type" } }, "example": { "issueTrackingSystemId": 1, "jiraProjectId": "12901", "issueType": { "id": "123", "fields": [ { "id": "priority", "values": [ "1" ] }, { "id": "customfield_1", "values": [ "c1", "c2" ] } ] } } }, "Cx.ProjectManagement.Presentation.Dtos.JiraIssueType": { "required": [ "id" ], "type": "object", "properties": { "id": { "description": "Specifies the Id of issue type", "type": "string" }, "fields": { "description": "Specifies the list of fields associated with issue type", "type": "array", "items": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.JiraField" } } } }, "Cx.ProjectManagement.Presentation.Dtos.JiraField": { "required": [ "id" ], "type": "object", "properties": { "id": { "description": "Specifies the Id of field", "type": "string" }, "values": { "description": "Specifies the list of values or single value", "type": "array", "items": { "type": "string" } } } }, "Cx.CrossCutting.WebAPIHost.ValueObjects.VersionResponseV1_1": { "type": "object", "properties": { "version": { "type": "string" }, "hotFix": { "type": "string" }, "enginePackVersion": { "type": "string" } } }, "Cx.ProjectManagement.Presentation.Dtos.GetGitSourceSettingsDto": { "type": "object", "properties": { "url": { "description": "The URL which is used to connect to GIT repository", "type": "string", "readOnly": true }, "branch": { "description": "The branch of a GIT repository", "type": "string", "readOnly": true }, "useSsh": { "description": "Specified whether a connection to GIT repository uses SSH protocol", "type": "boolean", "readOnly": true }, "link": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase", "description": "Link to the resource", "readOnly": true } } }, "Cx.ProjectManagement.Presentation.Dtos.GitSourceSettingsDtoV1_3": { "required": [ "url", "branch" ], "type": "object", "properties": { "url": { "description": "The URL which is used to connect to GIT repository", "type": "string" }, "branch": { "description": "The branch of a GIT repository", "type": "string" }, "authentication": { "description": "The authentication method which is used to connect to a private GIT repository", "enum": [ "Undefined", "none", "credentials", "PAT", "ssh" ], "type": "string" }, "userName": { "description": "The user name which is used to connect to GIT repository", "type": "string" }, "password": { "description": "The user password which is used to connect to GIT repository", "type": "string" }, "pat": { "description": "The user password which is used to connect to GIT repository", "type": "string" }, "privateKey": { "description": "The private key which is used to connect to GIT repository using SSH protocol", "type": "string" } } }, "Cx.ProjectManagement.Presentation.Dtos.GitSourceSettingsBaseDto": { "required": [ "url", "branch" ], "type": "object", "properties": { "url": { "description": "The URL which is used to connect to GIT repository", "type": "string" }, "branch": { "description": "The branch of a GIT repository", "type": "string" } } }, "Cx.CrossCutting.WebAPIHost.ValueObjects.LicenseDetailsResponse": { "type": "object", "properties": { "expirationDate": { "type": "string" }, "maxLOC": { "type": "string" }, "hid": { "type": "string" }, "maxConcurrentScans": { "type": "string" }, "supportedLanguages": { "type": "array", "items": { "$ref": "#/definitions/Checkmarx.ExtDataTypes.SupportedLanguage" } }, "edition": { "type": "string" }, "isOsaEnabled": { "type": "boolean" }, "osaExpirationDate": { "type": "string" }, "currentUsers": { "format": "int32", "type": "integer" }, "maxUsers": { "format": "int32", "type": "integer" }, "maxAuditUsers": { "format": "int32", "type": "integer" }, "currentAuditUsers": { "format": "int32", "type": "integer" }, "projectsAllowed": { "format": "int64", "type": "integer" }, "currentProjectsCount": { "format": "int64", "type": "integer" } } }, "Checkmarx.ExtDataTypes.SupportedLanguage": { "type": "object", "properties": { "language": { "type": "string" }, "isSupported": { "type": "boolean" } } }, "Cx.ProjectManagement.Presentation.Dtos.ProjectBranchDto": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "originalProjectId": { "format": "int64", "type": "integer" }, "originalProjectName": { "type": "string" }, "branchedOnScanId": { "format": "int64", "type": "integer" }, "branchedProjectId": { "format": "int64", "type": "integer" }, "timestamp": { "format": "date-time", "type": "string" }, "comment": { "type": "string" }, "status": { "enum": [ "Started", "InProgress", "Completed", "Failed" ], "type": "string" }, "errorMessage": { "type": "string" } } }, "Cx.QueryManagement.Presentation.Queries.Responses.QueryVersionCodeResponse": { "type": "object", "properties": { "queryId": { "format": "int64", "type": "integer" }, "queryVersionCode": { "format": "int64", "type": "integer" } } }, "Cx.CustomFields.Api.ViewModels.CustomFieldViewModelV5": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "isMandatory": { "type": "boolean" } } }, "Cx.ProjectManagement.Presentation.Dtos.ProjectBaseDtoV5": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "teamId": { "format": "int32", "type": "integer" }, "name": { "type": "string" }, "isPublic": { "type": "boolean" }, "customFields": { "type": "array", "items": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.ProjectCustomFieldDto_V5" } }, "links": { "type": "array", "items": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase" } }, "owner": { "type": "string" }, "isDeprecated": { "type": "boolean" }, "projectQueueSettings": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.ProjectQueueSettingsDto" }, "isBranched": { "type": "boolean" }, "originalProjectId": { "type": "string" }, "branchedOnScanId": { "type": "string" }, "relatedProjects": { "type": "array", "items": { "format": "int64", "type": "integer" } } } }, "Cx.ProjectManagement.Presentation.Dtos.ProjectCustomFieldDto_V5": { "type": "object", "properties": { "isMandatory": { "type": "boolean" }, "projectId": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "value": { "type": "string" }, "name": { "type": "string" } } }, "Cx.ProjectManagement.Presentation.Dtos.ProjectQueueSettingsDto": { "type": "object", "properties": { "queueKeepMode": { "enum": [ "KeepAll", "KeepOld", "KeepNew" ], "type": "string" }, "scansType": { "enum": [ "All", "OnlyFull", "OnlyIncremental" ], "type": "string" }, "includeScansInProcess": { "type": "boolean" }, "identicalCodeOnly": { "type": "boolean" } }, "example": { "queueKeepMode": "KeepAll", "scansType": "OnlyFull", "includeScansInProcess": false, "identicalCodeOnly": false } }, "Cx.ProjectManagement.Presentation.Dtos.UpdateFullProjectDto": { "required": [ "name", "owningTeam", "customFields" ], "type": "object", "properties": { "name": { "description": "Specifies the name of the project", "type": "string" }, "owningTeam": { "format": "int32", "description": "Specifies the team id which owns the project", "type": "integer" }, "customFields": { "description": "Specifies the custom fields in a project", "type": "array", "items": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.UpdateCustomFieldDto" } } } }, "Cx.ProjectManagement.Presentation.Dtos.UpdateCustomFieldDto": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "value": { "type": "string" } } }, "Cx.ProjectManagement.Presentation.Dtos.UpdateProjectDto": { "type": "object", "properties": { "name": { "description": "Specifies the name of the project", "type": "string" }, "owningTeam": { "format": "int32", "description": "Specifies the team id which owns the project", "type": "integer" } }, "example": { "name": "SomeProject", "owningTeam": 12345678 } }, "Cx.ProjectManagement.Presentation.Dtos.DeleteProjectDto": { "type": "object", "properties": { "deleteRunningScans": { "description": "Specifies whether the running scans must be deleted", "type": "boolean" } }, "example": { "deleteRunningScans": true } }, "Cx.ProjectManagement.Presentation.Dtos.GetPathFilterDto": { "type": "object", "properties": { "projectId": { "format": "int64", "type": "integer" }, "pathFilter": { "type": "string" }, "link": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase" } } }, "Cx.ProjectManagement.Presentation.Dtos.PathFilterDto": { "type": "object", "properties": { "pathFilter": { "type": "string" } } }, "Cx.ProjectManagement.Presentation.Dtos.ProjectIncementalScanValidityStatusDto": { "type": "object", "properties": { "validForIncrementalScan": { "type": "boolean" }, "consecutiveIncrementalScansLimitReached": { "type": "boolean" }, "enginePackUpgradedSinceLastFullScan": { "type": "boolean" }, "maxConsecutiveIncrementalScans": { "format": "int32", "type": "integer" }, "incrementalScansSinceLastFullScan": { "format": "int32", "type": "integer" }, "lastFullScanDate": { "format": "date-time", "type": "string" }, "enginePackUpgradeDate": { "format": "date-time", "type": "string" } } }, "Cx.CrossCutting.Configuration.DTOs.UserPersistenceDto": { "required": [ "key", "value" ], "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "Cx.ProjectManagement.Presentation.Dtos.SaveProjectDto": { "required": [ "owningTeam", "isPublic" ], "type": "object", "properties": { "name": { "description": "Specifies the name of the project", "type": "string" }, "owningTeam": { "description": "Specifies the team id which owns the project", "type": "string" }, "isPublic": { "description": "Specifies whether the project public or not", "type": "boolean" } }, "example": { "name": "SomeProject", "owningTeam": "1", "isPublic": true } }, "System.Net.Http.ByteArrayContent": { "type": "object", "properties": { "headers": { "type": "array", "items": { "$ref": "#/definitions/System.Collections.Generic.KeyValuePair[System.String,System.Collections.Generic.IEnumerable[System.String]]" }, "readOnly": true } } }, "System.Collections.Generic.KeyValuePair[System.String,System.Collections.Generic.IEnumerable[System.String]]": { "type": "object", "properties": { "key": { "type": "string", "readOnly": true }, "value": { "type": "array", "items": { "type": "string" }, "readOnly": true } } }, "Cx.Osa.Application.DTOs.OsaLicenseDto": { "type": "object", "properties": { "id": { "description": "The Id of the open source license", "type": "string", "readOnly": true }, "name": { "description": "License name", "type": "string", "readOnly": true }, "riskLevel": { "description": "License risk level (Low, Medium, High, Unknown)", "type": "string", "readOnly": true }, "copyrightRiskScore": { "format": "int32", "description": "The risk of infringing the license copyrights", "type": "integer", "readOnly": true }, "patentRiskScore": { "format": "int32", "description": "The risk of infringing patents", "type": "integer", "readOnly": true }, "copyLeft": { "description": "Status of copy-left licensing", "type": "string", "readOnly": true }, "linking": { "description": "The influent of the license on linked code", "type": "string", "readOnly": true }, "royalityFree": { "description": "Whether or not this license is royality-free", "type": "string", "readOnly": true }, "referenceType": { "description": "License description url", "type": "string", "readOnly": true }, "reference": { "type": "string", "readOnly": true }, "url": { "type": "string", "readOnly": true } } }, "Cx.Osa.Application.DTOs.Responses.VulnerabilityCommentDto": { "type": "object", "properties": { "userName": { "type": "string", "readOnly": true }, "timeStamp": { "format": "int64", "type": "integer", "readOnly": true }, "content": { "type": "string", "readOnly": true } } }, "Cx.Osa.Application.DTOs.Responses.ScanDtoV2": { "type": "object", "properties": { "findingsStatus": { "type": "string" }, "id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "startAnalyzeTime": { "format": "date-time", "type": "string" }, "endAnalyzeTime": { "format": "date-time", "type": "string" }, "origin": { "type": "string" }, "sourceCodeOrigin": { "type": "string" }, "state": { "$ref": "#/definitions/Cx.Osa.Application.DTOs.StateDTO" }, "sharedSourceLocationPaths": { "type": "array", "items": { "type": "string" } } } }, "Cx.Osa.Application.DTOs.StateDTO": { "type": "object", "properties": { "id": { "format": "int32", "type": "integer" }, "name": { "type": "string" }, "failureReason": { "type": "string" } } }, "Cx.Osa.Presentation.DTOs.NewDTOs.ScanRequestInfo": { "description": "Scan request details", "type": "object", "properties": { "projectId": { "format": "int64", "description": "The Project Id associated with requested scan", "minimum": 1, "type": "integer" }, "origin": { "description": "The location from which scan was requested (if not specified (Portal) will be selected)", "type": "string" }, "hashedFilesList": { "type": "array", "items": { "$ref": "#/definitions/Cx.Osa.Presentation.DTOs.NewDTOs.HashedFileDTO" } } } }, "Cx.Osa.Presentation.DTOs.NewDTOs.HashedFileDTO": { "type": "object", "properties": { "sha1": { "type": "string" }, "filename": { "type": "string" } } }, "Cx.Osa.Presentation.DTOs.NewDTOs.NewScanResponseDTO": { "required": [ "scanId" ], "type": "object", "properties": { "scanId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "Cx.Osa.Application.DTOs.Responses.V2.VulnerabilityDto": { "type": "object", "properties": { "id": { "type": "string" }, "cveName": { "type": "string" }, "score": { "format": "float", "type": "number" }, "severity": { "$ref": "#/definitions/Cx.Osa.Application.DTOs.SeverityDTO" }, "publishDate": { "format": "date-time", "type": "string" }, "url": { "type": "string" }, "description": { "type": "string" }, "recommendations": { "type": "string" }, "sourceFileName": { "type": "string" }, "libraryId": { "type": "string" }, "state": { "$ref": "#/definitions/Cx.Osa.Application.DTOs.Responses.VulnerabilityStateDto" }, "commentsAmount": { "format": "int32", "type": "integer" }, "similarityId": { "type": "string" }, "fixUrl": { "type": "string" } } }, "Cx.Osa.Application.DTOs.SeverityDTO": { "type": "object", "properties": { "id": { "format": "int32", "type": "integer" }, "name": { "type": "string" } } }, "Cx.Osa.Application.DTOs.Responses.VulnerabilityStateDto": { "type": "object", "properties": { "id": { "format": "int32", "type": "integer", "readOnly": true }, "actionType": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true } } }, "Cx.Osa.Application.DTOs.Responses.V3.ScannedLibraryDTO": { "description": "Library DTO", "type": "object", "properties": { "id": { "description": "Library ID", "type": "string" }, "name": { "description": "Library Name", "type": "string" }, "version": { "description": "Library Version", "type": "string" }, "releaseDate": { "format": "date-time", "description": "Library Release date of the current version", "type": "string" }, "highUniqueVulnerabilityCount": { "format": "int32", "description": "Number of high vulnerabilities", "type": "integer" }, "mediumUniqueVulnerabilityCount": { "format": "int32", "description": "Number of medium vulnerabilities", "type": "integer" }, "lowUniqueVulnerabilityCount": { "format": "int32", "description": "Number of low vulnerabilities", "type": "integer" }, "notExploitableVulnerabilityCount": { "format": "int32", "description": "Number of not exploitable vulnerabilities", "type": "integer" }, "newestVersion": { "description": "Newest version (if no newest version exists, then this field will remain empty)", "type": "string" }, "newestVersionReleaseDate": { "format": "date-time", "description": "Release date of newest version (if no newest version exists, then this field will contain 1970/1/1)", "type": "string" }, "numberOfVersionsSinceLastUpdate": { "format": "int32", "description": "Number of newer versions (if no newest version exists, then this field will be 0)", "type": "integer" }, "confidenceLevel": { "format": "int32", "description": "The confidence level about the provided result", "type": "integer" }, "matchType": { "$ref": "#/definitions/Cx.Osa.Application.DTOs.MatchTypeDto", "description": "The method which was used to match the library: Exact Match / Filename Match" }, "licenses": { "description": "Collection of legal licenses id", "type": "array", "items": { "type": "string" } }, "outdated": { "description": "Indicate whether this library outdated", "type": "boolean" }, "severity": { "$ref": "#/definitions/Cx.Osa.Application.DTOs.SeverityDTO", "description": "Library severity based on highest vulnerability severity" }, "riskScore": { "format": "double", "description": "Library risk score based on highest vulnerability risk score", "type": "number" }, "locations": { "description": "Library locations and their match-type", "type": "array", "items": { "$ref": "#/definitions/Cx.Osa.Application.DTOs.Responses.LibraryLocationDto" } }, "codeUsageStatus": { "type": "string" }, "codeReferenceCount": { "format": "int64", "type": "integer" }, "packageRepository": { "type": "string" } } }, "Cx.Osa.Application.DTOs.MatchTypeDto": { "type": "object", "properties": { "id": { "format": "int32", "type": "integer", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "description": { "type": "string", "readOnly": true } } }, "Cx.Osa.Application.DTOs.Responses.LibraryLocationDto": { "type": "object", "properties": { "path": { "type": "string", "readOnly": true }, "matchType": { "$ref": "#/definitions/Cx.Osa.Application.DTOs.MatchTypeDto", "readOnly": true } } }, "Cx.Sast.ScanSettings.Application.Dtos.EngineConfigurationDto": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer", "readOnly": true }, "name": { "type": "string", "readOnly": true } } }, "Cx.Sast.Results.Presentation.Models.ResultLabelGetModel": { "description": "Labels are changes made on the results' properties by the user. If no changes were made to the result's properties by the user - the state is \"null\"", "type": "object", "properties": { "state": { "format": "int32", "type": "integer" }, "severity": { "format": "int32", "type": "integer" }, "userAssignment": { "type": "string" }, "comment": { "type": "string" } } }, "Cx.Sast.Results.Presentation.Models.ResultLabelPatchModel": { "type": "object", "properties": { "state": { "format": "int32", "type": "integer" }, "severity": { "format": "int32", "type": "integer" }, "userAssignment": { "type": "string" }, "comment": { "type": "string" } } }, "Cx.Sast.Results.Presentation.Models.GetResultShortDescriptionModel": { "type": "object", "properties": { "shortDescription": { "type": "string" } } }, "Cx.ScansPublisher.Presentation.DTOs.StatusDto": { "type": "object", "properties": { "project": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource" }, "scan": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource" }, "status": { "type": "string" }, "lastSync": { "format": "date-time", "type": "string" } } }, "Cx.Sast.Results.Presentation.Models.GetAttackVectorsModel": { "type": "object", "properties": { "attackVectors": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Dtos.AttackVectorDto" }, "readOnly": true } } }, "Cx.Sast.Results.Presentation.Dtos.AttackVectorDto": { "type": "object", "properties": { "resultId": { "type": "string" }, "bestFixLocationNode": { "format": "int64", "type": "integer" }, "nodes": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Dtos.NodeDto" } } } }, "Cx.Sast.Results.Presentation.Dtos.NodeDto": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "order": { "format": "int64", "type": "integer" }, "shortName": { "type": "string" }, "fullName": { "type": "string" }, "fileName": { "type": "string" }, "folder": { "type": "string" }, "line": { "format": "int32", "type": "integer" }, "column": { "format": "int32", "type": "integer" }, "length": { "format": "int32", "type": "integer" }, "methodLine": { "format": "int32", "type": "integer" }, "sourceUrl": { "type": "string" } } }, "Cx.Sast.Results.Presentation.Models.GetAttackVectorsByBFLModel": { "type": "object", "properties": { "attackVectorsByBFL": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Dtos.AttackVectorBFLDto" }, "readOnly": true } } }, "Cx.Sast.Results.Presentation.Dtos.AttackVectorBFLDto": { "type": "object", "properties": { "scanId": { "format": "int64", "type": "integer" }, "queryVersion": { "format": "int64", "type": "integer" }, "bestFixLocationNode": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Dtos.NodeDto" }, "attackVectors": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Dtos.AttackVectorDto" } } } }, "Scheduler.Api.ViewModels.ProjectScansSchedulingViewModel": { "type": "object", "properties": { "scheduleType": { "description": "The Schedule type.\r\nAllowed values are: \"None\", \"Weekly\".", "type": "string" }, "scheduledDays": { "description": "The Schedule days, relevant just in case ScheduleType is \"Weekly\".type, allowed values are: \"None\", \"Weekly\".\r\nAllowed Values: \"Sunday\",\"Monday\",\"Tuesday\",\"Wednesday\",\"Thursday\",\"Friday\",\"Saturday\".", "type": "array", "items": { "type": "string" } }, "scheduleTime": { "description": "The Schedule time in each scheduled days format {HH:MM}.", "type": "string" } } }, "Cx.Sast.Results.Presentation.Dtos.SaveResultsTicketDto": { "required": [ "resultsId", "ticketId" ], "type": "object", "properties": { "resultsId": { "type": "array", "items": { "type": "string" } }, "ticketId": { "type": "string" } } }, "Cx.Sast.Results.Presentation.Models.IastResultsCorrelationUpdateModel": { "type": "object", "properties": { "scanId": { "format": "int64", "type": "integer" }, "pathId": { "format": "int64", "type": "integer" }, "iastCorrelationScore": { "format": "double", "type": "number" } } }, "Checkmarx.DataTypes.ScanInfo": { "type": "object", "properties": { "scanId": { "format": "int64", "type": "integer" }, "offset": { "format": "int64", "type": "integer" }, "limit": { "format": "int64", "type": "integer" }, "totalCount": { "format": "int64", "type": "integer" }, "results": { "type": "array", "items": { "$ref": "#/definitions/Checkmarx.DataTypes.ResultInfo" } } } }, "Checkmarx.DataTypes.ResultInfo": { "type": "object", "properties": { "index": { "format": "int64", "type": "integer" }, "pathId": { "format": "int64", "type": "integer" }, "similarityHash": { "format": "int64", "type": "integer" }, "date": { "format": "date-time", "type": "string" }, "detectionDate": { "format": "date-time", "type": "string" }, "confidenceLevel": { "format": "int32", "type": "integer" }, "cxRank": { "format": "double", "type": "number" }, "bflNodeShortName": { "type": "string" }, "bflNodeId": { "format": "int64", "type": "integer" }, "severity": { "format": "int32", "type": "integer" }, "state": { "format": "int32", "type": "integer" }, "status": { "format": "int32", "type": "integer" }, "assignedToUserId": { "format": "int32", "type": "integer" }, "assignedTo": { "type": "string" }, "comment": { "type": "string" }, "deepLink": { "type": "string" }, "query": { "$ref": "#/definitions/Checkmarx.DataTypes.QueryInfo" }, "sourceSnippet": { "$ref": "#/definitions/Checkmarx.DataTypes.SnippetInfo" }, "sinkSnippet": { "$ref": "#/definitions/Checkmarx.DataTypes.SnippetInfo" }, "nodes": { "type": "array", "items": { "$ref": "#/definitions/Checkmarx.DataTypes.NodeInfo" } }, "lcid": { "format": "int32", "type": "integer" }, "cxDescriptionID": { "format": "int32", "type": "integer" }, "resultDescription": { "type": "string" }, "bestFixLocation": { "type": "string", "readOnly": true }, "risk": { "type": "string", "readOnly": true }, "cause": { "type": "string", "readOnly": true }, "generalRecommendations": { "type": "string", "readOnly": true } } }, "Checkmarx.DataTypes.QueryInfo": { "type": "object", "properties": { "queryVersionId": { "format": "int64", "type": "integer" }, "queryId": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "severity": { "format": "int32", "type": "integer" }, "categories": { "type": "string" }, "cwe": { "format": "int64", "type": "integer" } } }, "Checkmarx.DataTypes.SnippetInfo": { "type": "object", "properties": { "fileName": { "type": "string" }, "line": { "format": "int64", "type": "integer" }, "code": { "type": "string" } } }, "Checkmarx.DataTypes.NodeInfo": { "type": "object", "properties": { "nodeId": { "format": "int64", "type": "integer" }, "fullName": { "type": "string" }, "shortName": { "type": "string" }, "fileName": { "type": "string" }, "line": { "format": "int32", "type": "integer" }, "column": { "format": "int32", "type": "integer" }, "length": { "format": "int32", "type": "integer" }, "remarks": { "type": "string" }, "methodLine": { "format": "int64", "type": "integer" } } }, "Cx.Sast.ScanExecution.Presentation.Dtos.SaveScanCommentDto": { "required": [ "comment" ], "type": "object", "properties": { "comment": { "description": "Specifies the scan comment", "type": "string" } }, "example": { "comment": "Some comment" } }, "Cx.Sast.ScanExecution.Presentation.Dtos.SastScansDtoV5": { "type": "object", "properties": { "scanId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "id": { "format": "int64", "type": "integer" }, "project": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ProjectDto" }, "status": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ScanStatusDto" }, "scanType": { "enum": [ "Unknown", "AllScans", "Regular", "Subset", "Partial", "Running" ], "type": "string" }, "comment": { "type": "string" }, "dateAndTime": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.DateAndTimeDto" }, "resultsStatistics": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ResultsStatisticsLink" }, "scanState": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ScanStateDto" }, "owner": { "type": "string" }, "origin": { "type": "string" }, "originURL": { "type": "string" }, "initiatorName": { "type": "string" }, "owningTeamId": { "format": "int32", "type": "integer" }, "isPublic": { "type": "boolean" }, "isLocked": { "type": "boolean" }, "isIncremental": { "type": "boolean" }, "scanRisk": { "format": "int64", "type": "integer" }, "scanRiskSeverity": { "format": "int64", "type": "integer" }, "engineServer": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.EngineServerDto" }, "finishedScanStatus": { "enum": [ "None", "Completed", "Partial" ], "type": "string" }, "partialScanReasons": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Domain.Entities.PartialScanDTO" } }, "customFields": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Cx.Sast.ScanExecution.Presentation.Dtos.ProjectDto": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "link": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase" } } }, "Cx.Sast.ScanExecution.Presentation.Dtos.ScanStatusDto": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "details": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ScanStatusDetailsDto", "readOnly": true } } }, "Cx.Sast.ScanExecution.Presentation.Dtos.DateAndTimeDto": { "type": "object", "properties": { "startedOn": { "format": "date-time", "type": "string", "readOnly": true }, "finishedOn": { "format": "date-time", "type": "string", "readOnly": true }, "engineStartedOn": { "format": "date-time", "type": "string", "readOnly": true }, "engineFinishedOn": { "format": "date-time", "type": "string", "readOnly": true } } }, "Cx.Sast.ScanExecution.Presentation.Dtos.ResultsStatisticsLink": { "type": "object", "properties": { "link": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase" } } }, "Cx.Sast.ScanExecution.Presentation.Dtos.ScanStateDto": { "type": "object", "properties": { "path": { "type": "string" }, "sourceId": { "type": "string" }, "filesCount": { "format": "int64", "type": "integer" }, "linesOfCode": { "format": "int64", "type": "integer" }, "failedLinesOfCode": { "format": "int64", "type": "integer" }, "cxVersion": { "type": "string" }, "languageStateCollection": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Domain.Entities.QueryLanguageState" } } } }, "Cx.Sast.ScanExecution.Presentation.Dtos.EngineServerDto": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "link": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase" } } }, "Cx.Sast.ScanExecution.Domain.Entities.PartialScanDTO": { "type": "object", "properties": { "abortedMessage": { "type": "string" }, "abortedStatus": { "enum": [ "None", "Queries", "Stages", "QueriesExceededResultThreshold" ], "type": "string" } } }, "Cx.Sast.ScanExecution.Presentation.Dtos.ScanStatusDetailsDto": { "type": "object", "properties": { "stage": { "type": "string", "readOnly": true }, "step": { "type": "string", "readOnly": true } } }, "Cx.Sast.ScanExecution.Domain.Entities.QueryLanguageState": { "type": "object", "properties": { "languageID": { "format": "int32", "type": "integer" }, "languageName": { "type": "string" }, "languageHash": { "type": "string" }, "stateCreationDate": { "format": "date-time", "type": "string" } } }, "DataRetention.Presentation.Dto.DataRetentionRequestViewModel": { "type": "object", "properties": { "id": { "format": "int32", "type": "integer", "readOnly": true }, "stage": { "enum": [ "New", "Processing", "DeletingZombies", "DeletingDeprecatedScans", "DeletingRetentionScans", "Stopping", "Stopped", "Failed", "Finished" ], "type": "string", "readOnly": true }, "link": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase", "readOnly": true } } }, "Cx.Sast.ScanSettings.Presentation.Dtos.ScanSettingsResponseDto": { "type": "object", "properties": { "project": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource", "readOnly": true }, "preset": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource", "readOnly": true }, "engineConfiguration": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource", "readOnly": true }, "postScanAction": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource", "readOnly": true }, "emailNotifications": { "$ref": "#/definitions/Cx.Sast.ScanSettings.Presentation.Dtos.EmailNotificationsDto", "readOnly": true } } }, "Cx.Sast.ScanSettings.Presentation.Dtos.EmailNotificationsDto": { "type": "object", "properties": { "failedScan": { "type": "array", "items": { "type": "string" } }, "beforeScan": { "type": "array", "items": { "type": "string" } }, "afterScan": { "type": "array", "items": { "type": "string" } } } }, "Cx.Sast.ScanSettings.Presentation.Dtos.ScanSettingsRequestDtoV4": { "required": [ "projectId", "presetId", "engineConfigurationId" ], "type": "object", "properties": { "projectId": { "format": "int64", "minimum": 1, "type": "integer" }, "presetId": { "format": "int64", "minimum": 1, "type": "integer" }, "engineConfigurationId": { "format": "int64", "minimum": 1, "type": "integer" }, "postScanActionId": { "format": "int64", "minimum": 1, "type": "integer" }, "emailNotifications": { "$ref": "#/definitions/Cx.Sast.ScanSettings.Presentation.Dtos.EmailNotificationsDto" }, "postScanActionConditions": { "$ref": "#/definitions/Cx.Sast.ScanSettings.Presentation.Dtos.PostScanActionConditionsDto" }, "postScanActionArguments": { "type": "string" } } }, "Cx.Sast.ScanSettings.Presentation.Dtos.PostScanActionConditionsDto": { "type": "object", "properties": { "runOnlyWhenNewResults": { "type": "boolean" }, "runOnlyWhenNewResultsMinSeverity": { "format": "int32", "maximum": 3, "minimum": 0, "type": "integer" } } }, "DataRetention.Presentation.Dto.DataRetentionByDatesDto": { "required": [ "startDate", "endDate" ], "type": "object", "properties": { "startDate": { "format": "date", "type": "string" }, "endDate": { "format": "date", "type": "string" }, "durationLimitInHours": { "format": "int64", "type": "integer" } } }, "DataRetention.Presentation.Dto.DataRetentionByAmountDto": { "required": [ "numOfSuccessfulScansToPreserve" ], "type": "object", "properties": { "numOfSuccessfulScansToPreserve": { "format": "int32", "type": "integer" }, "durationLimitInHours": { "format": "int64", "type": "integer" } } }, "Cx.Sast.ScanExecution.Presentation.Dtos.PatchScansQueue": { "required": [ "status" ], "type": "object", "properties": { "status": { "enum": [ "Empty", "Canceled", "Postponed" ], "type": "string" } }, "example": { "status": "Canceled" } }, "Cx.Sast.ScanExecution.Presentation.Dtos.SastScanRequestV1_2DTO": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "stage": { "enum": [ "New", "PreScan", "Queued", "Scanning", "PostScan", "Finished", "Canceled", "Failed", "SourcePullingAndDeployment", "None" ], "type": "string" }, "teamId": { "type": "string" }, "project": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.SastProjectV01DTO" }, "engineId": { "format": "int64", "type": "integer" }, "loc": { "format": "int32", "type": "integer" }, "languages": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Domain.ValueObjects.ProgramLanguage" } }, "dateCreated": { "format": "date-time", "type": "string" }, "queuedOn": { "format": "date-time", "type": "string" }, "engineStartedOn": { "format": "date-time", "type": "string" }, "engineFinishedOn": { "format": "date-time", "type": "string" }, "isIncremental": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "origin": { "type": "string" } } }, "Cx.Sast.ScanExecution.Presentation.Dtos.SastProjectV01DTO": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer", "readOnly": true }, "name": { "type": "string", "readOnly": true } } }, "Cx.Sast.ScanExecution.Domain.ValueObjects.ProgramLanguage": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" } } }, "ScanMetrics.Presentation.DTOs.Api.ScanParsedFilesDTO": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "scannedFilesPerLanguage": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ScanMetrics.Domain.Entities.ScanParsedFiles" } } } }, "ScanMetrics.Domain.Entities.ScanParsedFiles": { "type": "object", "properties": { "parsedSuccessfully": { "type": "string" }, "parsedUnsuccessfully": { "type": "string" }, "parsedPartially": { "type": "string" } } }, "ScanMetrics.Presentation.DTOs.Api.ScanFailedQueriesDTO": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "failedQueries": { "type": "array", "items": { "type": "string" } } } }, "ScanMetrics.Presentation.DTOs.Api.ScanFailedGeneralQueriesDTO": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "failedGeneralQueries": { "type": "array", "items": { "type": "string" } } } }, "ScanMetrics.Presentation.DTOs.Api.ScanSucceededGeneralQueriesDTO": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "generalQueriesResultCount": { "type": "object", "additionalProperties": { "format": "int32", "type": "integer" } } } }, "Cx.Sast.Results.Presentation.Dtos.ResultStateOutputDto": { "required": [ "id", "names", "permission" ], "type": "object", "properties": { "id": { "format": "int32", "type": "integer" }, "names": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Dtos.TranslationOutputDto" } }, "permission": { "type": "string" } } }, "Cx.Sast.Results.Presentation.Dtos.TranslationOutputDto": { "required": [ "languageId", "name", "isConstant" ], "type": "object", "properties": { "languageId": { "format": "int32", "type": "integer" }, "name": { "type": "string" }, "isConstant": { "type": "boolean" } } }, "Cx.Sast.Results.Presentation.Dtos.ResultStatePostInputDto": { "required": [ "names", "permission" ], "type": "object", "properties": { "names": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Dtos.TranslationInputDto" } }, "permission": { "type": "string" } }, "example": { "names": [ { "languageId": 1033, "name": "To Verify" }, { "languageId": 1034, "name": "Para verificar" } ], "permission": "set-result-state-toverify" } }, "Cx.Sast.Results.Presentation.Dtos.TranslationInputDto": { "required": [ "languageId", "name" ], "type": "object", "properties": { "languageId": { "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer" }, "name": { "type": "string" } } }, "Cx.Sast.Results.Presentation.Dtos.PostResultStateOutputDto": { "type": "object", "properties": { "id": { "format": "int32", "type": "integer" } } }, "Scheduler.Api.Responses.ScheduledJobsResponse": { "type": "object", "properties": { "projectId": { "format": "int64", "type": "integer" }, "projectName": { "type": "string" }, "scanDays": { "type": "array", "items": { "type": "string" } }, "scanTime": { "type": "string" } } }, "Cx.Sast.ScanSettings.Presentation.Dtos.ScanSettingsResponseDtoV4": { "type": "object", "properties": { "project": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource", "readOnly": true }, "preset": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource", "readOnly": true }, "engineConfiguration": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource", "readOnly": true }, "postScanActionData": { "type": "string", "readOnly": true }, "postScanActionName": { "type": "string", "readOnly": true }, "postScanAction": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkedResource", "readOnly": true }, "emailNotifications": { "$ref": "#/definitions/Cx.Sast.ScanSettings.Presentation.Dtos.EmailNotificationsDto", "readOnly": true }, "postScanActionConditions": { "$ref": "#/definitions/Cx.Sast.ScanSettings.Presentation.Dtos.PostScanActionConditionsDto", "readOnly": true }, "postScanActionArguments": { "type": "string", "readOnly": true } } }, "Cx.Sast.Results.Presentation.Dtos.ResultPathCommentResponse": { "type": "object", "properties": { "comments": { "type": "array", "items": { "type": "string" } } } }, "Cx.Sast.Results.Presentation.Dtos.ResultStatePatchInputDto": { "type": "object", "properties": { "names": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.Results.Presentation.Dtos.TranslationInputDto" } }, "permission": { "type": "string" } }, "example": { "names": [ { "languageId": 1033, "name": "To Verify" }, { "languageId": 1034, "name": "Para verificar" } ], "permission": "set-result-state-toverify" } }, "Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerResponse5Dto": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "uri": { "type": "string" }, "minLoc": { "format": "int32", "type": "integer" }, "maxLoc": { "format": "int32", "type": "integer" }, "maxScans": { "format": "int32", "type": "integer" }, "cxVersion": { "type": "string" }, "operatingSystem": { "type": "string" }, "status": { "enum": [ "Offline", "Blocked", "ScanningAndBlocked", "Scanning", "Idle" ], "type": "string" }, "link": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase" }, "offlineReasonCode": { "enum": [ "Online", "CannotAccess", "EngineServerError", "MessageQueueConfigurationIssue", "OnlineButMessageQueueConfigurationValidatationError", "ActiveMQConnectionError", "EngineAndPackVersionMismtach", "EngineDiskSpaceError" ], "type": "string" }, "offlineReasonMessage": { "type": "string" }, "offlineReasonMessageParameters": { "type": "string" }, "dedications": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerDedicationResponseDto" } } } }, "Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerDedicationResponseDto": { "description": "", "type": "object", "properties": { "itemType": { "type": "string" }, "itemId": { "format": "int64", "type": "integer" }, "itemName": { "type": "string" }, "isDeprecated": { "type": "boolean" } } }, "Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerV5DTO": { "description": "", "required": [ "name", "uri", "minLoc", "maxLoc", "isBlocked" ], "type": "object", "properties": { "dedications": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerDedicationDto" } }, "name": { "description": "", "type": "string" }, "uri": { "description": "", "type": "string" }, "minLoc": { "format": "int32", "description": "", "type": "integer" }, "maxLoc": { "format": "int32", "description": "", "type": "integer" }, "isBlocked": { "description": "", "type": "boolean" }, "maxScans": { "format": "int32", "description": "", "type": "integer" } } }, "Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerDedicationDto": { "description": "", "type": "object", "properties": { "itemType": { "enum": [ "Scan", "Project", "Team" ], "type": "string" }, "itemId": { "format": "int64", "type": "integer" } } }, "Cx.Sast.EngineServers.Presentation.Dtos.CreateEngineServerDto": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "link": { "$ref": "#/definitions/Cx.SuperTypes.API.Dtos.LinkDtoBase" } } }, "Cx.Sast.EngineServers.ApplicationContracts.Models.EngineServerPatchModelV5": { "description": "", "type": "object", "properties": { "dedications": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.EngineServers.ApplicationContracts.DTOs.EngineServerDedicationDto" } }, "name": { "description": "Engine Server name", "type": "string" }, "uri": { "description": "Engine Server Uri", "type": "string" }, "minLoc": { "format": "int32", "description": "Minimum LinesOfCode for the server", "type": "integer" }, "maxLoc": { "format": "int32", "description": "Maximum LinesOfCode for the server", "type": "integer" }, "isBlocked": { "description": "Flag to determine if EngineServer is blocked", "type": "boolean" }, "maxScans": { "format": "int32", "description": "Max concurrent scans", "type": "integer" } } }, "Cx.QueryManagement.Application.DTOs.PresetsQueryInfoDTO": { "type": "object", "properties": { "queryId": { "format": "int64", "type": "integer", "readOnly": true }, "queryName": { "type": "string", "readOnly": true }, "queryLanguage": { "type": "string", "readOnly": true }, "querySource": { "type": "string", "readOnly": true } } }, "ScanMetrics.Presentation.DTOs.Api.ScanStatisticsDTO2": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "scanId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "scanStatus": { "enum": [ "Null", "Finished", "Canceled", "Failed" ], "type": "string" }, "productVersion": { "type": "string" }, "engineVersion": { "type": "string" }, "memoryPeakInMB": { "format": "int32", "type": "integer" }, "virtualMemoryPeakInMB": { "format": "int32", "type": "integer" }, "isIncrementalScan": { "type": "boolean" }, "resultsCount": { "format": "int32", "type": "integer" }, "totalUnScannedFilesCount": { "format": "int32", "type": "integer" }, "fileCountOfDetectedButNotScannedLanguages": { "type": "object", "additionalProperties": { "format": "int32", "type": "integer" } }, "totalFilteredParsedLOC": { "format": "int64", "type": "integer" }, "totalUnFilteredParsedLOC": { "format": "int64", "type": "integer" }, "languageStatistics": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ScanMetrics.Domain.Entities.LanguageStatistics" } }, "pathFilterPattern": { "type": "string" }, "failedQueriesCount": { "format": "int32", "type": "integer" }, "generalQueries": { "$ref": "#/definitions/ScanMetrics.Domain.Entities.GeneralQueries" }, "failedStages": { "type": "string" }, "engineOperatingSystem": { "type": "string" }, "enginePackVersion": { "type": "string" } } }, "ScanMetrics.Domain.Entities.LanguageStatistics": { "type": "object", "properties": { "parsedFiles": { "$ref": "#/definitions/ScanMetrics.Domain.Entities.ScanParsedFilesCount" }, "scannedLOCPerLanguage": { "$ref": "#/definitions/ScanMetrics.Domain.Entities.ScannedLOC" }, "countOfDomObjects": { "format": "int32", "type": "integer" } } }, "ScanMetrics.Domain.Entities.GeneralQueries": { "type": "object", "properties": { "succeededGeneralQueriesCount": { "format": "int32", "type": "integer" }, "failedGeneralQueriesCount": { "format": "int32", "type": "integer" } } }, "ScanMetrics.Domain.Entities.ScanParsedFilesCount": { "type": "object", "properties": { "parsedSuccessfullyCount": { "format": "int32", "type": "integer" }, "parsedUnsuccessfullyCount": { "format": "int32", "type": "integer" }, "parsedPartiallyCount": { "format": "int32", "type": "integer" } } }, "ScanMetrics.Domain.Entities.ScannedLOC": { "type": "object", "properties": { "successfulLOC": { "format": "int64", "type": "integer" }, "unsuccessfulLOC": { "format": "int64", "type": "integer" }, "scannedSuccessfullyLOCPercentage": { "format": "float", "type": "number" } } }, "Cx.Sast.Results.Presentation.Models.ResultActionLabelModel": { "description": "Labels are changes made on the results' properties by the user. If no changes were made to the result's properties by the user - the state is \"null\"", "type": "object", "properties": { "user": { "type": "string" }, "comment": { "type": "string" }, "createdDate": { "format": "date-time", "type": "string" } } }, "Cx.ProjectManagement.Presentation.Dtos.RolesAuditTrailDto": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "ownerId": { "format": "int32", "type": "integer" }, "ownerName": { "type": "string" }, "event": { "type": "string" }, "timeStamp": { "format": "date-time", "type": "string" }, "roleDetails": { "$ref": "#/definitions/Cx.ProjectManagement.Presentation.Dtos.RolePermissionDetailsDto" } } }, "Cx.ProjectManagement.Presentation.Dtos.RolePermissionDetailsDto": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "permissionsAdded": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "permissionsRemoved": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "Cx.ProjectManagement.Presentation.Dtos.TeamsAuditTrailDto": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "ownerId": { "format": "int32", "type": "integer" }, "ownerName": { "type": "string" }, "event": { "type": "string" }, "timeStamp": { "format": "date-time", "type": "string" }, "teamDetails": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Cx.QueryManagement.Presentation.PresetAuditTrail.DTO.PresetsAuditTrailDTO": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer", "readOnly": true }, "ownerId": { "format": "int64", "type": "integer", "readOnly": true }, "ownerName": { "type": "string", "readOnly": true }, "event": { "type": "string", "readOnly": true }, "timeStamp": { "format": "date-time", "type": "string", "readOnly": true }, "presetId": { "format": "int64", "type": "integer", "readOnly": true }, "presetName": { "type": "string", "readOnly": true }, "isSuccessful": { "type": "boolean", "readOnly": true } } }, "Cx.Sast.ScanExecution.Presentation.Dtos.SastScansDtoV1_2": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "project": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ProjectDto" }, "status": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ScanStatusDto" }, "scanType": { "enum": [ "Unknown", "AllScans", "Regular", "Subset", "Partial", "Running" ], "type": "string" }, "comment": { "type": "string" }, "dateAndTime": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.DateAndTimeDto" }, "resultsStatistics": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ResultsStatisticsLink" }, "scanState": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ScanStateDto" }, "owner": { "type": "string" }, "origin": { "type": "string" }, "originURL": { "type": "string" }, "initiatorName": { "type": "string" }, "owningTeamId": { "format": "int32", "type": "integer" }, "isPublic": { "type": "boolean" }, "isLocked": { "type": "boolean" }, "isIncremental": { "type": "boolean" }, "scanRisk": { "format": "int64", "type": "integer" }, "scanRiskSeverity": { "format": "int64", "type": "integer" }, "engineServer": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.EngineServerDto" }, "finishedScanStatus": { "enum": [ "None", "Completed", "Partial" ], "type": "string" }, "partialScanReasons": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Domain.Entities.PartialScanDTO" } }, "customFields": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Cx.Sast.ScanExecution.ApplicationContracts.DTOs.SastScanRequestWriteDTO": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "format": "int64", "description": "Specifies the Unique Id of the specific project to be scanned", "minimum": 1, "type": "integer" }, "isIncremental": { "description": "Specifies whether the scan is incremental of full", "type": "boolean" }, "isPublic": { "description": "Specifies whether the requested scan is public or private", "type": "boolean" }, "forceScan": { "description": "Specifies whether the code should be scanned regardless of unchanged code", "type": "boolean" }, "comment": { "description": "Specifies the scan comment", "type": "string" }, "customFields": { "type": "object", "additionalProperties": { "type": "string" } } }, "example": { "projectId": 1, "isIncremental": false, "isPublic": true, "forceScan": true, "comment": "", "customFields": { "key": "value" } } }, "Cx.Sast.Results.Presentation.Dtos.SastResultsAuditTrailDto": { "type": "object", "properties": { "id": { "format": "int64", "type": "integer" }, "ownerName": { "type": "string" }, "updateType": { "type": "string" }, "timeStamp": { "format": "date-time", "type": "string" }, "projectId": { "format": "int64", "type": "integer" }, "scanId": { "format": "int64", "type": "integer" }, "isSuccessful": { "type": "boolean" } } }, "Cx.ProjectManagement.Presentation.Dtos.ScanSettingsExtRequestV4Dto": { "required": [ "projectId" ], "type": "object", "properties": { "projectId": { "format": "int64", "description": "Specifies the Unique Id of the specific project to be scanned", "minimum": 1, "type": "integer" }, "overrideProjectSetting": { "description": "Specifies whether to overwrite project settings to be the default for the next scans .If set to false or empty - do not overwrite project settings. If set to true - overwrite project settings", "type": "boolean" }, "isIncremental": { "description": "Specifies whether the scan is incremental of full", "type": "boolean" }, "isPublic": { "description": "Specifies whether the requested scan is public or private", "type": "boolean" }, "forceScan": { "description": "Specifies whether the code should be scanned regardless of unchanged code", "type": "boolean" }, "comment": { "description": "Specifies the scan comment", "type": "string" }, "presetId": { "format": "int64", "description": "Specify the preset id to use during the scan, 0 = use project's default", "minimum": 0, "type": "integer" }, "engineConfigurationId": { "format": "int64", "description": "Specify the engine-configuration to use during the scan, 0 = use project's default", "minimum": 0, "type": "integer" }, "customFields": { "description": "Any custom fields used to tag the scan. Example: {\"key1\":\"val1\",\"key2\":\"val2\"}", "type": "string" }, "postScanActionId": { "format": "int64", "description": "Specify post action to be executed after scan is completed", "type": "integer" }, "runPostScanOnlyWhenNewResults": { "description": "Specify if the configured post scan action will be executed only if new results are found, compared to the previous scan. Used in conjunction with PostScanActionId.", "type": "boolean" }, "runPostScanMinSeverity": { "format": "int32", "description": "Specify the minimal severity value when evaluating new results compared to the previous scan. Used in conjunction with RunPostScanOnlyWhenNewResults.", "maximum": 3, "minimum": 0, "type": "integer" }, "postScanActionArguments": { "description": "Specify the additional arguments to add to the post scan action. Used in conjunction with PostScanActionId.", "type": "string" } } }, "Cx.CrossCutting.FileSystem.Files.CxFile[System.Byte[]]": { "type": "object", "properties": { "name": { "type": "string" }, "content": { "format": "byte", "type": "string" } } }, "Cx.Sast.ScanExecution.Presentation.Dtos.ResultsStatisticsDto2": { "type": "object", "properties": { "criticalSeverity": { "format": "int64", "type": "integer" }, "highSeverity": { "format": "int64", "type": "integer" }, "mediumSeverity": { "format": "int64", "type": "integer" }, "lowSeverity": { "format": "int64", "type": "integer" }, "infoSeverity": { "format": "int64", "type": "integer" }, "statisticsCalculationDate": { "format": "date-time", "type": "string" } } }, "Cx.Sast.ScanExecution.Presentation.Dtos.ScanCompareSummaryDto2": { "type": "object", "properties": { "critical": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ScanCompareCountDto" }, "total": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ScanCompareCountDto" }, "high": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ScanCompareCountDto" }, "medium": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ScanCompareCountDto" }, "low": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ScanCompareCountDto" }, "info": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ScanCompareCountDto" } } }, "Cx.Sast.ScanExecution.Presentation.Dtos.ScanCompareCountDto": { "type": "object", "properties": { "new": { "format": "int32", "type": "integer" }, "fixed": { "format": "int32", "type": "integer" }, "reOccured": { "format": "int32", "type": "integer" } } }, "Cx.Sast.ScanExecution.Presentation.Dtos.ExtendedScanCompareResultsDtoV6": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/Cx.Sast.ScanExecution.Presentation.Dtos.ExtendedScanCompareResultDataDtoV6" } } } }, "Cx.Sast.ScanExecution.Presentation.Dtos.ExtendedScanCompareResultDataDtoV6": { "type": "object", "properties": { "queryId": { "format": "int64", "type": "integer" }, "pathId": { "format": "int64", "type": "integer" }, "sourceFolder": { "type": "string" }, "sourceFile": { "type": "string" }, "sourceLine": { "format": "int64", "type": "integer" }, "sourceObject": { "type": "string" }, "destFolder": { "type": "string" }, "destFile": { "type": "string" }, "destLine": { "format": "int64", "type": "integer" }, "numberOfNodes": { "format": "int32", "type": "integer" }, "destObject": { "type": "string" }, "comment": { "type": "string" }, "state": { "format": "int32", "type": "integer" }, "severity": { "format": "int32", "type": "integer" }, "assignedUser": { "type": "string" }, "resultStatus": { "format": "int32", "type": "integer" }, "queryVersionCode": { "format": "int64", "type": "integer" }, "scanId": { "format": "int64", "type": "integer" }, "comparedToScanId": { "format": "int64", "type": "integer" }, "comparedToScanPathId": { "format": "int64", "type": "integer" }, "queryName": { "type": "string" }, "cweId": { "format": "int64", "type": "integer" }, "similarityID": { "format": "int64", "type": "integer" }, "detectionDate": { "format": "date-time", "type": "string" }, "deepLink": { "type": "string" }, "presetId": { "format": "int64", "type": "integer" }, "presetName": { "type": "string" }, "categoriesCollection": { "type": "array", "items": { "$ref": "#/definitions/Checkmarx.DataTypes.CategoryEntity" } } } }, "Checkmarx.DataTypes.CategoryEntity": { "type": "object", "properties": { "categoryId": { "format": "int64", "type": "integer" }, "categoryName": { "type": "string" }, "categoryType": { "format": "int64", "type": "integer" }, "categoryTypeName": { "type": "string" } } } }, "securityDefinitions": { "Bearer": { "type": "oauth2", "description": "OAuth2 implicit Grant", "flow": "implicit", "authorizationUrl": "https://desktop-rmvpboc/CxRestAPI/auth/identity/connect/authorize", "tokenUrl": "https://desktop-rmvpboc/CxRestAPI/auth/identity/connect/token", "scopes": { "sast_api": "Sast API" } } }, "security": [ { "Bearer": [ "sast_api" ] } ] }