{ "openapi": "3.0.0", "info": { "title": "API Documentation", "version": "1.0" }, "paths": { "/api/{version}/open/uploads/dependencies/files": { "post": { "tags": [ "Dependency files management" ], "summary": "Upload a dependency file. Call this endpoint for each file you have in your commit (re-using the CI upload ID from the first call). Then call finishes/dependencies/files/uploads with your CI upload ID.", "operationId": "post_api_open_app_service_rest_manageprogramfilesrestopen_postuploaddependencyfile.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "fileData" ], "properties": { "fileData": { "description": "Raw dependency file data", "type": "file" }, "fileRelativePath": { "description": "File's relative path to root of your repository.", "type": "string" }, "repositoryName": { "description": "REQUIRED, repository to associate with this upload.", "type": "string" }, "commitName": { "description": "REQUIRED, commit to associate with this upload.", "type": "string" }, "productName": { "description": "DEPRECATED, please use repositoryName instead. Repository to associate with this upload.", "type": "string", "deprecated": true }, "releaseName": { "description": "DEPRECATED, please use commitName instead. Commit to associate with this upload.", "type": "string", "deprecated": true }, "repositoryUrl": { "description": "The repository uri, to create the link to the dependency's file in suggested fix.", "type": "string" }, "branchName": { "description": "Branch to associate with this upload.", "type": "string" }, "defaultBranchName": { "description": "Default branch for the repository.", "type": "string" }, "ciUploadId": { "description": "ID of upload returned by a previous call to this endpoint", "type": "string" } }, "type": "object" } }, "application/json": { "schema": { "properties": { "fileRelativePath": { "type": "string", "default": null }, "repositoryName": { "type": "string", "default": null, "pattern": ".+" }, "commitName": { "type": "string", "default": null, "pattern": ".+" }, "productName": { "type": "string", "default": null, "pattern": ".+" }, "releaseName": { "type": "string", "default": null, "pattern": ".+" }, "repositoryUrl": { "type": "string", "default": null, "pattern": ".+" }, "branchName": { "type": "string", "default": null, "pattern": ".+" }, "defaultBranchName": { "type": "string", "default": null, "pattern": ".+" }, "ciUploadId": { "type": "string", "default": null, "pattern": "\\d+" }, "manualUpload": { "type": "string", "default": null, "pattern": "[0-1]|true|false" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returned when successful, a JSON encoded array consisting of ciUploadId and uploadProgramsFileId." }, "400": { "$ref": "#/components/responses/bad_request" }, "402": { "description": "Returned when an user does not have required subscription to use feature." }, "401": { "$ref": "#/components/responses/unauthorized" }, "404": { "description": "Returned when an upload wasn't found with given ID." } } } }, "/api/{version}/open/finishes/dependencies/files/uploads": { "post": { "tags": [ "Dependency files management" ], "summary": "Call this endpoint to conclude file(s) upload and queue files for scan.", "operationId": "post_api_open_app_service_rest_manageprogramfilesrestopen_postfinishdependencyfilesupload.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "ciUploadId" ], "properties": { "ciUploadId": { "description": "ID of upload returned by /upload-dependency-file endpoint", "type": "string", "default": null, "pattern": "\\d+" }, "repositoryZip": { "description": "Files in repository.", "type": "file" }, "repositoryName": { "description": "Name of repository.", "type": "string", "default": null, "pattern": ".+" }, "commitName": { "description": "Name of commit.", "type": "string", "default": null, "pattern": ".+" }, "integrationName": { "description": "The integration name (azureDevOps, bitbucket or gitlab).", "type": "string", "default": null, "pattern": ".+" }, "debrickedIntegration": { "description": "The debricked integration (cli, legacy-cli).", "type": "string", "default": null, "pattern": ".+" }, "author": { "description": "Author of the commit the upload belongs to", "type": "string", "default": null, "pattern": ".+" }, "returnCommitData": { "description": "Set to true to return repository and commit ID associated with this upload", "default": false, "pattern": "true|false" }, "versionHint": { "description": "Set to true to enable versions consolidation between fingerprint and manifest parsings", "default": false, "pattern": "true|false" }, "isRelease": { "description": "Set to true to tag this commit as a release, this will prevent the commit from getting automatically pruned after 30 days. Requires enterprise subscription, click here to upgrade: /app/en/repositories?billingModal=enterprise,free", "default": false, "pattern": "true|false" }, "debrickedConfig": { "description": "Valid debricked config file. \"override\"/\"overrides\" applies only to Fingerprint matching. \"ignore\" filters packages by pURL across all detection methods (fingerprint, manifest, lock files).", "type": "object", "oneOf": [ { "required": [ "override" ], "properties": { "override": { "type": "array", "items": { "required": [ "pURL", "version", "fileRegexes" ], "properties": { "pURL": { "type": "string" }, "version": { "type": [ "string", "boolean" ] }, "fileRegexes": { "type": "array", "items": { "type": "string" } } }, "type": "object" } }, "ignore": { "properties": { "packages": { "type": "array", "items": { "required": [ "pURL" ], "properties": { "pURL": { "description": "Package URL identifying the dependency to ignore", "type": "string" }, "version": { "description": "Optional: Specific version to ignore. If omitted, all versions are ignored", "type": [ "string" ] } }, "type": "object" } } }, "type": "object" } }, "type": "object" }, { "required": [ "overrides" ], "properties": { "overrides": { "type": "array", "items": { "required": [ "pURL", "version", "fileRegexes" ], "properties": { "pURL": { "type": "string" }, "version": { "type": [ "string", "boolean" ] }, "fileRegexes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "deprecated": true }, "ignore": { "properties": { "packages": { "type": "array", "items": { "required": [ "pURL" ], "properties": { "pURL": { "description": "Package URL identifying the dependency to ignore", "type": "string" }, "version": { "description": "Optional: Specific version to ignore. If omitted, all versions are ignored", "type": [ "string" ] } }, "type": "object" } } }, "type": "object" } }, "type": "object" } ] }, "experimental": { "description": "Set to True to enable experimental features.", "default": false, "pattern": "true|false" } }, "type": "object" } }, "application/json": { "schema": { "required": [ "ciUploadId" ], "properties": { "ciUploadId": { "type": "string", "default": null, "pattern": "\\d+" }, "repositoryName": { "type": "string", "default": null, "pattern": ".+" }, "integrationName": { "type": "string", "default": null, "pattern": ".+" }, "debrickedIntegration": { "type": "string", "default": null, "pattern": ".+" }, "commitName": { "type": "string", "default": null, "pattern": ".+" }, "author": { "type": "string", "default": null, "pattern": ".+" }, "returnCommitData": { "type": "string", "default": false, "pattern": "true|false|.?" }, "versionHint": { "type": "string", "default": false, "pattern": "true|false|.?" }, "debrickedConfig": { "type": "string", "default": null }, "experimental": { "type": "string", "default": false }, "isRelease": { "type": "string", "default": false, "pattern": "true|false|.?" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returned when successful and returnCommitData is set to true.", "content": { "application/json": { "schema": { "properties": { "repositoryId": { "type": "integer" }, "commitId": { "type": "integer" } }, "type": "object" } } } }, "204": { "description": "Returned when successful." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "description": "Returned when one or more files/uploads belongs to a different user." }, "404": { "description": "Returned when an upload wasn't found with given ID." } } } }, "/api/{version}/open/supported/dependency/files": { "get": { "tags": [ "Dependency files management" ], "summary": "Please use files/supported-formats endpoint instead.", "operationId": "get_api_open_app_service_rest_manageprogramfilesrestopen_getsupporteddependencyfiles.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" } }, "deprecated": true } }, "/api/{version}/open/files/supported-formats": { "get": { "tags": [ "Dependency files management" ], "summary": "Get supported dependency file formats", "operationId": "get_api_open_app_service_rest_manageprogramfilesrestopen_getsupporteddependencyfileformats.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/ci/upload/status": { "get": { "tags": [ "Dependency files management", "Vulnerability management" ], "summary": "Get current status of a CI upload. An array consisting of progress and amount of vulnerabilities found (as well as the number of vulnerabilities marked as unaffected) is returned.", "operationId": "get_api_open_app_service_rest_manageprogramfilesrestopen_getciuploadstatus.api", "parameters": [ { "name": "ciUploadId", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "\\d+" } }, { "name": "extendedOutput", "in": "query", "description": "If true, returns an extended output containing stats for each file. When scan is complete, the result can only be fetched once per hour with this option enabled.", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successful and scan is completed." }, "201": { "description": "Returned when queue times are long and the scan is not completed." }, "202": { "description": "Returned when scan is in progress." }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "description": "Returned when you don't have access to one or more uploads/files." }, "404": { "description": "Returned when given upload doesn't exist." } } } }, "/api/{version}/open/sbom/generate-cyclonedx-sbom": { "post": { "tags": [ "CycloneDX SBOM" ], "summary": "Generate CycloneDX SBOM. Deprecated in favor of /api/{version}/open/sbom/generate", "operationId": "post_api_open_app_service_rest_sbomrestopen_postgeneratecyclonedxsbom.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateSbomRequest" } } } }, "responses": { "200": { "description": "Returned when successful. The response contains confirming message that CycloneDX SBOM generation has started.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateSbomResponse" } } } }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" } }, "deprecated": true } }, "/api/{version}/open/sbom/generate": { "post": { "tags": [ "SBOM" ], "summary": "Generate SBOM of a selected format (CycloneDX, SPDX-2.3)", "operationId": "post_api_open_app_service_rest_sbomrestopen_postgeneratesbom.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateSbomRequest" } } } }, "responses": { "200": { "description": "Returned when successful. The response contains confirming message that SBOM generation has started.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateSbomResponse" } } } }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" } } } }, "/api/{version}/open/sbom/download-generated-cyclonedx-sbom": { "get": { "tags": [ "CycloneDX SBOM" ], "summary": "Download result of generated CycloneDX SBOM, or get a status response is not yet complete. Deprecated in favor of /api/{version}/open/sbom/download", "operationId": "get_api_open_app_service_rest_sbomrestopen_getgeneratedcyclonedxsbom.api", "parameters": [ { "name": "reportUuid", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": ".*" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when complete. Response contains a JSON-encoded SBOM with requested data populated matching all its components." }, "202": { "description": "Returned when not complete." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "410": { "$ref": "#/components/responses/gone" } }, "deprecated": true } }, "/api/{version}/open/sbom/download": { "get": { "tags": [ "SBOM" ], "summary": "Download result of generated SBOM file, or get a status response is not yet complete", "operationId": "get_api_open_app_service_rest_sbomrestopen_getdownloadsbom.api", "parameters": [ { "name": "reportUuid", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": ".*" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when complete. Response contains a JSON-encoded SBOM with requested data populated matching all its components." }, "202": { "description": "Returned when not complete." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "410": { "$ref": "#/components/responses/gone" } } } }, "/api/{version}/open/reports": { "post": { "tags": [ "Reports" ], "summary": "Generate PDF report for repositories", "operationId": "post_api_open_app_service_dashboard_report_createreport.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReportRequest" } } } }, "responses": { "202": { "description": "Returned when successful. The response contains confirming message that report generation has started.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Report generation has been initiated successfully" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" } } } }, "/api/{version}/open/sbom/cyclonedx-to-spdx": { "post": { "tags": [ "CycloneDX SBOM" ], "summary": "Converts a CycloneDX SBOM into SPDX format for compatibility and compliance.", "operationId": "post_api_open_app_service_rest_stateless_sbomreststateless_postcyclonedxtospdx.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "sbomFile" ], "properties": { "sbomFile": { "description": "JSON-encoded SBOM file", "type": "file" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returned when successful. Response contains the id of an add-data upload." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" } } } }, "/api/{version}/open/sbom/cyclonedx-to-spdx/download": { "get": { "tags": [ "CycloneDX SBOM" ], "summary": "Download result of CycloneDX to SPDX SBOM, or get a status response is not yet complete", "operationId": "get_api_open_app_service_rest_stateless_sbomreststateless_getcyclonedxtospdxdownload.api", "parameters": [ { "name": "uploadId", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "^[1-9]\\d*" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when complete. Response contains a JSON-encoded SBOM with requested data populated matching all \n its components." }, "202": { "description": "Returned when not complete." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "410": { "$ref": "#/components/responses/gone" }, "422": { "description": "Information could not be added due to an internal error" } } } }, "/api/{version}/open/admin/users": { "get": { "tags": [ "Admin" ], "summary": "Get a list of your users.", "operationId": "get_api_open_app_admin_admintools_getusers.api", "parameters": [ { "$ref": "#/components/parameters/table_page" }, { "$ref": "#/components/parameters/table_rows_per_page" }, { "name": "search", "in": "query", "description": "Search by email or name", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": ".+" } }, { "name": "sortColumn", "in": "query", "description": "Which column to sort results by", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": ".+", "enum": [ "email", "firstName", "lastName", "userStatus", "userRoles" ] } }, { "name": "generateCsv", "in": "query", "description": "Generate csv report", "required": false, "schema": { "type": "bool" } }, { "name": "visibleColumns", "in": "query", "description": "Array of column names to include in the report output", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "$ref": "#/components/parameters/table_order" }, { "name": "showInvites", "in": "query", "description": "Whether user invites should also be returned", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "(1)|(0)" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successful, a JSON encoded array consisting of user data." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/admin/users/invite": { "post": { "tags": [ "Admin" ], "summary": "Generates and sends invite links for new users.", "operationId": "post_api_open_app_admin_admintools_createuserinvite.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "description": "Emails of the users to add, the roles and user group to assign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasicUserInviteRequest" } } } }, "responses": { "200": { "description": "Returned when successfully generated and sent invite links." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/admin/invite/{inviteId}": { "delete": { "tags": [ "Admin" ], "summary": "Delete a user invitation.", "operationId": "delete_api_open_app_admin_admintools_deleteinvite.api", "parameters": [ { "name": "inviteId", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successful." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/admin/invite/{inviteId}/resend": { "post": { "tags": [ "Admin" ], "summary": "Resend a user invitation.", "operationId": "post_api_open_app_admin_admintools_resendinvite.api", "parameters": [ { "name": "inviteId", "in": "path", "required": true, "schema": { "type": "integer", "pattern": "\\d+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successful." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/admin/user/{userId}": { "post": { "tags": [ "Admin" ], "summary": "Edit the given user.", "operationId": "post_api_open_app_admin_admintools_edituser.api", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "description": "Password is optional, leave unspecified if you want to keep user's password. Set isActive to true if you want to enable the user to log in straight away", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditUserType" } } } }, "responses": { "200": { "description": "Returned when form was not submitted, returns all form fields with current data." }, "201": { "description": "Returned when successfully edited user." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } }, "delete": { "tags": [ "Admin" ], "summary": "Delete the given user.", "operationId": "delete_api_open_app_admin_admintools_removeuser.api", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successful." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/admin/user/default-rules-enabled": { "get": { "tags": [ "Admin" ], "summary": "Get settings `default rules enabled`", "operationId": "get_api_open_app_admin_admintools_getdefaultrulesenabled.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returns value of settings `default rules enabled`." }, "401": { "$ref": "#/components/responses/unauthorized" } } }, "patch": { "tags": [ "Admin" ], "summary": "Edit value `default rules enabled` for the current user.", "operationId": "patch_api_open_app_admin_admintools_editdefaultrulesenabled.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "enabled": { "description": "Value of default_rules_enabled which will be set.", "type": "boolean" } }, "type": "object" } } } }, "responses": { "204": { "description": "Returned when successfully edited user." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/admin/rbac/repository-role": { "get": { "tags": [ "Admin" ], "summary": "Get the role that users in your company get when a new repository is added.", "operationId": "get_api_open_app_admin_roles_getrepositoryrole.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successful, a JSON encoded array with the role set and available roles", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RbacRepositoryRoleModel" } } } }, "401": { "$ref": "#/components/responses/unauthorized" } } }, "post": { "tags": [ "Admin" ], "summary": "Use to edit the default roles assigned to users when a new repo is added.", "operationId": "post_api_open_app_admin_roles_setrepositoryrole.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "description": "Role to be set", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetRbacRepositoryRoleRequest" } } } }, "responses": { "204": { "description": "Returned when successful." }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/admin/rbac/update-user-roles-by-repo": { "post": { "tags": [ "Admin" ], "summary": "Assign or remove roles to repository for one or many users.", "operationId": "post_api_open_app_admin_roles_updatebulkuserroles.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "description": "Json body of the Update user roles request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBulkUserRolesRequest" } } } }, "responses": { "204": { "description": "Returned when successfully updated" }, "200": { "description": "Partially successful. This is sent when update fails for some users. Look at the response body to know which users were not updated." }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "403": { "$ref": "#/components/responses/forbidden" } } } }, "/api/{version}/open/sso/oidc/request": { "post": { "tags": [ "Admin" ], "summary": "Requests approval of an Open ID Connect configuration to set up EnterpriseSSO", "operationId": "post_api_open_app_admin_enterprisessosetup_submitoidcconfigcustomer.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemporaryEnterpriseSSORequest" } } } }, "responses": { "204": { "description": "Returned when successfully submitted a SSO request" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/sso/saml/validate-metadata": { "post": { "tags": [ "Admin" ], "summary": "Validate SAML metadata XML file", "operationId": "post_api_open_app_admin_enterprisessosetup_uploadsamlmetadata.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "200": { "description": "Validation result", "content": { "application/json": { "schema": { "properties": { "valid": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid or unreadable file or invalid SAML metadata", "content": { "application/json": { "schema": { "properties": { "valid": { "type": "boolean" }, "error_code": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } } } }, "/api/{version}/open/sso/saml/submit-saml-configuration": { "post": { "tags": [ "Admin" ], "summary": "Submit SAML configuration with metadata file", "operationId": "post_api_open_app_admin_enterprisessosetup_submitsamlconfigurationcustomer.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "type": "string", "format": "binary" }, "emailDomains": { "type": "array", "items": { "type": "string" } }, "emailAttribute": { "type": "string" }, "fnameAttribute": { "type": "string" }, "lnameAttribute": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Validation result", "content": { "application/json": { "schema": { "properties": { "valid": { "type": "boolean" }, "message": { "type": "string" }, "emailDomains": { "type": "string" }, "emailAttribute": { "type": "string" }, "fnameAttribute": { "type": "string" }, "lnameAttribute": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid or unreadable file or invalid SAML metadata", "content": { "application/json": { "schema": { "properties": { "valid": { "type": "boolean" }, "error_code": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } } } }, "/api/{version}/open/admin/request-logs/get-request-logs": { "get": { "tags": [ "Admin", "Request logging" ], "summary": "Filter and get the request logs in a paginated fashion. Non-admins will only be able to access their own logs.", "operationId": "get_api_open_app_service_requestlog_requestlogrest_getrequestlogs.api", "parameters": [ { "name": "eventTypeId", "in": "query", "description": "Filter by eventTypeId", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "userEmail", "in": "query", "description": "Filter by user email", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": ".+" } }, { "name": "url", "in": "query", "description": "Filter by a specific url", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": ".+" } }, { "name": "ipAddress", "in": "query", "description": "Filter by a specific IP address", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": ".+" } }, { "name": "start", "in": "query", "description": "Starting timestamp to fetch logs, e.g. 2018-05-10T15:52:01", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2})?(\\+\\d{2}:\\d{2})?" }, "example": "" }, { "name": "end", "in": "query", "description": "Ending timestamp to fetch logs, e.g. 2021-05-10T15:52:01", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2})?(\\+\\d{2}:\\d{2})?" }, "example": "" }, { "name": "page", "in": "query", "description": "Page number for paginated content", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "pageSize", "in": "query", "description": "Amount of logs to return per page, maximum 50", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "excludeUnclassified", "in": "query", "description": "Setting this parameter to true excludes the logs which do not have an associated labeled event", "required": false, "allowEmptyValue": true, "schema": { "type": "boolean", "default": null } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched the logs", "content": { "application/json": { "schema": { "properties": { "page": { "type": "integer", "example": "1" }, "found": { "description": "Amount of logs returned", "type": "integer", "example": "1" }, "requestLogs": { "type": "array", "items": { "$ref": "#/components/schemas/RequestLogSample" } } }, "type": "object" } } } }, "404": { "description": "Returned when user is not found" }, "403": { "description": "Returned when attempted to access other users' logs while not being an admin" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/admin/request-logs/get-events": { "get": { "tags": [ "Admin", "Request logging" ], "summary": "Get event names and ids", "operationId": "get_api_open_app_service_requestlog_requestlogrest_getrequestevents.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched all the events", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "eventId": { "type": "integer", "example": 2 }, "eventName": { "type": "string", "example": "Created pull request" } }, "type": "object" } } } } }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/user-permissions/": { "get": { "tags": [ "Admin", "User permissions" ], "summary": "Get the current user permissions configuration", "operationId": "get_api_open_app_admin_userpermissions_getuserpermissions.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched the user permissions", "content": { "application/json": { "schema": { "properties": { "githubOauthAllowed": { "type": "boolean" }, "enforceUnaffectedComment": { "type": "boolean" }, "allowSnooze": { "type": "boolean" }, "organizations": { "description": "List of github organizations", "type": "array", "items": { "properties": { "name": { "type": "string", "example": "AmazingCompany" }, "githubId": { "type": "integer" } }, "type": "object" } }, "whitelist": { "type": "array", "items": { "type": "string", "example": "company.com" } }, "versionThreshold": { "description": "Version threshold configuration", "properties": { "value": { "type": "integer", "example": 6 }, "unit": { "type": "string", "enum": [ "DAYS", "WEEKS", "MONTHS", "YEARS" ], "example": "MONTHS" } }, "type": "object", "nullable": true } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/user-permissions/toggle-github-oauth": { "post": { "tags": [ "Admin", "User permissions" ], "summary": "Toggle githubOauthAllowed setting", "operationId": "post_api_open_app_admin_userpermissions_togglegithuboauth.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "githubOauthAllowed": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/user-permissions/toggle-allow-snooze": { "post": { "tags": [ "Admin", "User permissions" ], "summary": "Toggle, allow users to snooze vulnerabilties", "operationId": "post_api_open_app_admin_userpermissions_toggleallowsnooze.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "allowSnooze": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "403": { "$ref": "#/components/responses/forbidden" } } } }, "/api/{version}/open/user-permissions/toggle-enforce-comment": { "post": { "tags": [ "Admin", "User permissions" ], "summary": "Toggle enforceUnaffectedComment setting", "operationId": "post_api_open_app_admin_userpermissions_toggleenforceunaffectedcomment.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "enforceUnaffectedComment": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/user-permissions/set-email-whitelist": { "post": { "tags": [ "Admin", "User permissions" ], "summary": "Add a list of allowed email domains which users can use to sign up using SSO", "operationId": "post_api_open_app_admin_userpermissions_addwhitelistedemaildomains.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "emailDomains": { "type": "array", "items": { "type": "string", "example": "@company.com" } } }, "type": "object" } } } }, "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/user-permissions/version-threshold": { "post": { "tags": [ "Admin", "User permissions" ], "summary": "Update version threshold configuration", "operationId": "post_api_open_app_admin_userpermissions_updateversionthreshold.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "value", "unit" ], "properties": { "value": { "description": "Version threshold value (must be >= 0)", "type": "integer", "example": 6 }, "unit": { "description": "Version threshold time unit", "type": "string", "enum": [ "DAYS", "WEEKS", "MONTHS", "YEARS" ], "example": "MONTHS" } }, "type": "object" } } } }, "responses": { "200": { "description": "Version threshold updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Version threshold updated successfully" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/repository-settings/repositories": { "get": { "tags": [ "Repository settings" ], "summary": "Get a list of your repositories, their use cases, number of automations and more.", "operationId": "get_api_open_app_service_dashboard_repositorysettings_getrepositories.api", "parameters": [ { "$ref": "#/components/parameters/table_page" }, { "$ref": "#/components/parameters/table_rows_per_page" }, { "name": "search", "in": "query", "description": "Search by name or commit", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": ".+" } }, { "name": "sortColumn", "in": "query", "description": "Which column to sort result by", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": ".+", "enum": [ "name", "automations", "useCase", "integration", "scanningEnabled" ] } }, { "name": "generateCsv", "in": "query", "description": "Generate csv report", "required": false, "schema": { "type": "bool" } }, { "name": "visibleColumns", "in": "query", "description": "Array of column names to include in the report output", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "order", "in": "query", "description": "Sorting order, asc or desc", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": ".+", "enum": [ "asc", "desc" ] } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/repository-settings/commits": { "get": { "tags": [ "Repository settings" ], "summary": "Get a list of your commits.", "operationId": "get_api_open_app_service_dashboard_repositorysettings_getcommits.api", "parameters": [ { "$ref": "#/components/parameters/table_page" }, { "$ref": "#/components/parameters/table_rows_per_page" }, { "name": "search", "in": "query", "description": "Search by name or repository", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": ".+" } }, { "name": "sortColumn", "in": "query", "description": "Which column to sort result by", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": ".+", "enum": [ "name", "commitDate", "repository", "branch", "author" ] } }, { "name": "generateCsv", "in": "query", "description": "Generate csv report", "required": false, "schema": { "type": "bool" } }, { "name": "visibleColumns", "in": "query", "description": "Array of column names to include in the report output", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "order", "in": "query", "description": "Sorting order, asc or desc", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": ".+", "enum": [ "asc", "desc" ] } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/repository-settings/repositories/{repositoryId}/rename": { "post": { "tags": [ "Repository settings" ], "summary": "Change the name of a repository.", "operationId": "post_api_open_app_service_dashboard_repositorysettings_changerepositoryname.api", "parameters": [ { "name": "repositoryId", "in": "path", "description": "Id of the repository", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "newRepositoryName" ], "properties": { "newRepositoryName": { "description": "The new name.", "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/repository-settings/available-use-cases": { "get": { "tags": [ "Repository settings" ], "summary": "Get a list of all available use cases and their IDs.", "operationId": "get_api_open_app_service_dashboard_repositorysettings_getavailableusecases.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successful", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "label": { "type": "string" } }, "type": "object" } } } } }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/repository-settings/repositories/{repositoryId}/select-use-case": { "post": { "tags": [ "Repository settings" ], "summary": "Select a use case for a repository.", "operationId": "post_api_open_app_service_dashboard_repositorysettings_selectusecase.api", "parameters": [ { "name": "repositoryId", "in": "path", "description": "Id of the repository", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "description": "The use case ID. Get available options from available-use-cases endpoint", "required": true, "content": { "application/json": { "schema": { "required": [ "useCase" ], "properties": { "useCase": { "type": "string", "default": null, "maximum": 4, "minimum": 0 } }, "type": "object" } } } }, "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/repository-settings/repositories/remove/{repositoryId}": { "delete": { "tags": [ "Repository settings" ], "summary": "Remove a repository.", "operationId": "delete_api_open_app_service_dashboard_repositorysettings_removerepository.api", "parameters": [ { "name": "repositoryId", "in": "path", "description": "Id of repository to remove", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/repository-settings/commit/remove/{commitId}": { "delete": { "tags": [ "Repository settings" ], "summary": "Remove a commit.", "operationId": "delete_api_open_app_service_dashboard_repositorysettings_removecommit.api", "parameters": [ { "name": "commitId", "in": "path", "description": "Id of commit to remove", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successful, the id of the removed commit." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/repository-settings/repositories/{repositoryId}/enable-app-scanning/{enableScanning}": { "patch": { "tags": [ "Repository settings" ], "summary": "Enable/disable GitHub App dependency scanning.", "operationId": "patch_api_open_app_service_dashboard_repositorysettings_enableappscanning.api", "parameters": [ { "name": "repositoryId", "in": "path", "description": "Id of repository to change GitHub App scanning status for", "required": true, "schema": { "type": "integer" } }, { "name": "enableScanning", "in": "path", "description": "Enable/disable app scanning. 1 to enable, 0 to disable", "required": true, "allowEmptyValue": false, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" } } } }, "/api/{version}/open/scan/scan-status": { "get": { "tags": [ "Scan" ], "summary": "Get the scan status of your repositories.", "operationId": "get_api_open_app_service_scan_getscanstatus.api", "parameters": [ { "name": "repositoryIds", "in": "query", "description": "The ids of the repositories that should be checked, seperated by comma, leave empty to return all", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": "^\\d[,\\d]*$" } }, { "name": "commitId", "in": "query", "description": "Specify which commitId to check for.", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successful, a JSON encoded array consisting of repository information." }, "204": { "description": "Returned when no repositories are found." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/scan/latest-scan-status": { "get": { "tags": [ "Scan" ], "summary": "Get the status of your latest scan.", "operationId": "get_api_open_app_service_scan_getlatestscan.api", "parameters": [ { "name": "repositoryIds", "in": "query", "description": "The ids of the repositories that should be checked, seperated by comma, leave empty to return all.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "^\\d[,\\d]*$" } }, { "name": "commitId", "in": "query", "description": "Specify which commitId to check for.", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successful, a JSON encoded array consisting of repository information." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/scan/remaining-scans": { "get": { "tags": [ "Scan" ], "summary": "Get the data for remaining scans.", "operationId": "get_api_open_app_service_scan_getremainingscans.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successful, a JSON encoded object remaining scans data." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/repositories/get-repositories": { "get": { "tags": [ "Repositories" ], "summary": "Get a list of your repositories and an overview of their vulnerabilities", "operationId": "get_api_open_app_service_repositories_getrepositories.api", "parameters": [ { "$ref": "#/components/parameters/table_page" }, { "$ref": "#/components/parameters/table_rows_per_page" }, { "name": "search", "in": "query", "description": "Search by repository name", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": ".+" } }, { "name": "sortColumn", "in": "query", "description": "Which column to sort results by", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": ".+", "enum": [ "name", "totalVulnerabilities", "vulnerabilitiesWhichAreExploited" ] } }, { "$ref": "#/components/parameters/table_order" }, { "$ref": "#/components/parameters/group_id" }, { "name": "generateExcel", "in": "query", "description": "Generate excel report", "required": false, "schema": { "type": "bool" } }, { "name": "generateCsv", "in": "query", "description": "Generate csv report", "required": false, "schema": { "type": "bool" } }, { "name": "email", "in": "query", "description": "The email address of the recipient of the finished report. If not set the email of the current authorized user will be used", "required": false, "schema": { "type": "string" } }, { "name": "visibleColumns", "in": "query", "description": "Array of column names to include in the report output", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "includeNoAccess", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "(1)|(0)" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched all the repositories" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/repositories/get-repositories-names-links": { "get": { "tags": [ "Repositories" ], "summary": "Get a list of your repositories and id", "operationId": "get_api_open_app_service_repositories_getallrepositoriesnamesandlink.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched all the repositories" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/repositories/get-repositories-names-links-excluding-manual-uploads": { "get": { "tags": [ "Repositories" ], "summary": "Get a list of your integrated repositories and id, excluding manual uploads (uploads done in UI). If there is no integrated repos, amount of manual uploads are returned.", "operationId": "get_api_open_app_service_repositories_getrepositoriesnamesandlinkexcludingmanualuploads.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched all the repositories" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/repositories/get-by-groups": { "get": { "tags": [ "Repositories" ], "summary": "Get a list of repository ids by groups ids", "operationId": "get_api_open_app_service_repositories_getbygroups.api", "parameters": [ { "name": "groupIds", "in": "query", "description": "The ids of the groups that should be checked, seperated by comma, leave empty to return all.", "required": false, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched the repositories by groups ids" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/repositories/get-common-branches": { "get": { "tags": [ "Repositories" ], "summary": "Get the common branches for multiple repositories", "operationId": "get_api_open_app_service_repositories_getcommonbranches.api", "parameters": [ { "name": "repositoryIds", "in": "query", "description": "The ids of the repositories that should be checked, separated by comma", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when any repository is not found" } } } }, "/api/{version}/open/repository/{repositoryId}/set-default-branch": { "get": { "tags": [ "Repository" ], "summary": "Set the provided branch as default for a given repository", "operationId": "get_api_open_app_service_repository_setdefaultbranch.api", "parameters": [ { "$ref": "#/components/parameters/repository_id" }, { "name": "branchId", "in": "query", "description": "The ID of the new default branch to set", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully changed default branch" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when repository is not found" } } } }, "/api/{version}/open/repository/{repositoryId}/branch/{branchId}/get-pr-status": { "get": { "tags": [ "Repository" ], "summary": "Get the pull request status of a repository and branch", "operationId": "get_api_open_app_service_repository_getpullrequeststatus.api", "parameters": [ { "$ref": "#/components/parameters/repository_id" }, { "$ref": "#/components/parameters/branch_id" }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when repository is not found" } } } }, "/api/{version}/open/repository/{repositoryId}/branch/{branchId}/get-pr-progress": { "get": { "tags": [ "Repository" ], "summary": "Get the pull request progress of a repository and branch", "operationId": "get_api_open_app_service_repository_getpullrequestprogress.api", "parameters": [ { "$ref": "#/components/parameters/repository_id" }, { "$ref": "#/components/parameters/branch_id" }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when repository is not found" } } } }, "/api/{version}/open/repository/{repositoryId}/pull-request/branch/{branchId}/{notify}/{includeUnaffected}": { "get": { "tags": [ "Repository" ], "summary": "Current endpoint is deprecated. Consider using POST /api/{version}/open/repository/{repositoryId}/pull-request/branch/{branchId} instead", "operationId": "get_api_open_app_service_repository_generatebulkpullrequest.api", "parameters": [ { "$ref": "#/components/parameters/repository_id" }, { "$ref": "#/components/parameters/branch_id" }, { "name": "notify", "in": "path", "description": "Should notify owner by email when finished", "required": true, "schema": { "type": "integer", "default": 1, "enum": [ 1, 0 ] } }, { "name": "includeUnaffected", "in": "path", "description": "Should include unaffected dependencies", "required": true, "schema": { "type": "integer", "default": 1, "enum": [ 1, 0 ] } }, { "name": "commitMessage", "in": "query", "description": "If passed, should contain URL encoded string to be used as a commit message. Default message will be used otherwise", "required": false }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully created a new pull request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratingPullRequestStatus" } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when repository is not found" } }, "deprecated": true } }, "/api/{version}/open/repository/{repositoryId}/pull-request/branch/{branchId}": { "post": { "tags": [ "Repository" ], "summary": "Generate a new bulk pull request for specified repository and branch", "operationId": "post_api_open_app_service_repository_createbulkpullrequest.api", "parameters": [ { "$ref": "#/components/parameters/repository_id" }, { "$ref": "#/components/parameters/branch_id" }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBulkPullRequestPayload" } } } }, "responses": { "200": { "description": "Returned when successfully created a new pull request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratingPullRequestStatus" } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when repository is not found" } } } }, "/api/{version}/open/repository/{repositoryId}/pull-request/add-credentials": { "post": { "tags": [ "Repository" ], "summary": "Set pull request credentials.", "operationId": "post_api_open_app_service_repository_postpullrequestcredentials.api", "parameters": [ { "name": "repositoryId", "in": "path", "description": "Repository ID.", "required": true, "schema": { "type": "integer" } }, { "name": "scmServiceName", "in": "path", "description": "Name of SCM service (gitlab or azure).", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "host": { "description": "Host of SCM instance (Gitlab, Azure)", "type": "string", "example": "https://.gitlab.com, https://dev.azure.com/ etc." }, "privateToken": { "description": "Token used to authenticate to perform pull request on SCM instance", "type": "string", "example": "your_access_token" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returned when successful, a JSON encoded array consisting of ciUploadId and uploadProgramsFileId." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/repository/{repositoryId}/get-branches": { "get": { "tags": [ "Repository" ], "summary": "Get the avaiable branches for a repository", "operationId": "get_api_open_app_service_repository_getbranches.api", "parameters": [ { "$ref": "#/components/parameters/repository_id" }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when repository is not found" } } } }, "/api/{version}/open/repository/{repositoryId}/pull-request-availability": { "get": { "tags": [ "Repository" ], "summary": "Get info about PR availability", "operationId": "get_api_open_app_service_repository_getpullrequestavailability.api", "parameters": [ { "$ref": "#/components/parameters/repository_id" }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when repository is not found" } } } }, "/api/{version}/open/commits/get-commits": { "get": { "tags": [ "Commits" ], "summary": "Get a list of your commits", "operationId": "get_api_open_app_service_commits_getcommits.api", "parameters": [ { "$ref": "#/components/parameters/table_page" }, { "$ref": "#/components/parameters/table_rows_per_page" }, { "name": "search", "in": "query", "description": "Search by commit name", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": ".+" } }, { "name": "generateCsv", "in": "query", "description": "Generate csv report", "required": false, "schema": { "type": "bool" } }, { "name": "visibleColumns", "in": "query", "description": "Array of column names to include in the report output", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortColumn", "in": "query", "description": "Which column to sort results by", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": ".+", "enum": [ "name", "releaseDate", "totalVulnerabilities", "vulnerabilitiesWhichAreExploited", "author" ] } }, { "$ref": "#/components/parameters/table_order" }, { "name": "repositoryId", "in": "query", "description": "The ID of the repository in question", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "branchId", "in": "query", "description": "The ID of a specific desired branch", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched all the commits" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/dependencies/get-hierarchy": { "get": { "tags": [ "Dependencies" ], "summary": "Get a list of your dependencies", "operationId": "get_api_open_app_service_dashboard_dependencies_getdependencieshierarchy.api", "parameters": [ { "$ref": "#/components/parameters/table_page" }, { "$ref": "#/components/parameters/table_rows_per_page" }, { "name": "search", "in": "query", "description": "Search by dependency name", "required": false, "schema": { "type": "string" } }, { "name": "sortColumn", "in": "query", "description": "Which column to sort results by", "required": true, "schema": { "type": "string", "enum": [ "name", "totalVulnerabilities", "licenses" ] } }, { "$ref": "#/components/parameters/table_order" }, { "name": "repositoryId", "in": "query", "description": "The ID of a specific desired repository", "required": false, "schema": { "type": "integer" } }, { "name": "branchId", "in": "query", "description": "The ID of a specific desired branch", "required": false, "schema": { "type": "integer" } }, { "name": "commitId", "in": "query", "description": "The ID of a specific desired commit", "required": false, "schema": { "type": "integer" } }, { "name": "group", "in": "query", "description": "The ID of a specific desired group. Overrides commitId and repositoryId if specified.", "required": false, "schema": { "type": "integer" } }, { "name": "generateCsv", "in": "query", "description": "Generate csv report", "required": false, "schema": { "type": "bool" } }, { "name": "visibleColumns", "in": "query", "description": "Array of column names to include in the report output", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filters", "in": "query", "description": "Array of filter groups for sourceParser and dependencyScope", "required": true, "schema": { "type": "array", "items": { "oneOf": [ { "properties": { "label": { "type": "string", "enum": [ "sourceParser" ], "example": "sourceParser" }, "filters": { "type": "array", "items": { "properties": { "label": { "type": "string", "enum": [ "Any analysis", "Both manifest files & file fingerprinting", "Manifest", "Fingerprint" ], "example": "Manifest" }, "val": { "type": "boolean", "example": true } }, "type": "object" } } }, "type": "object" }, { "properties": { "label": { "type": "string", "enum": [ "dependencyScope" ], "example": "dependencyScope" }, "filters": { "type": "array", "items": { "properties": { "label": { "type": "string", "enum": [ "Production", "Non-production" ], "example": "Production" }, "val": { "type": "boolean", "example": true } }, "type": "object" } } }, "type": "object" } ] } } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched all the dependencies" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/dependency/{dependencyId}/": { "get": { "tags": [ "Dependency" ], "summary": "Get dependency information", "operationId": "get_api_open_app_service_dependency_index.api", "parameters": [ { "$ref": "#/components/parameters/dependency_id" }, { "name": "repositoryId", "in": "query", "description": "Get repository specific data of the dependency", "required": false, "schema": { "type": "integer" } }, { "name": "commitId", "in": "query", "description": "Get commit specific data of the dependency", "required": false, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when dependency is not found" } } } }, "/api/{version}/open/dependency/{dependencyId}/license-data": { "get": { "tags": [ "Dependency" ], "summary": "Get dependency license data", "operationId": "get_api_open_app_service_dependency_getdependencylicensedata.api", "parameters": [ { "name": "repositoryId", "in": "query", "description": "Repository to get license data of the dependency", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "branchId", "in": "query", "description": "Branch to select, if non provided will use all", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "commitId", "in": "query", "description": "Commit to select, if selected, repository and branch will be ignored", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "dependencyId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when dependency is not found" } } } }, "/api/{version}/open/dependency/{dependencyId}/versions": { "get": { "tags": [ "Dependency" ], "summary": "Get dependency versions", "operationId": "get_api_open_app_service_dependency_getdependencyversions.api", "parameters": [ { "name": "repositoryId", "in": "query", "description": "Repository to get the versions of the dependency", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "branchId", "in": "query", "description": "Branch to select, if non provided will use all", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "commitId", "in": "query", "description": "Commit to select, if selected, repository and branch will be ignored", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "staleness", "in": "query", "description": "If set to 1, returns staleness data (version and versionStatus) along with versions. Default: 0 (returns version strings only)", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+", "enum": [ 0, 1 ] } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "dependencyId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returns versions array. Format depends on staleness parameter.", "content": { "application/json": { "schema": { "oneOf": [ { "description": "Without staleness parameter (default)", "type": "array", "items": { "type": "string", "example": "1.12.2" } }, { "description": "With staleness=1", "type": "array", "items": { "properties": { "version": { "type": "string", "example": "1.12.2" }, "versionStatus": { "type": "string", "example": "outdated" } }, "type": "object" } } ] } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when dependency is not found" } } } }, "/api/{version}/open/dependency/{dependencyId}/hierarchy-status": { "get": { "tags": [ "Dependency" ], "summary": "Returns whether the dependency is direct, indirect or both in the context of the repository", "operationId": "get_api_open_app_service_dependency_gethierarchystatus.api", "parameters": [ { "name": "repositoryId", "in": "query", "description": "Repository to get license data of the dependency", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "branchId", "in": "query", "description": "Branch to select, if non provided will use all", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "commitId", "in": "query", "description": "Commit to select, if selected, repository and branch will be ignored", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "dependencyId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when dependency is not found" } } } }, "/api/{version}/open/dependency/{dependencyId}/repositories-and-branches": { "get": { "tags": [ "Dependency" ], "summary": "Returns the repositories and branches which contain this dependency", "operationId": "get_api_open_app_service_dependency_getrepositoriesandbranches.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "dependencyId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when dependency is not found" } } } }, "/api/{version}/open/dependency/{dependencyId}/vulnerable-files": { "get": { "tags": [ "Dependency" ], "summary": "Get the files containing a vulnerable version of this repository", "operationId": "get_api_open_app_service_dependency_getvulnerablefiles.api", "parameters": [ { "name": "repositoryId", "in": "query", "description": "Repository containing the files with the dependency", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "branchId", "in": "query", "description": "Branch to select, if non provided will use all", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "commitId", "in": "query", "description": "Commit to select, if selected, repository and branch will be ignored", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "dependencyId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when dependency is not found" } } } }, "/api/{version}/open/dependency/{dependencyId}/dependency-trees": { "get": { "tags": [ "Dependency" ], "summary": "Get the dependency trees for a given vulnerable dependency contained in a file", "operationId": "get_api_open_app_service_dependency_getdependencytrees.api", "parameters": [ { "name": "repositoryId", "in": "query", "description": "Repository containing the files with the dependency", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "branchId", "in": "query", "description": "Branch to select, if non provided will use all", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "commitId", "in": "query", "description": "Commit to select, if selected, repository and branch will be ignored", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "fileId", "in": "query", "description": "File containing the vulnerable dependency", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "dependencyId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when dependency is not found" } } } }, "/api/{version}/open/select-data/dependency-data/{dependencyId}": { "get": { "tags": [ "Dependency" ], "summary": "Get open source select data relevant to the dependency", "operationId": "get_api_open_app_service_rest_dependencyselectintegrationrest_getdependencyselectdata.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "dependencyId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when dependency is not found" } } } }, "/api/{version}/open/select-data/dependency-metrics/{dependencyId}": { "get": { "tags": [ "Dependency" ], "summary": "Get open source select metrics relevant to the dependency", "operationId": "get_api_open_app_service_rest_dependencyselectintegrationrest_getdependencyselectmetrics.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "dependencyId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when dependency is not found" } } } }, "/api/{version}/open/select-data/repos-by-purl/{purl}": { "get": { "tags": [ "Dependency" ], "summary": "Get repositories containing the dependency, including versions used by purl. Experimental, may change in the future", "operationId": "get_api_open_app_service_rest_dependencyselectintegrationrest_getrepositoriesusingdependency.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "purl", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".+" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when dependency is not found" } } } }, "/api/{version}/open/vulnerabilities/get-vulnerabilities": { "get": { "tags": [ "Vulnerabilities" ], "summary": "Get a list of your vulnerabilities", "operationId": "get_api_open_app_service_dashboard_vulnerabilities_getvulnerabilities.api", "parameters": [ { "$ref": "#/components/parameters/table_page" }, { "$ref": "#/components/parameters/table_rows_per_page" }, { "name": "search", "in": "query", "description": "Search by vulnerability name", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": ".+" } }, { "name": "sortColumn", "in": "query", "description": "Which column to sort results by", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": ".+", "enum": [ "name", "discovered", "cvss" ] } }, { "$ref": "#/components/parameters/table_order" }, { "name": "repositoryId", "in": "query", "description": "The ID of a specific desired repository", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "branchId", "in": "query", "description": "The ID of a specific desired branch", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "dependencyId", "in": "query", "description": "The ID of a specific desired dependency", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "commitId", "in": "query", "description": "The ID of a specific desired commit", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "group", "in": "query", "description": "The ID of a specific desired group", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": ".+" } }, { "name": "generateCsv", "in": "query", "description": "Generate csv report", "required": false, "schema": { "type": "bool" } }, { "name": "visibleColumns", "in": "query", "description": "Array of column names to include in the report output", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched all the vulnerabilities" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/cvesummary": { "get": { "tags": [ "Vulnerability" ], "summary": "Get a risk summary of a CVE.", "operationId": "get_api_open_app_service_dashboard_vulnerability_summary.api", "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/cvssdetails": { "get": { "tags": [ "Vulnerability" ], "summary": "Get the CVSS details for a specific CVE.", "operationId": "get_api_open_app_service_dashboard_vulnerability_cvssdetails.api", "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/refsummary": { "get": { "tags": [ "Vulnerability" ], "summary": "Get summaries from sources, including CWE, for a vulnerability.", "operationId": "get_api_open_app_service_dashboard_vulnerability_summaries.api", "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/review-status": { "get": { "tags": [ "Vulnerability" ], "summary": "Get review status for a vulnerability for all repositories.", "operationId": "get_api_open_app_service_dashboard_vulnerability_reviewstatus.api", "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" }, "example": 6551 }, { "name": "repositoryId", "in": "query", "description": "Repository ID. If specified, comment when setting status for this vulnerability and repository will be returned", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" }, "example": 1 }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched the review status", "content": { "application/json": { "schema": { "properties": { "repositories": { "description": "The id of the repository in question", "type": "array", "items": { "properties": { "name": { "type": "string", "example": "ExampleRepo" }, "type": { "type": "string", "example": "unaffected" }, "link": { "type": "string", "example": "https://debricked.com/app/en/vulnerability/6551?repositoryId=1" } }, "type": "object" } }, "enforceComment": { "description": "If providing a comment is mandatory to change the remediation status", "type": "boolean", "example": "false" }, "oldComment": { "description": "Previous comment related to a change in remediation status", "type": "string", "example": "" }, "oldCommentAutho": { "description": "User which wrote the previous comment", "type": "string", "example": "" }, "commentMinLength": { "description": "Minimum length necessary to provide a comment", "type": "integer", "example": 10 } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/set-review-status": { "post": { "tags": [ "Vulnerability" ], "summary": "set review status for a vulnerability in a specific repository", "operationId": "post_api_open_app_service_dashboard_vulnerability_setreviewstatus.api", "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "repoId": { "description": "The id of the repository in question", "type": "integer" }, "type": { "description": "Review status to be set: 'unaffected', 'vulnerable', 'remediated' or 'unexamined'", "type": "string", "example": "vulnerable" }, "comment": { "description": "Comment justifying the review status", "type": "string", "example": "Comment justifying the review status" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returned when review status was changed successfully." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/pause-status": { "get": { "tags": [ "Vulnerability" ], "summary": "Get pause and snooze status. If pause status is empty it is enabled", "operationId": "get_api_open_app_service_dashboard_vulnerability_getpausestatus.api", "parameters": [ { "name": "repositoryId", "in": "path", "description": "Repository ID.", "required": true, "schema": { "type": "integer" } }, { "name": "commitId", "in": "path", "description": "Commit ID.", "required": true, "schema": { "type": "integer" } }, { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "404": { "description": "Returned when not authorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/cveid": { "get": { "tags": [ "Vulnerability" ], "summary": "Get the CVE ID from a vulnerability ID.", "operationId": "get_api_open_app_service_dashboard_vulnerability_cveid.api", "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/tags": { "get": { "tags": [ "Vulnerability" ], "summary": "Get the related tags for a vulnerability.", "operationId": "get_api_open_app_service_dashboard_vulnerability_tags.api", "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/dates": { "get": { "tags": [ "Vulnerability" ], "summary": "Get the relevant dates for a vulnerability.", "description": "Here, we can switch between using the vulnDB or not (isDatabase). If true, we return data from\ne.g. NVD such as published date and updated date. If false, we return the date at which the\nvulnerability was discovered by us in the repo.", "operationId": "get_api_open_app_service_dashboard_vulnerability_dates.api", "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "isDatabase", "in": "query", "description": "Use vulnerability database. If false, it returns the date at which the vulnerability was found in the repo. If true, it returns the published/updated data from e.g., NVD", "required": false, "allowEmptyValue": true, "schema": { "type": "boolean", "default": null, "pattern": "0|1" } }, { "name": "repositoryId", "in": "query", "description": "Repository ID.", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/references": { "get": { "tags": [ "Vulnerability" ], "summary": "Get the relevant references for a vulnerability.", "operationId": "get_api_open_app_service_dashboard_vulnerability_references.api", "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched the remediation status", "content": { "application/json": { "schema": { "properties": { "references": { "type": "array", "items": { "properties": { "link": { "type": "string", "example": "https://nvd.nist.gov/vuln/detail/CVE-2021-26691" }, "title": { "type": "string", "example": "CVE-2021-26691" }, "domain": { "type": "string", "example": "nvd.nist.gov" }, "tags": { "type": "array", "items": { "type": "string", "example": "source" } } }, "type": "object" } } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/affected-dependencies": { "get": { "tags": [ "Vulnerability" ], "summary": "Get the affected dependencies for a vulnerability.", "operationId": "get_api_open_app_service_dashboard_vulnerability_affecteddependencies.api", "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "isDatabase", "in": "query", "description": "Use vulnerability database. If false, it returns the date at which the vulnerability was found in the repo. If true, it returns the published/updated data from e.g., NVD", "required": false, "allowEmptyValue": true, "schema": { "type": "boolean", "default": null, "pattern": "0|1" } }, { "name": "repositoryId", "in": "query", "description": "Repository ID.", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "commitId", "in": "query", "description": "Commit ID.", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "branchId", "in": "query", "description": "Branch ID.", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/vulnerable-timeline": { "get": { "tags": [ "Vulnerability" ], "summary": "Returns vulnerable status for each versions of the affected dependencies in a timeline fashion", "operationId": "get_api_open_app_service_dashboard_vulnerability_vulnerableversionstimeline.api", "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" }, "example": 6551 }, { "name": "repositoryId", "in": "query", "description": "Repository ID. When specified it will narrow down only to dependencies present in the repository", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" }, "example": 1 }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched the vulnerable timeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VulnerabilityTimelinesModel" } } } }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/files/{fileId}/dependency-tree": { "get": { "tags": [ "Vulnerability" ], "summary": "Get the dependency tree for a given vulnerability and file present in a repository. Other than the required parameters, either repositoryId or commitId has to be set", "operationId": "get_api_open_app_service_dashboard_vulnerability_dependencytreefile.api", "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "fileId", "in": "path", "description": "File ID.", "required": true, "schema": { "type": "integer" } }, { "name": "repositoryId", "in": "query", "description": "Repository ID.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "commitId", "in": "query", "description": "Commit ID.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "204": { "description": "No trees for given parameters." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" }, "500": { "description": "Returned if unexpected error occured" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/files": { "get": { "tags": [ "Vulnerability" ], "summary": "Get information about the files affected by the vulnerability. Other than the required paramteres, either reposiotoryId or commitId has to be set.", "operationId": "get_api_open_app_service_dashboard_vulnerability_vulnerablefiles.api", "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "repositoryId", "in": "query", "description": "Repository ID, to fetch information only from a specified repository", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "commitId", "in": "query", "description": "Commit ID, to fetch information only from a specified commit", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched files", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DependencyFile" } } } } }, "204": { "description": "No vulnerable files for given parameters." }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/repository-information": { "get": { "tags": [ "Vulnerability" ], "summary": "Get information about the repositories affected by the vulnerability.", "description": "Information includes: examined status, name of repo, link.", "operationId": "get_api_open_app_service_dashboard_vulnerability_currentrepositoryinfo.api", "parameters": [ { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "repositoryId", "in": "query", "description": "Repository ID, to fetch information only from a specified repository", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/activity/{repositoryId}": { "get": { "tags": [ "Vulnerability" ], "summary": "Retrieve all activity related to the vulnerability in the repository.", "operationId": "get_api_open_app_service_dashboard_vulnerability_getactivity.api", "parameters": [ { "name": "repositoryId", "in": "path", "description": "Repository ID.", "required": true, "schema": { "type": "integer" } }, { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/repository/{repositoryId}/commit/{commitId}/pull-request/status": { "get": { "tags": [ "Vulnerability" ], "summary": "Get pull request status.", "operationId": "get_api_open_app_service_dashboard_vulnerability_getpullrequeststatus.api", "parameters": [ { "name": "repositoryId", "in": "path", "description": "Repository ID.", "required": true, "schema": { "type": "integer" } }, { "name": "commitId", "in": "path", "description": "Commit ID.", "required": true, "schema": { "type": "integer" } }, { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/repository/{repositoryId}/commit/{commitId}/pull-request/progress": { "get": { "tags": [ "Vulnerability" ], "summary": "Get pull request progress info.", "operationId": "get_api_open_app_service_dashboard_vulnerability_getpullrequestprogress.api", "parameters": [ { "name": "repositoryId", "in": "path", "description": "Repository ID.", "required": true, "schema": { "type": "integer" } }, { "name": "commitId", "in": "path", "description": "Commit ID.", "required": true, "schema": { "type": "integer" } }, { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/pullrequest/{repositoryId}/{commitId}/{notify}/generate": { "get": { "tags": [ "Vulnerability" ], "summary": "Current endpoint is deprecated. Consider using POST /api/{version}/open/vulnerability/{vulnerabilityId}/pullrequest/{repositoryId}/{commitId}/generate instead", "operationId": "get_api_open_app_service_dashboard_vulnerability_generatepullrequest.api", "parameters": [ { "name": "repositoryId", "in": "path", "description": "Repository ID.", "required": true, "schema": { "type": "integer" } }, { "name": "commitId", "in": "path", "description": "Commit ID.", "required": true, "schema": { "type": "integer" } }, { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "notify", "in": "path", "description": "Should notify owner by email when finished", "required": true, "schema": { "type": "integer", "default": 1, "enum": [ 1, 0 ] } }, { "name": "commitMessage", "in": "query", "description": "If passed, should contain URL encoded string to be used as a commit message. Default message will be used otherwise", "required": false }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully created a new pull request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratingPullRequestStatus" } } } }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } }, "deprecated": true } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/pullrequest/{repositoryId}/{commitId}/generate": { "post": { "tags": [ "Vulnerability" ], "summary": "Generate pull request.", "operationId": "post_api_open_app_service_dashboard_vulnerability_createpullrequest.api", "parameters": [ { "name": "repositoryId", "in": "path", "description": "Repository ID.", "required": true, "schema": { "type": "integer" } }, { "name": "commitId", "in": "path", "description": "Commit ID.", "required": true, "schema": { "type": "integer" } }, { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePullRequestPayload" } } } }, "responses": { "200": { "description": "Returned when successfully created a new pull request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratingPullRequestStatus" } } } }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/pullrequest/{commitId}/receiptdata": { "get": { "tags": [ "Vulnerability" ], "summary": "Get pull request receipt data.", "operationId": "get_api_open_app_service_dashboard_vulnerability_getpullrequestreceiptdata.api", "parameters": [ { "name": "commitId", "in": "path", "description": "Commit ID.", "required": true, "schema": { "type": "integer" } }, { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/reachability-analysis/{commitId}/data": { "get": { "tags": [ "Vulnerability", "Reachability analysis" ], "summary": "Get reachability analysis data.", "operationId": "get_api_open_app_service_dashboard_vulnerability_getreachabilityanalysis.api", "parameters": [ { "name": "commitId", "in": "path", "description": "Commit ID.", "required": true, "schema": { "type": "integer" } }, { "name": "vulnerabilityId", "in": "path", "description": "Vulnerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully got reachability analysis data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReachabilityAnalysisDataResponse" } } } }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/reachability-analysis/{commitId}/repository-links": { "post": { "tags": [ "Vulnerability", "Reachability analysis" ], "summary": "Get links to repository for various reachability analysis file IDs.", "operationId": "post_api_open_app_service_dashboard_vulnerability_getreachabilityanalysisrepositorylinks.api", "parameters": [ { "name": "commitId", "in": "path", "description": "Commit ID.", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "vulnerabilityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetReachabilityAnalysisRepositoryLinksRequest" } } } }, "responses": { "200": { "description": "Returned when successfully retrieved repository links.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReachabilityAnalysisRepositoryLinks" } } } }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/vulnerability/{vulnerabilityId}/repositories/{repositoryId}/root-fixes": { "get": { "tags": [ "Vulnerability" ], "summary": "Get root fixes for concrete vulnerability for all files in the repository that are vulnerable.", "operationId": "get_api_open_app_service_dashboard_vulnerability_getrootfixesinfo.api", "parameters": [ { "name": "repositoryId", "in": "path", "description": "Repository ID.", "required": true, "schema": { "type": "integer" } }, { "name": "vulnerabilityId", "in": "path", "description": "Vunerability ID.", "required": true, "schema": { "type": "integer" } }, { "name": "commitId", "in": "query", "description": "Commit ID.", "required": false, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/repository-groups/": { "get": { "tags": [ "Repository groups" ], "summary": "Get all the owned groups", "operationId": "get_api_open_app_service_productgroup_getallproductgroups.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched all the groups" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/repository-groups/get-current-groups": { "get": { "tags": [ "Repository groups" ], "summary": "Get information about the sub-groups contained in the current group", "operationId": "get_api_open_app_service_productgroup_getcurrentproductgroups.api", "parameters": [ { "name": "current", "in": "query", "description": "ID of the current group, defaults to '/' which is the root level", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "default": null, "pattern": ".+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched all the subgroups" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when the current group is not found" } } } }, "/api/{version}/open/repository-groups/get-repositories": { "get": { "tags": [ "Repository groups" ], "summary": "Get repositories contained in a group", "operationId": "get_api_open_app_service_productgroup_getallproductsofgroup.api", "parameters": [ { "name": "current", "in": "query", "description": "ID of the desired current group", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "default": null, "pattern": ".+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched all the repositories under a group" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when the current group is not found" } } } }, "/api/{version}/open/repository-groups/new-group": { "post": { "tags": [ "Repository groups" ], "summary": "Create a new group", "operationId": "post_api_open_app_service_productgroup_createproductgroup.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "description": "New unique name for the group", "type": "string", "example": "FrontendTeam" }, "products": { "description": "An array of repositories, each containing a row number, a list of repository IDs, and the default branch ID", "type": "array", "items": { "properties": { "defaultBranchId": { "description": "Default Branch id for the specific row", "type": "integer", "example": 1 }, "rowId": { "description": "Row number of the repository row", "type": "integer", "example": 1 }, "repoIds": { "description": "An array of repository Ids", "type": "array", "items": { "type": "integer", "example": 42 } } }, "type": "object" } }, "groups": { "description": "Array of subgroup IDs to be included in the group", "type": "array", "items": { "type": "integer" } }, "current": { "description": "Decides where the group will be placed. To place it within an existing group, use the id of that group, otherwise use '/' to add it to the root level", "type": "string", "example": "1" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returned when successfully created a new group" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/repository-groups/edit-group": { "post": { "tags": [ "Repository groups" ], "summary": "Edit a group", "operationId": "post_api_open_app_service_productgroup_editproductgroup.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "group": { "description": "ID of the group to be edited", "type": "integer", "example": "1" }, "name": { "description": "Name of the group", "type": "string", "example": "FrontendTeam" }, "products": { "description": "An array of repositories, each containing a row number, a list of repository IDs, and the default branch ID", "type": "array", "items": { "properties": { "defaultBranchId": { "description": "Default Branch id for the specific row", "type": "integer", "example": 1 }, "rowId": { "description": "Row number of the repository row", "type": "integer", "example": 1 }, "repoIds": { "description": "An array of repository Ids", "type": "array", "items": { "type": "integer", "example": 42 } } }, "type": "object" } }, "groups": { "description": "Array of subgroup IDs to be included in the group", "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Returned when successfully created a new group" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/repository-groups/delete-group": { "post": { "tags": [ "Repository groups" ], "summary": "Delete a group", "operationId": "post_api_open_app_service_productgroup_deleteproductgroup.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "group": { "description": "ID of the group to be deleted", "type": "integer", "example": "1" }, "parent": { "description": "ID of the parent of the current groups, this is needed as groups can have multiple parents.", "type": "string", "example": "/" } }, "type": "object" } } } }, "responses": { "200": { "description": "Returned when successfully deleted a new group" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/access-tokens/": { "get": { "tags": [ "Access tokens" ], "summary": "Get a paginated list of your company's access tokens", "operationId": "get_api_open_app_admin_accesstokens_getaccesstokens.api", "parameters": [ { "$ref": "#/components/parameters/table_page" }, { "$ref": "#/components/parameters/table_rows_per_page" }, { "name": "search", "in": "query", "description": "Search by access token description", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": ".+" } }, { "name": "sortColumn", "in": "query", "description": "Which column to sort results by", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": ".+", "enum": [ "description", "created", "accessScopes" ] } }, { "name": "generateCsv", "in": "query", "description": "Generate csv report", "required": false, "schema": { "type": "bool" } }, { "name": "visibleColumns", "in": "query", "description": "Array of column names to include in the report output", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "$ref": "#/components/parameters/table_order" }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched list", "content": { "application/json": { "schema": { "properties": { "description": { "type": "string" }, "created": { "type": "string" }, "accessScopes": { "description": "Comma space separated list of access scopes. Field is not available for RBAC users.", "type": "string", "example": "API, Paid API" }, "tokenId": { "type": "integer" }, "userId": { "type": "integer" }, "createdBy": { "description": "Name of the creator of this access token. Available only for RBAC users.", "type": "string" }, "userRoles": { "description": "highest role assigned to the access token. Available only for RBAC users.", "type": "integer" }, "userRoleHierarchy": { "description": "highest role hierarchy for the token. Available only for RBAC users.", "type": "integer" }, "repoAccess": { "description": "Array of all repos and role mapping assigned to the token. Available only for RBAC users.", "type": "array", "items": { "properties": { "repositories": { "type": "array", "items": { "properties": { "name": { "type": "string" }, "id": { "type": "integer" }, "ownRoleId": { "type": "integer" } }, "type": "object" } }, "globalRoles": { "type": "array", "items": { "properties": { "id": { "type": "integer" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } }, "post": { "tags": [ "Access tokens" ], "summary": "Add an access token", "operationId": "post_api_open_app_admin_accesstokens_addaccesstoken.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "description": "Emails of the users to add and the roles", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddAccessTokenRequest" } } } }, "responses": { "200": { "description": "Returned when successfully added token", "content": { "application/json": { "schema": { "properties": { "token": { "description": "The added token", "type": "string" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/access-tokens/{tokenId}": { "delete": { "tags": [ "Access tokens" ], "summary": "Remove an access token", "operationId": "delete_api_open_app_admin_accesstokens_removeaccesstoken.api", "parameters": [ { "name": "tokenId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully removed token" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" } } } }, "/api/{version}/open/access-tokens/update-access-token": { "post": { "tags": [ "Access tokens" ], "summary": "Update description as well as assign or remove roles to repository for Access token.", "operationId": "post_api_open_app_admin_accesstokens_updateaccesstoken.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "description": "Json body of the Update access token roles request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccessTokenRequest" } } } }, "responses": { "200": { "description": "Returned when successfully updated" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "403": { "$ref": "#/components/responses/forbidden" } } } }, "/api/{version}/open/automations/make-default": { "put": { "tags": [ "Automations" ], "summary": "Make Automation rule a default Automation rule", "operationId": "put_api_open_app_service_dashboard_automations_makedefault.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "ruleIds": { "description": "Array of rule ids to add default for", "type": "array", "items": { "type": "integer" }, "example": [ 4, 6 ] }, "repositoryIds": { "description": "Array of repository ids to add default for", "type": "array", "items": { "type": "integer" }, "example": [ 4, 6 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Returned when successfully fetched all the results" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "403": { "$ref": "#/components/responses/forbidden" } } } }, "/api/{version}/open/automations/save-rules": { "put": { "tags": [ "Automations" ], "summary": "Create or edit automation rules. Use POST to create rules, leave ruleIds empty. Use PUT to edit existing rules, using the ruleIds array.", "operationId": "put_api_open_app_service_dashboard_automations_saverule_1.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "description": "Json body of the automation rule.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveRuleRequest" } } } }, "responses": { "200": { "description": "Returned when successfully saved rules" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "403": { "$ref": "#/components/responses/forbidden" } } }, "post": { "tags": [ "Automations" ], "summary": "Create or edit automation rules. Use POST to create rules, leave ruleIds empty. Use PUT to edit existing rules, using the ruleIds array.", "operationId": "post_api_open_app_service_dashboard_automations_saverule.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "description": "Json body of the automation rule.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveRuleRequest" } } } }, "responses": { "200": { "description": "Returned when successfully saved rules" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "403": { "$ref": "#/components/responses/forbidden" } } } }, "/api/{version}/open/automations/send-sample-webhook-request": { "post": { "tags": [ "Automations" ], "summary": "Send sample webhook request", "operationId": "post_api_open_app_service_dashboard_automations_sendsamplewebhookrequest.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendSampleWebhookRequest" } } } }, "responses": { "200": { "description": "Returned when successfully sent request to webhook URL", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendSampleWebhookResponseModel" } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "403": { "$ref": "#/components/responses/forbidden" } } } }, "/api/{version}/open/automations/rules/data": { "get": { "operationId": "get_api_open_app_service_dashboard_automations_getruledata.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "default": { "description": "" } }, "deprecated": true }, "post": { "tags": [ "Automations" ], "summary": "Get automation rule data", "operationId": "post_api_open_app_service_dashboard_automations_getruledata_1.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "description": "Contains necessary parameters to find rule data", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleDataRequest" } } } }, "responses": { "200": { "description": "Returned when successfully found rule data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleDataResponse" } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "403": { "$ref": "#/components/responses/forbidden" } } } }, "/api/{version}/open/automations/generate-rule": { "post": { "tags": [ "Automations" ], "summary": "Generate an automation rule.", "operationId": "post_api_open_app_service_dashboard_automations_generaterule.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "description": "Json body of the automation rule.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateRuleRequest" } } } }, "responses": { "200": { "description": "Returned when successfully generating a rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateRuleResponse" } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "403": { "$ref": "#/components/responses/forbidden" } } } }, "/api/{version}/open/automations/{repositoryId}/get-rules": { "post": { "tags": [ "Automations" ], "summary": "Get a list of your automations", "operationId": "post_api_open_app_service_dashboard_automations_getrules.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "repositoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "page": { "type": "integer", "default": 1 }, "rulesPerPage": { "description": "Amount of automations to return", "type": "integer", "default": 25 }, "search": { "description": "Search by rule description", "type": "string", "default": "", "maxLength": 255 }, "repositoryIds": { "description": "Repository IDs", "type": "array", "items": { "type": "integer" } }, "filters": { "description": "Filters", "type": "array", "items": { "type": "string" }, "default": [ "active", "inactive", "failPipeline", "warnPipeline", "sendEmail", "markUnaffected", "markVulnerable", "triggerWebhook", "default", "nonDefault" ] }, "policyId": { "description": "Filter for rules contained in a given policy", "type": "integer", "default": null }, "onlySortPolicy": { "description": "Only sort by the policyId parameter", "type": "boolean", "default": false } }, "type": "object" } } } }, "responses": { "200": { "description": "Returned when successfully fetched all the automations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRulesResponse" } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when repository is not found" } } } }, "/api/{version}/open/automations/rules-count": { "get": { "tags": [ "Automations" ], "summary": "Get a count of your automations rules", "operationId": "get_api_open_app_service_dashboard_automations_getrulescount.api", "parameters": [ { "name": "repositoryIds", "in": "query", "description": "The ids of the repositories that should be checked, seperated by comma, leave empty to return all", "required": false, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully calculated the count of rules", "content": { "application/json": { "schema": { "properties": { "count": { "type": "integer" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when repository is not found" } } } }, "/api/{version}/open/automations/delete-rules": { "delete": { "tags": [ "Automations" ], "summary": "Delete automation rules", "operationId": "delete_api_open_app_service_dashboard_automations_deleterules.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "description": "IDs of the rules to delete", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RulesRequest" } } } }, "responses": { "200": { "description": "Returned when successfully deleted all selected rules", "content": { "application/json": { "schema": { "properties": { "deletedCount": { "type": "integer" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "403": { "$ref": "#/components/responses/forbidden" } } } }, "/api/{version}/open/automations/set-active": { "put": { "tags": [ "Automations" ], "summary": "Activate/deactivate automation rules", "operationId": "put_api_open_app_service_dashboard_automations_setactive.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "description": "IDs of the rules to activate/deactivate", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetActiveRequest" } } } }, "responses": { "200": { "description": "Returned when successfully activated/deactivated all the automations", "content": { "application/json": { "schema": { "properties": { "editedCount": { "type": "integer" } }, "type": "object" } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "403": { "$ref": "#/components/responses/forbidden" } } } }, "/api/{version}/open/automations/get-rules-by-package": { "post": { "tags": [ "Automations" ], "summary": "Get automation rules data for a package", "operationId": "post_api_open_app_service_dashboard_automations_getruledataforpackage.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "dependencyId": { "type": "integer", "example": 1 }, "repositoryIds": { "type": "array", "items": { "type": "integer" }, "example": [ 1, 2, 3 ] }, "policyIds": { "type": "array", "items": { "type": "integer" }, "example": [ 1, 2, 3 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Returned when successfully found rule data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleDataResponse" } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when package is not found" } } } }, "/api/{version}/open/policy/{policyId}": { "get": { "tags": [ "Policies" ], "summary": "Get a policy by id", "operationId": "get_api_open_app_service_dashboard_policy_getpolicy.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returned when successfully fetched a policy", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyModel" } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } }, "delete": { "tags": [ "Policies" ], "summary": "Delete a policy by id", "operationId": "delete_api_open_app_service_dashboard_policy_deletepolicy.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "204": { "description": "Returned when successfully deleted a policy" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } }, "patch": { "tags": [ "Policies" ], "summary": "Update a policy by id", "operationId": "patch_api_open_app_service_dashboard_policy_editpolicy.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "policyId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditPolicyRequest" } } } }, "responses": { "204": { "description": "Returned when successfully updated a policy" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/policy/": { "post": { "tags": [ "Policies" ], "summary": "Create a new policy containing rules, assigned to repos", "operationId": "post_api_open_app_service_dashboard_policy_createpolicy.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyRequest" } } } }, "responses": { "200": { "description": "Returned when successfully created a policy", "content": { "application/json": { "schema": { "properties": { "id": { "type": "integer" } }, "type": "object" } } } }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/policy/search": { "post": { "tags": [ "Policies" ], "summary": "Search for policies", "operationId": "post_api_open_app_service_dashboard_policy_searchpolicies.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchPoliciesRequest" } } } }, "responses": { "200": { "description": "Returned when successfully found policies", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyModel" } } } } }, "204": { "description": "No policy found for provided filters" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/default-automations/delete": { "delete": { "tags": [ "Automations" ], "summary": "Delete default Automation rule", "operationId": "delete_api_open_app_service_dashboard_defaultautomations_deletedefaultrule.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "defaultRuleIds": { "description": "Array of default rule ids to delete", "type": "array", "items": { "type": "integer" }, "example": [ 4, 6 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Returned when successfully fetched all the results" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "403": { "$ref": "#/components/responses/forbidden" } } } }, "/api/{version}/open/user-profile/is-admin": { "get": { "tags": [ "User profile" ], "summary": "Checks whether user is an admin or not", "operationId": "get_api_open_app_security_userprofile_isadmin.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/user-profile/get-user-info": { "get": { "tags": [ "User profile" ], "summary": "Returns full user name, email and billing plan", "operationId": "get_api_open_app_security_userprofile_getuserinfo.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/user-profile/get-billing-info": { "get": { "tags": [ "User profile" ], "summary": "Returns billing plans per product", "operationId": "get_api_open_app_security_userprofile_getbillinginfo.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/licenses/get-licenses": { "get": { "tags": [ "Licenses" ], "summary": "Get a list of your licenses", "operationId": "get_api_open_app_service_dashboard_licenses_getlicenses.api", "parameters": [ { "$ref": "#/components/parameters/table_page" }, { "$ref": "#/components/parameters/table_rows_per_page" }, { "name": "search", "in": "query", "description": "Search by name", "required": false, "schema": { "type": "string" } }, { "name": "sortColumn", "in": "query", "description": "Which column to sort results by", "required": true, "schema": { "type": "string", "enum": [ "name", "repositories", "dependenciesCount", "licenseFamily" ] } }, { "$ref": "#/components/parameters/table_order" }, { "name": "repositoryId", "in": "query", "description": "The ID of a specific desired repository", "required": false, "deprecated": true, "schema": { "type": "integer" } }, { "name": "repositoryIds", "in": "query", "description": "The ids of the repositories that should be checked, seperated by comma, leave empty to return all", "required": false, "schema": { "type": "string" } }, { "name": "branchId", "in": "query", "description": "The ID of a specific desired branch", "required": false, "schema": { "type": "integer" } }, { "name": "commitId", "in": "query", "description": "The ID of a specific desired commit", "required": false, "schema": { "type": "integer" } }, { "name": "generateExcel", "in": "query", "description": "Generate excel report", "required": false, "schema": { "type": "bool" } }, { "name": "generateCsv", "in": "query", "description": "Generate csv report", "required": false, "schema": { "type": "bool" } }, { "name": "visibleColumns", "in": "query", "description": "Array of column names to include in the report output", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "email", "in": "query", "description": "The email address of the recipient of the finished report. If not set the email of the current authorized user will be used", "required": false, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched all the licenses" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/license/{licenseId}/": { "get": { "tags": [ "License" ], "summary": "Get information about a specific license and related repositories", "operationId": "get_api_open_app_service_dashboard_license_getrepositories.api", "parameters": [ { "$ref": "#/components/parameters/table_page" }, { "$ref": "#/components/parameters/table_rows_per_page" }, { "name": "search", "in": "query", "description": "Search by repository name", "required": false, "schema": { "type": "string" } }, { "name": "generateCsv", "in": "query", "description": "Generate csv report", "required": false, "schema": { "type": "bool" } }, { "name": "visibleColumns", "in": "query", "description": "Array of column names to include in the report output", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sortColumn", "in": "query", "description": "Which column to sort results by", "required": true, "schema": { "type": "string", "enum": [ "name", "licenseRisk", "dependencyCount" ] } }, { "$ref": "#/components/parameters/table_order" }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "licenseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returned when successfully fetched all the results" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when license is not found" } } } }, "/api/{version}/open/license/{licenseId}/get-repository-ids": { "get": { "tags": [ "License" ], "summary": "Get information about a specific license repository ids", "operationId": "get_api_open_app_service_dashboard_license_getrepositoryids.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "licenseId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returned when successfully fetched all the results" }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" }, "404": { "description": "Returned when license is not found" } } } }, "/api/{version}/open/overview/snapshots": { "get": { "tags": [ "Overview" ], "summary": "Gets the snapshots in the last timeFrame nr of timeScale, for instance the last 3 days, or in the last 5 months etc.", "operationId": "get_api_open_app_service_rest_overview_getsnapshots.api", "parameters": [ { "name": "repositoryId", "in": "query", "description": "Repository ID. If empty will check all repositories.", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "from", "in": "query", "description": "Specifies the start date of the range. Data will be fetched starting from this date (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "example": "2024-01-01" }, { "name": "to", "in": "query", "description": "Specifies the end date of the range. Data will be fetched up to this date (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "example": "2024-01-01" }, { "name": "branchId", "in": "query", "description": "The id of the branch to check. If empty will check the default branch", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "\\d+" } }, { "name": "excludeManualUploads", "in": "query", "description": "The id of the branch to check. If empty will check the default branch", "required": false, "allowEmptyValue": true, "schema": { "type": "boolean", "default": null, "pattern": "[0-1]" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successful." }, "400": { "description": "Returned when required data is missing. Look at the response body's message to know exactly what went wrong." }, "401": { "description": "Returned when authorisation fails, such as missing JWT-token, insufficient privileges or expired JWT-token. Look at the response body's message to know exactly what went wrong." } } } }, "/api/{version}/open/overview/vulnerabilities-fixed-snapshots": { "get": { "tags": [ "Overview" ], "summary": "Gets the number of vulnerabilities fixed for the selected time period", "operationId": "get_api_open_app_service_rest_overview_getfixedvulnerabilitiessnapshots.api", "parameters": [ { "name": "repositoryId", "in": "query", "description": "Repository ID. If empty, all repositories will be checked.", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "[1-9]\\d*" } }, { "name": "branchId", "in": "query", "description": "The id of the branch to check. If empty, the latest commit on the default branch will be checked", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "[1-9]\\d*" } }, { "name": "from", "in": "query", "description": "Specifies the start date of the range. Data will be fetched starting from this date (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "example": "2024-01-01" }, { "name": "to", "in": "query", "description": "Specifies the end date of the range. Data will be fetched up to this date (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "example": "2024-01-01" }, { "name": "excludeManualUploads", "in": "query", "description": "The id of the branch to check. If empty will check the default branch", "required": false, "allowEmptyValue": true, "schema": { "type": "boolean", "default": null, "pattern": "[0-1]" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successful." }, "400": { "description": "Returned when required data is missing. Look at the response body's message to know exactly what went wrong." }, "401": { "description": "Returned when authorisation fails, such as missing JWT-token, insufficient privileges or expired JWT-token. Look at the response body's message to know exactly what went wrong." } } } }, "/api/{version}/open/overview/vulnerabilities-fixed": { "get": { "tags": [ "Overview" ], "summary": "Gets the number of vulnerabilities fixed for the selected time period", "operationId": "get_api_open_app_service_rest_overview_getfixedvulnerabilitiestabledata.api", "parameters": [ { "name": "repositoryId", "in": "query", "description": "Repository ID. If empty, all repositories will be checked.", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "[1-9]\\d*" } }, { "name": "branchId", "in": "query", "description": "The id of the branch to check. If empty, the latest commit on the default branch will be checked", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "[1-9]\\d*" } }, { "name": "from", "in": "query", "description": "Specifies the start date of the range. Data will be fetched starting from this date (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "example": "2024-01-01" }, { "name": "to", "in": "query", "description": "Specifies the end date of the range. Data will be fetched up to this date (inclusive).", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "example": "2024-12-31" }, { "name": "excludeManualUploads", "in": "query", "description": "The id of the branch to check. If empty will check the default branch", "required": false, "allowEmptyValue": true, "schema": { "type": "boolean", "default": null, "pattern": "[0-1]" } }, { "$ref": "#/components/parameters/table_page" }, { "$ref": "#/components/parameters/table_rows_per_page" }, { "name": "sortColumn", "in": "query", "description": "Which column to sort results by", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": ".+", "enum": [ "cve", "date" ] } }, { "$ref": "#/components/parameters/table_order" }, { "name": "search", "in": "query", "description": "Search by cve id", "required": false, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successful." }, "400": { "description": "Returned when required data is missing. \n Look at the response body's message to know exactly what went wrong." }, "401": { "description": "Returned when authorisation fails, such as missing JWT-token, insufficient privileges or expired JWT-token. Look at the response body's message to know exactly what went wrong." } } } }, "/api/{version}/open/overview/license-risks": { "get": { "tags": [ "Overview" ], "summary": "Gets the current numbers of license risks.", "operationId": "get_api_open_app_service_rest_overview_getlicenserisks.api", "parameters": [ { "name": "repositoryId", "in": "query", "description": "Repository ID. If empty, all repositories will be checked.", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "[1-9]\\d*" } }, { "name": "branchId", "in": "query", "description": "The id of the branch to check. If empty, the latest commit on the default branch will be checked", "required": false, "allowEmptyValue": true, "schema": { "type": "integer", "default": null, "pattern": "[1-9]\\d*" } }, { "name": "excludeManualUploads", "in": "query", "description": "The id of the branch to check. If empty will check the default branch", "required": false, "allowEmptyValue": true, "schema": { "type": "boolean", "default": null, "pattern": "[0-1]" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successful." }, "400": { "description": "Returned when required data is missing. Look at the response body's message to know exactly what went wrong." }, "401": { "description": "Returned when authorisation fails, such as missing JWT-token, insufficient privileges or expired JWT-token. Look at the response body's message to know exactly what went wrong." } } } }, "/api/{version}/open/releases/by/name": { "get": { "tags": [ "Commits" ], "summary": "Get info about releases with the given name.", "operationId": "get_api_open_app_service_rest_releaserest_getreleasesbyname.api", "parameters": [ { "name": "name", "in": "query", "description": "The name of the release(s) you want to get info of", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": ".+" } }, { "name": "productId", "in": "query", "description": "(Optional) The product which the release(s) belong to.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "\\d+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "$ref": "#/components/responses/ok" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/open/dependencies-licenses/{repositoryId}/{branchId}": { "get": { "tags": [ "Licenses" ], "summary": "Gets dependencies and licenses by a given repositoryId and branchId", "operationId": "get_api_open_app_service_dashboard_dependencylicense_getdependencieslicenses.api", "parameters": [ { "$ref": "#/components/parameters/table_page" }, { "$ref": "#/components/parameters/table_rows_per_page" }, { "$ref": "#/components/parameters/search" }, { "name": "sortColumn", "in": "query", "description": "Parameter to help sort the results", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null, "pattern": ".+", "enum": [ "name", "licenseCount" ], "example": "name" } }, { "name": "filters", "in": "query", "description": "Array of filters for dependencyScope and reviewStatus", "required": false, "allowEmptyValue": true, "schema": { "type": "array", "items": { "properties": { "label": { "type": "string", "enum": [ "dependencyScope", "reviewStatus" ], "example": "dependencyScope" }, "filters": { "type": "array", "items": { "properties": { "label": { "type": "string", "enum": [ "prod", "non_prod", "unexamined", "approved" ], "example": "prod" }, "val": { "type": "string", "enum": [ "true", "false" ], "example": "true" } }, "type": "object" } } }, "type": "object" }, "default": null, "pattern": ".+" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "repositoryId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "branchId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returned when successfully fetched dependency licenses", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DependencyVersionAndLicensesModel" } } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/dependencies-licenses/get-license-options": { "get": { "tags": [ "Licenses" ], "summary": "Gets the available license options", "operationId": "get_api_open_app_service_dashboard_dependencylicense_getlicenseoptions.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successfully fetched license options", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseDataModel" } } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/dependencies-licenses/{repositoryId}/{branchId}/{dependencyVersionId}/{licenseId}/get-license-risk-and-type": { "get": { "tags": [ "Licenses" ], "summary": "Gets the license risk and type for the given license, repository, branch and dependency version", "operationId": "get_api_open_app_service_dashboard_dependencylicense_getlicenseriskandtype.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "repositoryId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "branchId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "dependencyVersionId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "licenseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "responses": { "200": { "description": "Returned when successfully fetched license risk and type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseDataModelWithExtraData" } } } }, "401": { "$ref": "#/components/responses/unauthorized" }, "400": { "$ref": "#/components/responses/bad_request" } } } }, "/api/{version}/open/dependencies-licenses/{repositoryId}/{branchId}/{dependencyVersionId}": { "put": { "tags": [ "Licenses" ], "summary": "Sets licenses manually to a given repository and dependency with a specific version. \n Providing empty array will result in reset to global licenses.", "operationId": "put_api_open_app_service_dashboard_dependencylicense_savedependencylicenses.api", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "repositoryId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "branchId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } }, { "name": "dependencyVersionId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "\\d+" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveDependencyLicensesRequest" } } } }, "responses": { "201": { "description": "Returned when successfully saved licenses for dependency" }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } }, "/api/{version}/public/translations/{view}": { "get": { "operationId": "get_api_public_app_service_rest_publicapi_gettranslations.api", "parameters": [ { "name": "locale", "in": "query", "description": "", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } }, { "name": "view", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".*" } } ], "responses": { "default": { "description": "" } } } }, "/api/{version}/public/vulnerability-database/{cveId}/get-vulnerability-id": { "get": { "tags": [ "Vulnerability" ], "summary": "Get vulnerability ID for given CVE ID.", "operationId": "get_app_service_dashboard_vulnerabilitydatabase_getvulnerabilitydatabaseid.api", "parameters": [ { "name": "cveId", "in": "path", "description": "CVE ID.", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "pattern": "1.0" } } ], "responses": { "200": { "description": "Returned when successful.", "content": { "text/plain": { "schema": { "type": "string", "example": "3424" } } } }, "400": { "$ref": "#/components/responses/bad_request" }, "401": { "$ref": "#/components/responses/unauthorized" } } } } }, "components": { "schemas": { "GenerateSbomRequest": { "properties": { "format": { "description": "Preferred format for generated SBOM file.", "type": "string", "default": "CycloneDX", "enum": [ "CycloneDX", "SPDX-2.3" ], "nullable": true }, "commitId": { "description": "CommitId of a repository to extract data from. Note that if this value is provided, the values for repositoryIds and branch will be ignored.", "type": "integer", "default": "0", "nullable": true }, "email": { "description": "The email address of the recipient of the finished report. If not set the email of the current authorized user will be used.", "type": "string", "nullable": true }, "repositoryIds": { "description": "RepositoryIds to extract data, default branch will be chosen for all of them.", "type": "array", "items": { "type": "integer" }, "nullable": true }, "branch": { "description": "Branch name to select when using a repositoryId", "type": "string", "default": "master", "nullable": true }, "locale": { "description": "The language of the email message, en/sv. Note that the SBOM will always be generated in English.", "type": "string", "default": "en", "nullable": true }, "vulnerabilities": { "description": "Add vulnerabilities matching the components in the SBOM.", "type": "bool", "default": "false" }, "rootFixes": { "description": "Add root fixes information to matching vulnerabilities. By default it is true if vulnerabilities is true", "type": "bool", "default": "null" }, "licenses": { "description": "Add license data for the components in the SBOM.", "type": "bool", "default": "false" }, "sendEmail": { "description": "Send email with SBOM report. When set to false, make sure to download the SBOM through download endpoint.", "type": "bool", "default": "true" }, "vulnerabilityStatuses": { "description": "Vulnerabilities only in selected statuses will be added to report. If empty, only 'vulnerable', 'unexamined', 'paused', 'snoozed' will be included.", "type": "array", "items": { "type": "string", "enum": [ "unaffected", "vulnerable", "remediated", "unexamined", "paused", "snoozed" ] }, "default": [ "vulnerable", "unexamined", "paused", "snoozed" ], "nullable": true } }, "type": "object" }, "GenerateSbomResponse": { "properties": { "message": { "description": "Information on how to get the report after generation is finished.", "type": "string", "example": "The report has started generating and will be sent to your email once ready. Be aware that it might take some time before it's finished. It is also possible to download the SBOM through the 'download' endpoint, by using the reportUuId stated below. " }, "reportUuid": { "description": "Generated report uuid. It's used to download the SBOM report once it's been generated.", "type": "string", "example": "c1154db9-33e2-43c4-80cb-137d7ccf6a62" }, "notes": { "description": "Specifies notes to consider once the generation has begun. For example if certain parameters are ignored due to conflicts.", "type": "array", "items": { "type": "string", "example": "Example note" } } }, "type": "object" }, "CreateReportRequest": { "required": [ "type", "startDate", "endDate" ], "properties": { "type": { "type": "string", "enum": [ "executiveSummary" ] }, "startDate": { "type": "string" }, "endDate": { "type": "string" } }, "type": "object" }, "BasicUserInviteRequest": { "properties": { "emails": { "type": "array", "items": { "type": "string" } }, "roleId": { "type": "integer" } }, "type": "object" }, "EditUserType": { "required": [ "email", "firstName", "lastName", "isActive", "plainPassword", "_token" ], "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "isActive": { "type": "boolean" }, "plainPassword": { "type": "string", "format": "password" }, "_token": { "description": "CSRF token", "type": "string" } }, "type": "object" }, "RbacRepositoryRoleModel": { "properties": { "rbacRepositoryRole": { "description": "Role currently set when a new repository is created", "type": "string", "default": "NO_ACCESS", "nullable": true }, "availableRoles": { "description": "Available roles to be set", "type": "array", "items": { "type": "string" } } }, "type": "object" }, "SetRbacRepositoryRoleRequest": { "required": [ "rbacRepositoryRole" ], "properties": { "rbacRepositoryRole": { "description": "Role to be set", "type": "string", "nullable": true } }, "type": "object" }, "UpdateBulkUserRolesRequest": { "properties": { "userIds": { "type": "array", "items": { "type": "integer" } }, "access": { "type": "array", "items": { "$ref": "#/components/schemas/AccessModel" } }, "noAccess": { "type": "array", "items": { "$ref": "#/components/schemas/AccessModel" } } }, "type": "object" }, "TemporaryEnterpriseSSORequest": { "required": [ "providerUrl", "clientId", "clientSecret", "emailDomains" ], "properties": { "providerUrl": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "emailDomains": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "RequestLogSample": { "properties": { "user": { "description": "Email of user", "type": "string", "example": "tony.montana@debricked.com" }, "eventName": { "description": "Name of the event", "type": "string", "example": "Created pull request" }, "eventId": { "description": "ID of the event", "type": "integer", "example": 2 }, "ipAddress": { "description": "IP address associated with the request", "type": "string", "example": "56.139.181.204" }, "timestamp": { "description": "Timestamp of the request", "type": "string", "example": "2021-11-06 19:45:14" }, "method": { "description": "Method used for the request", "type": "string", "example": "GET" }, "statusCode": { "description": "Response status code", "type": "integer", "example": 200 }, "breadcrumbs": { "description": "Information about the pages the user visted in the UI", "type": "array", "items": { "properties": { "url": { "type": "string", "example": "/app/en/repositories" }, "text": { "type": "string", "example": "Repositories" } }, "type": "object" } }, "url": { "description": "Url of the request", "type": "string", "example": "https://debricked.com/vulnerability/1/repository/2/commit/3/pull-request/generate" } }, "type": "object" }, "Branch": { "properties": { "id": { "description": "Id of the branch", "type": "int" }, "name": { "description": "Name of the branch", "type": "string" }, "default": { "description": "If the branch is a default branch or not", "type": "bool" } }, "type": "object" }, "GeneratingPullRequestStatus": { "properties": { "generating": { "type": "boolean" }, "reason": { "type": "string" } }, "type": "object" }, "CreateBulkPullRequestPayload": { "properties": { "commitMessage": { "description": "Commit message to be used", "type": "string", "example": "Bulk fix vulnerabilities" }, "notify": { "description": "Should notify owner by email when finished", "type": "boolean" }, "includeUnaffected": { "description": "Should include unaffected dependencies", "type": "boolean" } }, "type": "object" }, "LicenseDataModel": { "properties": { "licenseId": { "description": "Id of license, can be used to get further data on the license.", "type": "int", "example": 1 }, "spdxIdentifier": { "description": "SPDX license identifier, the license name.", "type": "string", "example": "MIT" } }, "type": "object" }, "DependencyHierarchyStatusModel": { "properties": { "status": { "description": "Tells if dependency is direct, indirect or both ", "type": "string", "nullable": true }, "dependencyFoundSources": { "type": "string" } }, "type": "object" }, "RepositoryAndBranchesModel": { "properties": { "repositoryName": { "description": "Name of the repository containing the dependency.", "type": "string" }, "repositoryId": { "description": "Id of the repository containing the dependency.", "type": "int" }, "branches": { "description": "The names and ids of all the branches containing the dependency", "type": "array", "items": { "$ref": "#/components/schemas/BranchModel" } } }, "type": "object" }, "DependencyFile": { "properties": { "id": { "description": "File ID", "type": "integer" }, "name": { "description": "Filename", "type": "string" }, "url": { "description": "File link", "type": "string" } }, "type": "object" }, "DependencyTreeFile": { "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "SelectDependencyDataModel": { "properties": { "lastPublished": { "description": "Date of the latest published version", "type": "string", "nullable": true }, "dependencySummary": { "description": "Brief explaination of the dependency", "type": "string", "nullable": true }, "dependencyLinks": { "$ref": "#/components/schemas/SelectDependencyLinksModel" }, "dependencyTopics": { "description": "Topics of the dependency", "type": "array", "items": { "type": "string" } }, "selectPage": { "description": "Link to the open source select page", "type": "string" }, "packageManager": { "description": "Package manger of the dependency", "type": "string", "nullable": true }, "name": { "description": "Dependency name", "type": "string" } }, "type": "object" }, "SelectDependencyMetricsModel": { "properties": { "popularity": { "description": "Popularity score connected to the dependency", "type": "int" }, "contributors": { "description": "Contributors score connected to the dependency", "type": "int" }, "security": { "description": "Security score connected to the dependency", "type": "int" } }, "type": "object" }, "DependencyInRepoModel": { "properties": { "repositoryId": { "type": "integer" }, "repositoryName": { "type": "string" }, "dependencyId": { "type": "integer" } }, "type": "object" }, "VulnerabilityTimelinesModel": { "properties": { "timelines": { "description": "Multiple timelines for a given CVE.", "type": "array", "items": { "$ref": "#/components/schemas/VulnerabilityTimelineModel" } } }, "type": "object" }, "CreatePullRequestPayload": { "properties": { "commitMessage": { "description": "Commit message to be used", "type": "string", "example": "Fix CVE\u20132021\u201344906" }, "notify": { "description": "Should notify owner by email when finished", "type": "boolean" } }, "type": "object" }, "ReachabilityAnalysisDataResponse": { "properties": { "reachAnalysisLanguage": { "type": "string" }, "reachAnalysisMessage": { "type": "string" }, "reachAnalysis": { "type": "string", "example": "0.5" }, "graphs": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/SignatureDataDTO" } } } } }, "type": "object" }, "GetReachabilityAnalysisRepositoryLinksRequest": { "properties": { "fileIds": { "description": "File IDs which you received from reachability analysis data endpoint.", "type": "array", "items": { "type": "integer" }, "example": [ 1, 2, 3 ] } }, "type": "object" }, "ReachabilityAnalysisRepositoryLinks": { "properties": { "repositoryUrls": { "description": "Repository URLs indexed by their line number, which in turn is indexed by the file IDs. \n You may get less file IDs in return than you requested!", "type": "array", "items": { "type": "string" }, "example": { "1": { "32": "https://github.com/myaccount/myrepo/myfile#L32", "78": "https://github.com/myaccount/myrepo/myfile#L78" }, "2": { "43": "https://github.com/myaccount/myrepo/another-file#L43" }, "3": { "65": "https://github.com/myaccount/myrepo/third-file#L65" } } } }, "type": "object" }, "AddAccessTokenRequest": { "properties": { "adminToken": { "type": "boolean" }, "description": { "type": "string" }, "access": { "type": "array", "items": { "$ref": "#/components/schemas/AccessModel" } } }, "type": "object" }, "UpdateAccessTokenRequest": { "required": [ "tokenId" ], "properties": { "tokenId": { "type": "integer" }, "description": { "type": "string" }, "access": { "type": "array", "items": { "$ref": "#/components/schemas/AccessModel" } }, "noAccess": { "type": "array", "items": { "$ref": "#/components/schemas/AccessModel" } } }, "type": "object" }, "SaveRuleRequest": { "required": [ "conditions" ], "properties": { "repositoryIds": { "description": "The repository ids to create or edit the rule for", "type": "array", "items": { "type": "integer" } }, "ruleIds": { "description": "The rule ids to be edited. Set to null if creating rule.", "type": "array", "items": { "type": "integer" } }, "conditions": { "description": "The conditions that the rule should consist of.", "type": "array", "items": { "$ref": "#/components/schemas/ConditionModel" } }, "failPipeline": { "description": "If the triggering of a rule should fail the pipeline or not.", "type": "boolean" }, "warnPipeline": { "description": "If the triggering of a rule should warn the pipeline or not.", "type": "boolean" }, "markUnaffected": { "description": "If the rule should mark the cve the rule triggered for as unaffected.", "type": "boolean" }, "markVulnerable": { "description": "If the rule should mark the cve the rule triggered for as vulnerable.", "type": "boolean" }, "ignoreIfMarkedUnaffected": { "description": "If the rule should ignore CVEs marked as unaffected when checking rules.", "type": "boolean" }, "notifyEmailAddresses": { "description": "Array of email adresses to notify", "type": "array", "items": { "type": "string" }, "example": [ "abc123@gmail.com", "john.doe@outlook.com" ] }, "notifyRoles": { "description": "Array of user groups to notify", "type": "array", "items": { "type": "string" }, "example": [ "Users", "Admins" ] }, "default": { "description": "If the rule should be created as a default rule or not.", "type": "boolean" }, "webhookUrl": { "description": "The webhook url to send the result to if rule triggers.", "type": "string" }, "webhookSecret": { "description": "The secret for the webhook url.", "type": "string" }, "enableMonitoring": { "description": "If the rule should be monitored or not.", "type": "boolean" } }, "type": "object" }, "SendSampleWebhookRequest": { "required": [ "repositoryIds", "webhookUrl" ], "properties": { "repositoryIds": { "type": "array", "items": { "type": "integer" } }, "ruleIds": { "type": "array", "items": { "type": "integer" } }, "webhookUrl": { "type": "string" }, "webhookSecret": { "type": "string" } }, "type": "object" }, "SendSampleWebhookResponseModel": { "properties": { "ok": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" }, "RuleDataRequest": { "properties": { "repositoryIds": { "type": "array", "items": { "type": "integer" } }, "ruleIds": { "type": "array", "items": { "type": "integer" } }, "locale": { "type": "string" } }, "type": "object" }, "RuleDataResponse": { "properties": { "desc": { "type": "string" }, "repository": { "type": "string" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionModel2" } }, "failPipeline": { "type": "boolean" }, "warnPipeline": { "type": "boolean" }, "markUnaffected": { "type": "boolean" }, "markVulnerable": { "type": "boolean" }, "ignoreIfMarkedUnaffected": { "type": "boolean" }, "notifyEmailAddresses": { "type": "array", "items": { "type": "string" } }, "notifyRoles": { "type": "array", "items": { "type": "string" } }, "webhookUrl": { "type": "string" }, "webhookSecret": { "type": "string" }, "branchOptions": { "type": "array", "items": { "type": "string" } }, "emailAddressOptions": { "type": "array", "items": { "properties": { "email": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } } }, "type": "object" } }, "licenseOptions": { "type": "array", "items": { "type": "string" } }, "licenseFamilyNames": { "type": "array", "items": { "type": "string" } }, "licenseRiskOptions": { "type": "array", "items": { "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "tooltip": { "type": "string" } }, "type": "object" } }, "roleOptions": { "type": "array", "items": { "type": "string" } }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectedPolicyModel" } }, "monitoringEnabled": { "type": "boolean" } }, "type": "object" }, "GenerateRuleRequest": { "required": [ "conditions" ], "properties": { "repositoryIds": { "description": "The repository ids to create or edit the rule for", "type": "array", "items": { "type": "integer" } }, "ruleIds": { "description": "The rule ids to be edited. Set to null if creating rule.", "type": "array", "items": { "type": "integer" } }, "conditions": { "description": "The conditions that the rule should consist of.", "type": "array", "items": { "$ref": "#/components/schemas/ConditionModel" } }, "failPipeline": { "description": "If the triggering of a rule should fail the pipeline or not.", "type": "boolean" }, "warnPipeline": { "description": "If the triggering of a rule should warn the pipeline or not.", "type": "boolean" }, "markUnaffected": { "description": "If the rule should mark the cve the rule triggered for as unaffected.", "type": "boolean" }, "markVulnerable": { "description": "If the rule should mark the cve the rule triggered for as vulnerable.", "type": "boolean" }, "ignoreIfMarkedUnaffected": { "description": "If the rule should ignore CVEs marked as unaffected when checking rules.", "type": "boolean" }, "notifyEmailAddresses": { "description": "Array of email adresses to notify", "type": "array", "items": { "type": "string" }, "example": [ "abc123@gmail.com", "john.doe@outlook.com" ] }, "notifyRoles": { "description": "Array of user groups to notify", "type": "array", "items": { "type": "string" }, "example": [ "Users", "Admins" ] }, "default": { "description": "If the rule should be created as a default rule or not.", "type": "boolean" }, "webhookUrl": { "description": "The webhook url to send the result to if rule triggers.", "type": "string" }, "webhookSecret": { "description": "The secret for the webhook url.", "type": "string" }, "enableMonitoring": { "description": "If the rule should be monitored or not.", "type": "boolean" } }, "type": "object" }, "GenerateRuleResponse": { "properties": { "warnings": { "description": "Warnings to be beware of if activating this rule", "type": "array", "items": { "$ref": "#/components/schemas/GenerateRuleWarningsModel" } }, "description": { "description": "The description of the successfully generated rule", "type": "string" }, "invalidWebhookUrl": { "description": "If the provided webhook url was invalid or not.", "type": "boolean" }, "errorConditionText": { "description": "If the provided webhook url was invalid or not.", "type": "string" }, "errorConditionIndex": { "description": "If the provided webhook url was invalid or not.", "type": "integer" } }, "type": "object" }, "GetRulesResponse": { "properties": { "ruleGroups": { "type": "array", "items": { "$ref": "#/components/schemas/RuleGroupModel" } }, "totalRules": { "type": "integer" }, "isBitbucketIntegration": { "type": "boolean" } }, "type": "object" }, "RulesRequest": { "properties": { "ruleIds": { "description": "Automation rule IDs", "type": "array", "items": { "type": "integer" } } }, "type": "object" }, "SetActiveRequest": { "properties": { "ruleIds": { "description": "Automation rule IDs", "type": "array", "items": { "type": "integer" } }, "active": { "description": "activate/deactivate rules", "type": "boolean" } }, "type": "object" }, "PolicyModel": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Example Policy" }, "repositoryIds": { "type": "array", "items": { "type": "integer" }, "example": [ 1, 2, 3 ] }, "ruleIds": { "type": "array", "items": { "type": "integer" }, "example": [ 1, 2, 3 ] }, "uniqueCount": { "type": "integer", "example": 1 }, "uniqueRuleIds": { "type": "array", "items": { "type": "integer" }, "example": [ 1, 2, 3 ] }, "useCase": { "type": "integer", "enum": "AppBundle\\Entity\\Service\\UseCaseEnum" } }, "type": "object" }, "EditPolicyRequest": { "properties": { "repositoryIds": { "description": "The repositories to apply the policy for", "type": "array", "items": { "type": "integer" } }, "ruleIds": { "description": "The rules to be added to this policy", "type": "array", "items": { "type": "integer" } }, "name": { "description": "Name of the policy", "type": "string", "maxLength": 30, "minLength": 1 }, "useCase": { "description": "The chosen use case", "type": "integer", "enum": "AppBundle\\Entity\\Service\\UseCaseEnum" } }, "type": "object" }, "PolicyRequest": { "properties": { "repositoryIds": { "description": "The repositories to apply the policy for", "type": "array", "items": { "type": "integer" } }, "ruleIds": { "description": "The rules to be added to this policy", "type": "array", "items": { "type": "integer" } }, "name": { "description": "Name of the policy", "type": "string", "maxLength": 30, "minLength": 1 }, "useCase": { "description": "The chosen use case", "type": "integer", "enum": "AppBundle\\Entity\\Service\\UseCaseEnum" } }, "type": "object" }, "SearchPoliciesRequest": { "properties": { "repositoryIds": { "description": "Repositories to filter the results by", "type": "array", "items": { "type": "integer" } }, "name": { "description": "Search by policy name", "type": "string" } }, "type": "object" }, "DependencyVersionAndLicensesModel": { "properties": { "isDependencyLicenseApproved": { "type": "bool", "example": true }, "dependencyLicenses": { "type": "array", "items": { "$ref": "#/components/schemas/DependencyLicenseModel" } }, "globalDependencyLicenses": { "type": "array", "items": { "$ref": "#/components/schemas/DependencyLicenseModel" } }, "dependencyId": { "type": "int", "example": 1 }, "dependencyVersionId": { "type": "int", "example": 1 }, "name": { "type": "string", "example": "lodash" }, "version": { "type": "string", "example": "1.2.3" }, "dependencyScope": { "description": "Should be any of the integer values from Enum DependencyScopeEnum", "type": "int", "example": "DependencyScopeEnum::PROD_DEPENDENCY->value" } }, "type": "object" }, "LicenseDataModelWithExtraData": { "properties": { "licenseId": { "description": "Id of license, can be used to get further data on the license.", "type": "int", "example": 1 }, "spdxIdentifier": { "description": "SPDX license identifier, the license name.", "type": "string", "example": "MIT" }, "licenseType": { "type": "string", "example": "Automatically found", "nullable": true }, "licenseFamily": { "type": "string", "example": "Permissive" }, "licenseUrls": { "type": "array", "items": { "type": "string" }, "example": [ "https://debrickedcore.com/npm-@debricked/core/MIT", "https://debrickedcore.com/npm-@debricked/core/Apache-2.0" ] }, "licenseRisk": { "oneOf": [ { "$ref": "#/components/schemas/LicenseRiskModel" } ], "nullable": true } }, "type": "object" }, "SaveDependencyLicensesRequest": { "properties": { "licenseIds": { "description": "The licenseIds you want to change to for this dependency and version", "type": "array", "items": { "type": "integer" } }, "isDependencyLicenseApproved": { "description": "Sets the approval status of licenses for a dependency ", "type": "boolean" } }, "type": "object" }, "AccessModel": { "required": [ "roleId" ], "properties": { "repoId": { "type": "integer" }, "roleId": { "type": "integer" } }, "type": "object" }, "BranchModel": { "properties": { "branchName": { "description": "Name of the branch containing the dependency.", "type": "string" }, "branchId": { "description": "Id of the branch containing the dependency.", "type": "int" } }, "type": "object" }, "SelectDependencyLinksModel": { "properties": { "homePage": { "description": "Home page url of the dependency", "type": "string" }, "packageUrl": { "description": "Package manager url", "type": "string", "nullable": true }, "docsUrl": { "description": "Documentation url", "type": "string", "nullable": true }, "repositoryUrl": { "description": "Repository url", "type": "string", "nullable": true } }, "type": "object" }, "VulnerabilityTimelineModel": { "properties": { "dependencies": { "description": "Details about dependencies with the given timeline", "type": "array", "items": { "$ref": "#/components/schemas/DependencyDetailsDataModel" } }, "intervals": { "description": "Version intervals composing the timeline", "type": "array", "items": { "$ref": "#/components/schemas/VulnerabilityTimelineIntervalModel" } } }, "type": "object" }, "SignatureDataDTO": { "properties": { "fileName": { "type": "string" }, "fileId": { "type": "integer" }, "startLine": { "type": "integer" }, "endLine": { "type": "integer" }, "className": { "type": "string" }, "functionName": { "type": "string" }, "isApplicationClass": { "type": "boolean" }, "isStdLibClass": { "type": "boolean" }, "lineNumberCall": { "type": "integer" } }, "type": "object" }, "ConditionModel": { "required": [ "subject", "op" ], "properties": { "subject": { "description": "The type of object the rule checks", "type": "string", "enum": [ "vulnerability", "dependency", "branch", "cvss", "rule", "license", "licenseFamily", "licenseRisk", "vulnerabilityDiscoveredDate", "securityScore", "contributorScore", "popularityScore", "scope", "licenseReviewStatus", "dependencyDepth", "cve", "dependencyAge", "dependencyVersion" ], "example": { "0": "vulnerability", "1": "dependency", "2": "branch", "3": "cvss", "5": "rule", "6": "license", "7": "licenseFamily", "8": "licenseRisk", "9": "vulnerabilityDiscoveredDate", "10": "securityScore", "11": "contributorScore", "12": "popularityScore", "13": "scope", "14": "licenseReviewStatus", "15": "dependencyDepth", "16": "cve", "17": "dependencyAge", "18": "dependencyVersion" } }, "op": { "description": "The operation to perform when checking the condition.", "type": "string", "enum": [ "is", "less", "greater", "is_not", "untriggered", "is_more_than" ], "example": [ "is", "less", "greater", "is_not", "untriggered", "is_more_than" ] }, "value": { "description": "The operation to perform when checking the condition.", "type": "array", "items": { "type": "string" }, "example": [ [ "untriggered_vulnerability", "untriggered_dependency", "untriggered_vulnerability_in_dependency", "low", "medium", "high", "critical", "missing", "new", "existing", "vulnerable" ] ] }, "conj": { "description": "The conjunction to perform with a previous condition.", "type": "string", "enum": [ "and", "or" ], "example": [ "and", "or" ] } }, "type": "object" }, "ConditionModel2": { "properties": { "subject": { "type": "string" }, "op": { "type": "string" }, "conj": { "type": "string" } }, "type": "object" }, "ConnectedPolicyModel": { "properties": { "policyId": { "type": "integer" }, "policyUseCase": { "$ref": "#/components/schemas/UseCaseEnum" } }, "type": "object" }, "GenerateRuleWarningsModel": { "properties": { "message": { "type": "string" }, "ruleIds": { "type": "string" } }, "type": "object" }, "RuleGroupModel": { "properties": { "repositoryIds": { "type": "array", "items": { "type": "integer" } }, "ruleIds": { "type": "array", "items": { "type": "integer" } }, "defaultRuleIds": { "type": "array", "items": { "type": "integer" } }, "desc": { "type": "string" }, "active": { "type": "boolean" }, "updatedAt": { "type": "integer" }, "updatedBy": { "type": "string" }, "updatedType": { "type": "string" }, "actions": { "type": "array", "items": { "type": "string" } }, "selectedPolicyId": { "type": "integer" }, "monitoringEnabled": { "type": "boolean" } }, "type": "object" }, "DependencyLicenseModel": { "properties": { "dependencyLicenseId": { "type": "integer", "example": 1 }, "license": { "$ref": "#/components/schemas/LicenseDataModelWithExtraData" } }, "type": "object" }, "LicenseRiskModel": { "properties": { "type": { "type": "int", "example": 6 }, "text": { "type": "string", "example": "Unknown" }, "description": { "type": "string", "example": "Unknown risk" } }, "type": "object" }, "DependencyDetailsDataModel": { "properties": { "name": { "type": "string" }, "shortName": { "type": "string" }, "link": { "type": "string" } }, "type": "object" }, "VulnerabilityTimelineIntervalModel": { "properties": { "vulnerable": { "type": "boolean" }, "startVersion": { "type": "string" }, "endVersion": { "type": "string" } }, "type": "object" }, "UseCaseEnum": { "type": "integer", "enum": [ 0, 1, 2, 3, 4 ] } }, "responses": { "forbidden": { "description": "Returned when you do not have access to current operation" }, "unauthorized": { "description": "Returned when authorisation fails, such as missing JWT-token, insufficient privileges or expired JWT-token. Look at the response body's message to know exactly what went wrong." }, "bad_request": { "description": "Returned when required data is missing or given data is invalid. Look at the response body's message to know exactly what went wrong." }, "gone": { "description": "This response is sent when the requested content has been permanently deleted from server, with no forwarding address." }, "unprocessable_content": { "description": "This response status code indicates that the server understands the content type of the request entity, and that there's no validation errors, but it was unable to process the contained instructions." }, "ok": { "description": "Returned when successful." } }, "parameters": { "table_page": { "name": "page", "in": "query", "description": "Which page to show results for, starting at 1", "required": false, "schema": { "type": "integer", "default": 1 } }, "table_rows_per_page": { "name": "rowsPerPage", "in": "query", "description": "Amount of rows per page", "required": false, "schema": { "type": "integer", "default": 25 } }, "table_order": { "name": "order", "in": "query", "description": "Sorting order, asc or desc", "required": true, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, "search": { "name": "search", "in": "query", "description": "What to search for", "required": false, "schema": { "type": "string", "default": "" } }, "group_id": { "name": "group", "in": "query", "description": "Group ID to select from", "required": false, "schema": { "type": "integer" } }, "repository_id": { "name": "repositoryId", "in": "path", "description": "The ID of the repository in question", "required": true, "schema": { "type": "integer" } }, "branch_id": { "name": "branchId", "in": "path", "description": "The ID of a specific desired branch", "required": true, "schema": { "type": "integer" } }, "dependency_id": { "name": "dependencyId", "in": "path", "description": "The ID of a specific desired dependency", "required": true, "schema": { "type": "integer" } } }, "securitySchemes": { "JWT": { "type": "apiKey", "description": "The token you get from: \"curl -X POST https://debricked.com/api/login_check -d _username=YOUR_USERNAME -d _password=YOUR_PASSWORD\", prefixed with \"Bearer\". Example value: \"Bearer YOUR_VERY_LONG_TOKEN\"", "name": "Authorization", "in": "header" } } }, "security": [ { "JWT": [] } ] }