Subscribe to this changelog: add
https://docs.semgrep.dev/api-reference/v2/Changelog/rss.xml to any
feed reader, or run /feed subscribe https://docs.semgrep.dev/api-reference/v2/Changelog/rss.xml in Slack to post new
entries to a channel. Most readers also accept this page’s own URL and
find the feed automatically.Potentially breaking changes
Changes
| Change | Description | Endpoint |
|---|---|---|
| Removed | removed the optional property resolutionConfigs.perSubproject.additionalProperties.systemPackages from the response with the 200 status | GET /api |
| Change | Description | Endpoint |
|---|---|---|
| Added | added the new ACTION_TYPE_AI_AUTOTRIAGE enum value to the type request and response property | GET /api GET /api POST /api |
| Added | added the optional property buckets[].scanningUsers to the response with the 200 status | POST /api |
Changes
| Change | Description | Endpoint |
|---|---|---|
| Added | added the optional property repo.latestScan.isFullScan to the response with the 200 status | PATCH /api |
| Added | added the optional property repo.latestWorkflow to the response with the 200 status | PATCH /api |
| Added | added the optional property repo.workflowAvailability to the response with the 200 status | PATCH /api |
| Added | added the optional property repo.latestScan.isFullScan to the response with the 202 status | POST /api |
| Added | added the optional property repo.latestWorkflow to the response with the 202 status | POST /api |
| Added | added the optional property repo.workflowAvailability to the response with the 202 status | POST /api |
| Added | added the optional property brioFindings[].projectedAttributes.sca to the response with the 200 status | POST /api |
Breaking changes
Changes
| Change | Description | Endpoint |
|---|---|---|
| Removed | api path removed without deprecation | POST /api |
| Change | Description | Endpoint |
|---|---|---|
| Added | added the optional property data.issueUrl to the response with the 200 status | GET /api POST /api |
| Added | added the optional property history[].newValues.issueUrl to the response with the 200 status | GET /api |
| Added | added the optional property history[].oldValues.issueUrl to the response with the 200 status | GET /api |
| Added | added the optional property issues[].issueUrl to the response with the 200 status | POST /api |
| Removed | removed the schema protos.ai.v1.CreatePatternFixTaskRequest | — |
| Removed | removed the schema protos.ai.v1.CreatePatternFixTaskResponse | — |
Changes
| Change | Description | Endpoint |
|---|---|---|
| Added | added the new TRIGGER_SOURCE_MALWARE_FIREWALL_EXCEPTION_REQUEST enum value to the triggerSource request and response property | GET /api GET /api POST /api |
Breaking changesChanges
| Change | Description | Endpoint |
|---|---|---|
| Added | added the optional property repo.deletionPending to the response with the 200 status | PATCH /api |
| Removed | removed the REPO_SCOPE_ASSIGN_TEAM enum value from the repo.authorizedScopes response property for the response status 200 | PATCH /api |
| Removed | removed the REPO_SCOPE_AUTOINSTALL enum value from the repo.authorizedScopes response property for the response status 200 | PATCH /api |
| Removed | removed the REPO_SCOPE_DELETE_PROJECT enum value from the repo.authorizedScopes response property for the response status 200 | PATCH /api |
| Removed | removed the REPO_SCOPE_MANAGE_PROJECT_SETTINGS enum value from the repo.authorizedScopes response property for the response status 200 | PATCH /api |
| Removed | removed the REPO_SCOPE_READ_FINDING enum value from the repo.authorizedScopes response property for the response status 200 | PATCH /api |
| Removed | removed the REPO_SCOPE_TRIAGE_FINDING enum value from the repo.authorizedScopes response property for the response status 200 | PATCH /api |
| Removed | removed the REPO_SCOPE_UNSPECIFIED enum value from the repo.authorizedScopes[] response property for the response status 200 | PATCH /api |
| Added | added the optional property repo.deletionPending to the response with the 202 status | POST /api |
| Removed | removed the REPO_SCOPE_ASSIGN_TEAM enum value from the repo.authorizedScopes response property for the response status 202 | POST /api |
| Removed | removed the REPO_SCOPE_AUTOINSTALL enum value from the repo.authorizedScopes response property for the response status 202 | POST /api |
| Removed | removed the REPO_SCOPE_DELETE_PROJECT enum value from the repo.authorizedScopes response property for the response status 202 | POST /api |
| Removed | removed the REPO_SCOPE_MANAGE_PROJECT_SETTINGS enum value from the repo.authorizedScopes response property for the response status 202 | POST /api |
| Removed | removed the REPO_SCOPE_READ_FINDING enum value from the repo.authorizedScopes response property for the response status 202 | POST /api |
| Removed | removed the REPO_SCOPE_TRIAGE_FINDING enum value from the repo.authorizedScopes response property for the response status 202 | POST /api |
| Removed | removed the REPO_SCOPE_UNSPECIFIED enum value from the repo.authorizedScopes[] response property for the response status 202 | POST /api |
| Added | the endpoint scheme security SemgrepWebToken was added to the API | GET /api |
| Added | the endpoint scheme security SemgrepWebToken was added to the API | GET /api |
| Added | the endpoint scheme security SemgrepWebToken was added to the API | GET /api |
| Removed | removed the TEAM_SCOPE_DIRECT_MEMBER enum value from the teams[].authorizedScopes response property for the response status 200 | POST /api |
| Removed | removed the TEAM_SCOPE_MANAGE enum value from the teams[].authorizedScopes response property for the response status 200 | POST /api |
| Removed | removed the TEAM_SCOPE_UNSPECIFIED enum value from the teams[].authorizedScopes[] response property for the response status 200 | POST /api |
| Removed | removed the TEAM_SCOPE_DIRECT_MEMBER enum value from the team.authorizedScopes response property for the response status 200 | GET /api PATCH /api POST /api |
| Removed | removed the TEAM_SCOPE_MANAGE enum value from the team.authorizedScopes response property for the response status 200 | GET /api PATCH /api POST /api |
| Removed | removed the TEAM_SCOPE_UNSPECIFIED enum value from the team.authorizedScopes[] response property for the response status 200 | GET /api PATCH /api POST /api |
| Added | the endpoint scheme security SemgrepWebToken was added to the API | POST /api |
| Removed | removed the PRODUCT_AI_SAST enum value from the scans[].enabledProducts response property for the response status 200 | POST /api |
| Removed | removed the PRODUCT_SAST enum value from the scans[].enabledProducts response property for the response status 200 | POST /api |
| Removed | removed the PRODUCT_SCA enum value from the scans[].enabledProducts response property for the response status 200 | POST /api |
| Removed | removed the PRODUCT_SECRETS enum value from the scans[].enabledProducts response property for the response status 200 | POST /api |
| Removed | removed the PRODUCT_UNSPECIFIED enum value from the scans[].enabledProducts[] response property for the response status 200 | POST /api |
| Removed | removed the PRODUCT_AI_SAST enum value from the scan.enabledProducts response property for the response status 200 | GET /api |
| Removed | removed the PRODUCT_SAST enum value from the scan.enabledProducts response property for the response status 200 | GET /api |
| Removed | removed the PRODUCT_SCA enum value from the scan.enabledProducts response property for the response status 200 | GET /api |
| Removed | removed the PRODUCT_SECRETS enum value from the scan.enabledProducts response property for the response status 200 | GET /api |
| Removed | removed the PRODUCT_UNSPECIFIED enum value from the scan.enabledProducts[] response property for the response status 200 | GET /api |
Changes
| Change | Description | Endpoint |
|---|---|---|
| Added | added the new ACTION_TYPE_APPROVE_PR enum value to the type request and response property | GET /api GET /api POST /api |
| Added | added the optional property brioFindings[].triagePermission to the response with the 200 status | POST /api |
| Added | added the optional property projects[].branchFindings[].repositoryRefId to the response with the 200 status | POST /api |
| Added | added the optional property projects[].repositoryId to the response with the 200 status | POST /api |
| Added | added the optional property workflows[].phases to the response with the 200 status | GET /api |
| Added | added the optional property workflows[].productSkus to the response with the 200 status | GET /api |
Changes
| Change | Description | Endpoint |
|---|---|---|
| Added | added the new HISTORY_TYPE_CLICK_TO_FIX_PR_CLOSED, HISTORY_TYPE_CLICK_TO_FIX_PR_REOPENED enum values to the historyType response property | GET /api POST /api POST /api |
| Added | added the new optional request property filters.detectionTypes | POST /api POST /api POST /api |
Changes
| Change | Description | Endpoint |
|---|---|---|
| Deprecated | response property issues[].issue.relatedIssues deprecated | POST /api |
| Changed | the issues[].issue.relatedIssues[].id response’s property format was narrowed from none to int64 for status 200 | POST /api |
| Deprecated | response property relatedIssues deprecated | GET /api |
| Changed | the relatedIssues[].id response’s property format was narrowed from none to int64 for status 200 | GET /api |
| Added | endpoint added | GET /api |
| Deprecated | response property findings[].relatedIssues deprecated | POST /api |
| Changed | the findings[].relatedIssues[].id response’s property format was narrowed from none to int64 for status 200 | POST /api |
Changes
| Change | Description | Endpoint |
|---|---|---|
| Added | added the optional property metadata.workflowRevision to the response with the 200 status | GET /api |
Changes
| Change | Description | Endpoint |
|---|---|---|
| Added | added the optional property products.ai.manualProviderSelectionAvailable to the response with the 200 status | GET /api PUT /api |
| Added | added the optional property products.secrets.custom_validator_hosts to the response with the 200 status | GET /api PUT /api |
| Added | added the optional property products.secrets.custom_validators_available to the response with the 200 status | GET /api PUT /api |
| Added | added the optional property products.smsProduct to the response with the 200 status | GET /api |
Changes
| Change | Description | Endpoint |
|---|---|---|
| Added | endpoint added | GET /api |
| Added | added the optional property instances[].integrationId to the response with the 200 status | GET /api |
| Added | added the optional property repositorySummaries[].isScmArchived to the response with the 200 status | POST /api |
| Added | added the optional property repositorySummaries[].isSemgrepArchived to the response with the 200 status | POST /api |
| Added | added the optional property projects[].isScmArchived to the response with the 200 status | POST /api |
| Added | added the optional property projects[].isSemgrepArchived to the response with the 200 status | POST /api |
| Added | added the optional property project.isScmArchived to the response with the 200 status | DELETE /api GET /api |
| Added | added the optional property project.isSemgrepArchived to the response with the 200 status | DELETE /api GET /api |
Changes
Changes
| Change | Description | Endpoint |
|---|---|---|
| Added | added the optional property issues[].issue.exceptionRequest.reviewerNote to the response with the 200 status | POST /api |
| Added | added the optional property exceptionRequest.reviewerNote to the response with the 200 status | GET /api |
| Added | added the optional property packageManagerConfigsWithCredentials[].config.basePath to the response with the 200 status | GET /api |
| Added | added the new optional request property packageManagerConfigForInsert.config.basePath | PATCH /api POST /api |
| Added | added the optional property packageManagerConfig.basePath to the response with the 200 status | PATCH /api POST /api |
| Added | added the optional property findings[].exceptionRequest.reviewerNote to the response with the 200 status | POST /api |
| Added | added the new AUTOFIX_ERROR_TYPE_PERMISSION_DENIED enum value to the errors[].errorType response property for the response status 200 | POST /api |
Changes
| Change | Description | Endpoint |
|---|---|---|
| Added | added the optional property workflows[].supportsPr to the response with the 200 status | GET /api |
Potentially breaking changes
Changes
| Change | Description | Endpoint |
|---|---|---|
| Removed | removed the optional property issues[].issue.codeowners from the response with the 200 status | POST /api |
| Removed | removed the optional property codeowners from the response with the 200 status | GET /api |
| Removed | removed the optional property findings[].codeowners from the response with the 200 status | POST /api |
| Change | Description | Endpoint |
|---|---|---|
| Removed | removed the schema protos.ai.v1.Codeowner | — |
Breaking changes
Changes
| Change | Description | Endpoint |
|---|---|---|
| Removed | api path removed without deprecation | GET /api |
| Removed | api path removed without deprecation | GET /api |
| Removed | api path removed without deprecation | GET /api |
| Removed | api path removed without deprecation | GET /api |
| Removed | api path removed without deprecation | GET /api |
| Removed | api path removed without deprecation | GET /api |
| Removed | api path removed without deprecation | GET /api |
| Removed | api path removed without deprecation | GET /api |
| Removed | api path removed without deprecation | GET /api |
| Removed | api path removed without deprecation | GET /api |
| Removed | api path removed without deprecation | PATCH /api |
| Removed | api path removed without deprecation | GET /api |
| Removed | api path removed without deprecation | POST /api |
| Removed | api path removed without deprecation | GET /api |
| Removed | api path removed without deprecation | PUT /api |
| Removed | api path removed without deprecation | GET /api |
| Removed | api path removed without deprecation | PATCH /api |
| Removed | api path removed without deprecation | POST /api |
| Removed | api path removed without deprecation | GET /api |
| Removed | api path removed without deprecation | POST /api |
| Removed | api path removed without deprecation | GET /api |
| Removed | api path removed without deprecation | GET /api |
| Removed | api path removed without deprecation | POST /api |
| Change | Description | Endpoint |
|---|---|---|
| Added | added the new SCM_TYPE_CODE_STORAGE, SCM_TYPE_CURSOR_ORIGIN enum values to the type request and response property | GET /api GET /api PATCH /api |
| Added | added the optional property repo.tokenScopes.readChecks to the response with the 200 status | PATCH /api |
| Added | added the optional property repo.tokenScopes.writeChecks to the response with the 200 status | PATCH /api |
| Added | added the optional property repo.tokenScopes.readChecks to the response with the 202 status | POST /api |
| Added | added the optional property repo.tokenScopes.writeChecks to the response with the 202 status | POST /api |
| Added | endpoint added | POST /api |
| Added | endpoint added | POST /api |
| Added | endpoint added | POST /api |
| Added | endpoint added | GET /api |
| Added | added the new optional request property note | POST /api |
| Added | endpoint added | POST /api |
| Added | added the optional property teams[].scimManaged to the response with the 200 status | POST /api |
| Added | added the optional property team.scimManaged to the response with the 200 status | GET /api PATCH /api POST /api |
| Added | added the optional property configs[].providerAppId to the response with the 200 status | GET /api POST /api |
| Added | added the optional property configs[].providerInstallationId to the response with the 200 status | GET /api POST /api |
| Added | added the optional property configs[].tokenScopes.readChecks to the response with the 200 status | GET /api POST /api |
| Added | added the optional property configs[].tokenScopes.writeChecks to the response with the 200 status | GET /api POST /api |
| Added | added the optional property configs[].usesSharedApp to the response with the 200 status | GET /api POST /api |
| Added | added the optional property config.providerAppId to the response with the 201 status | POST /api |
| Added | added the optional property config.providerInstallationId to the response with the 201 status | POST /api |
| Added | added the optional property config.tokenScopes.readChecks to the response with the 201 status | POST /api |
| Added | added the optional property config.tokenScopes.writeChecks to the response with the 201 status | POST /api |
| Added | added the optional property config.usesSharedApp to the response with the 201 status | POST /api |
| Added | added the new optional request property privateKey | PATCH /api POST /api |
| Added | added the new optional request property providerAppId | PATCH /api POST /api |
| Added | added the new optional request property providerInstallationId | PATCH /api POST /api |
| Added | added the optional property config.providerAppId to the response with the 200 status | PATCH /api |
| Added | added the optional property config.providerInstallationId to the response with the 200 status | PATCH /api |
| Added | added the optional property config.tokenScopes.readChecks to the response with the 200 status | PATCH /api |
| Added | added the optional property config.tokenScopes.writeChecks to the response with the 200 status | PATCH /api |
| Added | added the optional property config.usesSharedApp to the response with the 200 status | PATCH /api |
| Added | added the optional property tokenScopes.readChecks to the response with the 200 status | GET /api |
| Added | added the optional property tokenScopes.writeChecks to the response with the 200 status | GET /api |
| Added | added the new SCM_TYPE_CODE_STORAGE, SCM_TYPE_CURSOR_ORIGIN enum values to the scmType request and response property | DELETE /api GET /api GET /api |
| Added | added the optional property hasBranchTarget to the response with the 200 status | GET /api |
| Added | added the optional property hasPrTarget to the response with the 200 status | GET /api |
| Removed | removed the schema protos.auth.v1.DeploymentIdentity | — |
| Removed | removed the schema protos.auth.v1.DeploymentSsoProvider | — |
| Removed | removed the schema protos.auth.v1.GetUserResponse | — |
| Removed | removed the schema protos.auth.v1.GetUserSettingsResponse | — |
| Removed | removed the schema protos.auth.v1.ListDeploymentSsoProvidersResponse | — |
| Removed | removed the schema protos.auth.v1.ListUserAuthorizedResourcesResponse | — |
| Removed | removed the schema protos.auth.v1.ListUserJoinableOrgsResponse | — |
| Removed | removed the schema protos.auth.v1.ListUserOrgsResponse | — |
| Removed | removed the schema protos.auth.v1.OpenIdProviderData | — |
| Removed | removed the schema protos.auth.v1.PatchUserSettingsRequest | — |
| Removed | removed the schema protos.auth.v1.PatchUserSettingsResponse | — |
| Removed | removed the schema protos.auth.v1.Saml2ProviderData | — |
| Removed | removed the schema protos.auth.v1.SimpleProviderData | — |
| Removed | removed the schema protos.auth.v1.SsoProvider | — |
| Removed | removed the schema protos.auth.v1.TourStateEntry | — |
| Removed | removed the schema protos.auth.v1.UserAuthDetails | — |
| Removed | removed the schema protos.auth.v1.UserEmail | — |
| Removed | removed the schema protos.auth.v1.UserSettings | — |
| Removed | removed the schema protos.auth.v1.User | — |
| Removed | removed the schema protos.feature_rollout.v1.FeatureRollout | — |
| Removed | removed the schema protos.feature_rollout.v1.ListAvailableFeatureRolloutsResponse | — |
| Removed | removed the schema protos.issues.api.SearchIssuesRequest | — |
| Removed | removed the schema protos.issues.api.SearchIssuesResponse | — |
| Removed | removed the schema protos.misc.v1.GetIpResponse | — |
| Removed | removed the schema protos.misc.v1.GetPingResponse | — |
| Removed | removed the schema protos.misc.v1.GetTenantResponse | — |
| Removed | removed the schema protos.misc.v1.HealthCheckResponse | — |
| Removed | removed the schema protos.misc.v1.ReadinessCheckResponse | — |
| Removed | removed the schema protos.notifications.v1.GetNotificationsResponse | — |
| Removed | removed the schema protos.notifications.v1.MarkNotificationsAsSeenRequest | — |
| Removed | removed the schema protos.notifications.v1.MarkNotificationsAsSeenResponse | — |
| Removed | removed the schema protos.notifications.v1.Notification | — |
| Removed | removed the schema protos.onboarding.v1.GetChecklistStatusResponse | — |
| Removed | removed the schema protos.onboarding.v1.InviteMembersRequest | — |
| Removed | removed the schema protos.onboarding.v1.InviteMembersResponse | — |
| Removed | removed the schema protos.onboarding.v1.OnboardingTask | — |
| Removed | removed the schema protos.onboarding.v1.PatchChecklistRequest | — |
| Removed | removed the schema protos.onboarding.v1.PatchChecklistResponse | — |
| Removed | removed the schema protos.support.v1.CreateSupportCaseRequest | — |
| Removed | removed the schema protos.support.v1.CreateSupportCaseResponse | — |
| Removed | removed the schema protos.support.v1.ListSupportCasesResponse | — |
| Removed | removed the schema protos.support.v1.SupportCase | — |
| Removed | removed the schema protos.survey.v1.CreateSurveyResponseRequest | — |
| Removed | removed the schema protos.survey.v1.CreateSurveyResponseResponse | — |
| Removed | removed the schema protos.survey.v1.GetSurveyResponseResponse | — |
| Removed | removed the schema protos.survey.v1.SurveyResponse | — |
Breaking changes
| Change | Description | Endpoint |
|---|---|---|
| Added | added the new required header request parameter if-match | PUT /api |
Changes
| Change | Description | Endpoint |
|---|---|---|
| Added | added the optional property gitSha to the response with the 200 status | GET /api |
| Added | endpoint added | GET /api |
| Added | endpoint added | GET /api |
| Added | endpoint added | POST /api |
| Added | endpoint added | GET /api |
| Added | endpoint added | POST /api |
Changes
| Change | Description | Endpoint |
|---|---|---|
| Added | added the optional property byProject.additionalProperties.projectId to the response with the 200 status | POST /api POST /api |
Changes
| Change | Description | Endpoint |
|---|---|---|
| Added | added the new optional request property filters.latestScanStatus | PATCH /api POST /api POST /api |
Potentially breaking changes
Changes
| Change | Description | Endpoint |
|---|---|---|
| Removed | removed the optional property products.sast.autofix_pr_enabled from the response with the 200 status | GET /api PUT /api |
| Removed | removed the request property sast.autofix_pr_enabled | PUT /api |
| Change | Description | Endpoint |
|---|---|---|
| Added | added the new TRIGGER_SOURCE_PATCH_READY enum value to the triggerSource request and response property | GET /api GET /api POST /api |
| Added | added the new enum value TOKEN_ROLE_READ_ONLY to the query request parameter roleFilter | DELETE /api |
Changes
Potentially breaking changes
Changes
| Change | Description | Endpoint |
|---|---|---|
| Removed | removed the optional property instances[].transitionStates from the response with the 200 status | GET /api |
| Change | Description | Endpoint |
|---|---|---|
| Added | added the optional property errorDetail to the response with the 200 status | POST /api POST /api |
| Added | added the new FIX_JOB_ERROR_TYPE_AI_PROVIDER_NOT_ALLOWED, FIX_JOB_ERROR_TYPE_ARCHIVED_REPOSITORY, FIX_JOB_ERROR_TYPE_AUTOFIX_DISABLED, FIX_JOB_ERROR_TYPE_GROUPING_DISABLED, FIX_JOB_ERROR_TYPE_INVALID_GROUP, FIX_JOB_ERROR_TYPE_NON_PRIMARY_BRANCH_DISABLED, FIX_JOB_ERROR_TYPE_UNSUPPORTED_ISSUE_TYPE enum values to the errors[].errorType response property for the response status 200 | POST /api |
| Added | added the optional property products.ai.mdr_enabled to the response with the 200 status | GET /api PUT /api |
| Added | added the optional property automations[].actions[].id to the response with the 200 status | GET /api GET /api |
| Added | added the new optional request property automation.actions[].id | POST /api PUT /api |
| Added | added the optional property automation.actions[].id to the response with the 200 status | POST /api PUT /api |
| Added | added the optional property instances[].fixedTransitionState to the response with the 200 status | GET /api |
Changes
| Change | Description | Endpoint |
|---|---|---|
| Added | added the new TOUR_ID_WORKFLOWS_ACTIVATION enum value to the id request and response property | GET /api PATCH /api |
| Added | added the new WorkflowsActivationBanner enum value to the request property eventSource | PATCH /api |
Changes
| Change | Description | Endpoint |
|---|---|---|
| Added | added the new CONDITION_TYPE_BREAKING_CHANGE, CONDITION_TYPE_FULL_SCAN enum values to the type request and response property | GET /api GET /api POST /api |
| Added | added the new TRIGGER_SOURCE_UPGRADE_GUIDANCE enum value to the triggerSource request and response property | GET /api GET /api POST /api |
Potentially breaking changes
Changes
| Change | Description | Endpoint |
|---|---|---|
| Deprecated | endpoint deprecated | GET /api |
| Deprecated | endpoint deprecated | GET /api |
| Deprecated | endpoint deprecated | PUT /api |