{"webServices":[{"path":"api/alm_integrations","since":"8.2","description":"Manage DevOps Platform Integrations","actions":[{"key":"import_azure_project","description":"Create a SonarQube project with the information from the provided Azure DevOps project.\u003cbr/\u003eAutoconfigure pull request decoration mechanism.\u003cbr/\u003eRequires the \u0027Create Projects\u0027 permission","since":"8.6","deprecatedSince":"10.5","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"This endpoint is deprecated, please use its API v2 version /api/v2/dop-translation/bound-projects","version":"10.5"},{"description":"Parameter almSetting becomes optional if you have only one configuration for Azure","version":"10.3"},{"description":"Endpoint visibility change from internal to public","version":"10.3"}],"params":[{"key":"almSetting","description":"DevOps Platform configuration key. This parameter is optional if you have only one Azure integration.","required":false,"internal":false,"maximumLength":200},{"key":"newCodeDefinitionType","description":"Project New Code Definition Type\u003cbr/\u003eNew code definitions of the following types are allowed:\u003cul\u003e\u003cli\u003ePREVIOUS_VERSION\u003c/li\u003e\u003cli\u003eNUMBER_OF_DAYS\u003c/li\u003e\u003cli\u003eREFERENCE_BRANCH - will default to the main branch.\u003c/li\u003e\u003c/ul\u003e","since":"10.1","required":false,"internal":false},{"key":"newCodeDefinitionValue","description":"Project New Code Definition Value\u003cbr/\u003eFor each new code definition type, a different value is expected:\u003cul\u003e\u003cli\u003eno value, when the new code definition type is PREVIOUS_VERSION and REFERENCE_BRANCH\u003c/li\u003e\u003cli\u003ea number between 1 and 90, when the new code definition type is NUMBER_OF_DAYS\u003c/li\u003e\u003c/ul\u003e","since":"10.1","required":false,"internal":false},{"key":"projectName","description":"Azure project name","required":true,"internal":false,"maximumLength":200},{"key":"repositoryName","description":"Azure repository name","required":true,"internal":false,"maximumLength":200}]},{"key":"import_bitbucketcloud_repo","description":"Create a SonarQube project with the information from the provided Bitbucket Cloud repository.\u003cbr/\u003eAutoconfigure pull request decoration mechanism.\u003cbr/\u003eRequires the \u0027Create Projects\u0027 permission","since":"9.0","deprecatedSince":"10.5","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"This endpoint is deprecated, please use its API v2 version /api/v2/dop-translation/bound-projects","version":"10.5"},{"description":"Parameter almSetting becomes optional if you have only one configuration for BitBucket Cloud","version":"10.3"},{"description":"Endpoint visibility change from internal to public","version":"10.3"}],"params":[{"key":"almSetting","description":"DevOps Platform configuration key. This parameter is optional if you have only one BitBucket Cloud integration.","required":false,"internal":false,"maximumLength":200},{"key":"newCodeDefinitionType","description":"Project New Code Definition Type\u003cbr/\u003eNew code definitions of the following types are allowed:\u003cul\u003e\u003cli\u003ePREVIOUS_VERSION\u003c/li\u003e\u003cli\u003eNUMBER_OF_DAYS\u003c/li\u003e\u003cli\u003eREFERENCE_BRANCH - will default to the main branch.\u003c/li\u003e\u003c/ul\u003e","since":"10.1","required":false,"internal":false},{"key":"newCodeDefinitionValue","description":"Project New Code Definition Value\u003cbr/\u003eFor each new code definition type, a different value is expected:\u003cul\u003e\u003cli\u003eno value, when the new code definition type is PREVIOUS_VERSION and REFERENCE_BRANCH\u003c/li\u003e\u003cli\u003ea number between 1 and 90, when the new code definition type is NUMBER_OF_DAYS\u003c/li\u003e\u003c/ul\u003e","since":"10.1","required":false,"internal":false},{"key":"repositorySlug","description":"Bitbucket Cloud repository slug","required":true,"internal":false,"maximumLength":200}]},{"key":"import_bitbucketserver_project","description":"Create a SonarQube project with the information from the provided BitbucketServer project.\u003cbr/\u003eAutoconfigure pull request decoration mechanism.\u003cbr/\u003eRequires the \u0027Create Projects\u0027 permission","since":"8.2","deprecatedSince":"10.5","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"This endpoint is deprecated, please use its API v2 version /api/v2/dop-translation/bound-projects","version":"10.5"},{"description":"Parameter almSetting becomes optional if you have only one configuration for BitBucket Server","version":"10.3"},{"description":"Endpoint visibility change from internal to public","version":"10.3"}],"params":[{"key":"almSetting","description":"DevOps Platform configuration key. This parameter is optional if you have only one BitBucket Server integration.","required":false,"internal":false,"maximumLength":200},{"key":"newCodeDefinitionType","description":"Project New Code Definition Type\u003cbr/\u003eNew code definitions of the following types are allowed:\u003cul\u003e\u003cli\u003ePREVIOUS_VERSION\u003c/li\u003e\u003cli\u003eNUMBER_OF_DAYS\u003c/li\u003e\u003cli\u003eREFERENCE_BRANCH - will default to the main branch.\u003c/li\u003e\u003c/ul\u003e","since":"10.1","required":false,"internal":false},{"key":"newCodeDefinitionValue","description":"Project New Code Definition Value\u003cbr/\u003eFor each new code definition type, a different value is expected:\u003cul\u003e\u003cli\u003eno value, when the new code definition type is PREVIOUS_VERSION and REFERENCE_BRANCH\u003c/li\u003e\u003cli\u003ea number between 1 and 90, when the new code definition type is NUMBER_OF_DAYS\u003c/li\u003e\u003c/ul\u003e","since":"10.1","required":false,"internal":false},{"key":"projectKey","description":"BitbucketServer project key","required":true,"internal":false,"maximumLength":200},{"key":"repositorySlug","description":"BitbucketServer repository slug","required":true,"internal":false,"maximumLength":200}]},{"key":"import_github_project","description":"Create a SonarQube project with the information from the provided GitHub repository.\u003cbr/\u003eAutoconfigure pull request decoration mechanism. If Automatic Provisioning is enable for GitHub, it will also synchronize permissions from the repository.\u003cbr/\u003eRequires the \u0027Create Projects\u0027 permission","since":"8.4","deprecatedSince":"10.5","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"This endpoint is deprecated, please use its API v2 version /api/v2/dop-translation/bound-projects","version":"10.5"},{"description":"Parameter organization is not necessary anymore","version":"10.3"},{"description":"Parameter almSetting becomes optional if you have only one configuration for GitHub","version":"10.3"},{"description":"Endpoint visibility change from internal to public","version":"10.3"}],"params":[{"key":"almSetting","description":"DevOps Platform configuration key. This parameter is optional if you have only one GitHub integration.","required":false,"internal":false,"maximumLength":200},{"key":"newCodeDefinitionType","description":"Project New Code Definition Type\u003cbr/\u003eNew code definitions of the following types are allowed:\u003cul\u003e\u003cli\u003ePREVIOUS_VERSION\u003c/li\u003e\u003cli\u003eNUMBER_OF_DAYS\u003c/li\u003e\u003cli\u003eREFERENCE_BRANCH - will default to the main branch.\u003c/li\u003e\u003c/ul\u003e","since":"10.1","required":false,"internal":false},{"key":"newCodeDefinitionValue","description":"Project New Code Definition Value\u003cbr/\u003eFor each new code definition type, a different value is expected:\u003cul\u003e\u003cli\u003eno value, when the new code definition type is PREVIOUS_VERSION and REFERENCE_BRANCH\u003c/li\u003e\u003cli\u003ea number between 1 and 90, when the new code definition type is NUMBER_OF_DAYS\u003c/li\u003e\u003c/ul\u003e","since":"10.1","required":false,"internal":false},{"key":"repositoryKey","description":"GitHub repository key (organization/repoSlug","required":true,"internal":false,"maximumLength":256}]},{"key":"import_gitlab_project","description":"Import a GitLab project to SonarQube, creating a new project and configuring MR decoration\u003cbr/\u003eRequires the \u0027Create Projects\u0027 permission","since":"8.5","deprecatedSince":"10.5","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"This endpoint is deprecated, please use its API v2 version /api/v2/dop-translation/bound-projects","version":"10.5"},{"description":"Parameter almSetting becomes optional if you have only one configuration for GitLab","version":"10.3"}],"params":[{"key":"almSetting","description":"DevOps Platform configuration key. This parameter is optional if you have only one GitLab integration.","required":false,"internal":false},{"key":"gitlabProjectId","description":"GitLab project ID","required":true,"internal":false},{"key":"newCodeDefinitionType","description":"Project New Code Definition Type\u003cbr/\u003eNew code definitions of the following types are allowed:\u003cul\u003e\u003cli\u003ePREVIOUS_VERSION\u003c/li\u003e\u003cli\u003eNUMBER_OF_DAYS\u003c/li\u003e\u003cli\u003eREFERENCE_BRANCH - will default to the main branch.\u003c/li\u003e\u003c/ul\u003e","since":"10.1","required":false,"internal":false},{"key":"newCodeDefinitionValue","description":"Project New Code Definition Value\u003cbr/\u003eFor each new code definition type, a different value is expected:\u003cul\u003e\u003cli\u003eno value, when the new code definition type is PREVIOUS_VERSION and REFERENCE_BRANCH\u003c/li\u003e\u003cli\u003ea number between 1 and 90, when the new code definition type is NUMBER_OF_DAYS\u003c/li\u003e\u003c/ul\u003e","since":"10.1","required":false,"internal":false}]},{"key":"list_azure_projects","description":"List Azure projects\u003cbr/\u003eRequires the \u0027Create Projects\u0027 permission","since":"8.6","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"almSetting","description":"DevOps Platform setting key","required":true,"internal":false,"maximumLength":200}]},{"key":"list_bitbucketserver_projects","description":"List the Bitbucket Server projects\u003cbr/\u003eRequires the \u0027Create Projects\u0027 permission","since":"8.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"almSetting","description":"DevOps Platform setting key","required":true,"internal":false,"maximumLength":200},{"key":"pageSize","description":"Number of items to return.","required":false,"internal":false,"defaultValue":"25","maximumValue":100},{"key":"start","description":"Start number for the page (inclusive). If not passed, the first page is assumed.","required":false,"internal":false,"exampleValue":"2154"}]},{"key":"search_azure_repos","description":"Search the Azure repositories\u003cbr/\u003eRequires the \u0027Create Projects\u0027 permission","since":"8.6","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"almSetting","description":"DevOps Platform setting key","required":true,"internal":false,"maximumLength":200},{"key":"projectName","description":"Project name filter","required":false,"internal":false,"maximumLength":200},{"key":"searchQuery","description":"Search query filter","required":false,"internal":false,"maximumLength":200}]},{"key":"search_bitbucketcloud_repos","description":"Search the Bitbucket Cloud repositories\u003cbr/\u003eRequires the \u0027Create Projects\u0027 permission","since":"9.0","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"almSetting","description":"DevOps Platform setting key","required":true,"internal":false,"maximumLength":200},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 100","required":false,"internal":false,"defaultValue":"20","exampleValue":"20","maximumValue":100},{"key":"repositoryName","description":"Repository name filter","required":false,"internal":false,"maximumLength":200}]},{"key":"search_bitbucketserver_repos","description":"Search the Bitbucket Server repositories with REPO_ADMIN access\u003cbr/\u003eRequires the \u0027Create Projects\u0027 permission","since":"8.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"almSetting","description":"DevOps Platform setting key","required":true,"internal":false,"maximumLength":200},{"key":"pageSize","description":"Number of items to return.","required":false,"internal":false,"defaultValue":"25","maximumValue":100},{"key":"projectName","description":"Project name filter","required":false,"internal":false,"maximumLength":200},{"key":"repositoryName","description":"Repository name filter","required":false,"internal":false,"maximumLength":200},{"key":"start","description":"Start number for the page (inclusive). If not passed, the first page is assumed.","required":false,"internal":false,"exampleValue":"2154"}]},{"key":"search_gitlab_repos","description":"Search the GitLab projects.\u003cbr/\u003eRequires the \u0027Create Projects\u0027 permission","since":"8.5","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"almSetting","description":"DevOps Platform setting key","required":true,"internal":false,"maximumLength":200},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"projectName","description":"Project name filter","required":false,"internal":false,"maximumLength":200},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 100","required":false,"internal":false,"defaultValue":"20","exampleValue":"20","maximumValue":100}]},{"key":"set_pat","description":"Set a Personal Access Token for the given DevOps Platform setting\u003cbr/\u003eRequires the \u0027Create Projects\u0027 permission","since":"8.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Allow setting Personal Access Tokens for all DevOps platforms","version":"10.3"},{"description":"Parameter almSetting becomes optional if you have only one DevOps Platform configuration","version":"10.3"},{"description":"Bitbucket Cloud support and optional Username parameter were added","version":"9.0"}],"params":[{"key":"almSetting","description":"DevOps Platform configuration key. This parameter is optional if you have only one single DevOps Platform integration.","required":false,"internal":false},{"key":"pat","description":"Personal Access Token","required":true,"internal":false,"maximumLength":2000},{"key":"username","description":"Username","required":false,"internal":false,"maximumLength":2000}]}]},{"path":"api/alm_settings","since":"8.1","description":"Manage DevOps Platform Settings","actions":[{"key":"count_binding","description":"Count number of project bound to an DevOps Platform setting.\u003cbr/\u003eRequires the \u0027Administer System\u0027 permission","since":"8.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"almSetting","description":"DevOps Platform setting key","required":true,"internal":false}]},{"key":"create_azure","description":"Create Azure instance Setting. \u003cbr/\u003eRequires the \u0027Administer System\u0027 permission","since":"8.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Parameter \u0027url\u0027 is now rejected with a 400 response when it is not a valid absolute HTTP(S) URL","version":"2026.5"},{"description":"Parameter \u0027URL\u0027 was added","version":"8.6"}],"params":[{"key":"key","description":"Unique key of the Azure Devops instance setting","required":true,"internal":false,"maximumLength":200},{"key":"personalAccessToken","description":"Azure Devops personal access token","required":true,"internal":false,"maximumLength":2000},{"key":"url","description":"Azure API URL. Must be a valid absolute HTTP(S) URL, e.g. https://dev.azure.com/myorg","required":true,"internal":false,"maximumLength":2000}]},{"key":"create_bitbucket","description":"Create Bitbucket instance Setting. \u003cbr/\u003eRequires the \u0027Administer System\u0027 permission","since":"8.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"key","description":"Unique key of the Bitbucket instance setting","required":true,"internal":false,"maximumLength":200},{"key":"personalAccessToken","description":"Bitbucket personal access token","required":true,"internal":false,"maximumLength":2000},{"key":"url","description":"BitBucket server API URL","required":true,"internal":false,"maximumLength":2000}]},{"key":"create_bitbucketcloud","description":"Configure a new instance of Bitbucket Cloud. \u003cbr/\u003eRequires the \u0027Administer System\u0027 permission","since":"8.7","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"clientId","description":"Bitbucket Cloud Client ID","required":true,"internal":false,"maximumLength":2000},{"key":"clientSecret","description":"Bitbucket Cloud Client Secret","required":true,"internal":false,"maximumLength":2000},{"key":"key","description":"Unique key of the Bitbucket Cloud setting","required":true,"internal":false,"maximumLength":200},{"key":"workspace","description":"Bitbucket Cloud workspace ID","required":true,"internal":false}]},{"key":"create_github","description":"Create GitHub instance Setting. \u003cbr/\u003eRequires the \u0027Administer System\u0027 permission","since":"8.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Optional parameter \u0027webhookSecret\u0027 was added","version":"9.7"}],"params":[{"key":"appId","description":"GitHub App ID","required":true,"internal":false,"maximumLength":80},{"key":"clientId","description":"GitHub App Client ID","required":true,"internal":false,"maximumLength":80},{"key":"clientSecret","description":"GitHub App Client Secret","required":true,"internal":false,"maximumLength":160},{"key":"key","description":"Unique key of the GitHub instance setting","required":true,"internal":false,"maximumLength":200},{"key":"privateKey","description":"GitHub App private key","required":true,"internal":false,"maximumLength":2500},{"key":"url","description":"GitHub API URL","required":true,"internal":false,"maximumLength":2000},{"key":"webhookSecret","description":"GitHub App Webhook Secret","required":false,"internal":false,"maximumLength":160}]},{"key":"create_gitlab","description":"Create GitLab instance Setting. \u003cbr/\u003eRequires the \u0027Administer System\u0027 permission","since":"8.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Parameter \u0027URL\u0027 was added","version":"8.2"}],"params":[{"key":"key","description":"Unique key of the GitLab instance setting","required":true,"internal":false,"maximumLength":200},{"key":"personalAccessToken","description":"GitLab personal access token","required":true,"internal":false,"maximumLength":2000},{"key":"url","description":"GitLab API URL","required":true,"internal":false,"maximumLength":2000}]},{"key":"delete","description":"Delete an DevOps Platform Setting.\u003cbr/\u003eRequires the \u0027Administer System\u0027 permission","since":"8.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"key","description":"DevOps Platform Setting key","required":true,"internal":false}]},{"key":"delete_binding","description":"Delete the DevOps Platform binding of a project.\u003cbr/\u003eRequires the \u0027Administer\u0027 permission on the project","since":"8.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"project","description":"Project key","required":true,"internal":false}]},{"key":"get_binding","description":"Get DevOps Platform binding of a given project.\u003cbr/\u003eRequires the \u0027Browse\u0027 permission on the project","since":"8.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"GitHub and GitLab bindings now contain a slug field with the repository\u0027s full name or path","version":"2026.5"},{"description":"Bitbucket Cloud and Bitbucket Server bindings now contain a repositoryUrl field with the URL to the repository","version":"2026.5"},{"description":"GitHub, GitLab and Azure bindings now contain a repositoryUrl field with the URL to the repository","version":"2025.6"},{"description":"Azure binding now contains a inlineAnnotationsEnabled flag for inline annotations feature","version":"2025.1"},{"description":"Permission needed changed from \u0027Administer\u0027 to \u0027Browse\u0027","version":"10.1"},{"description":"Azure binding now contains a monorepo flag for monorepo feature in Enterprise Edition and above","version":"8.7"},{"description":"Azure binding now contains the project and repository names","version":"8.6"}],"params":[{"key":"project","description":"Project key","required":true,"internal":false}]},{"key":"list","description":"List DevOps Platform setting available for a given project, sorted by DevOps Platform key\u003cbr/\u003eRequires the \u0027Administer project\u0027 permission if the \u0027project\u0027 parameter is provided, requires the \u0027Create Projects\u0027 permission otherwise.","since":"8.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Field \u0027URL\u0027 added for Azure definitions","version":"8.6"},{"description":"Permission needed changed to \u0027Administer project\u0027 or \u0027Create Projects\u0027","version":"8.3"},{"description":"Permission needed changed from \u0027Administer project\u0027 to \u0027Create Projects\u0027","version":"8.2"}],"params":[{"key":"project","description":"Project key","required":false,"internal":false}]},{"key":"list_definitions","description":"List DevOps Platform Settings, sorted by created date.\u003cbr/\u003eRequires the \u0027Administer System\u0027 permission","since":"8.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Fields \u0027personalAccessToken\u0027, \u0027privateKey\u0027, and \u0027clientSecret\u0027 are no longer returned","version":"8.7"},{"description":"Field \u0027URL\u0027 added for Azure definitions","version":"8.6"},{"description":"Field \u0027URL\u0027 added for GitLab definitions","version":"8.2"}]},{"key":"set_azure_binding","description":"Bind a Azure DevOps instance to a project.\u003cbr/\u003eIf the project was already bound to a previous Azure DevOps instance, the binding will be updated to the new one.Requires the \u0027Administer\u0027 permission on the project","since":"8.1","deprecatedSince":"2026.5","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"This endpoint is deprecated, please use POST api/v2/dop-translation/bound-projects instead. Parameters \u0027projectName\u0027 and \u0027repositoryName\u0027 are now rejected with a 400 response when they contain any of the Azure DevOps reserved characters: \\ / : \u003c \u003e | ? *","version":"2026.5"},{"description":"Add inline annotations parameter","version":"2025.1"}],"params":[{"key":"almSetting","description":"Azure DevOps setting key","required":true,"internal":false},{"key":"inlineAnnotationsEnabled","description":"Enable inline annotations during Pull Request decoration for this project","since":"2025.1","required":false,"internal":false,"defaultValue":"true"},{"key":"monorepo","description":"Is this project part of a monorepo","since":"8.7","required":true,"internal":false},{"key":"project","description":"SonarQube project key","required":true,"internal":false},{"key":"projectName","description":"Azure project name. Must not contain any of the Azure DevOps reserved characters: \\ / : \u003c \u003e | ? *","since":"8.6","required":true,"internal":false},{"key":"repositoryName","description":"Azure repository name. Must not contain any of the Azure DevOps reserved characters: \\ / : \u003c \u003e | ? *","since":"8.6","required":true,"internal":false}]},{"key":"set_bitbucket_binding","description":"Bind a Bitbucket instance to a project.\u003cbr/\u003eIf the project was already bound to a previous Bitbucket instance, the binding will be updated to the new one.Requires the \u0027Administer\u0027 permission on the project","since":"8.1","deprecatedSince":"2026.5","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"This endpoint is deprecated, please use POST api/v2/dop-translation/bound-projects instead","version":"2026.5"}],"params":[{"key":"almSetting","description":"Bitbucket Server setting key","required":true,"internal":false},{"key":"monorepo","description":"Is this project part of a monorepo","since":"8.7","required":true,"internal":false},{"key":"project","description":"Project key","required":true,"internal":false},{"key":"repository","description":"Bitbucket Server repository key","required":true,"internal":false},{"key":"slug","description":"Bitbucket repository slug","required":true,"internal":false}]},{"key":"set_bitbucketcloud_binding","description":"Bind a Bitbucket Cloud setting to a project.\u003cbr/\u003eIf the project was already bound to a different Bitbucket Cloud setting, the binding will be updated to the new one.Requires the \u0027Administer\u0027 permission on the project","since":"8.7","deprecatedSince":"2026.5","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"This endpoint is deprecated, please use POST api/v2/dop-translation/bound-projects instead","version":"2026.5"}],"params":[{"key":"almSetting","description":"Bitbucket Cloud setting key","required":true,"internal":false},{"key":"monorepo","description":"Is this project part of a monorepo","since":"8.8","required":true,"internal":false},{"key":"project","description":"Project key","required":true,"internal":false},{"key":"repository","description":"Bitbucket Cloud repository key","required":true,"internal":false}]},{"key":"set_github_binding","description":"Bind a GitHub instance to a project.\u003cbr/\u003eIf the project was already bound to a previous GitHub instance, the binding will be updated to the new one.Requires the \u0027Administer\u0027 permission on the project","since":"8.1","deprecatedSince":"2026.5","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"This endpoint is deprecated, please use POST api/v2/dop-translation/bound-projects instead","version":"2026.5"},{"description":"Add \u0027summaryCommentEnabled\u0027 param to enable/disable of putting analysis summary in a conversation tab of GitHub","version":"8.3"}],"params":[{"key":"almSetting","description":"GitHub setting key","required":true,"internal":false},{"key":"monorepo","description":"Is this project part of a monorepo","since":"8.7","required":true,"internal":false},{"key":"project","description":"Project key","required":true,"internal":false},{"key":"repository","description":"GitHub Repository","required":true,"internal":false,"maximumLength":256},{"key":"summaryCommentEnabled","description":"Enable/disable summary in PR discussion tab","required":false,"internal":false,"defaultValue":"true"}]},{"key":"set_gitlab_binding","description":"Bind a GitLab instance to a project.\u003cbr/\u003eIf the project was already bound to a previous Gitlab instance, the binding will be updated to the new one.Requires the \u0027Administer\u0027 permission on the project","since":"8.1","deprecatedSince":"2026.5","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"This endpoint is deprecated, please use POST api/v2/dop-translation/bound-projects instead","version":"2026.5"},{"description":"Parameter \u0027repository\u0027 was added","version":"8.2"}],"params":[{"key":"almSetting","description":"GitLab setting key","required":true,"internal":false},{"key":"monorepo","description":"Is this project part of a monorepo","since":"8.7","required":true,"internal":false},{"key":"project","description":"Project key","required":true,"internal":false},{"key":"repository","description":"GitLab project ID","required":true,"internal":false}]},{"key":"update_azure","description":"Update Azure instance Setting. \u003cbr/\u003eRequires the \u0027Administer System\u0027 permission","since":"8.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Parameter \u0027url\u0027 is now rejected with a 400 response when its value changes and is not a valid absolute HTTP(S) URL","version":"2026.5"},{"description":"Parameter \u0027personalAccessToken\u0027 is no longer required","version":"8.7"},{"description":"Parameter \u0027URL\u0027 was added","version":"8.6"}],"params":[{"key":"key","description":"Unique key of the Azure instance setting","required":true,"internal":false,"maximumLength":200},{"key":"newKey","description":"Optional new value for an unique key of the Azure Devops instance setting","required":false,"internal":false,"maximumLength":200},{"key":"personalAccessToken","description":"Azure Devops personal access token","required":false,"internal":false,"maximumLength":2000},{"key":"url","description":"Azure API URL. Must be a valid absolute HTTP(S) URL, e.g. https://dev.azure.com/myorg. The format is only enforced when the value differs from the currently stored URL, so existing pre-validation settings can still be updated without fixing the URL first.","required":true,"internal":false,"maximumLength":2000}]},{"key":"update_bitbucket","description":"Update Bitbucket instance Setting. \u003cbr/\u003eRequires the \u0027Administer System\u0027 permission","since":"8.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Parameter \u0027personalAccessToken\u0027 is no longer required","version":"8.7"}],"params":[{"key":"key","description":"Unique key of the Bitbucket instance setting","required":true,"internal":false,"maximumLength":200},{"key":"newKey","description":"Optional new value for an unique key of the Bitbucket instance setting","required":false,"internal":false,"maximumLength":200},{"key":"personalAccessToken","description":"Bitbucket personal access token","required":false,"internal":false,"maximumLength":2000},{"key":"url","description":"Bitbucket API URL","required":true,"internal":false,"maximumLength":2000}]},{"key":"update_bitbucketcloud","description":"Update Bitbucket Cloud Setting. \u003cbr/\u003eRequires the \u0027Administer System\u0027 permission","since":"8.7","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"clientId","description":"Bitbucket Cloud Client ID","required":true,"internal":false,"maximumLength":80},{"key":"clientSecret","description":"Optional new value for the Bitbucket Cloud client secret","required":false,"internal":false,"maximumLength":160},{"key":"key","description":"Unique key of the Bitbucket Cloud setting","required":true,"internal":false,"maximumLength":200},{"key":"newKey","description":"Optional new value for an unique key of the Bitbucket Cloud setting","required":false,"internal":false,"maximumLength":200},{"key":"workspace","description":"Bitbucket Cloud workspace ID","required":true,"internal":false,"maximumLength":80}]},{"key":"update_github","description":"Update GitHub instance Setting. \u003cbr/\u003eRequires the \u0027Administer System\u0027 permission","since":"8.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Optional parameter \u0027webhookSecret\u0027 was added","version":"9.7"},{"description":"Parameter \u0027privateKey\u0027 is no longer required","version":"8.7"},{"description":"Parameter \u0027clientSecret\u0027 is no longer required","version":"8.7"}],"params":[{"key":"appId","description":"GitHub API ID","required":true,"internal":false,"maximumLength":80},{"key":"clientId","description":"GitHub App Client ID","required":true,"internal":false,"maximumLength":80},{"key":"clientSecret","description":"GitHub App Client Secret","required":false,"internal":false,"maximumLength":160},{"key":"key","description":"Unique key of the GitHub instance setting","required":true,"internal":false,"maximumLength":200},{"key":"newKey","description":"Optional new value for an unique key of the GitHub instance setting","required":false,"internal":false,"maximumLength":200},{"key":"privateKey","description":"GitHub App private key","required":false,"internal":false,"maximumLength":2500},{"key":"url","description":"GitHub API URL","required":true,"internal":false,"maximumLength":2000},{"key":"webhookSecret","description":"GitHub App Webhook Secret","required":false,"internal":false,"maximumLength":160}]},{"key":"update_gitlab","description":"Update GitLab instance Setting. \u003cbr/\u003eRequires the \u0027Administer System\u0027 permission","since":"8.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Parameter \u0027personalAccessToken\u0027 is no longer required","version":"8.7"},{"description":"Parameter \u0027URL\u0027 was added","version":"8.2"}],"params":[{"key":"key","description":"Unique key of the GitLab instance setting","required":true,"internal":false,"maximumLength":200},{"key":"newKey","description":"Optional new value for an unique key of the GitLab instance setting","required":false,"internal":false,"maximumLength":200},{"key":"personalAccessToken","description":"GitLab personal access token","required":false,"internal":false,"maximumLength":2000},{"key":"url","description":"GitLab API URL","required":true,"internal":false,"maximumLength":2000}]},{"key":"validate","description":"Validate an DevOps Platform Setting by checking connectivity and permissions\u003cbr/\u003eRequires the \u0027Administer System\u0027 permission","since":"8.6","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"key","description":"Unique key of the DevOps Platform settings","required":true,"internal":false,"maximumLength":200}]}]},{"path":"api/analysis_cache","since":"9.4","description":"Access the analysis cache","actions":[{"key":"get","description":"Get the scanner\u0027s cached data for a branch. Requires scan permission on the project. Data is returned gzipped if the corresponding \u0027Accept-Encoding\u0027 header is set in the request.","since":"9.4","internal":false,"post":false,"hasResponseExample":false,"contentType":"BINARY","changelog":[{"description":"The web service is no longer internal","version":"9.9"}],"params":[{"key":"branch","description":"Branch key. If not provided, main branch will be used.","required":false,"internal":false,"exampleValue":"feature/my_branch"},{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"}]}]},{"path":"api/applications","since":"7.2","description":"Manage applications.","actions":[{"key":"add_project","description":"Add a project to an application.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the application","since":"7.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"application","description":"Key of the application","required":true,"internal":false},{"key":"project","description":"Key of the project","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"create","description":"Create a new application.\u003cbr/\u003eRequires \u0027Administer System\u0027 permission or \u0027Create Applications\u0027 permission","since":"7.3","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"This web service is using the \u0027Create Applications\u0027 permission","version":"7.4"}],"params":[{"key":"description","description":"Application description","required":false,"internal":false,"maximumLength":256},{"key":"key","description":"Application key. A suitable key will be generated if not provided","required":false,"internal":false,"maximumLength":400},{"key":"name","description":"Application name","required":true,"internal":false,"maximumLength":256},{"key":"visibility","description":"Whether the created application should be visible to everyone, or only specific user/groups.\u003cbr/\u003eIf no visibility is specified, the default visibility will be used.","required":false,"internal":false,"possibleValues":["private","public"]}]},{"key":"create_branch","description":"Create a new branch on a given application.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the application and \u0027Browse\u0027 permission on its child projects","since":"7.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"application","description":"Application key","required":true,"internal":false},{"key":"branch","description":"Branch name","required":true,"internal":false,"maximumLength":255},{"key":"project","description":"Project keys. To set several values, the parameter must be called once for each value.","required":true,"internal":false,"exampleValue":"project\u003dfirstProjectKey\u0026project\u003dsecondProjectKey\u0026project\u003dthirdProjectKey"},{"key":"projectBranch","description":"Project branches. To set main branch, provide an empty value. To set several values, the parameter must be called once for each value.","required":true,"internal":false,"exampleValue":"projectBranch\u003d\u0026projectBranch\u003dbranch-2.0\u0026projectBranch\u003dbranch-2.1"}]},{"key":"delete","description":"Delete an application definition.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the application","since":"7.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"application","description":"Application key","required":true,"internal":false}]},{"key":"delete_branch","description":"Delete a branch on a given application.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the application","since":"7.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"application","description":"Application key","required":true,"internal":false},{"key":"branch","description":"Branch name","required":true,"internal":false}]},{"key":"remove_project","description":"Remove a project from an application\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the application","since":"7.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"application","description":"Key of the application","required":true,"internal":false},{"key":"project","description":"Key of the project","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"set_tags","description":"Set tags on a application.\u003cbr\u003eRequires the following permission: \u0027Administer\u0027 rights on the specified application","since":"8.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"application","description":"Application key","required":true,"internal":false},{"key":"tags","description":"Comma-separated list of tags","required":true,"internal":false,"exampleValue":"finance, offshore"}]},{"key":"show","description":"Returns an application and its associated projects. \u003cbr\u003e Requires the \u0027Browse\u0027 permission on the application and on its child projects.","since":"7.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Change required permission from \u0027Admin\u0027 to \u0027Browse\u0027","version":"8.3"}],"params":[{"key":"application","description":"Application key","required":true,"internal":false,"exampleValue":"my_application"},{"key":"branch","description":"Branch name","required":false,"internal":false,"exampleValue":"branch-2.0"}]},{"key":"update","description":"Update an application.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the application","since":"7.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"application","description":"Application key","required":true,"internal":false},{"key":"description","description":"New description for the application","required":false,"internal":false,"maximumLength":256},{"key":"name","description":"New name for the application","required":true,"internal":false,"maximumLength":256}]},{"key":"update_branch","description":"Update a branch on a given application.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the application and \u0027Browse\u0027 permission on its child projects","since":"7.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"application","description":"Application key","required":true,"internal":false,"exampleValue":"my_application"},{"key":"branch","description":"Branch name","required":true,"internal":false,"exampleValue":"branch-2.0"},{"key":"name","description":"New branch name","required":true,"internal":false,"maximumLength":255},{"key":"project","description":"Project keys. To set several values, the parameter must be called once for each value.","required":true,"internal":false,"exampleValue":"project\u003dfirstProjectKey\u0026project\u003dsecondProjectKey\u0026project\u003dthirdProjectKey"},{"key":"projectBranch","description":"Project branches. To set main branch, provide an empty value. To set several values, the parameter must be called once for each value.","required":true,"internal":false,"exampleValue":"projectBranch\u003d\u0026projectBranch\u003dbranch-2.0\u0026projectBranch\u003dbranch-2.1"}]}]},{"path":"api/audit_logs","since":"9.1","description":"Manage Audit logs","actions":[{"key":"download","description":"Returns security related audits of this SonarQube instance. Logs are returned in JSON format.\u003cbr/\u003eRequires the system administration permission\u003cbr/\u003e","since":"9.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Fields \u0027permissionUuid\u0027, \u0027componentUuid\u0027, \u0027groupUuid\u0027, \u0027permissionTemplateUuid\u0027,\n\u0027devOpsPlatformSettingUuid\u0027, \u0027qualityGateUuid\u0027, \u0027patUuid\u0027, \u0027userUuid\u0027, \u0027pluginUuid\u0027, \u0027webhookUuid\u0027, \u0027tokenUuid\u0027 in response are\nnow deprecated.","version":"10.2"},{"description":"Field \u0027userTriggered\u0027 added to the response payload.","version":"9.5"}],"params":[{"key":"from","description":"Date in ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hh:mm) from which the logs will be returned. Inclusive.","required":true,"internal":false},{"key":"to","description":"Date in ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hh:mm) until which the logs will be returned. Inclusive.","required":true,"internal":false}]}]},{"path":"api/authentication","description":"Handle authentication.","actions":[{"key":"login","description":"Authenticate a user.","since":"6.0","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"login","description":"Login of the user","required":true,"internal":false},{"key":"password","description":"Password of the user","required":true,"internal":false}]},{"key":"logout","description":"Logout a user.","since":"6.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[]},{"key":"validate","description":"Check credentials.","since":"3.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[]}]},{"path":"api/ce","description":"Get information on Compute Engine tasks.","actions":[{"key":"activity","description":"Search for tasks.\u003cbr\u003e Requires the system administration permission, or project administration permission if component is set.","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"field \"infoMessages\" added to response","version":"10.4"},{"description":"The use of module keys in parameter \u0027component\u0027 is removed","version":"10.1"},{"description":"Warnings field will be now be filled (it was always empty in the past).","version":"10.1"},{"description":"Remove deprecated field \u0027componentId\u0027","version":"10.0"},{"description":"field \"logs\" is dropped","version":"8.8"},{"description":"The use of module keys in parameters \u0027q\u0027 is deprecated","version":"7.6"},{"description":"field \"pullRequest\" added","version":"7.1"},{"description":"fields \"branch\" and \"branchType\" added","version":"6.6"},{"description":"field \"logs\" is deprecated and its value is always false","version":"6.1"},{"description":"it\u0027s no more possible to specify the page parameter.","version":"5.5"}],"params":[{"key":"component","description":"Key of the component (project) to filter on","since":"8.0","required":false,"internal":false,"exampleValue":"projectKey"},{"key":"maxExecutedAt","description":"Maximum date of end of task processing (inclusive)","required":false,"internal":false,"exampleValue":"2017-10-19T13:00:00+0200"},{"key":"minSubmittedAt","description":"Minimum date of task submission (inclusive)","required":false,"internal":false,"exampleValue":"2017-10-19T13:00:00+0200"},{"key":"onlyCurrents","description":"Filter on the last tasks (only the most recent finished task by project)","required":false,"internal":false,"defaultValue":"false","possibleValues":["true","false","yes","no"]},{"key":"p","description":"1-based page number","since":"9.4","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 1000","required":false,"internal":false,"defaultValue":"100","exampleValue":"20","maximumValue":1000},{"key":"q","description":"Limit search to: \u003cul\u003e\u003cli\u003ecomponent names that contain the supplied string\u003c/li\u003e\u003cli\u003ecomponent keys that are exactly the same as the supplied string\u003c/li\u003e\u003cli\u003etask ids that are exactly the same as the supplied string\u003c/li\u003e\u003c/ul\u003e","since":"5.5","required":false,"internal":false,"exampleValue":"Apache"},{"key":"status","description":"Comma separated list of task statuses","required":false,"internal":false,"defaultValue":"SUCCESS,FAILED,CANCELED","exampleValue":"IN_PROGRESS,SUCCESS","possibleValues":["SUCCESS","FAILED","CANCELED","PENDING","IN_PROGRESS"]},{"key":"type","description":"Task type","required":false,"internal":false,"exampleValue":"REPORT","possibleValues":["REPORT","ISSUE_SYNC","AUDIT_PURGE","HISTORY_PURGE","PROJECT_EXPORT","A3S_FRONTEND_CONTEXT_ZIP_PROCESSOR","APP_REFRESH","SCA_RESCAN_BRANCH","PROJECT_IMPORT","VIEW_REFRESH","REPORT_SUBMIT","GITHUB_AUTH_PROVISIONING","GITHUB_PROJECT_PERMISSIONS_PROVISIONING","GITLAB_AUTH_PROVISIONING","GITLAB_PROJECT_PERMISSIONS_PROVISIONING","SANDBOX_DEFERRAL_REOPEN"]}]},{"key":"activity_status","description":"Returns CE activity related metrics.\u003cbr\u003eRequires \u0027Administer System\u0027 permission or \u0027Administer\u0027 rights on the specified project.","since":"5.5","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Remove deprecated field \u0027componentId\u0027","version":"10.0"},{"description":"Parameter \u0027componentId\u0027 is now deprecated.","version":"8.8"},{"description":"Parameter \u0027componentKey\u0027 is now removed. Please use parameter \u0027component\u0027 instead.","version":"8.8"},{"description":"New field \u0027pendingTime\u0027 in response, only included when there are pending tasks","version":"7.8"},{"description":"New field \u0027inProgress\u0027 in response","version":"6.6"}],"params":[{"key":"component","description":"Key of the component (project) to filter on","required":false,"internal":false,"exampleValue":"my_project"}]},{"key":"component","description":"Get the pending tasks, in-progress tasks and the last executed task of a given component (usually a project).\u003cbr\u003eRequires the following permission: \u0027Browse\u0027 on the specified component.","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"field \"logs\" is dropped","version":"8.8"},{"description":"Deprecated parameter \u0027componentId\u0027 has been removed.","version":"8.8"},{"description":"Parameter \u0027component\u0027 is now required.","version":"8.8"},{"description":"The use of module keys in parameter \"component\" is deprecated","version":"7.6"},{"description":"fields \"branch\" and \"branchType\" added","version":"6.6"},{"description":"field \"logs\" is deprecated and its value is always false","version":"6.1"}],"params":[{"key":"component","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"task","description":"Give Compute Engine task details such as type, status, duration and associated component.\u003cbr/\u003eRequires one of the following permissions: \u003cul\u003e\u003cli\u003e\u0027Administer\u0027 at global or project level\u003c/li\u003e\u003cli\u003e\u0027Execute Analysis\u0027 at global or project level\u003c/li\u003e\u003c/ul\u003eSince 6.1, field \"logs\" is deprecated and its value is always false.","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Warnings field will be now always be filled (it is not necessary to mention it explicitly in \u0027additionalFields\u0027). \u0027additionalFields\u0027 value `warning\u0027 is deprecated.","version":"10.1"},{"description":"\u0027Project Administrator\u0027 is added to the list of allowed permissions to access this endpoint","version":"10.1"},{"description":"fields \"branch\" and \"branchType\" added","version":"6.6"}],"params":[{"key":"additionalFields","description":"Comma-separated list of the optional fields to be returned in response.","since":"6.1","required":false,"internal":false,"possibleValues":["stacktrace","scannerContext","warnings"]},{"key":"id","description":"Id of task","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"}]}]},{"path":"api/components","since":"4.2","description":"Get information about a component (file, directory, project, ...) and its ancestors or descendants. Update a project or module key.","actions":[{"key":"search","description":"Search for components","since":"6.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Param \u0027language\u0027 has been removed","version":"8.4"},{"description":"The use of \u0027DIR\u0027,\u0027FIL\u0027,\u0027UTS\u0027 and \u0027BRC\u0027 as values for parameter \u0027qualifiers\u0027 is no longer supported","version":"8.4"},{"description":"Field \u0027id\u0027 from response has been removed","version":"8.0"},{"description":"The use of \u0027BRC\u0027 as value for parameter \u0027qualifiers\u0027 is deprecated","version":"7.6"}],"params":[{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 500","required":false,"internal":false,"defaultValue":"100","exampleValue":"20","maximumValue":500},{"key":"q","description":"Limit search to: \u003cul\u003e\u003cli\u003ecomponent names that contain the supplied string\u003c/li\u003e\u003cli\u003ecomponent keys that are exactly the same as the supplied string\u003c/li\u003e\u003c/ul\u003e\u003cbr\u003eThe value length of the param must be between 2 and 15 (inclusive) characters. In case longer value is provided it will be truncated.","required":false,"internal":false,"exampleValue":"sonar"},{"key":"qualifiers","description":"Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:\u003cul\u003e\u003cli\u003eAPP - Applications\u003c/li\u003e\u003cli\u003eVW - Portfolios\u003c/li\u003e\u003cli\u003eSVW - Portfolios\u003c/li\u003e\u003cli\u003eTRK - Projects\u003c/li\u003e\u003c/ul\u003e","required":true,"internal":false,"possibleValues":["APP","VW","SVW","TRK"]}]},{"key":"show","description":"Returns a component (file, directory, project, portfolio…) and its ancestors. The ancestors are ordered from the parent to the root project. Requires the following permission: \u0027Browse\u0027 on the project of the specified component.","since":"5.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The use of module keys in parameter \u0027component\u0027 is removed","version":"10.1"},{"description":"The use of module keys in parameter \u0027component\u0027 is deprecated","version":"7.6"}],"params":[{"key":"branch","description":"Branch key. Not available in the community edition.","since":"6.6","required":false,"internal":false,"exampleValue":"feature/my_branch"},{"key":"component","description":"Component key","required":true,"internal":false,"exampleValue":"my_project"},{"key":"pullRequest","description":"Pull request id. Not available in the community edition.","since":"7.1","required":false,"internal":false,"exampleValue":"5461"}]},{"key":"tree","description":"Navigate through components based on the chosen strategy.\u003cbr\u003eRequires the following permission: \u0027Browse\u0027 on the specified project.\u003cbr\u003eWhen limiting search with the q parameter, directories are not returned.","since":"5.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Response field \u0027refQualifier\u0027 has been added.","version":"2026.5"},{"description":"The use of module keys in parameter \u0027component\u0027 is removed","version":"10.1"},{"description":"The use of \u0027BRC\u0027 as value for parameter \u0027qualifiers\u0027 is removed","version":"10.1"},{"description":"The use of \u0027BRC\u0027 as value for parameter \u0027qualifiers\u0027 is deprecated","version":"7.6"},{"description":"The use of module keys in parameter \u0027component\u0027 is deprecated","version":"7.6"}],"params":[{"key":"asc","description":"Ascending sort","required":false,"internal":false,"defaultValue":"true","possibleValues":["true","false","yes","no"]},{"key":"branch","description":"Branch key. Not available in the community edition.","since":"6.6","required":false,"internal":false,"exampleValue":"feature/my_branch"},{"key":"component","description":"Base component key. The search is based on this component.","required":true,"internal":false,"exampleValue":"my_project"},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 500","required":false,"internal":false,"defaultValue":"100","exampleValue":"20","maximumValue":500},{"key":"pullRequest","description":"Pull request id. Not available in the community edition.","since":"7.1","required":false,"internal":false,"exampleValue":"5461"},{"key":"q","description":"Limit search to: \u003cul\u003e\u003cli\u003ecomponent names that contain the supplied string\u003c/li\u003e\u003cli\u003ecomponent keys that are exactly the same as the supplied string\u003c/li\u003e\u003c/ul\u003e","required":false,"internal":false,"exampleValue":"FILE_NAM","minimumLength":3},{"key":"qualifiers","description":"Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:\u003cul\u003e\u003cli\u003eAPP - Applications\u003c/li\u003e\u003cli\u003eVW - Portfolios\u003c/li\u003e\u003cli\u003eSVW - Portfolios\u003c/li\u003e\u003cli\u003eUTS - Test Files\u003c/li\u003e\u003cli\u003eFIL - Files\u003c/li\u003e\u003cli\u003eDIR - Directories\u003c/li\u003e\u003cli\u003eTRK - Projects\u003c/li\u003e\u003c/ul\u003e","required":false,"internal":false,"possibleValues":["APP","VW","SVW","UTS","FIL","DIR","TRK"]},{"key":"s","description":"Comma-separated list of sort fields","required":false,"internal":false,"defaultValue":"name","exampleValue":"name, path","possibleValues":["name","path","qualifier"]},{"key":"strategy","description":"Strategy to search for base component descendants:\u003cul\u003e\u003cli\u003echildren: return the children components of the base component. Grandchildren components are not returned\u003c/li\u003e\u003cli\u003eall: return all the descendants components of the base component. Grandchildren are returned.\u003c/li\u003e\u003cli\u003eleaves: return all the descendant components (files, in general) which don\u0027t have other children. They are the leaves of the component tree.\u003c/li\u003e\u003c/ul\u003e","required":false,"internal":false,"defaultValue":"all","possibleValues":["all","children","leaves"]}]}]},{"path":"api/duplications","since":"4.4","description":"Get duplication information for a project.","actions":[{"key":"show","description":"Get duplications. Require Browse permission on file\u0027s project","since":"4.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The fields \u0027subProject\u0027, \u0027subProjectName\u0027 were removed from the response.","version":"9.6"},{"description":"Deprecated parameter \u0027uuid\u0027 was removed.","version":"8.8"},{"description":"The fields \u0027uuid\u0027, \u0027projectUuid\u0027, \u0027subProjectUuid\u0027 were removed from the response.","version":"8.8"},{"description":"Parameter \u0027uuid\u0027 is now deprecated.","version":"6.5"},{"description":"The fields \u0027uuid\u0027, \u0027projectUuid\u0027, \u0027subProjectUuid\u0027 are now deprecated in the response.","version":"6.5"}],"params":[{"key":"key","description":"File key","required":true,"internal":false,"exampleValue":"my_project:/src/foo/Bar.php"}]}]},{"path":"api/editions","since":"6.7","description":"Manage SonarSource commercial editions","actions":[{"key":"activate_grace_period","description":"Enable a license 7-days grace period if the Server ID is invalid. Require \u0027Administer System\u0027 permission.","since":"10.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[]},{"key":"set_license","description":"Set the license for enabling features of commercial editions. Require \u0027Administer System\u0027 permission.","since":"7.2","deprecatedSince":"2025.6","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"This endpoint is deprecated in favor of /api/v2/entitlements/legacy-activation for legacy licenses, and /api/v2/entitlements/online-activation for new licenses","version":"2025.6"}],"params":[{"key":"license","required":true,"internal":false}]}]},{"path":"api/favorites","since":"6.3","description":"Manage user favorites","actions":[{"key":"add","description":"Add a component (project, portfolio, etc.) as favorite for the authenticated user.\u003cbr\u003eOnly 100 components by qualifier can be added as favorite.\u003cbr\u003eRequires authentication and the following permission: \u0027Browse\u0027 on the component.","since":"6.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"The use of module keys in parameter \u0027component\u0027 is removed","version":"10.1"},{"description":"It\u0027s no longer possible to set a file as favorite","version":"8.4"},{"description":"It\u0027s no longer possible to have more than 100 favorites by qualifier","version":"7.7"},{"description":"It\u0027s no longer possible to set a directory as favorite","version":"7.7"},{"description":"The use of module keys in parameter \u0027component\u0027 is deprecated","version":"7.6"}],"params":[{"key":"component","description":"Component key. Only components with qualifiers TRK, VW, SVW, APP are supported","required":true,"internal":false,"exampleValue":"my_project:/src/foo/Bar.php"}]},{"key":"remove","description":"Remove a component (project, portfolio, application etc.) as favorite for the authenticated user.\u003cbr\u003eRequires authentication.","since":"6.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"The use of module keys in parameter \u0027component\u0027 is removed","version":"10.1"},{"description":"The use of module keys in parameter \u0027component\u0027 is deprecated","version":"7.6"}],"params":[{"key":"component","description":"Component key","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"search","description":"Search for the authenticated user favorites.\u003cbr\u003eRequires authentication.","since":"6.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 500","required":false,"internal":false,"defaultValue":"100","exampleValue":"20","maximumValue":500}]}]},{"path":"api/hotspots","since":"8.1","description":"Read and update Security Hotspots.","actions":[{"key":"change_status","description":"Change the status of a Security Hotpot.\u003cbr/\u003eRequires the \u0027Administer Security Hotspot\u0027 permission.","since":"8.1","deprecatedSince":"2026.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Hotspots are deprecated and replaced by security issues (software quality) and vulnerabilities (type). Please use the API of security issues / vulnerabilities instead.","version":"2026.4"},{"description":"The following \u0027resolution\u0027 values are not deprecated anymore: FIXED, SAFE, ACKNOWLEDGED","version":"2025.1"},{"description":"The following \u0027status\u0027 values are not deprecated anymore: TO_REVIEW, REVIEWED","version":"2025.1"},{"description":"Endpoint visibility change from internal to public","version":"10.1"}],"params":[{"key":"comment","description":"Comment text.","required":false,"internal":false,"exampleValue":"This is safe because user input is validated by the calling code"},{"key":"hotspot","description":"Key of the Security Hotspot","required":true,"internal":false,"exampleValue":"AU-TpxcA-iU5OvuD2FL0"},{"key":"resolution","description":"Resolution of the Security Hotspot when new status is REVIEWED, otherwise must not be set.","required":false,"internal":false,"possibleValues":["FIXED","SAFE","ACKNOWLEDGED"]},{"key":"status","description":"New status of the Security Hotspot.","required":true,"internal":false,"possibleValues":["TO_REVIEW","REVIEWED"]}]},{"key":"search","description":"Search for Security Hotpots. \u003cbr\u003eRequires the \u0027Browse\u0027 permission on the specified project(s). \u003cbr\u003eFor applications, it also requires \u0027Browse\u0027 permission on its child projects. \u003cbr\u003eWhen issue indexing is in progress returns 503 service unavailable HTTP code.","since":"8.1","deprecatedSince":"2026.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Parameter \u0027projectKey\u0027 is removed. Use \u0027project\u0027 instead.","version":"2026.5"},{"description":"Hotspots are deprecated and replaced by security issues (software quality) and vulnerabilities (type). Please use the API of security issues / vulnerabilities instead.","version":"2026.4"},{"description":"Param \u0027complianceStandards\u0027 has been added","version":"2025.6"},{"description":"Added parameter \u0027stig-ASD_V5R3\u0027 and \u0027casa\u0027","version":"10.7"},{"description":"Parameter \u0027projectKey\u0027 renamed to \u0027project\u0027","version":"10.2"},{"description":"Parameter \u0027sansTop25\u0027 is deprecated","version":"10.0"},{"description":"Endpoint visibility change from internal to public","version":"9.8"},{"description":"Add message formatting to issue and locations response","version":"9.8"},{"description":"Hotspot flows in the response may contain a description and a type","version":"9.7"},{"description":"Hotspot in the response contain the corresponding ruleKey","version":"9.7"},{"description":"Added parameters \u0027pciDss-3.2\u0027 and \u0027pciDss-4.0","version":"9.6"}],"params":[{"key":"branch","description":"Branch key. Not available in the community edition.","required":false,"internal":false,"exampleValue":"feature/my_branch"},{"key":"casa","description":"Comma-separated list of CASA categories.","since":"10.7","required":false,"internal":false},{"key":"complianceStandards","description":"Comma-separated list of compliance standards","since":"2025.6","required":false,"internal":false,"exampleValue":"asvs:4.0.3\u003d6.1.2"},{"key":"cwe","description":"Comma-separated list of CWE numbers","since":"8.8","required":false,"internal":false,"exampleValue":"89,434,352"},{"key":"files","description":"Comma-separated list of files. Returns only hotspots found in those files","since":"9.0","required":false,"internal":false,"exampleValue":"src/main/java/org/sonar/server/Test.java"},{"key":"hotspots","description":"Comma-separated list of Security Hotspot keys. This parameter is required unless project is provided.","required":false,"internal":false,"exampleValue":"AWhXpLoInp4On-Y3xc8x"},{"key":"inNewCodePeriod","description":"If \u0027inNewCodePeriod\u0027 is provided, only Security Hotspots created in the new code period are returned.","since":"9.5","required":false,"internal":false,"defaultValue":"false","possibleValues":["true","false","yes","no"]},{"key":"onlyMine","description":"If \u0027project\u0027 is provided, returns only Security Hotspots assigned to the current user","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"owaspAsvs-4.0","description":"Comma-separated list of OWASP ASVS v4.0 categories or rules.","since":"9.7","required":false,"internal":false,"exampleValue":"6,6.1.2"},{"key":"owaspAsvsLevel","description":"Filters hotspots with lower or equal OWASP ASVS level to the parameter value. Should be used in combination with the \u0027owaspAsvs-4.0\u0027 parameter.","since":"9.7","required":false,"internal":false,"exampleValue":"2","possibleValues":["1","2","3"]},{"key":"owaspTop10","description":"Comma-separated list of OWASP 2017 Top 10 lowercase categories.","since":"8.6","required":false,"internal":false,"possibleValues":["a1","a2","a3","a4","a5","a6","a7","a8","a9","a10"]},{"key":"owaspTop10-2021","description":"Comma-separated list of OWASP 2021 Top 10 lowercase categories.","since":"9.4","required":false,"internal":false,"possibleValues":["a1","a2","a3","a4","a5","a6","a7","a8","a9","a10"]},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"pciDss-3.2","description":"Comma-separated list of PCI DSS v3.2 categories.","since":"9.6","required":false,"internal":false,"exampleValue":"4,6.5.8,10.1"},{"key":"pciDss-4.0","description":"Comma-separated list of PCI DSS v4.0 categories.","since":"9.6","required":false,"internal":false,"exampleValue":"4,6.5.8,10.1"},{"key":"project","description":"Key of the project or application. This parameter is required unless hotspots is provided.","required":false,"internal":false,"exampleValue":"my_project"},{"key":"ps","description":"Page size. Must be greater than 0.","required":false,"internal":false,"defaultValue":"100","exampleValue":"20"},{"key":"pullRequest","description":"Pull request id. Not available in the community edition.","required":false,"internal":false,"exampleValue":"5461"},{"key":"resolution","description":"If \u0027project\u0027 is provided and if status is \u0027REVIEWED\u0027, only Security Hotspots with the specified resolution are returned.","required":false,"internal":false,"possibleValues":["FIXED","SAFE","ACKNOWLEDGED"]},{"key":"sansTop25","description":"Comma-separated list of SANS Top 25 categories.","since":"8.6","required":false,"internal":false,"deprecatedSince":"10.0","possibleValues":["insecure-interaction","risky-resource","porous-defenses"]},{"key":"sonarsourceSecurity","description":"Comma-separated list of SonarSource security categories. Use \u0027others\u0027 to select issues not associated with any category","since":"8.6","required":false,"internal":false,"possibleValues":["malicious-dependencies","buffer-overflow","sql-injection","rce","object-injection","command-injection","path-traversal-injection","ldap-injection","xpath-injection","log-injection","xxe","xss","dos","ssrf","csrf","http-response-splitting","open-redirect","weak-cryptography","auth","insecure-conf","file-manipulation","encrypt-data","traceability","permission","others"]},{"key":"status","description":"If \u0027project\u0027 is provided, only Security Hotspots with the specified status are returned.","required":false,"internal":false,"possibleValues":["TO_REVIEW","REVIEWED"]},{"key":"stig-ASD_V5R3","description":"Comma-separated list of STIG V5R3 lowercase categories.","since":"10.7","required":false,"internal":false}]},{"key":"show","description":"Provides the details of a Security Hotspot.","since":"8.1","deprecatedSince":"2026.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Hotspots are deprecated and replaced by security issues (software quality) and vulnerabilities (type). Please use the API of security issues / vulnerabilities instead.","version":"2026.4"},{"description":"Add the \u0027codeVariants\u0027 response field","version":"10.1"},{"description":"Add message formatting to issue and locations response","version":"9.8"},{"description":"Hotspot flows in the response may contain a description and a type","version":"9.7"},{"description":"The fields rule.riskDescription, rule.fixRecommendations, rule.vulnerabilityDescription of the response are deprecated. /api/rules/show endpoint should be used to fetch rule descriptions.","version":"9.5"}],"params":[{"key":"hotspot","description":"Key of the Security Hotspot","required":true,"internal":false,"exampleValue":"AU-TpxcA-iU5OvuD2FL0"}]}]},{"path":"api/issues","since":"3.6","description":"Read and update issues.","actions":[{"key":"add_comment","description":"Add a comment.\u003cbr/\u003eRequires authentication and the following permission: \u0027Browse\u0027 on the project of the specified issue.","since":"3.6","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"The response fields \u0027severity\u0027 and \u0027type\u0027 are not deprecated anymore.","version":"10.8"},{"description":"Possible values \u0027INFO\u0027 and \u0027BLOCKER\u0027 for response field \u0027severity\u0027 of \u0027impacts\u0027 have been added.","version":"10.8"},{"description":"The response fields \u0027severity\u0027 and \u0027type\u0027 are deprecated. Please use \u0027impacts\u0027 instead.","version":"10.4"},{"description":"The response fields \u0027status\u0027 and \u0027resolution\u0027 are deprecated. Please use \u0027issueStatus\u0027 instead.","version":"10.4"},{"description":"Add \u0027issueStatus\u0027 field to the response.","version":"10.4"},{"description":"Add \u0027impacts\u0027, \u0027cleanCodeAttribute\u0027, \u0027cleanCodeAttributeCategory\u0027 fields to the response","version":"10.2"},{"description":"Response field \u0027ruleDescriptionContextKey\u0027 added","version":"9.6"},{"description":"The response field components.uuid is removed","version":"8.8"},{"description":"the database ids of the components are removed from the response","version":"6.5"},{"description":"the response field components.uuid is deprecated. Use components.key instead.","version":"6.5"},{"description":"the response returns the issue with all its details","version":"6.3"}],"params":[{"key":"issue","description":"Issue key","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"text","description":"Comment text","required":true,"internal":false,"exampleValue":"Won\u0027t fix because it doesn\u0027t apply to the context"}]},{"key":"assign","description":"Assign/Unassign an issue. Requires authentication and Browse permission on project","since":"3.6","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"The response fields \u0027severity\u0027 and \u0027type\u0027 are not deprecated anymore.","version":"10.8"},{"description":"Possible values \u0027INFO\u0027 and \u0027BLOCKER\u0027 for response field \u0027severity\u0027 of \u0027impacts\u0027 have been added.","version":"10.8"},{"description":"The response fields \u0027severity\u0027 and \u0027type\u0027 are deprecated. Please use \u0027impacts\u0027 instead.","version":"10.4"},{"description":"The response fields \u0027status\u0027 and \u0027resolution\u0027 are deprecated. Please use \u0027issueStatus\u0027 instead.","version":"10.4"},{"description":"Add \u0027issueStatus\u0027 field to the response.","version":"10.4"},{"description":"Add \u0027impacts\u0027, \u0027cleanCodeAttribute\u0027, \u0027cleanCodeAttributeCategory\u0027 fields to the response","version":"10.2"},{"description":"Response field \u0027ruleDescriptionContextKey\u0027 added","version":"9.6"},{"description":"The response field components.uuid is removed","version":"8.8"},{"description":"the database ids of the components are removed from the response","version":"6.5"},{"description":"the response field components.uuid is deprecated. Use components.key instead.","version":"6.5"}],"params":[{"key":"assignee","description":"Login of the assignee. When not set, it will unassign the issue. Use \u0027_me\u0027 to assign to current user","required":false,"internal":false,"exampleValue":"admin"},{"key":"issue","description":"Issue key","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"}]},{"key":"authors","description":"Search SCM accounts which match a given query.\u003cbr/\u003eRequires authentication.\u003cbr/\u003eWhen issue indexing is in progress returns 503 service unavailable HTTP code.","since":"5.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The maximum size of \u0027ps\u0027 is set to 100","version":"7.4"}],"params":[{"key":"project","description":"Project key","since":"7.4","required":false,"internal":false,"exampleValue":"my_project"},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 100","required":false,"internal":false,"defaultValue":"10","exampleValue":"20","maximumValue":100},{"key":"q","description":"Limit search to authors that contain the supplied string.","required":false,"internal":false,"exampleValue":"luke"}]},{"key":"bulk_change","description":"Bulk change on issues. Up to 500 issues can be updated. \u003cbr/\u003eRequires authentication.","since":"3.7","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"The parameters \u0027set_severity\u0027 and \u0027set_type\u0027 are not deprecated anymore.","version":"10.8"},{"description":"Transitions \u0027wontfix\u0027 and \u0027confirm\u0027 are now deprecated. Use transition \u0027accept\u0027 instead. The transition \u0027unconfirm\u0027 is deprecated too.","version":"10.4"},{"description":"Transition \u0027accept\u0027 is now supported.","version":"10.4"},{"description":"Parameters \u0027set_severity\u0027 and \u0027set_type\u0027 are now deprecated.","version":"10.2"},{"description":"Security hotspots are no longer supported and will be ignored.","version":"8.2"},{"description":"Transitions \u0027setinreview\u0027, \u0027resolveasreviewed\u0027 and \u0027openasvulnerability\u0027 are no more supported","version":"8.2"},{"description":"\u0027actions\u0027 parameter is ignored","version":"6.3"}],"params":[{"key":"add_tags","description":"Add tags","required":false,"internal":false,"exampleValue":"security,java8"},{"key":"assign","description":"To assign the list of issues to a specific user (login), or un-assign all the issues","required":false,"internal":false,"exampleValue":"john.smith"},{"key":"comment","description":"Add a comment. The comment will only be added to issues that are affected either by a change of type or a change of severity as a result of the same WS call.","required":false,"internal":false,"exampleValue":"Here is my comment"},{"key":"do_transition","description":"Transition","required":false,"internal":false,"exampleValue":"reopen","possibleValues":["confirm","unconfirm","reopen","resolve","falsepositive","wontfix","resolveasreviewed","resetastoreview","accept"]},{"key":"issues","description":"Comma-separated list of issue keys","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy,AU-TpxcA-iU5OvuD2FLz"},{"key":"remove_tags","description":"Remove tags","required":false,"internal":false,"exampleValue":"security,java8"},{"key":"sendNotifications","since":"4.0","required":false,"internal":false,"defaultValue":"false","possibleValues":["true","false","yes","no"]},{"key":"set_severity","description":"To change the severity of the list of issues","required":false,"internal":false,"exampleValue":"BLOCKER","possibleValues":["INFO","MINOR","MAJOR","CRITICAL","BLOCKER"]},{"key":"set_type","description":"To change the type of the list of issues","since":"5.5","required":false,"internal":false,"exampleValue":"BUG","possibleValues":["CODE_SMELL","BUG","VULNERABILITY","SECURITY_HOTSPOT"]}]},{"key":"changelog","description":"Display changelog of an issue.\u003cbr/\u003eRequires the \u0027Browse\u0027 permission on the project of the specified issue.","since":"4.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"\u0027severity\u0027 and \u0027type\u0027 keys are not deprecated anymore.","version":"10.8"},{"description":"\u0027issueStatus\u0027 key is added in the differences","version":"10.4"},{"description":"\u0027status\u0027, \u0027resolution\u0027, \u0027severity\u0027 and \u0027type\u0027 keys are now deprecated in the differences","version":"10.4"},{"description":"\u0027externalUser\u0027 and \u0027webhookSource\u0027 information added to the answer","version":"9.7"},{"description":"changes on effort is expressed with the raw value in minutes (instead of the duration previously)","version":"6.3"}],"params":[{"key":"issue","description":"Issue key","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"}]},{"key":"delete_comment","description":"Delete a comment.\u003cbr/\u003eRequires authentication and the following permission: \u0027Browse\u0027 on the project of the specified issue.","since":"3.6","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"The response fields \u0027severity\u0027 and \u0027type\u0027 are not deprecated anymore.","version":"10.8"},{"description":"The response fields \u0027severity\u0027 and \u0027type\u0027 are deprecated. Please use \u0027impacts\u0027 instead.","version":"10.4"},{"description":"The response fields \u0027status\u0027 and \u0027resolution\u0027 are deprecated. Please use \u0027issueStatus\u0027 instead.","version":"10.4"},{"description":"Add \u0027issueStatus\u0027 field to the response.","version":"10.4"},{"description":"Add \u0027impacts\u0027, \u0027cleanCodeAttribute\u0027, \u0027cleanCodeAttributeCategory\u0027 fields to the response","version":"10.2"},{"description":"Response field \u0027ruleDescriptionContextKey\u0027 added","version":"9.6"},{"description":"The response field components.uuid is removed","version":"8.8"},{"description":"the response field components.uuid is deprecated. Use components.key instead.","version":"6.5"},{"description":"the database ids of the components are removed from the response","version":"6.5"},{"description":"the response returns the issue with all its details","version":"6.3"},{"description":"the \u0027key\u0027 parameter is renamed \u0027comment\u0027","version":"6.3"}],"params":[{"key":"comment","description":"Comment key","since":"6.3","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"}]},{"key":"do_transition","description":"Do workflow transition on an issue. Requires authentication and Browse permission on project.\u003cbr/\u003e\nThe transitions \u0027accept\u0027, \u0027wontfix\u0027 and \u0027falsepositive\u0027 require the permission \u0027Administer Issues\u0027.\u003cbr/\u003e\nThe transitions involving security hotspots require the permission \u0027Administer Security Hotspot\u0027.\n","since":"3.6","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"The response fields \u0027severity\u0027 and \u0027type\u0027 are not deprecated anymore.","version":"10.8"},{"description":"Possible values \u0027INFO\u0027 and \u0027BLOCKER\u0027 for response field \u0027severity\u0027 of \u0027impacts\u0027 have been added.","version":"10.8"},{"description":"The transitions \u0027wontfix\u0027 and \u0027confirm\u0027 are deprecated. Please use \u0027accept\u0027 instead. The transition \u0027unconfirm\u0027 is deprecated too. ","version":"10.4"},{"description":"Add transition \u0027accept\u0027.","version":"10.4"},{"description":"The response fields \u0027severity\u0027 and \u0027type\u0027 are deprecated. Please use \u0027impacts\u0027 instead.","version":"10.4"},{"description":"The response fields \u0027status\u0027 and \u0027resolution\u0027 are deprecated. Please use \u0027issueStatus\u0027 instead.","version":"10.4"},{"description":"Add \u0027issueStatus\u0027 field to the response.","version":"10.4"},{"description":"Add \u0027impacts\u0027, \u0027cleanCodeAttribute\u0027, \u0027cleanCodeAttributeCategory\u0027 fields to the response","version":"10.2"},{"description":"Response field \u0027ruleDescriptionContextKey\u0027 added","version":"9.6"},{"description":"The response field components.uuid is removed","version":"8.8"},{"description":"transitions \u0027setinreview\u0027 and \u0027openasvulnerability\u0027 are no more supported","version":"8.1"},{"description":"added \u0027setinreview\u0027, resolveasreviewed, openasvulnerability and resetastoreview transitions for security hotspots ","version":"7.8"},{"description":"added transitions for security hotspots","version":"7.3"},{"description":"the database ids of the components are removed from the response","version":"6.5"},{"description":"the response field components.uuid is deprecated. Use components.key instead.","version":"6.5"}],"params":[{"key":"issue","description":"Issue key","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"transition","description":"Transition","required":true,"internal":false,"possibleValues":["confirm","unconfirm","reopen","resolve","falsepositive","wontfix","resolveasreviewed","resetastoreview","accept"]}]},{"key":"edit_comment","description":"Edit a comment.\u003cbr/\u003eRequires authentication and the following permission: \u0027Browse\u0027 on the project of the specified issue.","since":"3.6","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"The response fields \u0027severity\u0027 and \u0027type\u0027 are not deprecated anymore.","version":"10.8"},{"description":"Possible values \u0027INFO\u0027 and \u0027BLOCKER\u0027 for response field \u0027severity\u0027 of \u0027impacts\u0027 have been added.","version":"10.8"},{"description":"The response fields \u0027severity\u0027 and \u0027type\u0027 are deprecated. Please use \u0027impacts\u0027 instead.","version":"10.4"},{"description":"The response fields \u0027status\u0027 and \u0027resolution\u0027 are deprecated. Please use \u0027issueStatus\u0027 instead.","version":"10.4"},{"description":"Add \u0027issueStatus\u0027 field to the response.","version":"10.4"},{"description":"Add \u0027impacts\u0027, \u0027cleanCodeAttribute\u0027, \u0027cleanCodeAttributeCategory\u0027 fields to the response","version":"10.2"},{"description":"Response field \u0027ruleDescriptionContextKey\u0027 added","version":"9.6"},{"description":"The response field components.uuid is removed","version":"8.8"},{"description":"the database ids of the components are removed from the response","version":"6.5"},{"description":"the response field components.uuid is deprecated. Use components.key instead.","version":"6.5"},{"description":"the response returns the issue with all its details","version":"6.3"},{"description":"the \u0027key\u0027 parameter has been renamed comment","version":"6.3"}],"params":[{"key":"comment","description":"Comment key","since":"6.3","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"text","description":"Comment text","required":true,"internal":false,"exampleValue":"Won\u0027t fix because it doesn\u0027t apply to the context"}]},{"key":"gitlab_sast_export","description":"Return a list of vulnerabilities according to the Gitlab SAST JSON format.\u003cbr\u003e The JSON produced can be used in GitLab for generating the Vulnerability Report.Requires the \u0027Browse\u0027 or \u0027Scan\u0027 permission on the specified project.","since":"10.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"branch","description":"Branch key.If this parameter is set, pullRequest must not be set.","required":false,"internal":false,"exampleValue":"feature/my_branch"},{"key":"projectKey","description":"The project key for which the vulnerabilities are being fetched","required":true,"internal":false,"exampleValue":"my_project"},{"key":"pullRequest","description":"Pull request id.If this parameter is set, branch must not be set.","required":false,"internal":false,"exampleValue":"5461"}]},{"key":"reindex","description":"Reindex issues for a project.\u003cbr\u003e Require \u0027Administer System\u0027 permission.","since":"9.8","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"search","description":"Search for issues.\u003cbr\u003eRequires the \u0027Browse\u0027 permission on the specified project(s). \u003cbr\u003eFor applications, it also requires \u0027Browse\u0027 permission on its child projects.\u003cbr/\u003eWhen issue indexing is in progress returns 503 service unavailable HTTP code.","since":"3.6","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Param \u0027complianceStandards\u0027 has been added","version":"2025.6"},{"description":"Facet \u0027complianceStandards\u0027 has been added","version":"2025.6"},{"description":"Facet \u0027linkedTicketStatus\u0027 has been added","version":"2025.6"},{"description":"Response field \u0027internalTags\u0027 has been added","version":"2025.5"},{"description":"Facet \u0027fromSonarQubeUpdate\u0027 has been added","version":"2025.5"},{"description":"Param \u0027fromSonarQubeUpdate\u0027 has been added","version":"2025.5"},{"description":"Facet \u0027owaspMobileTop10-2024\u0027 has been added","version":"2025.3"},{"description":"Param \u0027owaspMobileTop10-2024\u0027 has been added","version":"2025.3"},{"description":"The response fields \u0027severity\u0027 and \u0027type\u0027 are not deprecated anymore..","version":"10.8"},{"description":"The fields \u0027severity\u0027 and \u0027type\u0027 are not deprecated anymore.","version":"10.8"},{"description":"The parameters \u0027severities\u0027 and \u0027types\u0027 are not deprecated anymore.","version":"10.8"},{"description":"Possible values \u0027INFO\u0027 and \u0027BLOCKER\u0027 for response field \u0027impactSeverities\u0027 of \u0027facets\u0027 have been added.","version":"10.8"},{"description":"Possible values \u0027INFO\u0027 and \u0027BLOCKER\u0027 for response field \u0027severity\u0027 of \u0027impacts\u0027 have been added.","version":"10.8"},{"description":"Parameter \u0027severities\u0027 now supports values: \u0027INFO\u0027,\u0027BLOCKER\u0027.","version":"10.8"},{"description":"Facet \u0027casa\u0027 has been added","version":"10.7"},{"description":"Param \u0027casa\u0027 has been added","version":"10.7"},{"description":"Facet \u0027stig-ASD_V5R3\u0027 has been added","version":"10.7"},{"description":"Param \u0027stig-ASD_V5R3\u0027 has been added","version":"10.7"},{"description":"Facet \u0027prioritizedRule\u0027 has been added","version":"10.6"},{"description":"Param \u0027prioritizedRule\u0027 has been added","version":"10.6"},{"description":"Added new param \u0027fixedInPullRequest\u0027","version":"10.4"},{"description":"Value \u0027wontfix\u0027 for \u0027transition\u0027 response field is deprecated, use \u0027accept\u0027 instead","version":"10.4"},{"description":"Possible value \u0027accept\u0027 for \u0027transition\u0027 response field has been added","version":"10.4"},{"description":"Param \u0027issueStatuses\u0027 has been added","version":"10.4"},{"description":"Parameters \u0027resolutions\u0027 and \u0027statuses\u0027 are deprecated in favor of \u0027issueStatuses\u0027.","version":"10.4"},{"description":"Parameters \u0027severities\u0027 and \u0027types\u0027 are deprecated, use \u0027impactSeverities\u0027 and \u0027impactSoftwareQualities\u0027 instead.","version":"10.4"},{"description":"Facet \u0027issueStatuses\u0027 has been added","version":"10.4"},{"description":"Facets \u0027resolutions\u0027 and \u0027statuses\u0027 are deprecated in favor of \u0027issueStatuses\u0027","version":"10.4"},{"description":"Response fields \u0027severity\u0027 and \u0027type\u0027 are deprecated, use \u0027impacts\u0027 instead.","version":"10.4"},{"description":"Response field \u0027issueStatus\u0027 added","version":"10.4"},{"description":"Response fields \u0027status\u0027 and \u0027resolutions\u0027 are deprecated, in favor of \u0027issueStatus\u0027","version":"10.4"},{"description":"Possible value \u0027CONFIRMED\u0027 for \u0027issueStatus\u0027 field is deprecated.","version":"10.4"},{"description":"Add \u0027impacts\u0027, \u0027cleanCodeAttribute\u0027, \u0027cleanCodeAttributeCategory\u0027 fields to the response","version":"10.2"},{"description":"Param \u0027impactSoftwareQualities\u0027 has been added","version":"10.2"},{"description":"Param \u0027impactSeverities\u0027 has been added","version":"10.2"},{"description":"Param \u0027cleanCodeAttributeCategories\u0027 has been added","version":"10.2"},{"description":"Facet \u0027impactSoftwareQualities\u0027 has been added","version":"10.2"},{"description":"Facet \u0027impactSeverities\u0027 has been added","version":"10.2"},{"description":"Facet \u0027cleanCodeAttributeCategories\u0027 has been added","version":"10.2"},{"description":"Parameter \u0027componentKeys\u0027 renamed to \u0027components\u0027","version":"10.2"},{"description":"Add the \u0027codeVariants\u0027 parameter, facet and response field","version":"10.1"},{"description":"Parameter \u0027sansTop25\u0027 is deprecated","version":"10.0"},{"description":"The value \u0027sansTop25\u0027 for the parameter \u0027facets\u0027 has been deprecated","version":"10.0"},{"description":"Deprecated value \u0027ASSIGNEE\u0027 in parameter \u0027s\u0027 is dropped","version":"10.0"},{"description":"Parameter \u0027sinceLeakPeriod\u0027 is removed, please use \u0027inNewCodePeriod\u0027 instead","version":"10.0"},{"description":"Add message formatting to issue and locations response","version":"9.8"},{"description":"response fields \u0027total\u0027, \u0027s\u0027, \u0027ps\u0027 have been deprecated, please use \u0027paging\u0027 object instead","version":"9.8"},{"description":"Issues flows in the response may contain a description and a type","version":"9.7"},{"description":"Response field \u0027fromHotspot\u0027 dropped.","version":"9.6"},{"description":"Added facets \u0027pciDss-3.2\u0027 and \u0027pciDss-4.0","version":"9.6"},{"description":"Added parameters \u0027pciDss-3.2\u0027 and \u0027pciDss-4.0","version":"9.6"},{"description":"Response field \u0027ruleDescriptionContextKey\u0027 added","version":"9.6"},{"description":"New possible value for \u0027additionalFields\u0027 parameter: \u0027ruleDescriptionContextKey\u0027","version":"9.6"},{"description":"Facet \u0027moduleUuids\u0027 is dropped.","version":"9.6"},{"description":"Parameter \u0027sinceLeakPeriod\u0027 is deprecated, please use \u0027inNewCodePeriod\u0027 instead","version":"9.4"},{"description":"Response field \u0027quickFixAvailable\u0027 added","version":"9.2"},{"description":"Deprecated parameters \u0027authors\u0027, \u0027facetMode\u0027 and \u0027moduleUuids\u0027 were dropped","version":"9.1"},{"description":"Parameter \u0027timeZone\u0027 added","version":"8.6"},{"description":"Facet \u0027fileUuids\u0027 is dropped in favour of the new facet \u0027files\u0027Note that they are not strictly identical, the latter returns the file paths.","version":"8.5"},{"description":"Internal parameter \u0027fileUuids\u0027 has been dropped","version":"8.5"},{"description":"parameters \u0027componentUuids\u0027, \u0027projectKeys\u0027 has been dropped.","version":"8.4"},{"description":"\u0027REVIEWED\u0027, \u0027TO_REVIEW\u0027 status param values are no longer supported","version":"8.2"},{"description":"Security hotspots are no longer returned as type \u0027SECURITY_HOTSPOT\u0027 is not supported anymore, use dedicated api/hotspots","version":"8.2"},{"description":"response field \u0027fromHotspot\u0027 has been deprecated and is no more populated","version":"8.2"},{"description":"Status \u0027IN_REVIEW\u0027 for Security Hotspots has been deprecated","version":"8.2"},{"description":"added new Security Hotspots statuses : TO_REVIEW, IN_REVIEW and REVIEWED","version":"7.8"},{"description":"Security hotspots are returned by default","version":"7.8"},{"description":"Value \u0027authors\u0027 in parameter \u0027facets\u0027 is deprecated, please use \u0027author\u0027 instead","version":"7.7"},{"description":"The use of module keys in parameter \u0027componentKeys\u0027 is deprecated","version":"7.6"},{"description":"The facet \u0027projectUuids\u0027 is dropped in favour of the new facet \u0027projects\u0027. Note that they are not strictly identical, the latter returns the project keys.","version":"7.4"},{"description":"Parameter \u0027facetMode\u0027 does not accept anymore deprecated value \u0027debt\u0027","version":"7.4"},{"description":"response field \u0027fromHotspot\u0027 added to issues that are security hotspots","version":"7.3"},{"description":"added facets \u0027sansTop25\u0027, \u0027owaspTop10\u0027 and \u0027cwe\u0027","version":"7.3"},{"description":"response field \u0027externalRuleEngine\u0027 added to issues that have been imported from an external rule engine","version":"7.2"},{"description":"value \u0027ASSIGNEE\u0027 in parameter \u0027s\u0027 is deprecated, it won\u0027t have any effect","version":"7.2"},{"description":"parameters \u0027projects\u0027, \u0027projectUuids\u0027, \u0027moduleUuids\u0027, \u0027directories\u0027, \u0027fileUuids\u0027 are marked as internal","version":"6.5"},{"description":"response field \u0027email\u0027 is renamed \u0027avatar\u0027","version":"6.3"},{"description":"response fields \u0027reporter\u0027 and \u0027actionPlan\u0027 are removed (drop of action plan and manual issue features)","version":"5.5"},{"description":"parameters \u0027reporters\u0027, \u0027actionPlans\u0027 and \u0027planned\u0027 are dropped and therefore ignored (drop of action plan and manual issue features)","version":"5.5"},{"description":"response field \u0027debt\u0027 is renamed \u0027effort\u0027","version":"5.5"}],"params":[{"key":"additionalFields","description":"Comma-separated list of the optional fields to be returned in response. Action plans are dropped in 5.5, it is not returned in the response.","since":"5.2","required":false,"internal":false,"possibleValues":["_all","comments","languages","rules","ruleDescriptionContextKey","transitions","actions","users"]},{"key":"asc","description":"Ascending sort","required":false,"internal":false,"defaultValue":"true","possibleValues":["true","false","yes","no"]},{"key":"assigned","description":"To retrieve assigned or unassigned issues","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"assignees","description":"Comma-separated list of assignee logins. The value \u0027__me__\u0027 can be used as a placeholder for user who performs the request","required":false,"internal":false,"exampleValue":"admin,usera,__me__"},{"key":"author","description":"SCM accounts. To set several values, the parameter must be called once for each value.","required":false,"internal":false,"exampleValue":"author\u003dtorvalds@linux-foundation.org\u0026author\u003dlinux@fondation.org"},{"key":"branch","description":"Branch key. Not available in the community edition.","since":"6.6","required":false,"internal":false,"exampleValue":"feature/my_branch"},{"key":"casa","description":"Comma-separated list of CASA categories.","since":"10.7","required":false,"internal":false},{"key":"cleanCodeAttributeCategories","description":"Comma-separated list of Clean Code Attribute Categories","since":"10.2","required":false,"internal":false,"exampleValue":"ADAPTABLE,INTENTIONAL","possibleValues":["ADAPTABLE","CONSISTENT","INTENTIONAL","RESPONSIBLE"]},{"key":"codeVariants","description":"Comma-separated list of code variants.","since":"10.1","required":false,"internal":false,"exampleValue":"windows,linux"},{"key":"complianceStandards","description":"Comma-separated list of compliance standards","since":"2025.6","required":false,"internal":false,"exampleValue":"asvs:4.0.3\u003d6.1.2"},{"key":"components","description":"Comma-separated list of component keys. Retrieve issues associated to a specific list of components (and all its descendants). A component can be a portfolio, project, module, directory or file.","required":false,"internal":false,"exampleValue":"my_project","deprecatedKey":"componentKeys","deprecatedKeySince":"10.2"},{"key":"createdAfter","description":"To retrieve issues created after the given date (inclusive). \u003cbr\u003eEither a date (use \u0027timeZone\u0027 attribute or it will default to server timezone) or datetime can be provided. \u003cbr\u003eIf this parameter is set, createdInLast must not be set","required":false,"internal":false,"exampleValue":"2017-10-19 or 2017-10-19T13:00:00+0200"},{"key":"createdAt","description":"Datetime to retrieve issues created during a specific analysis","required":false,"internal":false,"exampleValue":"2017-10-19T13:00:00+0200"},{"key":"createdBefore","description":"To retrieve issues created before the given date (exclusive). \u003cbr\u003eEither a date (use \u0027timeZone\u0027 attribute or it will default to server timezone) or datetime can be provided.","required":false,"internal":false,"exampleValue":"2017-10-19 or 2017-10-19T13:00:00+0200"},{"key":"createdInLast","description":"To retrieve issues created during a time span before the current time (exclusive). Accepted units are \u0027y\u0027 for year, \u0027m\u0027 for month, \u0027w\u0027 for week and \u0027d\u0027 for day. If this parameter is set, createdAfter must not be set","required":false,"internal":false,"exampleValue":"1m2w (1 month 2 weeks)"},{"key":"cwe","description":"Comma-separated list of CWE identifiers. Use \u0027unknown\u0027 to select issues not associated to any CWE.","required":false,"internal":false,"exampleValue":"12,125,unknown"},{"key":"facets","description":"Comma-separated list of the facets to be computed. No facet is computed by default.","required":false,"internal":false,"possibleValues":["projects","files","assigned_to_me","severities","statuses","resolutions","rules","assignees","author","directories","scopes","languages","tags","types","pciDss-3.2","pciDss-4.0","owaspAsvs-4.0","owaspMobileTop10-2024","owaspTop10","owaspTop10-2021","stig-ASD_V5R3","casa","sansTop25","cwe","createdAt","sonarsourceSecurity","codeVariants","cleanCodeAttributeCategories","impactSoftwareQualities","impactSeverities","issueStatuses","prioritizedRule","complianceStandards","fromSonarQubeUpdate","linkedTicketStatus"]},{"key":"fixedInPullRequest","description":"Pull request id to filter issues that would be fixed in the specified project or branch by the pull request. Should not be used together with + \u0027pullRequest\u0027. At least the \u0027components\u0027 must be be specified when this param is used.  Not available in the community edition.","since":"10.4","required":false,"internal":false,"exampleValue":"5461"},{"key":"fromSonarQubeUpdate","description":"To match issues detected because of SonarQube updates","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"impactSeverities","description":"Comma-separated list of Software Quality Severities","since":"10.2","required":false,"internal":false,"exampleValue":"HIGH,MEDIUM","possibleValues":["INFO","LOW","MEDIUM","HIGH","BLOCKER"]},{"key":"impactSoftwareQualities","description":"Comma-separated list of Software Qualities","since":"10.2","required":false,"internal":false,"exampleValue":"MAINTAINABILITY,RELIABILITY","possibleValues":["MAINTAINABILITY","RELIABILITY","SECURITY"]},{"key":"inNewCodePeriod","description":"To retrieve issues created in the new code period.\u003cbr\u003eIf this parameter is set to a truthy value, createdAfter must not be set and one component uuid or key must be provided.\u003cbr\u003eThis parameter is ignored if the requested component is Application or Portfolio.","since":"9.4","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"issueStatuses","description":"","since":"10.4","required":false,"internal":false,"exampleValue":"ACCEPTED,FIXED","possibleValues":["OPEN","CONFIRMED","FALSE_POSITIVE","ACCEPTED","FIXED","IN_SANDBOX"]},{"key":"issues","description":"Comma-separated list of issue keys","required":false,"internal":false,"exampleValue":"5bccd6e8-f525-43a2-8d76-fcb13dde79ef"},{"key":"languages","description":"Comma-separated list of languages. Available since 4.4","required":false,"internal":false,"exampleValue":"java,js"},{"key":"linkedTicketStatus","description":"Has linked JIRA work item","required":false,"internal":false,"exampleValue":"LINKED","possibleValues":["LINKED","NOT_LINKED"]},{"key":"onComponentOnly","description":"Return only issues at a component\u0027s level, not on its descendants (modules, directories, files, etc). This parameter is only considered when componentKeys is set.","required":false,"internal":false,"defaultValue":"false","possibleValues":["true","false","yes","no"]},{"key":"owaspAsvs-4.0","description":"Comma-separated list of OWASP ASVS v4.0 categories.","since":"9.7","required":false,"internal":false,"exampleValue":"6,10.1.1"},{"key":"owaspAsvsLevel","description":"Level of OWASP ASVS categories.","since":"9.7","required":false,"internal":false,"possibleValues":["1","2","3"]},{"key":"owaspMobileTop10-2024","description":"Comma-separated list of OWASP Mobile Top 10 2024 lowercase categories.","since":"2025.3","required":false,"internal":false,"possibleValues":["m1","m2","m3","m4","m5","m6","m7","m8","m9","m10"]},{"key":"owaspTop10","description":"Comma-separated list of OWASP Top 10 2017 lowercase categories.","since":"7.3","required":false,"internal":false,"possibleValues":["a1","a2","a3","a4","a5","a6","a7","a8","a9","a10"]},{"key":"owaspTop10-2021","description":"Comma-separated list of OWASP Top 10 2021 lowercase categories.","since":"9.4","required":false,"internal":false,"possibleValues":["a1","a2","a3","a4","a5","a6","a7","a8","a9","a10"]},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"pciDss-3.2","description":"Comma-separated list of PCI DSS v3.2 categories.","since":"9.6","required":false,"internal":false,"exampleValue":"4,6.5.8,10.1"},{"key":"pciDss-4.0","description":"Comma-separated list of PCI DSS v4.0 categories.","since":"9.6","required":false,"internal":false,"exampleValue":"4,6.5.8,10.1"},{"key":"prioritizedRule","description":"To match issues with prioritized rule or not","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 500","required":false,"internal":false,"defaultValue":"100","exampleValue":"20","maximumValue":500},{"key":"pullRequest","description":"Pull request id. Not available in the community edition.","since":"7.1","required":false,"internal":false,"exampleValue":"5461"},{"key":"resolutions","description":"Comma-separated list of resolutions","required":false,"internal":false,"exampleValue":"FIXED,REMOVED","possibleValues":["FALSE-POSITIVE","WONTFIX","FIXED","REMOVED"]},{"key":"resolved","description":"To match resolved or unresolved issues","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"rules","description":"Comma-separated list of coding rule keys. Format is \u0026lt;repository\u0026gt;:\u0026lt;rule\u0026gt;","required":false,"internal":false,"exampleValue":"java:S1144"},{"key":"s","description":"Sort field","required":false,"internal":false,"possibleValues":["TYPE_SEVERITY","UPDATE_DATE","CLOSE_DATE","FILE_LINE","STATUS","SEVERITY","CREATION_DATE","IMPACT_RANK","HOTSPOTS"]},{"key":"sansTop25","description":"Comma-separated list of SANS Top 25 categories.","since":"7.3","required":false,"internal":false,"deprecatedSince":"10.0","possibleValues":["insecure-interaction","risky-resource","porous-defenses"]},{"key":"scopes","description":"Comma-separated list of scopes. Available since 8.5","required":false,"internal":false,"exampleValue":"MAIN,TEST","possibleValues":["MAIN","TEST"]},{"key":"severities","description":"Comma-separated list of severities","required":false,"internal":false,"exampleValue":"BLOCKER,CRITICAL","possibleValues":["INFO","MINOR","MAJOR","CRITICAL","BLOCKER"]},{"key":"sonarsourceSecurity","description":"Comma-separated list of SonarSource security categories. Use \u0027others\u0027 to select issues not associated with any category","since":"7.8","required":false,"internal":false,"possibleValues":["malicious-dependencies","buffer-overflow","sql-injection","rce","object-injection","command-injection","path-traversal-injection","ldap-injection","xpath-injection","log-injection","xxe","xss","dos","ssrf","csrf","http-response-splitting","open-redirect","weak-cryptography","auth","insecure-conf","file-manipulation","encrypt-data","traceability","permission","others"]},{"key":"statuses","description":"Comma-separated list of statuses","required":false,"internal":false,"exampleValue":"OPEN,REOPENED","deprecatedSince":"10.4","possibleValues":["OPEN","CONFIRMED","REOPENED","RESOLVED","CLOSED","IN_SANDBOX"]},{"key":"stig-ASD_V5R3","description":"Comma-separated list of STIG V5R3 categories.","since":"10.7","required":false,"internal":false},{"key":"tags","description":"Comma-separated list of tags.","required":false,"internal":false,"exampleValue":"security,convention"},{"key":"timeZone","description":"To resolve dates passed to \u0027createdAfter\u0027 or \u0027createdBefore\u0027 (does not apply to datetime) and to compute creation date histogram","since":"8.6","required":false,"internal":false,"exampleValue":"\u0027Europe/Paris\u0027, \u0027Z\u0027 or \u0027+02:00\u0027"},{"key":"types","description":"Comma-separated list of types.","since":"5.5","required":false,"internal":false,"exampleValue":"CODE_SMELL,BUG","possibleValues":["CODE_SMELL","BUG","VULNERABILITY"]}]},{"key":"set_severity","description":"Change severity.\u003cbr/\u003eRequires the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Authentication\u0027\u003c/li\u003e  \u003cli\u003e\u0027Browse\u0027 rights on project of the specified issue\u003c/li\u003e  \u003cli\u003e\u0027Administer Issues\u0027 rights on project of the specified issue\u003c/li\u003e\u003c/ul\u003e","since":"3.6","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"Add \u0027impact\u0027 parameter to the request.","version":"10.8"},{"description":"Parameter \u0027severity\u0027 is now optional.","version":"10.8"},{"description":"This endpoint is not deprecated anymore.","version":"10.8"},{"description":"The response fields \u0027status\u0027 and \u0027resolution\u0027 are deprecated. Please use \u0027issueStatus\u0027 instead.","version":"10.4"},{"description":"Add \u0027issueStatus\u0027 field to the response.","version":"10.4"},{"description":"This endpoint is now deprecated.","version":"10.2"},{"description":"Add \u0027impacts\u0027, \u0027cleanCodeAttribute\u0027, \u0027cleanCodeAttributeCategory\u0027 fields to the response","version":"10.2"},{"description":"Response field \u0027ruleDescriptionContextKey\u0027 added","version":"9.6"},{"description":"The response field components.uuid is removed","version":"8.8"},{"description":"the database ids of the components are removed from the response","version":"6.5"},{"description":"the response field components.uuid is deprecated. Use components.key instead.","version":"6.5"}],"params":[{"key":"impact","description":"Override of impact severity for the rule. Cannot be used as the same time as \u0027severity\u0027","required":false,"internal":false,"exampleValue":"impact\u003dMAINTAINABILITY\u003dHIGH"},{"key":"issue","description":"Issue key","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"severity","description":"New severity","required":false,"internal":false,"possibleValues":["INFO","MINOR","MAJOR","CRITICAL","BLOCKER"]}]},{"key":"set_tags","description":"Set tags on an issue. \u003cbr/\u003eRequires authentication and Browse permission on project","since":"5.1","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"The response fields \u0027severity\u0027 and \u0027type\u0027 are not deprecated anymore.","version":"10.8"},{"description":"Possible values \u0027INFO\u0027 and \u0027BLOCKER\u0027 for response field \u0027severity\u0027 of \u0027impacts\u0027 have been added.","version":"10.8"},{"description":"The response fields \u0027severity\u0027 and \u0027type\u0027 are deprecated. Please use \u0027impacts\u0027 instead.","version":"10.4"},{"description":"The response fields \u0027status\u0027 and \u0027resolution\u0027 are deprecated. Please use \u0027issueStatus\u0027 instead.","version":"10.4"},{"description":"Add \u0027issueStatus\u0027 field to the response.","version":"10.4"},{"description":"Add \u0027impacts\u0027, \u0027cleanCodeAttribute\u0027, \u0027cleanCodeAttributeCategory\u0027 fields to the response","version":"10.2"},{"description":"Response field \u0027ruleDescriptionContextKey\u0027 added","version":"9.6"},{"description":"The response field components.uuid is removed","version":"8.8"},{"description":"the database ids of the components are removed from the response","version":"6.5"},{"description":"the response field components.uuid is deprecated. Use components.key instead.","version":"6.5"},{"description":"response contains issue information instead of list of tags","version":"6.4"}],"params":[{"key":"issue","description":"Issue key","since":"6.3","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"tags","description":"Comma-separated list of tags. All tags are removed if parameter is empty or not set.","required":false,"internal":false,"exampleValue":"security,cwe,misra-c"}]},{"key":"set_type","description":"Change type of issue, for instance from \u0027code smell\u0027 to \u0027bug\u0027.\u003cbr/\u003eRequires the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Authentication\u0027\u003c/li\u003e  \u003cli\u003e\u0027Browse\u0027 rights on project of the specified issue\u003c/li\u003e  \u003cli\u003e\u0027Administer Issues\u0027 rights on project of the specified issue\u003c/li\u003e\u003c/ul\u003e","since":"5.5","deprecatedSince":"10.2","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"The response fields \u0027status\u0027 and \u0027resolution\u0027 are deprecated. Please use \u0027issueStatus\u0027 instead.","version":"10.4"},{"description":"Add \u0027issueStatus\u0027 field to the response.","version":"10.4"},{"description":"Add \u0027impacts\u0027, \u0027cleanCodeAttribute\u0027, \u0027cleanCodeAttributeCategory\u0027 fields to the response","version":"10.2"},{"description":"This endpoint is now deprecated.","version":"10.2"},{"description":"Response field \u0027ruleDescriptionContextKey\u0027 added","version":"9.6"},{"description":"The response field components.uuid is removed","version":"8.8"},{"description":"the database ids of the components are removed from the response","version":"6.5"},{"description":"the response field components.uuid is deprecated. Use components.key instead.","version":"6.5"}],"params":[{"key":"issue","description":"Issue key","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"type","description":"New type","required":true,"internal":false,"possibleValues":["CODE_SMELL","BUG","VULNERABILITY"]}]},{"key":"tags","description":"List tags matching a given query","since":"5.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Max page size increased to 500","version":"9.4"},{"description":"Result doesn\u0027t include rules tags anymore","version":"7.4"}],"params":[{"key":"all","description":"Indicator to search for all tags or only for tags in the main branch of a project","since":"9.2","required":false,"internal":false,"defaultValue":"false","possibleValues":["true","false"]},{"key":"branch","description":"Branch key","since":"9.2","required":false,"internal":false,"exampleValue":"feature/my_branch"},{"key":"project","description":"Project key","since":"7.4","required":false,"internal":false,"exampleValue":"my_project"},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 500","required":false,"internal":false,"defaultValue":"10","exampleValue":"20","maximumValue":500},{"key":"q","description":"Limit search to tags that contain the supplied string.","required":false,"internal":false,"exampleValue":"misra"}]}]},{"path":"api/languages","since":"5.1","description":"Get the list of programming languages supported in this instance.","actions":[{"key":"list","description":"List supported programming languages","since":"5.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"ps","description":"The size of the list to return, 0 for all languages","required":false,"internal":false,"defaultValue":"0","exampleValue":"25"},{"key":"q","description":"A pattern to match language keys/names against","required":false,"internal":false,"exampleValue":"java"}]}]},{"path":"api/measures","since":"5.4","description":"Get components or children with specified measures.","actions":[{"key":"component","description":"Return component with specified measures.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e\u003cli\u003e\u0027Browse\u0027 on the project of the specified component\u003c/li\u003e\u003cli\u003e\u0027Execute Analysis\u0027 on the project of the specified component\u003c/li\u003e\u003c/ul\u003e","since":"5.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The following SCA metrics are available on licensed enterprise/datacenter editions with SCA enabled: \u0027sca_rating_licensing\u0027, \u0027sca_rating_vulnerability\u0027, \u0027sca_rating_any_issue\u0027, \u0027sca_severity_licensing\u0027, \u0027sca_severity_vulnerability\u0027, \u0027sca_severity_any_issue\u0027, \u0027sca_count_any_issue\u0027, \u0027new_sca_rating_licensing\u0027, \u0027new_sca_rating_vulnerability\u0027, \u0027new_sca_rating_any_issue\u0027, \u0027new_sca_severity_licensing\u0027, \u0027new_sca_severity_vulnerability\u0027, \u0027new_sca_severity_any_issue\u0027, \u0027new_sca_count_any_issue\u0027","version":"2025.4"},{"description":"The \u0027Execute Analysis\u0027 permission also allows to access the endpoint","version":"2025.2"},{"description":"The following metrics are not deprecated anymore: \u0027bugs\u0027, \u0027new_bugs\u0027, \u0027vulnerabilities\u0027, \u0027new_vulnerabilities\u0027, \u0027code_smells\u0027, \u0027new_code_smells\u0027, \u0027high_impact_accepted_issues\u0027, \u0027new_blocker_violations\u0027, \u0027new_critical_violations\u0027, \u0027new_major_violations\u0027, \u0027new_minor_violations\u0027, \u0027new_info_violations\u0027, \u0027blocker_violations\u0027, \u0027critical_violations\u0027, \u0027major_violations\u0027, \u0027minor_violations\u0027, \u0027info_violations\u0027","version":"10.8"},{"description":"Added new accepted values for the \u0027metricKeys\u0027 param: \u0027software_quality_blocker_issues\u0027, \u0027software_quality_high_issues\u0027, \u0027software_quality_info_issues\u0027, \u0027software_quality_medium_issues\u0027, \u0027software_quality_low_issues\u0027, \u0027software_quality_maintainability_issues\u0027, \u0027software_quality_reliability_issues\u0027, \u0027software_quality_security_issues\u0027, \u0027new_software_quality_blocker_issues\u0027, \u0027new_software_quality_high_issues\u0027, \u0027new_software_quality_info_issues\u0027, \u0027new_software_quality_medium_issues\u0027, \u0027new_software_quality_low_issues\u0027, \u0027new_software_quality_maintainability_issues\u0027, \u0027new_software_quality_reliability_issues\u0027, \u0027new_software_quality_security_issues\u0027","version":"10.8"},{"description":"The metrics \u0027maintainability_issues\u0027, \u0027reliability_issues\u0027, \u0027security_issues\u0027, \u0027new_maintainability_issues\u0027, \u0027new_reliability_issues\u0027, \u0027new_security_issues\u0027 are now deprecated. Use \u0027software_quality_maintainability_issues\u0027, \u0027software_quality_reliability_issues\u0027, \u0027software_quality_security_issues\u0027, \u0027new_software_quality_maintainability_issues\u0027, \u0027new_software_quality_reliability_issues\u0027, \u0027new_software_quality_security_issues\u0027 instead.","version":"10.8"},{"description":"Added new accepted values for the \u0027metricKeys\u0027 param: \u0027software_quality_maintainability_debt_ratio\u0027, \u0027software_quality_maintainability_rating\u0027, \u0027software_quality_reliability_rating\u0027, \u0027software_quality_security_rating\u0027, \u0027software_quality_maintainability_remediation_effort\u0027, \u0027software_quality_reliability_remediation_effort\u0027, \u0027software_quality_security_remediation_effort\u0027, \u0027effort_to_reach_software_quality_maintainability_rating_a\u0027, \u0027new_software_quality_maintainability_debt_ratio\u0027, \u0027new_software_quality_maintainability_rating\u0027, \u0027new_software_quality_reliability_rating\u0027, \u0027new_software_quality_security_rating\u0027, \u0027new_software_quality_maintainability_remediation_effort\u0027, \u0027new_software_quality_reliability_remediation_effort\u0027, \u0027new_software_quality_security_remediation_effort\u0027","version":"10.7"},{"description":"The metrics \u0027new_blocker_violations\u0027, \u0027new_critical_violations\u0027, \u0027new_major_violations\u0027, \u0027new_minor_violations\u0027, \u0027new_info_violations\u0027, \u0027blocker_violations\u0027, \u0027critical_violations\u0027, \u0027major_violations\u0027, \u0027minor_violations\u0027, \u0027info_violations\u0027 are now deprecated without exact replacement. Use \u0027maintainability_issues\u0027, \u0027reliability_issues\u0027 and \u0027security_issues\u0027 instead.","version":"10.5"},{"description":"Added new accepted values for the \u0027metricKeys\u0027 param: \u0027new_maintainability_issues\u0027, \u0027new_reliability_issues\u0027, \u0027new_security_issues\u0027","version":"10.5"},{"description":"The metrics \u0027bugs\u0027, \u0027new_bugs\u0027, \u0027vulnerabilities\u0027, \u0027new_vulnerabilities\u0027, \u0027code_smells\u0027, \u0027new_code_smells\u0027, \u0027high_impact_accepted_issues\u0027 are now deprecated without exact replacement. Use \u0027maintainability_issues\u0027, \u0027reliability_issues\u0027 and \u0027security_issues\u0027 instead.","version":"10.4"},{"description":"Added new accepted values for the \u0027metricKeys\u0027 param: \u0027maintainability_issues\u0027, \u0027reliability_issues\u0027, \u0027security_issues\u0027","version":"10.4"},{"description":"The metrics \u0027open_issues\u0027, \u0027reopened_issues\u0027 and \u0027confirmed_issues\u0027 are now deprecated in the response. Consume \u0027violations\u0027 instead.","version":"10.4"},{"description":"The use of \u0027open_issues\u0027, \u0027reopened_issues\u0027 and \u0027confirmed_issues\u0027 values in \u0027metricKeys\u0027 param are now deprecated. Use \u0027violations\u0027 instead.","version":"10.4"},{"description":"The metric \u0027wont_fix_issues\u0027 is now deprecated in the response. Consume \u0027accepted_issues\u0027 instead.","version":"10.4"},{"description":"The use of \u0027wont_fix_issues\u0027 value in \u0027metricKeys\u0027 param is now deprecated. Use \u0027accepted_issues\u0027 instead.","version":"10.4"},{"description":"Added new accepted value for the \u0027metricKeys\u0027 param: \u0027accepted_issues\u0027.","version":"10.4"},{"description":"The use of module keys in parameter \u0027component\u0027 is removed","version":"10.1"},{"description":"The use of the following metrics in \u0027metricKeys\u0027 parameter is not deprecated anymore: \u0027releasability_effort\u0027, \u0027security_rating_effort\u0027, \u0027reliability_rating_effort\u0027, \u0027security_review_rating_effort\u0027, \u0027maintainability_rating_effort\u0027, \u0027last_change_on_maintainability_rating\u0027, \u0027last_change_on_releasability_rating\u0027, \u0027last_change_on_reliability_rating\u0027, \u0027last_change_on_security_rating\u0027, \u0027last_change_on_security_review_rating\u0027","version":"10.0"},{"description":"the response field periods under measures field is removed.","version":"10.0"},{"description":"the option `periods` of \u0027additionalFields\u0027 request field is removed.","version":"10.0"},{"description":"When the new code period is set to \u0027reference branch\u0027, the response field \u0027date\u0027 under the \u0027period\u0027 field has been removed","version":"9.3"},{"description":"The use of the following metrics in \u0027metricKeys\u0027 parameter is deprecated: \u0027releasability_effort\u0027, \u0027security_rating_effort\u0027, \u0027reliability_rating_effort\u0027, \u0027security_review_rating_effort\u0027, \u0027maintainability_rating_effort\u0027, \u0027last_change_on_maintainability_rating\u0027, \u0027last_change_on_releasability_rating\u0027, \u0027last_change_on_reliability_rating\u0027, \u0027last_change_on_security_rating\u0027, \u0027last_change_on_security_review_rating\u0027","version":"9.3"},{"description":"deprecated response field \u0027id\u0027 has been removed","version":"8.8"},{"description":"deprecated response field \u0027refId\u0027 has been removed.","version":"8.8"},{"description":"the response field periods under measures field is deprecated. Use period instead.","version":"8.1"},{"description":"the response field periods is deprecated. Use period instead.","version":"8.1"},{"description":"The use of module keys in parameter \u0027component\u0027 is deprecated","version":"7.6"},{"description":"the response field \u0027id\u0027 is deprecated. Use \u0027key\u0027 instead.","version":"6.6"},{"description":"the response field \u0027refId\u0027 is deprecated. Use \u0027refKey\u0027 instead.","version":"6.6"}],"params":[{"key":"additionalFields","description":"Comma-separated list of additional fields that can be returned in the response.","required":false,"internal":false,"exampleValue":"period,metrics","possibleValues":["metrics","period"]},{"key":"branch","description":"Branch key. Not available in the community edition.","since":"6.6","required":false,"internal":false,"exampleValue":"feature/my_branch"},{"key":"component","description":"Component key","required":true,"internal":false,"exampleValue":"my_project"},{"key":"metricKeys","description":"Comma-separated list of metric keys","required":true,"internal":false,"exampleValue":"ncloc,complexity,violations"},{"key":"pullRequest","description":"Pull request id. Not available in the community edition.","since":"7.1","required":false,"internal":false,"exampleValue":"5461"}]},{"key":"component_tree","description":"Navigate through components based on the chosen strategy with specified measures.\u003cbr\u003eRequires the following permission: \u0027Browse\u0027 on the specified project.\u003cbr\u003eFor applications, it also requires \u0027Browse\u0027 permission on its child projects. \u003cbr\u003eWhen limiting search with the q parameter, directories are not returned.","since":"5.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The following SCA metrics are available on licensed enterprise/datacenter editions with SCA enabled: \u0027sca_rating_licensing\u0027, \u0027sca_rating_vulnerability\u0027, \u0027sca_rating_any_issue\u0027, \u0027sca_severity_licensing\u0027, \u0027sca_severity_vulnerability\u0027, \u0027sca_severity_any_issue\u0027, \u0027sca_count_any_issue\u0027, \u0027new_sca_rating_licensing\u0027, \u0027new_sca_rating_vulnerability\u0027, \u0027new_sca_rating_any_issue\u0027, \u0027new_sca_severity_licensing\u0027, \u0027new_sca_severity_vulnerability\u0027, \u0027new_sca_severity_any_issue\u0027, \u0027new_sca_count_any_issue\u0027","version":"2025.4"},{"description":"Number of metric keys is limited to 75","version":"10.8"},{"description":"Portfolio project metrics now also include: \u0027contains_ai_code\u0027, \u0027reliability_rating_without_aica\u0027, \u0027reliability_rating_with_aica\u0027, \u0027software_quality_security_rating_without_aica\u0027, \u0027software_quality_security_rating_with_aica\u0027, \u0027security_rating_without_aica\u0027, \u0027security_rating_with_aica\u0027, \u0027new_reliability_rating_without_aica\u0027, \u0027new_reliability_rating_with_aica\u0027, \u0027new_software_quality_reliability_rating_without_aica\u0027, \u0027new_software_quality_reliability_rating_with_aica\u0027, \u0027new_security_rating_without_aica\u0027, \u0027new_security_rating_with_aica\u0027, \u0027new_software_quality_security_rating_without_aica\u0027, \u0027new_software_quality_security_rating_with_aica\u0027, \u0027security_review_rating_without_aica\u0027, \u0027security_review_rating_with_aica\u0027, \u0027sqale_rating_without_aica\u0027, \u0027sqale_rating_with_aica\u0027, \u0027new_software_quality_maintainability_rating_without_aica\u0027, \u0027new_software_quality_maintainability_rating_with_aica\u0027, \u0027ncloc_without_aica\u0027, \u0027ncloc_with_aica\u0027, \u0027software_quality_reliability_rating_without_aica\u0027, \u0027software_quality_reliability_rating_with_aica\u0027, \u0027new_maintainability_rating_without_aica\u0027, \u0027new_maintainability_rating_with_aica\u0027, \u0027software_quality_maintainability_rating_without_aica\u0027, \u0027software_quality_maintainability_rating_with_aica\u0027, \u0027new_security_review_rating_without_aica\u0027, \u0027new_security_review_rating_with_aica\u0027, \u0027releasability_rating_without_aica\u0027, \u0027releasability_rating_with_aica\u0027","version":"10.8"},{"description":"The following metrics are not deprecated anymore: \u0027bugs\u0027, \u0027new_bugs\u0027, \u0027vulnerabilities\u0027, \u0027new_vulnerabilities\u0027, \u0027code_smells\u0027, \u0027new_code_smells\u0027, \u0027high_impact_accepted_issues\u0027, \u0027new_blocker_violations\u0027, \u0027new_critical_violations\u0027, \u0027new_major_violations\u0027, \u0027new_minor_violations\u0027, \u0027new_info_violations\u0027, \u0027blocker_violations\u0027, \u0027critical_violations\u0027, \u0027major_violations\u0027, \u0027minor_violations\u0027, \u0027info_violations\u0027","version":"10.8"},{"description":"Added new accepted values for the \u0027metricKeys\u0027 param: \u0027software_quality_blocker_issues\u0027, \u0027software_quality_high_issues\u0027, \u0027software_quality_info_issues\u0027, \u0027software_quality_medium_issues\u0027, \u0027software_quality_low_issues\u0027, \u0027software_quality_maintainability_issues\u0027, \u0027software_quality_reliability_issues\u0027, \u0027software_quality_security_issues\u0027, \u0027new_software_quality_blocker_issues\u0027, \u0027new_software_quality_high_issues\u0027, \u0027new_software_quality_info_issues\u0027, \u0027new_software_quality_medium_issues\u0027, \u0027new_software_quality_low_issues\u0027, \u0027new_software_quality_maintainability_issues\u0027, \u0027new_software_quality_reliability_issues\u0027, \u0027new_software_quality_security_issues\u0027","version":"10.8"},{"description":"The metrics \u0027maintainability_issues\u0027, \u0027reliability_issues\u0027, \u0027security_issues\u0027, \u0027new_maintainability_issues\u0027, \u0027new_reliability_issues\u0027, \u0027new_security_issues\u0027 are now deprecated. Use \u0027software_quality_maintainability_issues\u0027, \u0027software_quality_reliability_issues\u0027, \u0027software_quality_security_issues\u0027, \u0027new_software_quality_maintainability_issues\u0027, \u0027new_software_quality_reliability_issues\u0027, \u0027new_software_quality_security_issues\u0027 instead.","version":"10.8"},{"description":"Number of metric keys is limited to 25","version":"10.7"},{"description":"Added new accepted values for the \u0027metricKeys\u0027 param: \u0027software_quality_maintainability_debt_ratio\u0027, \u0027software_quality_maintainability_rating\u0027, \u0027software_quality_reliability_rating\u0027, \u0027software_quality_security_rating\u0027, \u0027software_quality_maintainability_remediation_effort\u0027, \u0027software_quality_reliability_remediation_effort\u0027, \u0027software_quality_security_remediation_effort\u0027, \u0027effort_to_reach_software_quality_maintainability_rating_a\u0027, \u0027new_software_quality_maintainability_debt_ratio\u0027, \u0027new_software_quality_maintainability_rating\u0027, \u0027new_software_quality_reliability_rating\u0027, \u0027new_software_quality_security_rating\u0027, \u0027new_software_quality_maintainability_remediation_effort\u0027, \u0027new_software_quality_reliability_remediation_effort\u0027, \u0027new_software_quality_security_remediation_effort\u0027","version":"10.7"},{"description":"Added new accepted values for the \u0027metricKeys\u0027 param: \u0027new_maintainability_issues\u0027, \u0027new_reliability_issues\u0027, \u0027new_security_issues\u0027","version":"10.5"},{"description":"The metrics \u0027new_blocker_violations\u0027, \u0027new_critical_violations\u0027, \u0027new_major_violations\u0027, \u0027new_minor_violations\u0027, \u0027new_info_violations\u0027, \u0027blocker_violations\u0027, \u0027critical_violations\u0027, \u0027major_violations\u0027, \u0027minor_violations\u0027, \u0027info_violations\u0027 are now deprecated without exact replacement. Use \u0027maintainability_issues\u0027, \u0027reliability_issues\u0027 and \u0027security_issues\u0027 instead.","version":"10.5"},{"description":"Added new accepted values for the \u0027metricKeys\u0027 param: \u0027maintainability_issues\u0027, \u0027reliability_issues\u0027, \u0027security_issues\u0027","version":"10.5"},{"description":"The metrics \u0027bugs\u0027, \u0027new_bugs\u0027, \u0027vulnerabilities\u0027, \u0027new_vulnerabilities\u0027, \u0027code_smells\u0027, \u0027new_code_smells\u0027, \u0027high_impact_accepted_issues\u0027 are now deprecated without exact replacement. Use \u0027maintainability_issues\u0027, \u0027reliability_issues\u0027 and \u0027security_issues\u0027 instead.","version":"10.4"},{"description":"The metrics \u0027open_issues\u0027, \u0027reopened_issues\u0027 and \u0027confirmed_issues\u0027 are now deprecated in the response. Consume \u0027violations\u0027 instead.","version":"10.4"},{"description":"The use of \u0027open_issues\u0027, \u0027reopened_issues\u0027 and \u0027confirmed_issues\u0027 values in \u0027metricKeys\u0027 param are now deprecated. Use \u0027violations\u0027 instead.","version":"10.4"},{"description":"The metric \u0027wont_fix_issues\u0027 is now deprecated in the response. Consume \u0027accepted_issues\u0027 instead.","version":"10.4"},{"description":"The use of \u0027wont_fix_issues\u0027 value in \u0027metricKeys\u0027 and \u0027metricSort\u0027 params is now deprecated. Use \u0027accepted_issues\u0027 instead.","version":"10.4"},{"description":"Added new accepted value for the \u0027metricKeys\u0027 and \u0027metricSort\u0027 param: \u0027accepted_issues\u0027.","version":"10.4"},{"description":"The use of \u0027BRC\u0027 as value for parameter \u0027qualifiers\u0027 is removed","version":"10.1"},{"description":"The use of the following metrics in \u0027metricKeys\u0027 parameter is not deprecated anymore: \u0027releasability_effort\u0027, \u0027security_rating_effort\u0027, \u0027reliability_rating_effort\u0027, \u0027security_review_rating_effort\u0027, \u0027maintainability_rating_effort\u0027, \u0027last_change_on_maintainability_rating\u0027, \u0027last_change_on_releasability_rating\u0027, \u0027last_change_on_reliability_rating\u0027, \u0027last_change_on_security_rating\u0027, \u0027last_change_on_security_review_rating\u0027","version":"10.0"},{"description":"the response field periods under measures field is removed.","version":"10.0"},{"description":"the option `periods` of \u0027additionalFields\u0027 request field is removed.","version":"10.0"},{"description":"The use of the following metrics in \u0027metricKeys\u0027 parameter is deprecated: \u0027releasability_effort\u0027, \u0027security_rating_effort\u0027, \u0027reliability_rating_effort\u0027, \u0027security_review_rating_effort\u0027, \u0027maintainability_rating_effort\u0027, \u0027last_change_on_maintainability_rating\u0027, \u0027last_change_on_releasability_rating\u0027, \u0027last_change_on_reliability_rating\u0027, \u0027last_change_on_security_rating\u0027, \u0027last_change_on_security_review_rating\u0027","version":"9.3"},{"description":"parameter \u0027component\u0027 is now required","version":"8.8"},{"description":"deprecated parameter \u0027baseComponentId\u0027 has been removed","version":"8.8"},{"description":"deprecated parameter \u0027baseComponentKey\u0027 has been removed.","version":"8.8"},{"description":"deprecated response field \u0027id\u0027 has been removed","version":"8.8"},{"description":"deprecated response field \u0027refId\u0027 has been removed.","version":"8.8"},{"description":"the response field periods under measures field is deprecated. Use period instead.","version":"8.1"},{"description":"the response field periods is deprecated. Use period instead.","version":"8.1"},{"description":"The use of module keys in parameter \u0027component\u0027 is deprecated","version":"7.6"},{"description":"field \u0027bestValue\u0027 is added to the response","version":"7.2"},{"description":"the response field \u0027id\u0027 is deprecated. Use \u0027key\u0027 instead.","version":"6.6"},{"description":"the response field \u0027refId\u0027 is deprecated. Use \u0027refKey\u0027 instead.","version":"6.6"},{"description":"Number of metric keys is limited to 15","version":"6.3"}],"params":[{"key":"additionalFields","description":"Comma-separated list of additional fields that can be returned in the response.","required":false,"internal":false,"exampleValue":"period,metrics","possibleValues":["metrics","period"]},{"key":"asc","description":"Ascending sort","required":false,"internal":false,"defaultValue":"true","possibleValues":["true","false","yes","no"]},{"key":"branch","description":"Branch key. Not available in the community edition.","since":"6.6","required":false,"internal":false,"exampleValue":"feature/my_branch"},{"key":"component","description":"Component key. The search is based on this component.","required":true,"internal":false,"exampleValue":"my_project"},{"key":"metricKeys","description":"Comma-separated list of metric keys. Types DISTRIB are not allowed. For type DATA only reliability_issues, new_maintainability_issues, new_security_issues, new_reliability_issues, security_issues, maintainability_issues metrics are supported","required":true,"internal":false,"exampleValue":"ncloc,complexity,violations","maxValuesAllowed":75},{"key":"metricPeriodSort","description":"Sort measures by leak period or not ?. The \u0027s\u0027 parameter must contain the \u0027metricPeriod\u0027 value.","since":"5.5","required":false,"internal":false,"possibleValues":["1"]},{"key":"metricSort","description":"Metric key to sort by. The \u0027s\u0027 parameter must contain the \u0027metric\u0027 or \u0027metricPeriod\u0027 value. It must be part of the \u0027metricKeys\u0027 parameter","required":false,"internal":false,"exampleValue":"ncloc"},{"key":"metricSortFilter","description":"Filter components. Sort must be on a metric. Possible values are: \u003cul\u003e\u003cli\u003eall: return all components\u003c/li\u003e\u003cli\u003ewithMeasuresOnly: filter out components that do not have a measure on the sorted metric\u003c/li\u003e\u003c/ul\u003e","required":false,"internal":false,"defaultValue":"all","possibleValues":["all","withMeasuresOnly"]},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 500","required":false,"internal":false,"defaultValue":"100","exampleValue":"20","maximumValue":500},{"key":"pullRequest","description":"Pull request id. Not available in the community edition.","since":"7.1","required":false,"internal":false,"exampleValue":"5461"},{"key":"q","description":"Limit search to: \u003cul\u003e\u003cli\u003ecomponent names that contain the supplied string\u003c/li\u003e\u003cli\u003ecomponent keys that are exactly the same as the supplied string\u003c/li\u003e\u003c/ul\u003e","required":false,"internal":false,"exampleValue":"FILE_NAM","minimumLength":3},{"key":"qualifiers","description":"Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:\u003cul\u003e\u003cli\u003eAPP - Applications\u003c/li\u003e\u003cli\u003eVW - Portfolios\u003c/li\u003e\u003cli\u003eSVW - Portfolios\u003c/li\u003e\u003cli\u003eUTS - Test Files\u003c/li\u003e\u003cli\u003eFIL - Files\u003c/li\u003e\u003cli\u003eDIR - Directories\u003c/li\u003e\u003cli\u003eTRK - Projects\u003c/li\u003e\u003c/ul\u003e","required":false,"internal":false,"possibleValues":["APP","VW","SVW","UTS","FIL","DIR","TRK"]},{"key":"s","description":"Comma-separated list of sort fields","required":false,"internal":false,"defaultValue":"name","exampleValue":"name,path","possibleValues":["metric","metricPeriod","name","path","qualifier"]},{"key":"strategy","description":"Strategy to search for base component descendants:\u003cul\u003e\u003cli\u003echildren: return the children components of the base component. Grandchildren components are not returned\u003c/li\u003e\u003cli\u003eall: return all the descendants components of the base component. Grandchildren are returned.\u003c/li\u003e\u003cli\u003eleaves: return all the descendant components (files, in general) which don\u0027t have other children. They are the leaves of the component tree.\u003c/li\u003e\u003c/ul\u003e","required":false,"internal":false,"defaultValue":"all","possibleValues":["children","leaves","all"]}]},{"key":"search_history","description":"Search measures history of a component.\u003cbr\u003eMeasures are ordered chronologically.\u003cbr\u003ePagination applies to the number of measures for each metric.\u003cbr\u003eRequires the following permission: \u0027Browse\u0027 on the specified component. \u003cbr\u003eFor applications, it also requires \u0027Browse\u0027 permission on its child projects.","since":"6.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The following SCA metrics are available on licensed enterprise/datacenter editions with SCA enabled: \u0027sca_rating_licensing\u0027, \u0027sca_rating_vulnerability\u0027, \u0027sca_rating_any_issue\u0027, \u0027sca_severity_licensing\u0027, \u0027sca_severity_vulnerability\u0027, \u0027sca_severity_any_issue\u0027, \u0027sca_count_any_issue\u0027, \u0027new_sca_rating_licensing\u0027, \u0027new_sca_rating_vulnerability\u0027, \u0027new_sca_rating_any_issue\u0027, \u0027new_sca_severity_licensing\u0027, \u0027new_sca_severity_vulnerability\u0027, \u0027new_sca_severity_any_issue\u0027, \u0027new_sca_count_any_issue\u0027","version":"2025.4"},{"description":"The following metrics are not deprecated anymore: \u0027bugs\u0027, \u0027new_bugs\u0027, \u0027vulnerabilities\u0027, \u0027new_vulnerabilities\u0027, \u0027code_smells\u0027, \u0027new_code_smells\u0027, \u0027high_impact_accepted_issues\u0027, \u0027new_blocker_violations\u0027, \u0027new_critical_violations\u0027, \u0027new_major_violations\u0027, \u0027new_minor_violations\u0027, \u0027new_info_violations\u0027, \u0027blocker_violations\u0027, \u0027critical_violations\u0027, \u0027major_violations\u0027, \u0027minor_violations\u0027, \u0027info_violations\u0027","version":"10.8"},{"description":"Added new accepted values for the \u0027metricKeys\u0027 param: \u0027software_quality_blocker_issues\u0027, \u0027software_quality_high_issues\u0027, \u0027software_quality_info_issues\u0027, \u0027software_quality_medium_issues\u0027, \u0027software_quality_low_issues\u0027, \u0027software_quality_maintainability_issues\u0027, \u0027software_quality_reliability_issues\u0027, \u0027software_quality_security_issues\u0027, \u0027new_software_quality_blocker_issues\u0027, \u0027new_software_quality_high_issues\u0027, \u0027new_software_quality_info_issues\u0027, \u0027new_software_quality_medium_issues\u0027, \u0027new_software_quality_low_issues\u0027, \u0027new_software_quality_maintainability_issues\u0027, \u0027new_software_quality_reliability_issues\u0027, \u0027new_software_quality_security_issues\u0027","version":"10.8"},{"description":"The metrics \u0027maintainability_issues\u0027, \u0027reliability_issues\u0027, \u0027security_issues\u0027, \u0027new_maintainability_issues\u0027, \u0027new_reliability_issues\u0027, \u0027new_security_issues\u0027 are now deprecated. Use \u0027software_quality_maintainability_issues\u0027, \u0027software_quality_reliability_issues\u0027, \u0027software_quality_security_issues\u0027, \u0027new_software_quality_maintainability_issues\u0027, \u0027new_software_quality_reliability_issues\u0027, \u0027new_software_quality_security_issues\u0027 instead.","version":"10.8"},{"description":"Added new accepted values for the \u0027metricKeys\u0027 param: \u0027software_quality_maintainability_debt_ratio\u0027, \u0027software_quality_maintainability_rating\u0027, \u0027software_quality_reliability_rating\u0027, \u0027software_quality_security_rating\u0027, \u0027software_quality_maintainability_remediation_effort\u0027, \u0027software_quality_reliability_remediation_effort\u0027, \u0027software_quality_security_remediation_effort\u0027, \u0027effort_to_reach_software_quality_maintainability_rating_a\u0027, \u0027new_software_quality_maintainability_debt_ratio\u0027, \u0027new_software_quality_maintainability_rating\u0027, \u0027new_software_quality_reliability_rating\u0027, \u0027new_software_quality_security_rating\u0027, \u0027new_software_quality_maintainability_remediation_effort\u0027, \u0027new_software_quality_reliability_remediation_effort\u0027, \u0027new_software_quality_security_remediation_effort\u0027","version":"10.7"},{"description":"The metrics \u0027new_blocker_violations\u0027, \u0027new_critical_violations\u0027, \u0027new_major_violations\u0027, \u0027new_minor_violations\u0027, \u0027new_info_violations\u0027, \u0027blocker_violations\u0027, \u0027critical_violations\u0027, \u0027major_violations\u0027, \u0027minor_violations\u0027, \u0027info_violations\u0027 are now deprecated without exact replacement. Use \u0027maintainability_issues\u0027, \u0027reliability_issues\u0027 and \u0027security_issues\u0027 instead.","version":"10.5"},{"description":"Added new accepted values for the \u0027metricKeys\u0027 param: \u0027new_maintainability_issues\u0027, \u0027new_reliability_issues\u0027, \u0027new_security_issues\u0027","version":"10.5"},{"description":"The metrics \u0027bugs\u0027, \u0027new_bugs\u0027, \u0027vulnerabilities\u0027, \u0027new_vulnerabilities\u0027, \u0027code_smells\u0027, \u0027new_code_smells\u0027, \u0027high_impact_accepted_issues\u0027 are now deprecated without exact replacement. Use \u0027maintainability_issues\u0027, \u0027reliability_issues\u0027 and \u0027security_issues\u0027 instead.","version":"10.4"},{"description":"The metrics \u0027open_issues\u0027, \u0027reopened_issues\u0027 and \u0027confirmed_issues\u0027 are now deprecated in the response. Consume \u0027violations\u0027 instead.","version":"10.4"},{"description":"The use of \u0027open_issues\u0027, \u0027reopened_issues\u0027 and \u0027confirmed_issues\u0027 values in \u0027metricKeys\u0027 param are now deprecated. Use \u0027violations\u0027 instead.","version":"10.4"},{"description":"The metric \u0027wont_fix_issues\u0027 is now deprecated in the response. Consume \u0027accepted_issues\u0027 instead.","version":"10.4"},{"description":"The use of \u0027wont_fix_issues\u0027 value in \u0027metricKeys\u0027 param is now deprecated. Use \u0027accepted_issues\u0027 instead.","version":"10.4"},{"description":"Added new accepted value for the \u0027metricKeys\u0027 param: \u0027accepted_issues\u0027.","version":"10.4"},{"description":"The use of the following metrics in \u0027metricKeys\u0027 parameter is not deprecated anymore: \u0027releasability_effort\u0027, \u0027security_rating_effort\u0027, \u0027reliability_rating_effort\u0027, \u0027security_review_rating_effort\u0027, \u0027maintainability_rating_effort\u0027, \u0027last_change_on_maintainability_rating\u0027, \u0027last_change_on_releasability_rating\u0027, \u0027last_change_on_reliability_rating\u0027, \u0027last_change_on_security_rating\u0027, \u0027last_change_on_security_review_rating\u0027","version":"10.0"},{"description":"The use of the following metrics in \u0027metrics\u0027 parameter is deprecated: \u0027releasability_effort\u0027, \u0027security_rating_effort\u0027, \u0027reliability_rating_effort\u0027, \u0027security_review_rating_effort\u0027, \u0027maintainability_rating_effort\u0027, \u0027last_change_on_maintainability_rating\u0027, \u0027last_change_on_releasability_rating\u0027, \u0027last_change_on_reliability_rating\u0027, \u0027last_change_on_security_rating\u0027, \u0027last_change_on_security_review_rating\u0027","version":"9.3"},{"description":"The use of module keys in parameter \u0027component\u0027 is deprecated","version":"7.6"}],"params":[{"key":"branch","description":"Branch key. Not available in the community edition.","since":"6.6","required":false,"internal":false,"exampleValue":"feature/my_branch"},{"key":"component","description":"Component key","required":true,"internal":false,"exampleValue":"my_project"},{"key":"from","description":"Filter measures created after the given date (inclusive). \u003cbr\u003eEither a date (server timezone) or datetime can be provided","required":false,"internal":false,"exampleValue":"2017-10-19 or 2017-10-19T13:00:00+0200"},{"key":"metrics","description":"Comma-separated list of metric keys","required":true,"internal":false,"exampleValue":"ncloc,coverage,new_violations"},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 1000","required":false,"internal":false,"defaultValue":"100","exampleValue":"20","maximumValue":1000},{"key":"pullRequest","description":"Pull request id. Not available in the community edition.","since":"7.1","required":false,"internal":false,"exampleValue":"5461"},{"key":"to","description":"Filter measures created before the given date (inclusive). \u003cbr\u003eEither a date (server timezone) or datetime can be provided","required":false,"internal":false,"exampleValue":"2017-10-19 or 2017-10-19T13:00:00+0200"}]}]},{"path":"api/metrics","since":"2.6","description":"Get information on automatic metrics","actions":[{"key":"search","description":"Search for metrics","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Field \u0027id\u0027 in the response is deprecated","version":"8.4"}],"params":[{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 500","required":false,"internal":false,"defaultValue":"100","exampleValue":"20","maximumValue":500}]},{"key":"types","description":"List all available metric types.","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[]}]},{"path":"api/monitoring","since":"9.3","description":"Monitoring","actions":[{"key":"metrics","description":"Return monitoring metrics in Prometheus format.  \nSupport content type \u0027text/plain\u0027 (default) and \u0027application/openmetrics-text\u0027.\nThis endpoint can be accessed using a Bearer token, which needs to be defined in sonar.properties with the \u0027sonar.web.systemPasscode\u0027 key.","since":"9.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Added \u0027sonarqube_elasticsearch_read_only_indices_total\u0027 and \u0027sonarqube_elasticsearch_disk_usage_percent\u0027 metrics","version":"2026.3"}]}]},{"path":"api/new_code_periods","since":"8.0","description":"Manage \u003ca href\u003d\"https://docs.sonarsource.com/sonarqube-server/2026.6/project-administration/configuring-new-code-calculation#setting-specific-new-code-definition-for-project\" target\u003d\"_blank\" rel\u003d\"noopener noreferrer\"\u003enew code definition\u003c/a\u003e.","actions":[{"key":"list","description":"Lists the \u003ca href\u003d\"https://docs.sonarsource.com/sonarqube-server/2026.6/project-administration/configuring-new-code-calculation#setting-specific-new-code-definition-for-project\" target\u003d\"_blank\" rel\u003d\"noopener noreferrer\"\u003enew code definition\u003c/a\u003e for all branches in a project.\u003cbr\u003eRequires the permission to browse the project","since":"8.0","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"project","description":"Project key","required":true,"internal":false}]},{"key":"set","description":"Updates the \u003ca href\u003d\"https://docs.sonarsource.com/sonarqube-server/2026.6/project-administration/configuring-new-code-calculation#setting-specific-new-code-definition-for-project\" target\u003d\"_blank\" rel\u003d\"noopener noreferrer\"\u003enew code definition\u003c/a\u003e on different levels:\u003cbr\u003e\u003cul\u003e\u003cli\u003eNot providing a project key and a branch key will update the default value at global level. Existing projects or branches having a specific new code definition will not be impacted\u003c/li\u003e\u003cli\u003eProject key must be provided to update the value for a project\u003c/li\u003e\u003cli\u003eBoth project and branch keys must be provided to update the value for a branch\u003c/li\u003e\u003c/ul\u003eRequires one of the following permissions: \u003cul\u003e\u003cli\u003e\u0027Administer System\u0027 to change the global setting\u003c/li\u003e\u003cli\u003e\u0027Administer\u0027 rights on the specified project to change the project setting\u003c/li\u003e\u003c/ul\u003e","since":"8.0","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"branch","description":"Branch key","required":false,"internal":false},{"key":"project","description":"Project key","required":false,"internal":false},{"key":"type","description":"Type\u003cbr/\u003eNew code definitions of the following types are allowed:\u003cul\u003e\u003cli\u003eSPECIFIC_ANALYSIS - can be set at branch level only\u003c/li\u003e\u003cli\u003ePREVIOUS_VERSION - can be set at any level (global, project, branch)\u003c/li\u003e\u003cli\u003eNUMBER_OF_DAYS - can be set at any level (global, project, branch)\u003c/li\u003e\u003cli\u003eREFERENCE_BRANCH - can only be set for projects and branches\u003c/li\u003e\u003c/ul\u003e","required":true,"internal":false},{"key":"value","description":"Value\u003cbr/\u003eFor each type, a different value is expected:\u003cul\u003e\u003cli\u003ethe uuid of an analysis, when type is SPECIFIC_ANALYSIS\u003c/li\u003e\u003cli\u003eno value, when type is PREVIOUS_VERSION\u003c/li\u003e\u003cli\u003ea number between 1 and 90, when type is NUMBER_OF_DAYS\u003c/li\u003e\u003cli\u003ea string, when type is REFERENCE_BRANCH\u003c/li\u003e\u003c/ul\u003e","required":false,"internal":false}]},{"key":"show","description":"Shows the \u003ca href\u003d\"https://docs.sonarsource.com/sonarqube-server/2026.6/project-administration/configuring-new-code-calculation#setting-specific-new-code-definition-for-project\" target\u003d\"_blank\" rel\u003d\"noopener noreferrer\"\u003enew code definition\u003c/a\u003e.\u003cbr\u003e If the component requested doesn\u0027t exist or if no new code definition is set for it, a value is inherited from the project or from the global setting.Requires one of the following permissions if a component is specified: \u003cul\u003e\u003cli\u003e\u0027Administer\u0027 rights on the specified component\u003c/li\u003e\u003cli\u003e\u0027Execute analysis\u0027 rights on the specified component\u003c/li\u003e\u003c/ul\u003e","since":"8.0","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"branch","description":"Branch key","required":false,"internal":false},{"key":"project","description":"Project key","required":false,"internal":false}]},{"key":"unset","description":"Unsets the \u003ca href\u003d\"https://docs.sonarsource.com/sonarqube-server/2026.6/project-administration/configuring-new-code-calculation#setting-specific-new-code-definition-for-project\" target\u003d\"_blank\" rel\u003d\"noopener noreferrer\"\u003enew code definition\u003c/a\u003e for a branch, project or global. It requires the inherited New Code Definition to be compatible with the Clean as You Code methodology, and one of the following permissions: \u003cul\u003e\u003cli\u003e\u0027Administer System\u0027 to change the global setting\u003c/li\u003e\u003cli\u003e\u0027Administer\u0027 rights for a specified component\u003c/li\u003e\u003c/ul\u003e","since":"8.0","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"branch","description":"Branch key","required":false,"internal":false},{"key":"project","description":"Project key","required":false,"internal":false}]}]},{"path":"api/notifications","since":"6.3","description":"Manage notifications of the authenticated user","actions":[{"key":"add","description":"Add a notification for the authenticated user.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e \u003cli\u003eAuthentication if no login is provided. If a project is provided, requires the \u0027Browse\u0027 permission on the specified project.\u003c/li\u003e \u003cli\u003eSystem administration if a login is provided. If a project is provided, requires the \u0027Browse\u0027 permission on the specified project.\u003c/li\u003e\u003c/ul\u003e","since":"6.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"channel","description":"Channel through which the notification is sent. For example, notifications can be sent by email.","required":false,"internal":false,"defaultValue":"EmailNotificationChannel","possibleValues":["EmailNotificationChannel"]},{"key":"login","description":"User login","since":"6.4","required":false,"internal":false},{"key":"project","description":"Project key","required":false,"internal":false,"exampleValue":"my_project"},{"key":"type","description":"Notification type. Possible values are for:\u003cul\u003e  \u003cli\u003eGlobal notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, QualityGateConditionsMismatch, SQ-MyNewIssues\u003c/li\u003e  \u003cli\u003ePer project notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, NewFalsePositiveIssue, NewIssues, SQ-MyNewIssues\u003c/li\u003e\u003c/ul\u003e","required":true,"internal":false,"exampleValue":"SQ-MyNewIssues"}]},{"key":"list","description":"List notifications of the authenticated user.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003eAuthentication if no login is provided\u003c/li\u003e  \u003cli\u003eSystem administration if a login is provided\u003c/li\u003e\u003c/ul\u003e","since":"6.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"filter","description":"Category of notification types to return.","since":"2026.5","required":false,"internal":false,"defaultValue":"all","possibleValues":["user","groupSubscription","all"]},{"key":"login","description":"User login","since":"6.4","required":false,"internal":false}]},{"key":"remove","description":"Remove a notification for the authenticated user.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003eAuthentication if no login is provided\u003c/li\u003e  \u003cli\u003eSystem administration if a login is provided\u003c/li\u003e\u003c/ul\u003e","since":"6.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"channel","description":"Channel through which the notification is sent. For example, notifications can be sent by email.","required":false,"internal":false,"defaultValue":"EmailNotificationChannel","possibleValues":["EmailNotificationChannel"]},{"key":"login","description":"User login","since":"6.4","required":false,"internal":false},{"key":"project","description":"Project key","required":false,"internal":false,"exampleValue":"my_project"},{"key":"type","description":"Notification type. Possible values are for:\u003cul\u003e  \u003cli\u003eGlobal notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, QualityGateConditionsMismatch, SQ-MyNewIssues\u003c/li\u003e  \u003cli\u003ePer project notifications: CeReportTaskFailure, ChangesOnMyIssue, NewAlerts, NewFalsePositiveIssue, NewIssues, SQ-MyNewIssues\u003c/li\u003e\u003c/ul\u003e","required":true,"internal":false,"exampleValue":"SQ-MyNewIssues"}]}]},{"path":"api/permissions","since":"3.7","description":"Manage permission templates, and the granting and revoking of permissions at the global and project levels.","actions":[{"key":"add_group","description":"Add a permission to a group.\u003cbr /\u003e This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.\u003cbr /\u003e The group name must be provided. \u003cbr /\u003eRequires one of the following permissions:\u003cul\u003e\u003cli\u003e\u0027Administer System\u0027\u003c/li\u003e\u003cli\u003e\u0027Administer\u0027 rights on the specified project\u003c/li\u003e\u003c/ul\u003e","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Parameter \u0027groupName\u0027 no longer accepts \u0027Anyone\u0027, which is not a recognized group name anymore.","version":"2026.6"},{"description":"Parameter \u0027groupId\u0027 is removed. Use \u0027groupName\u0027 instead.","version":"10.0"},{"description":"Parameter \u0027groupId\u0027 is deprecated. Format changes from integer to string. Use \u0027groupName\u0027 instead.","version":"8.4"}],"params":[{"key":"groupName","description":"Group name","required":true,"internal":false,"exampleValue":"sonar-administrators"},{"key":"permission","description":"The permission you would like to grant to the group.\u003cul\u003e\u003cli\u003ePossible values for global permissions: admin, gateadmin, profileadmin, architectureadmin, provisioning, scan, applicationcreator, portfoliocreator\u003c/li\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, architectureadmin, scan, user\u003c/li\u003e\u003c/ul\u003e","required":true,"internal":false},{"key":"projectId","description":"Project id","required":false,"internal":false,"exampleValue":"ce4c03d6-430f-40a9-b777-ad877c00aa4d"},{"key":"projectKey","description":"Project key","required":false,"internal":false,"exampleValue":"my_project"}]},{"key":"add_group_to_template","description":"Add a group to a permission template.\u003cbr /\u003e The group name must be provided. \u003cbr /\u003eRequires the following permission: \u0027Administer System\u0027.","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Parameter \u0027groupName\u0027 no longer accepts \u0027Anyone\u0027, which is not a recognized group name anymore.","version":"2026.6"},{"description":"Parameter \u0027groupId\u0027 is removed. Use \u0027groupName\u0027 instead.","version":"10.0"},{"description":"Parameter \u0027groupId\u0027 is deprecated. Format changes from integer to string. Use \u0027groupName\u0027 instead.","version":"8.4"}],"params":[{"key":"groupName","description":"Group name","required":true,"internal":false,"exampleValue":"sonar-administrators"},{"key":"permission","description":"Permission\u003cul\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, architectureadmin, scan, user\u003c/li\u003e\u003c/ul\u003e","required":true,"internal":false,"possibleValues":["admin","codeviewer","issueadmin","securityhotspotadmin","architectureadmin","scan","user"]},{"key":"templateId","description":"Template id","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"templateName","description":"Template name","required":false,"internal":false,"exampleValue":"Default Permission Template for Projects"}]},{"key":"add_project_creator_to_template","description":"Add a project creator to a permission template.\u003cbr\u003eRequires the following permission: \u0027Administer System\u0027.","since":"6.0","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"permission","description":"Permission\u003cul\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, architectureadmin, scan, user\u003c/li\u003e\u003c/ul\u003e","required":true,"internal":false,"possibleValues":["admin","codeviewer","issueadmin","securityhotspotadmin","architectureadmin","scan","user"]},{"key":"templateId","description":"Template id","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"templateName","description":"Template name","required":false,"internal":false,"exampleValue":"Default Permission Template for Projects"}]},{"key":"add_user","description":"Add permission to a user.\u003cbr /\u003e This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.\u003cbr /\u003eRequires one of the following permissions:\u003cul\u003e\u003cli\u003e\u0027Administer System\u0027\u003c/li\u003e\u003cli\u003e\u0027Administer\u0027 rights on the specified project\u003c/li\u003e\u003c/ul\u003e","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"login","description":"User login","required":true,"internal":false,"exampleValue":"g.hopper"},{"key":"permission","description":"The permission you would like to grant to the user\u003cul\u003e\u003cli\u003ePossible values for global permissions: admin, gateadmin, profileadmin, architectureadmin, provisioning, scan, applicationcreator, portfoliocreator\u003c/li\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, architectureadmin, scan, user\u003c/li\u003e\u003c/ul\u003e","required":true,"internal":false},{"key":"projectId","description":"Project id","required":false,"internal":false,"exampleValue":"ce4c03d6-430f-40a9-b777-ad877c00aa4d"},{"key":"projectKey","description":"Project key","required":false,"internal":false,"exampleValue":"my_project"}]},{"key":"add_user_to_template","description":"Add a user to a permission template.\u003cbr /\u003e Requires the following permission: \u0027Administer System\u0027.","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"login","description":"User login","required":true,"internal":false,"exampleValue":"g.hopper"},{"key":"permission","description":"Permission\u003cul\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, architectureadmin, scan, user\u003c/li\u003e\u003c/ul\u003e","required":true,"internal":false,"possibleValues":["admin","codeviewer","issueadmin","securityhotspotadmin","architectureadmin","scan","user"]},{"key":"templateId","description":"Template id","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"templateName","description":"Template name","required":false,"internal":false,"exampleValue":"Default Permission Template for Projects"}]},{"key":"apply_template","description":"Apply a permission template to one project.\u003cbr\u003eThe project id or project key must be provided.\u003cbr\u003eThe template id or name must be provided.\u003cbr\u003eRequires the following permission: \u0027Administer System\u0027.","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"projectId","description":"Project id","required":false,"internal":false,"exampleValue":"ce4c03d6-430f-40a9-b777-ad877c00aa4d"},{"key":"projectKey","description":"Project key","required":false,"internal":false,"exampleValue":"my_project"},{"key":"templateId","description":"Template id","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"templateName","description":"Template name","required":false,"internal":false,"exampleValue":"Default Permission Template for Projects"}]},{"key":"bulk_apply_template","description":"Apply a permission template to several components. Managed projects will be ignored.\u003cbr /\u003eThe template id or name must be provided.\u003cbr /\u003eRequires the following permission: \u0027Administer System\u0027.","since":"5.5","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Parameter projects accepts maximum 1000 values","version":"6.7.2"}],"params":[{"key":"analyzedBefore","description":"Filter the projects for which last analysis is older than the given date (exclusive).\u003cbr\u003e Either a date (server timezone) or datetime can be provided.","since":"6.6","required":false,"internal":false,"exampleValue":"2017-10-19 or 2017-10-19T13:00:00+0200"},{"key":"onProvisionedOnly","description":"Filter the projects that are provisioned","since":"6.6","required":false,"internal":false,"defaultValue":"false","possibleValues":["true","false","yes","no"]},{"key":"projects","description":"Comma-separated list of project keys","since":"6.6","required":false,"internal":false,"exampleValue":"my_project,another_project","maxValuesAllowed":1000},{"key":"q","description":"Limit search to: \u003cul\u003e\u003cli\u003eproject names that contain the supplied string\u003c/li\u003e\u003cli\u003eproject keys that are exactly the same as the supplied string\u003c/li\u003e\u003c/ul\u003e","required":false,"internal":false,"exampleValue":"apac"},{"key":"qualifiers","description":"Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:\u003cul\u003e\u003cli\u003eAPP - Applications\u003c/li\u003e\u003cli\u003eTRK - Projects\u003c/li\u003e\u003cli\u003eVW - Portfolios\u003c/li\u003e\u003c/ul\u003e","required":false,"internal":false,"defaultValue":"TRK","possibleValues":["APP","TRK","VW"]},{"key":"templateId","description":"Template id","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"templateName","description":"Template name","required":false,"internal":false,"exampleValue":"Default Permission Template for Projects"}]},{"key":"create_template","description":"Create a permission template.\u003cbr /\u003eRequires the following permission: \u0027Administer System\u0027.","since":"5.2","internal":false,"post":true,"hasResponseExample":true,"changelog":[],"params":[{"key":"description","description":"Description","required":false,"internal":false,"exampleValue":"Permissions for all projects related to the financial service"},{"key":"name","description":"Name","required":true,"internal":false,"exampleValue":"Financial Service Permissions"},{"key":"projectKeyPattern","description":"Project key pattern. Must be a valid Java regular expression","required":false,"internal":false,"exampleValue":".*\\.finance\\..*"}]},{"key":"delete_template","description":"Delete a permission template.\u003cbr /\u003eRequires the following permission: \u0027Administer System\u0027.","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"templateId","description":"Template id","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"templateName","description":"Template name","required":false,"internal":false,"exampleValue":"Default Permission Template for Projects"}]},{"key":"remove_group","description":"Remove a permission from a group.\u003cbr /\u003e This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.\u003cbr /\u003e The group name must be provided.\u003cbr /\u003eRequires one of the following permissions:\u003cul\u003e\u003cli\u003e\u0027Administer System\u0027\u003c/li\u003e\u003cli\u003e\u0027Administer\u0027 rights on the specified project\u003c/li\u003e\u003c/ul\u003e","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Parameter \u0027groupName\u0027 no longer accepts \u0027Anyone\u0027, which is not a recognized group name anymore.","version":"2026.6"},{"description":"Parameter \u0027groupId\u0027 is removed. Use \u0027groupName\u0027 instead.","version":"10.0"},{"description":"Parameter \u0027groupId\u0027 is deprecated. Format changes from integer to string. Use \u0027groupName\u0027 instead.","version":"8.4"}],"params":[{"key":"groupName","description":"Group name","required":true,"internal":false,"exampleValue":"sonar-administrators"},{"key":"permission","description":"The permission you would like to revoke from the group.\u003cul\u003e\u003cli\u003ePossible values for global permissions: admin, gateadmin, profileadmin, architectureadmin, provisioning, scan, applicationcreator, portfoliocreator\u003c/li\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, architectureadmin, scan, user\u003c/li\u003e\u003c/ul\u003e","required":true,"internal":false},{"key":"projectId","description":"Project id","required":false,"internal":false,"exampleValue":"ce4c03d6-430f-40a9-b777-ad877c00aa4d"},{"key":"projectKey","description":"Project key","required":false,"internal":false,"exampleValue":"my_project"}]},{"key":"remove_group_from_template","description":"Remove a group from a permission template.\u003cbr /\u003e The group name must be provided. \u003cbr /\u003eRequires the following permission: \u0027Administer System\u0027.","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Parameter \u0027groupName\u0027 no longer accepts \u0027Anyone\u0027, which is not a recognized group name anymore.","version":"2026.6"},{"description":"Parameter \u0027groupId\u0027 is removed. Use \u0027groupName\u0027 instead.","version":"10.0"},{"description":"Parameter \u0027groupId\u0027 is deprecated. Format changes from integer to string. Use \u0027groupName\u0027 instead.","version":"8.4"}],"params":[{"key":"groupName","description":"Group name","required":true,"internal":false,"exampleValue":"sonar-administrators"},{"key":"permission","description":"Permission\u003cul\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, architectureadmin, scan, user\u003c/li\u003e\u003c/ul\u003e","required":true,"internal":false,"possibleValues":["admin","codeviewer","issueadmin","securityhotspotadmin","architectureadmin","scan","user"]},{"key":"templateId","description":"Template id","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"templateName","description":"Template name","required":false,"internal":false,"exampleValue":"Default Permission Template for Projects"}]},{"key":"remove_project_creator_from_template","description":"Remove a project creator from a permission template.\u003cbr\u003eRequires the following permission: \u0027Administer System\u0027.","since":"6.0","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"permission","description":"Permission\u003cul\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, architectureadmin, scan, user\u003c/li\u003e\u003c/ul\u003e","required":true,"internal":false,"possibleValues":["admin","codeviewer","issueadmin","securityhotspotadmin","architectureadmin","scan","user"]},{"key":"templateId","description":"Template id","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"templateName","description":"Template name","required":false,"internal":false,"exampleValue":"Default Permission Template for Projects"}]},{"key":"remove_user","description":"Remove permission from a user.\u003cbr /\u003e This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.\u003cbr /\u003e Requires one of the following permissions:\u003cul\u003e\u003cli\u003e\u0027Administer System\u0027\u003c/li\u003e\u003cli\u003e\u0027Administer\u0027 rights on the specified project\u003c/li\u003e\u003c/ul\u003e","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"login","description":"User login","required":true,"internal":false,"exampleValue":"g.hopper"},{"key":"permission","description":"The permission you would like to revoke from the user.\u003cul\u003e\u003cli\u003ePossible values for global permissions: admin, gateadmin, profileadmin, architectureadmin, provisioning, scan, applicationcreator, portfoliocreator\u003c/li\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, architectureadmin, scan, user\u003c/li\u003e\u003c/ul\u003e","required":true,"internal":false},{"key":"projectId","description":"Project id","required":false,"internal":false,"exampleValue":"ce4c03d6-430f-40a9-b777-ad877c00aa4d"},{"key":"projectKey","description":"Project key","required":false,"internal":false,"exampleValue":"my_project"}]},{"key":"remove_user_from_template","description":"Remove a user from a permission template.\u003cbr /\u003e Requires the following permission: \u0027Administer System\u0027.","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"login","description":"User login","required":true,"internal":false,"exampleValue":"g.hopper"},{"key":"permission","description":"Permission\u003cul\u003e\u003cli\u003ePossible values for project permissions admin, codeviewer, issueadmin, securityhotspotadmin, architectureadmin, scan, user\u003c/li\u003e\u003c/ul\u003e","required":true,"internal":false,"possibleValues":["admin","codeviewer","issueadmin","securityhotspotadmin","architectureadmin","scan","user"]},{"key":"templateId","description":"Template id","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"templateName","description":"Template name","required":false,"internal":false,"exampleValue":"Default Permission Template for Projects"}]},{"key":"search_templates","description":"List permission templates.\u003cbr /\u003eRequires the following permission: \u0027Administer System\u0027.","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Add optional pagination support to search_templates API.","version":"2026.2"}],"params":[{"key":"p","description":"1-based page number","required":false,"internal":false,"exampleValue":"2"},{"key":"ps","description":"Page size. Must be greater than or equal to 0 and less or equal than 500. If this and p param are not provided, pagination is disabled and all results are returned. If pageSize\u003d0, no results are returned but the response will contain the total count of matching templates.","required":false,"internal":false,"exampleValue":"100"},{"key":"q","description":"Limit search to permission template names that contain the supplied string.","required":false,"internal":false,"exampleValue":"defau"}]},{"key":"set_default_template","description":"Set a permission template as default.\u003cbr /\u003eRequires the following permission: \u0027Administer System\u0027.","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"qualifier","description":"Project qualifier. Filter the results with the specified qualifier. Possible values are:\u003cul\u003e\u003cli\u003eAPP - Applications\u003c/li\u003e\u003cli\u003eTRK - Projects\u003c/li\u003e\u003cli\u003eVW - Portfolios\u003c/li\u003e\u003c/ul\u003e","required":false,"internal":false,"defaultValue":"TRK","possibleValues":["APP","TRK","VW"]},{"key":"templateId","description":"Template id","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"templateName","description":"Template name","required":false,"internal":false,"exampleValue":"Default Permission Template for Projects"}]},{"key":"update_template","description":"Update a permission template.\u003cbr /\u003eRequires the following permission: \u0027Administer System\u0027.","since":"5.2","internal":false,"post":true,"hasResponseExample":true,"changelog":[],"params":[{"key":"description","description":"Description","required":false,"internal":false,"exampleValue":"Permissions for all projects related to the financial service"},{"key":"id","description":"Id","required":true,"internal":false,"exampleValue":"af8cb8cc-1e78-4c4e-8c00-ee8e814009a5"},{"key":"name","description":"Name","required":false,"internal":false,"exampleValue":"Financial Service Permissions"},{"key":"projectKeyPattern","description":"Project key pattern. Must be a valid Java regular expression","required":false,"internal":false,"exampleValue":".*\\.finance\\..*"}]}]},{"path":"api/plugins","since":"5.2","description":"Manage the plugins on the server, including installing, uninstalling, and upgrading.","actions":[{"key":"available","description":"Get the list of all the plugins available for installation on the SonarQube instance, sorted by plugin name.\u003cbr/\u003ePlugin information is retrieved from Update Center. Date and time at which Update Center was last refreshed is provided in the response.\u003cbr/\u003eUpdate status values are: \u003cul\u003e\u003cli\u003eCOMPATIBLE: plugin is compatible with current SonarQube instance.\u003c/li\u003e\u003cli\u003eINCOMPATIBLE: plugin is not compatible with current SonarQube instance.\u003c/li\u003e\u003cli\u003eREQUIRES_SYSTEM_UPGRADE: plugin requires SonarQube to be upgraded before being installed.\u003c/li\u003e\u003cli\u003eDEPS_REQUIRE_SYSTEM_UPGRADE: at least one plugin on which the plugin is dependent requires SonarQube to be upgraded.\u003c/li\u003e\u003c/ul\u003eRequire \u0027Administer System\u0027 permission.","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[]},{"key":"cancel_all","description":"Cancels any operation pending on any plugin (install, update or uninstall)\u003cbr/\u003eRequires user to be authenticated with Administer System permissions","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[]},{"key":"install","description":"Installs the latest version of a plugin specified by its key.\u003cbr/\u003ePlugin information is retrieved from Update Center.\u003cbr/\u003eFails if used on commercial editions or plugin risk consent has not been accepted.\u003cbr/\u003eRequires user to be authenticated with Administer System permissions","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"key","description":"The key identifying the plugin to install","required":true,"internal":false}]},{"key":"installed","description":"Get the list of all the plugins installed on the SonarQube instance, sorted by plugin name.\u003cbr/\u003eRequires authentication.","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The response field \u0027requiredForLanguages\u0027 is added for plugins that support it","version":"10.4"},{"description":"The \u0027documentationPath\u0027 field is deprecated","version":"9.8"},{"description":"Authentication check added","version":"9.7"},{"description":"The \u0027documentationPath\u0027 field is added","version":"8.0"},{"description":"The fields \u0027compressedHash\u0027 and \u0027compressedFilename\u0027 are added","version":"7.0"},{"description":"The \u0027filename\u0027 field is added","version":"6.6"},{"description":"The \u0027fileHash\u0027 field is added","version":"6.6"},{"description":"The \u0027sonarLintSupported\u0027 field is added","version":"6.6"},{"description":"The \u0027updatedAt\u0027 field is added","version":"6.6"}],"params":[{"key":"f","description":"Comma-separated list of the additional fields to be returned in response. No additional field is returned by default. Possible values are:\u003cul\u003e\u003cli\u003ecategory - category as defined in the Update Center. A connection to the Update Center is needed\u003c/li\u003e\u003c/ul\u003e","since":"5.6","required":false,"internal":false,"possibleValues":["category"]}]},{"key":"pending","description":"Get the list of plugins which will either be installed or removed at the next startup of the SonarQube instance, sorted by plugin name.\u003cbr/\u003eRequire \u0027Administer System\u0027 permission.","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The \u0027documentationPath\u0027 field is deprecated","version":"9.8"},{"description":"The \u0027documentationPath\u0027 field is added","version":"8.0"}]},{"key":"uninstall","description":"Uninstalls the plugin specified by its key.\u003cbr/\u003eRequires user to be authenticated with Administer System permissions.","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"key","description":"The key identifying the plugin to uninstall","required":true,"internal":false}]},{"key":"update","description":"Updates a plugin specified by its key to the latest version compatible with the SonarQube instance.\u003cbr/\u003ePlugin information is retrieved from Update Center.\u003cbr/\u003eRequires user to be authenticated with Administer System permissions","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"key","description":"The key identifying the plugin to update","required":true,"internal":false}]},{"key":"updates","description":"Lists plugins installed on the SonarQube instance for which at least one newer version is available, sorted by plugin name.\u003cbr/\u003eEach newer version is listed, ordered from the oldest to the newest, with its own update/compatibility status.\u003cbr/\u003ePlugin information is retrieved from Update Center. Date and time at which Update Center was last refreshed is provided in the response.\u003cbr/\u003eUpdate status values are: [COMPATIBLE, INCOMPATIBLE, REQUIRES_UPGRADE, DEPS_REQUIRE_UPGRADE].\u003cbr/\u003eRequire \u0027Administer System\u0027 permission.","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[]}]},{"path":"api/project_analyses","since":"6.3","description":"Manage project analyses.","actions":[{"key":"create_event","description":"Create a project analysis event.\u003cbr\u003eOnly event of category \u0027VERSION\u0027 and \u0027OTHER\u0027 can be created.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer System\u0027\u003c/li\u003e  \u003cli\u003e\u0027Administer\u0027 rights on the specified project\u003c/li\u003e\u003c/ul\u003e","since":"6.3","internal":false,"post":true,"hasResponseExample":true,"changelog":[],"params":[{"key":"analysis","description":"Analysis key","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"category","description":"Category","required":false,"internal":false,"defaultValue":"OTHER","possibleValues":["VERSION","OTHER"]},{"key":"name","description":"Name","required":true,"internal":false,"exampleValue":"5.6","maximumLength":400}]},{"key":"delete","description":"Delete a project analysis.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer System\u0027\u003c/li\u003e  \u003cli\u003e\u0027Administer\u0027 rights on the project of the specified analysis\u003c/li\u003e\u003c/ul\u003e","since":"6.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"analysis","description":"Analysis key","required":true,"internal":false,"exampleValue":"AU-TpxcA-iU5OvuD2FL1"}]},{"key":"delete_event","description":"Delete a project analysis event.\u003cbr\u003eOnly event of category \u0027VERSION\u0027 and \u0027OTHER\u0027 can be deleted.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer System\u0027\u003c/li\u003e  \u003cli\u003e\u0027Administer\u0027 rights on the specified project\u003c/li\u003e\u003c/ul\u003e","since":"6.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"event","description":"Event key","required":true,"internal":false,"exampleValue":"AU-TpxcA-iU5OvuD2FLz"}]},{"key":"search","description":"Search a project analyses and attached events.\u003cbr\u003eRequires the following permission: \u0027Browse\u0027 on the specified project. \u003cbr\u003eFor applications, it also requires \u0027Browse\u0027 permission on its child projects.","since":"6.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Add response field \u0027relativePathFromScmRoot\u0027","version":"2026.5"},{"description":"Add response field \u0027qualityProfile\u0027 for events related to quality profile changes","version":"10.3"},{"description":"Add response field \u0027detectedCI\u0027","version":"9.0"},{"description":"Add QualityGate information on Applications","version":"7.5"}],"params":[{"key":"category","description":"Event category. Filter analyses that have at least one event of the category specified.","required":false,"internal":false,"exampleValue":"OTHER","possibleValues":["VERSION","OTHER","QUALITY_PROFILE","QUALITY_GATE","DEFINITION_CHANGE","ISSUE_DETECTION","SQ_UPGRADE"]},{"key":"from","description":"Filter analyses created after the given date (inclusive). \u003cbr\u003eEither a date (server timezone) or datetime can be provided","since":"6.5","required":false,"internal":false,"exampleValue":"2013-05-01"},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 500","required":false,"internal":false,"defaultValue":"100","exampleValue":"20","maximumValue":500},{"key":"to","description":"Filter analyses created before the given date (inclusive). \u003cbr\u003eEither a date (server timezone) or datetime can be provided","since":"6.5","required":false,"internal":false,"exampleValue":"2017-10-19 or 2017-10-19T13:00:00+0200"}]},{"key":"update_event","description":"Update a project analysis event.\u003cbr\u003eOnly events of category \u0027VERSION\u0027 and \u0027OTHER\u0027 can be updated.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer System\u0027\u003c/li\u003e  \u003cli\u003e\u0027Administer\u0027 rights on the specified project\u003c/li\u003e\u003c/ul\u003e","since":"6.3","internal":false,"post":true,"hasResponseExample":true,"changelog":[],"params":[{"key":"event","description":"Event key","required":true,"internal":false,"exampleValue":"AU-TpxcA-iU5OvuD2FL5"},{"key":"name","description":"New name","required":true,"internal":false,"exampleValue":"5.6","maximumLength":400}]}]},{"path":"api/project_badges","since":"7.1","description":"Generate badges based on quality gates or measures","actions":[{"key":"ai_code_assurance","description":"Generate a badge for project\u0027s AI assurance as an SVG.\u003cbr/\u003eRequires \u0027Browse\u0027 permission on the specified project.","since":"10.7","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"project","description":"Project or application key","required":true,"internal":false,"exampleValue":"my_project"},{"key":"token","description":"Project badge token. Required for private projects or if the \u0027sonar.forceAuthentication\u0027 setting is enabled.","required":false,"internal":false,"exampleValue":"8bb493196edb5896ccb64582499895f187a2ae8f"}]},{"key":"measure","description":"Generate badge for project\u0027s measure as an SVG.\u003cbr/\u003eRequires \u0027Browse\u0027 permission on the specified project.","since":"7.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The following metric keys are not deprecated anymore: bugs, code_smells, security_hotspots, vulnerabilities","version":"10.8"},{"description":"The following metric keys are now deprecated: bugs, code_smells, security_hotspots, vulnerabilities","version":"10.4"}],"params":[{"key":"branch","description":"Branch key","required":false,"internal":false,"exampleValue":"feature/my_branch"},{"key":"metric","description":"Metric key","required":true,"internal":false,"possibleValues":["coverage","duplicated_lines_density","ncloc","alert_status","security_hotspots","bugs","code_smells","vulnerabilities","sqale_rating","reliability_rating","security_rating","sqale_index","software_quality_reliability_issues","software_quality_maintainability_issues","software_quality_security_issues","software_quality_maintainability_rating","software_quality_reliability_rating","software_quality_security_rating","software_quality_maintainability_remediation_effort"]},{"key":"project","description":"Project or application key","required":true,"internal":false,"exampleValue":"my_project"},{"key":"token","description":"Project badge token. Required for private projects or if the \u0027sonar.forceAuthentication\u0027 setting is enabled.","required":false,"internal":false,"exampleValue":"8bb493196edb5896ccb64582499895f187a2ae8f"}]},{"key":"quality_gate","description":"Generate badge for project\u0027s quality gate as an SVG.\u003cbr/\u003eRequires \u0027Browse\u0027 permission on the specified project.","since":"7.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"branch","description":"Branch key","required":false,"internal":false,"exampleValue":"feature/my_branch"},{"key":"project","description":"Project or application key","required":true,"internal":false,"exampleValue":"my_project"},{"key":"token","description":"Project badge token. Required for private projects or if the \u0027sonar.forceAuthentication\u0027 setting is enabled.","required":false,"internal":false,"exampleValue":"8bb493196edb5896ccb64582499895f187a2ae8f"}]},{"key":"renew_token","description":"Creates new token replacing any existing token for project or application badge access for private projects and applications.\u003cbr/\u003eThis token can be used to authenticate with api/project_badges/quality_gate and api/project_badges/measure endpoints.\u003cbr/\u003eRequires \u0027Administer\u0027 permission on the specified project or application.\u003cbr/\u003eIf the \u0027sonar.forceAuthentication\u0027 setting is enabled, then a token is required for public projects as well.","since":"9.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Application key can be used for project parameter.","version":"10.1"}],"params":[{"key":"project","description":"Project or application key","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"token","description":"Retrieve a token to use for project or application badge access for private projects or applications.\u003cbr/\u003eThis token can be used to authenticate with api/project_badges/quality_gate and api/project_badges/measure endpoints.\u003cbr/\u003eRequires \u0027Browse\u0027 permission on the specified project or application.\u003cbr/\u003eIf the \u0027sonar.forceAuthentication\u0027 setting is enabled, then a token is required for public projects as well.","since":"9.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Application key can be used for project parameter.","version":"10.1"}],"params":[{"key":"project","description":"Project or application key","required":true,"internal":false,"exampleValue":"my_project"}]}]},{"path":"api/project_branches","since":"6.6","description":"Manage branch","actions":[{"key":"delete","description":"Delete a non-main branch of a project or application.\u003cbr/\u003eRequires \u0027Administer\u0027 rights on the specified project or application.","since":"6.6","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"branch","description":"Branch key","required":true,"internal":false,"exampleValue":"feature/my_branch"},{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"list","description":"List the branches of a project or application.\u003cbr/\u003eRequires \u0027Browse\u0027 or \u0027Execute analysis\u0027 rights on the specified project or application.","since":"6.6","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Field \u0027branchId\u0027 added to the response","version":"10.6"},{"description":"Application can be used on this web service","version":"7.2"}],"params":[{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"rename","description":"Rename the main branch of a project or application.\u003cbr/\u003eRequires \u0027Administer\u0027 permission on the specified project or application.","since":"6.6","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"name","description":"New name of the main branch","required":true,"internal":false,"exampleValue":"branch1","maximumLength":255},{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"set_automatic_deletion_protection","description":"Protect a specific branch from automatic deletion. Protection can\u0027t be disabled for the main branch.\u003cbr/\u003eRequires \u0027Administer\u0027 permission on the specified project or application.","since":"8.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"branch","description":"Branch key","required":true,"internal":false,"exampleValue":"feature/my_branch"},{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"},{"key":"value","description":"Sets whether the branch should be protected from automatic deletion when it hasn\u0027t been analyzed for a set period of time.","required":true,"internal":false,"exampleValue":"true","possibleValues":["true","false","yes","no"]}]},{"key":"set_main","description":"Allow to set a new main branch.\u003cbr/\u003e. Caution, only applicable on projects.\u003cbr\u003eRequires \u0027Administer\u0027 rights on the specified project or application.","since":"10.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"branch","description":"Branch key","required":true,"internal":false,"exampleValue":"new_master"},{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"}]}]},{"path":"api/project_dump","since":"1.0","description":"Project export/import","actions":[{"key":"export","description":"Triggers project dump so that the project can be imported to another SonarQube server (see api/project_dump/import, available in Enterprise Edition). Requires the \u0027Administer\u0027 permission.","since":"1.0","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"Moved from Enterprise Edition to Community Edition","version":"9.2"}],"params":[{"key":"key","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"import","description":"Triggers the import of a project dump. Permission \u0027Administer\u0027 is required. This feature is provided by the Governance plugin.","since":"1.0","internal":false,"post":true,"hasResponseExample":true,"changelog":[],"params":[{"key":"key","required":true,"internal":false,"exampleValue":"my_project"}]}]},{"path":"api/project_links","since":"6.1","description":"Manage projects links.","actions":[{"key":"create","description":"Create a new project link.\u003cbr\u003eRequires \u0027Administer\u0027 permission on the specified project, or global \u0027Administer\u0027 permission.","since":"6.1","internal":false,"post":true,"hasResponseExample":true,"changelog":[],"params":[{"key":"name","description":"Link name","required":true,"internal":false,"exampleValue":"Custom","maximumLength":128},{"key":"projectId","description":"Project id","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"projectKey","description":"Project key","required":false,"internal":false,"exampleValue":"my_project"},{"key":"url","description":"Link url","required":true,"internal":false,"exampleValue":"http://example.com","maximumLength":2048}]},{"key":"delete","description":"Delete existing project link.\u003cbr\u003eRequires \u0027Administer\u0027 permission on the specified project, or global \u0027Administer\u0027 permission.","since":"6.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"id","description":"Link id","required":true,"internal":false,"exampleValue":"17"}]},{"key":"search","description":"List links of a project.\u003cbr\u003eThe \u0027projectId\u0027 or \u0027projectKey\u0027 must be provided.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e\u003cli\u003e\u0027Administer System\u0027\u003c/li\u003e\u003cli\u003e\u0027Administer\u0027 rights on the specified project\u003c/li\u003e\u003cli\u003e\u0027Browse\u0027 on the specified project\u003c/li\u003e\u003c/ul\u003e","since":"6.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"projectId","description":"Project Id","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"projectKey","description":"Project Key","required":false,"internal":false,"exampleValue":"my_project"}]}]},{"path":"api/project_pull_requests","since":"7.1","description":"Manage pull request","actions":[{"key":"delete","description":"Delete a pull request.\u003cbr/\u003eRequires \u0027Administer\u0027 rights on the specified project.","since":"7.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"},{"key":"pullRequest","description":"Pull request id","required":true,"internal":false,"exampleValue":"1543"}]},{"key":"list","description":"List the pull requests of a project.\u003cbr/\u003eOne of the following permissions is required: \u003cul\u003e\u003cli\u003e\u0027Browse\u0027 rights on the specified project\u003c/li\u003e\u003cli\u003e\u0027Execute Analysis\u0027 rights on the specified project\u003c/li\u003e\u003c/ul\u003e","since":"7.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Response field \u0027pullRequestId\u0027 has been added","version":"2026.6"},{"description":"Response fields: \u0027bugs\u0027, \u0027vulnerabilities\u0027, \u0027codeSmells\u0027 has been dropped.","version":"9.8"},{"description":"Response fields: \u0027bugs\u0027, \u0027vulnerabilities\u0027, \u0027codeSmells\u0027 are deprecated.","version":"8.4"}],"params":[{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"}]}]},{"path":"api/project_tags","since":"6.4","description":"Manage project tags","actions":[{"key":"search","description":"Search tags","since":"6.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Parameter \u0027page\u0027 added","version":"9.2"}],"params":[{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 100","required":false,"internal":false,"defaultValue":"10","exampleValue":"20","maximumValue":100},{"key":"q","description":"Limit search to tags that contain the supplied string.","required":false,"internal":false,"exampleValue":"off"}]},{"key":"set","description":"Set tags on a project.\u003cbr\u003eRequires the following permission: \u0027Administer\u0027 rights on the specified project","since":"6.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"},{"key":"tags","description":"Comma-separated list of tags","required":true,"internal":false,"exampleValue":"finance, offshore"}]}]},{"path":"api/projects","since":"2.10","description":"Manage project existence.","actions":[{"key":"bulk_delete","description":"Delete one or several projects.\u003cbr /\u003eOnly the 1\u0027000 first items in project filters are taken into account.\u003cbr /\u003eRequires \u0027Administer System\u0027 permission.\u003cbr /\u003eAt least one parameter is required among analyzedBefore, projects and q","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"The parameter \u0027analyzedBefore\u0027 takes into account the analysis of all branches and pull requests, not only the main branch.","version":"9.1"},{"description":"At least one parameter is required among analyzedBefore, projects and q","version":"7.8"}],"params":[{"key":"analyzedBefore","description":"Filter the projects for which last analysis of any branch is older than the given date (exclusive).\u003cbr\u003e Either a date (server timezone) or datetime can be provided.","since":"6.6","required":false,"internal":false,"exampleValue":"2017-10-19 or 2017-10-19T13:00:00+0200"},{"key":"onProvisionedOnly","description":"Filter the projects that are provisioned","since":"6.6","required":false,"internal":false,"defaultValue":"false","possibleValues":["true","false","yes","no"]},{"key":"projects","description":"Comma-separated list of project keys","required":false,"internal":false,"exampleValue":"my_project,another_project"},{"key":"q","description":"Limit to: \u003cul\u003e\u003cli\u003ecomponent names that contain the supplied string\u003c/li\u003e\u003cli\u003ecomponent keys that contain the supplied string\u003c/li\u003e\u003c/ul\u003e","required":false,"internal":false,"exampleValue":"sonar"},{"key":"qualifiers","description":"Comma-separated list of component qualifiers. Filter the results with the specified qualifiers","required":false,"internal":false,"defaultValue":"TRK","possibleValues":["TRK","VW","APP"]}]},{"key":"create","description":"Create a project.\u003cbr/\u003eIf your project is hosted on a DevOps Platform, please use the import endpoint under api/alm_integrations, so it creates and properly configures the project.Requires \u0027Create Projects\u0027 permission.\u003cbr/\u003e","since":"4.0","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"Field \u0027mainBranch\u0027 added to the request","version":"9.8"},{"description":"The \u0027visibility\u0027 parameter is public","version":"7.1"}],"params":[{"key":"mainBranch","description":"Key of the main branch of the project. If not provided, the default main branch key will be used.","since":"9.8","required":false,"internal":false,"exampleValue":"develop"},{"key":"name","description":"Name of the project. If name is longer than 500, it is abbreviated.","required":true,"internal":false,"exampleValue":"SonarQube"},{"key":"newCodeDefinitionType","description":"Project New Code Definition Type\u003cbr/\u003eNew code definitions of the following types are allowed:\u003cul\u003e\u003cli\u003ePREVIOUS_VERSION\u003c/li\u003e\u003cli\u003eNUMBER_OF_DAYS\u003c/li\u003e\u003cli\u003eREFERENCE_BRANCH - will default to the main branch.\u003c/li\u003e\u003c/ul\u003e","since":"10.1","required":false,"internal":false},{"key":"newCodeDefinitionValue","description":"Project New Code Definition Value\u003cbr/\u003eFor each new code definition type, a different value is expected:\u003cul\u003e\u003cli\u003eno value, when the new code definition type is PREVIOUS_VERSION and REFERENCE_BRANCH\u003c/li\u003e\u003cli\u003ea number between 1 and 90, when the new code definition type is NUMBER_OF_DAYS\u003c/li\u003e\u003c/ul\u003e","since":"10.1","required":false,"internal":false},{"key":"project","description":"Key of the project","required":true,"internal":false,"exampleValue":"my_project","maximumLength":400},{"key":"visibility","description":"Whether the created project should be visible to everyone, or only specific user/groups.\u003cbr/\u003eIf no visibility is specified, the default project visibility will be used.","since":"6.4","required":false,"internal":false,"possibleValues":["private","public"]}]},{"key":"delete","description":"Delete a project.\u003cbr\u003e Requires \u0027Administer System\u0027 permission or \u0027Administer\u0027 permission on the project.","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"export_findings","description":"Export all findings (issues and hotspots) of a specific project branch.\u003cbr/\u003eRequires \u0027Administer System\u0027 permission. Keep in mind that this endpoint will return all findings, issues and hotspots (no filter), which can take time and use a lot of resources on the SonarQube server side and put pressure on the database until completion. This endpoint can be used to feed third party systems. Either the branch key or the pull request key should be specified, and not both at the same time.","since":"9.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"\u0027type\u0027 and \u0027severity\u0027 fields are not deprecated anymore.","version":"10.8"},{"description":"\u0027status\u0027 and \u0027resolution\u0027 fields are now deprecated for issues. Use \u0027issueStatus\u0027 instead. Note that both fields remain available for \u0027type\u003dSECURITY_HOTSPOT\u0027.","version":"10.4"},{"description":"Add \u0027issueStatus\u0027 field to the response","version":"10.4"},{"description":"\u0027type\u0027 and \u0027severity\u0027 fields are now deprecated for issues. Use \u0027impacts\u0027, \u0027cleanCodeAttribute\u0027, \u0027cleanCodeAttributeCategory\u0027 fields instead. Note that \u0027type\u0027 remains available for \u0027type\u003dSECURITY_HOTSPOT\u0027.","version":"10.4"},{"description":"Add \u0027impacts\u0027, \u0027cleanCodeAttribute\u0027, \u0027cleanCodeAttributeCategory\u0027 fields to the response","version":"10.2"},{"description":"ruleReference field now contain \u0027repository_key:rule_key\u0027 instead of only the rule key","version":"9.3"},{"description":"add field \u0027branch\u0027 and \u0027pullRequest\u0027 in the payload. mutually exclusive, depending on the request","version":"9.3"},{"description":"createdAt and updatedAt now return effective issue creation and update date, instead of the database operation date","version":"9.3"},{"description":"projectKey field now return correctly the projectKey, instead of \u003cprojectKey\u003e:PULL_REQUEST:\u003cpullRequestKey\u003e","version":"9.3"}],"params":[{"key":"branch","description":"Branch key. When not specified, if no Pull Request key is defined either, it will default to the main branch","required":false,"internal":false,"exampleValue":"feature-branch"},{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"},{"key":"pullRequest","description":"Pull Request key. When not specified, the branch data will be returned instead","required":false,"internal":false,"exampleValue":"2"}]},{"key":"get_contains_ai_code","description":"Get whether a project contains AI code or not","since":"2025.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"license_usage","description":"Help admins to understand how much each project affects the total number of lines of code. Returns the list of projects together with information about their usage, sorted by lines of code descending.\u003cbr/\u003eRequires Administer System permission.","since":"9.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Response format changed from CSV to Json","version":"9.5"}]},{"key":"search","description":"Search for projects or views to administrate them.\n\u003cul\u003e\n  \u003cli\u003eThe response field \u0027lastAnalysisDate\u0027 takes into account the analysis of all branches and pull requests, not only the main branch.\u003c/li\u003e\n  \u003cli\u003eThe response field \u0027revision\u0027 takes into account the analysis of the main branch only.\u003c/li\u003e\n\u003c/ul\u003e\nRequires \u0027Administer System\u0027 permission","since":"6.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Response includes \u0027projectUuid\u0027 field.","version":"2025.6"},{"description":"Response includes \u0027managed\u0027 field.","version":"10.2"},{"description":"The parameter \u0027analyzedBefore\u0027 and the field \u0027lastAnalysisDate\u0027 of the returned projects take into account the analysis of all branches and pull requests, not only the main branch.","version":"9.1"}],"params":[{"key":"analyzedBefore","description":"Filter the projects for which the last analysis of all branches are older than the given date (exclusive).\u003cbr\u003e Either a date (server timezone) or datetime can be provided.","since":"6.6","required":false,"internal":false,"exampleValue":"2017-10-19 or 2017-10-19T13:00:00+0200"},{"key":"onProvisionedOnly","description":"Filter the projects that are provisioned","since":"6.6","required":false,"internal":false,"defaultValue":"false","possibleValues":["true","false","yes","no"]},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"projectKeys","description":"Comma-separated list of project keys (case insensitive)","since":"2026.3","required":false,"internal":false,"exampleValue":"my_project,another_project","maxValuesAllowed":1000},{"key":"projects","description":"Comma-separated list of project keys. Deprecated, use projectKeys instead","since":"6.6","required":false,"internal":false,"exampleValue":"my_project,another_project","deprecatedSince":"2026.3","maxValuesAllowed":1000},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 500","required":false,"internal":false,"defaultValue":"100","exampleValue":"20","maximumValue":500},{"key":"q","description":"Limit search to: \u003cul\u003e\u003cli\u003ecomponent names that contain the supplied string\u003c/li\u003e\u003cli\u003ecomponent keys that contain the supplied string\u003c/li\u003e\u003c/ul\u003e","required":false,"internal":false,"exampleValue":"sonar"},{"key":"qualifiers","description":"Comma-separated list of component qualifiers. Filter the results with the specified qualifiers","required":false,"internal":false,"defaultValue":"TRK","possibleValues":["TRK","VW","APP"]}]},{"key":"set_contains_ai_code","description":"Sets if the project passed as parameter contains or not AI code according to the value of the contains_ai_code parameter.\u003cbr/\u003eRequires \u0027Administer\u0027 rights on the specified project.","since":"10.8","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Make endpoint public","version":"2025.1"}],"params":[{"key":"contains_ai_code","description":"Flag to set whether the project contains AI code or not.","required":true,"internal":false,"exampleValue":"true"},{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"update_key","description":"Update a project all its sub-components keys.\u003cbr\u003eRequires \u0027Administer\u0027 permission on the project.","since":"6.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Ability to update key of a disabled module","version":"7.1"}],"params":[{"key":"from","description":"Project key","required":true,"internal":false,"exampleValue":"my_old_project"},{"key":"to","description":"New project key","required":true,"internal":false,"exampleValue":"my_new_project"}]},{"key":"update_visibility","description":"Updates visibility of a project, application or a portfolio.\u003cbr\u003eRequires \u0027Project administer\u0027 permission on the specified entity","since":"6.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"project","description":"Project, application or portfolio key","required":true,"internal":false,"exampleValue":"my_project"},{"key":"visibility","description":"New visibility","required":true,"internal":false,"possibleValues":["private","public"]}]}]},{"path":"api/qualitygates","since":"4.3","description":"Manage quality gates, including conditions and project association.","actions":[{"key":"add_group","description":"Allow a group of users to edit a Quality Gate.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer Quality Gates\u0027\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality gate\u003c/li\u003e\u003c/ul\u003e","since":"9.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"gateName","description":"Quality Gate name","required":true,"internal":false,"exampleValue":"SonarSource Way","maximumLength":100},{"key":"groupName","description":"Group name or \u0027anyone\u0027 (case insensitive)","required":true,"internal":false,"exampleValue":"sonar-administrators"}]},{"key":"add_user","description":"Allow a user to edit a Quality Gate.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer Quality Gates\u0027\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality gate\u003c/li\u003e\u003c/ul\u003e","since":"9.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"gateName","description":"Quality Gate name","required":true,"internal":false,"exampleValue":"SonarSource Way","maximumLength":100},{"key":"login","description":"User login","required":true,"internal":false,"exampleValue":"john.doe"}]},{"key":"copy","description":"Copy a Quality Gate.\u003cbr\u003e\u0027sourceName\u0027 must be provided. Requires the \u0027Administer Quality Gates\u0027 permission.","since":"4.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Field \u0027id\u0027 in the response is deprecated","version":"10.0"},{"description":"Parameter \u0027id\u0027 is removed. Use \u0027sourceName\u0027 instead.","version":"10.0"},{"description":"Parameter \u0027id\u0027 is deprecated. Format changes from integer to string. Use \u0027sourceName\u0027 instead.","version":"8.4"},{"description":"Parameter \u0027sourceName\u0027 added","version":"8.4"}],"params":[{"key":"name","description":"The name of the quality gate to create","required":true,"internal":false,"exampleValue":"My New Quality Gate"},{"key":"sourceName","description":"The name of the quality gate to copy","since":"8.4","required":true,"internal":false,"exampleValue":"My Quality Gate","maximumLength":100}]},{"key":"create","description":"Create a Quality Gate.\u003cbr\u003eRequires the \u0027Administer Quality Gates\u0027 permission.","since":"4.3","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"Field \u0027id\u0027 in the response is removed.","version":"10.0"},{"description":"Field \u0027id\u0027 in the response is deprecated. Format changes from integer to string.","version":"8.4"}],"params":[{"key":"name","description":"The name of the quality gate to create","required":true,"internal":false,"exampleValue":"My Quality Gate","maximumLength":100}]},{"key":"create_condition","description":"Add a new condition to a quality gate.\u003cbr\u003eParameter \u0027gateName\u0027 must be provided. Requires the \u0027Administer Quality Gates\u0027 permission.","since":"4.3","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"Parameter \u0027gateId\u0027 is removed. Use \u0027gateName\u0027 instead.","version":"10.0"},{"description":"Parameter \u0027gateName\u0027 added","version":"8.4"},{"description":"Parameter \u0027gateId\u0027 is deprecated. Use \u0027gateName\u0027 instead.","version":"8.4"},{"description":"Removed optional \u0027warning\u0027 and \u0027period\u0027 parameters","version":"7.6"},{"description":"Made \u0027error\u0027 parameter mandatory","version":"7.6"},{"description":"Reduced the possible values of \u0027op\u0027 parameter to LT and GT","version":"7.6"}],"params":[{"key":"error","description":"Condition error threshold","required":true,"internal":false,"exampleValue":"10","maximumLength":64},{"key":"gateName","description":"Name of the quality gate","required":true,"internal":false,"exampleValue":"SonarSource way"},{"key":"metric","description":"Condition metric.\u003cbr/\u003e Only metric of the following types are allowed:\u003cul\u003e\u003cli\u003eINT\u003c/li\u003e\u003cli\u003eMILLISEC\u003c/li\u003e\u003cli\u003eRATING\u003c/li\u003e\u003cli\u003eWORK_DUR\u003c/li\u003e\u003cli\u003eFLOAT\u003c/li\u003e\u003cli\u003ePERCENT\u003c/li\u003e\u003cli\u003eLEVEL\u003c/li\u003e\u003c/ul\u003eFollowing metrics are forbidden:\u003cul\u003e\u003cli\u003esecurity_hotspots\u003c/li\u003e\u003cli\u003enew_security_hotspots\u003c/li\u003e\u003cli\u003ealert_status\u003c/li\u003e\u003c/ul\u003e","required":true,"internal":false,"exampleValue":"blocker_violations, vulnerabilities, new_code_smells"},{"key":"op","description":"Condition operator:\u003cbr/\u003e\u003cul\u003e\u003cli\u003eLT \u003d is lower than\u003c/li\u003e\u003cli\u003eGT \u003d is greater than\u003c/li\u003e\u003c/ul\u003e","required":false,"internal":false,"exampleValue":"GT","possibleValues":["LT","GT"]}]},{"key":"delete_condition","description":"Delete a condition from a quality gate.\u003cbr\u003eRequires the \u0027Administer Quality Gates\u0027 permission.","since":"4.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"id","description":"Condition UUID","required":true,"internal":false,"exampleValue":"2"}]},{"key":"deselect","description":"Remove the association of a project from a quality gate.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e\u003cli\u003e\u0027Administer Quality Gates\u0027\u003c/li\u003e\u003cli\u003e\u0027Administer\u0027 rights on the project\u003c/li\u003e\u003c/ul\u003e","since":"4.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Allow to change the Quality Gate of a project flagged as containing AI code.","version":"10.8"},{"description":"It is not possible anymore to change the Quality Gate of a project flagged as containing AI code.","version":"10.7"},{"description":"The parameter \u0027projectId\u0027 was removed","version":"8.3"},{"description":"The parameter \u0027gateId\u0027 was removed","version":"6.6"}],"params":[{"key":"projectKey","description":"Project key","since":"6.1","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"destroy","description":"Delete a Quality Gate.\u003cbr\u003eParameter \u0027name\u0027 must be specified. Requires the \u0027Administer Quality Gates\u0027 permission.","since":"4.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Parameter \u0027id\u0027 is removed. Use \u0027name\u0027 instead.","version":"10.0"},{"description":"Parameter \u0027name\u0027 added","version":"8.4"},{"description":"Parameter \u0027id\u0027 is deprecated. Format changes from integer to string. Use \u0027name\u0027 instead.","version":"8.4"}],"params":[{"key":"name","description":"Name of the quality gate to delete","since":"8.4","required":true,"internal":false,"exampleValue":"SonarSource Way","maximumLength":100}]},{"key":"get_by_project","description":"Get the quality gate of a project.\u003cbr /\u003eRequires one of the following permissions:\u003cul\u003e\u003cli\u003e\u0027Administer System\u0027\u003c/li\u003e\u003cli\u003e\u0027Administer\u0027 rights on the specified project\u003c/li\u003e\u003cli\u003e\u0027Browse\u0027 on the specified project\u003c/li\u003e\u003c/ul\u003e","since":"6.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Field \u0027id\u0027 in the response has been removed","version":"10.0"},{"description":"Field \u0027id\u0027 in the response is deprecated. Format changes from integer to string.","version":"8.4"},{"description":"The parameter \u0027projectId\u0027 has been removed","version":"6.6"},{"description":"The parameter \u0027projectKey\u0027 has been renamed to \u0027project\u0027","version":"6.6"},{"description":"This webservice is now part of the public API","version":"6.6"}],"params":[{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"list","description":"Get a list of quality gates","since":"4.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"\u0027isAiCodeSupported\u0027 field is added on quality gate","version":"10.8"},{"description":"\u0027hasMQRConditions\u0027 and \u0027hasStandardConditions\u0027 fields are added on quality gate","version":"10.8"},{"description":"Field \u0027default\u0027 in the response has been removed","version":"10.0"},{"description":"Field \u0027id\u0027 in the response has been removed","version":"10.0"},{"description":"\u0027caycStatus\u0027 field is added on quality gate","version":"9.9"},{"description":"Field \u0027id\u0027 in the response is deprecated. Format changes from integer to string.","version":"8.4"},{"description":"\u0027isDefault\u0027 field is added on quality gate","version":"7.0"},{"description":"\u0027default\u0027 field on root level is deprecated","version":"7.0"},{"description":"\u0027isBuiltIn\u0027 field is added in the response","version":"7.0"},{"description":"\u0027actions\u0027 fields are added in the response","version":"7.0"}]},{"key":"project_status","description":"Get the quality gate status of a project or a Compute Engine task.\u003cbr /\u003eEither \u0027analysisId\u0027, \u0027projectId\u0027 or \u0027projectKey\u0027 must be provided \u003cbr /\u003eThe different statuses returned are: OK, WARN, ERROR, NONE. The NONE status is returned when there is no quality gate associated with the analysis.\u003cbr /\u003eReturns an HTTP code 404 if the analysis associated with the task is not found or does not exist.\u003cbr /\u003eRequires one of the following permissions:\u003cul\u003e\u003cli\u003e\u0027Administer System\u0027\u003c/li\u003e\u003cli\u003e\u0027Administer\u0027 rights on the specified project\u003c/li\u003e\u003cli\u003e\u0027Browse\u0027 on the specified project\u003c/li\u003e\u003cli\u003e\u0027Execute Analysis\u0027 on the specified project\u003c/li\u003e\u003c/ul\u003e","since":"5.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The fields \u0027periods\u0027 and \u0027periodIndex\u0027 in the response are removed","version":"10.0"},{"description":"\u0027caycStatus\u0027 field is added to the response","version":"9.9"},{"description":"The \u0027Execute Analysis\u0027 permission also allows to access the endpoint","version":"9.5"},{"description":"The field \u0027periods\u0027 in the response is deprecated. Use \u0027period\u0027 instead","version":"8.5"},{"description":"The parameters \u0027branch\u0027 and \u0027pullRequest\u0027 were added","version":"7.7"},{"description":"The field \u0027warning\u0027 in the response is deprecated","version":"7.6"},{"description":"The field \u0027ignoredConditions\u0027 is added to the response","version":"6.4"}],"params":[{"key":"analysisId","description":"Analysis id","required":false,"internal":false,"exampleValue":"AU-TpxcA-iU5OvuD2FL1"},{"key":"branch","description":"Branch key","since":"7.7","required":false,"internal":false,"exampleValue":"feature/my_branch"},{"key":"projectId","description":"Project UUID. Doesn\u0027t work with branches or pull requests","since":"5.4","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"projectKey","description":"Project key","since":"5.4","required":false,"internal":false,"exampleValue":"my_project"},{"key":"pullRequest","description":"Pull request id","since":"7.7","required":false,"internal":false,"exampleValue":"5461"}]},{"key":"remove_group","description":"Remove the ability from a group to edit a Quality Gate.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer Quality Gates\u0027\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality gate\u003c/li\u003e\u003c/ul\u003e","since":"9.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"gateName","description":"Quality Gate name","required":true,"internal":false,"exampleValue":"SonarSource Way","maximumLength":100},{"key":"groupName","description":"Group name or \u0027anyone\u0027 (case insensitive)","required":true,"internal":false,"exampleValue":"sonar-administrators"}]},{"key":"remove_user","description":"Remove the ability from an user to edit a Quality Gate.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer Quality Gates\u0027\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality gate\u003c/li\u003e\u003c/ul\u003e","since":"9.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"gateName","description":"Quality Gate name","required":true,"internal":false,"exampleValue":"SonarSource Way","maximumLength":100},{"key":"login","description":"User login","required":true,"internal":false,"exampleValue":"john.doe"}]},{"key":"rename","description":"Rename a Quality Gate.\u003cbr\u003e\u0027currentName\u0027 must be specified. Requires the \u0027Administer Quality Gates\u0027 permission.","since":"4.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Field \u0027id\u0027 in the response is deprecated","version":"10.0"},{"description":"Parameter \u0027id\u0027 is removed. Use \u0027currentName\u0027 instead.","version":"10.0"},{"description":"Parameter \u0027currentName\u0027 added","version":"8.4"},{"description":"Parameter \u0027id\u0027 is deprecated. Format changes from integer to string. Use \u0027currentName\u0027 instead.","version":"8.4"}],"params":[{"key":"currentName","description":"Current name of the quality gate","since":"8.4","required":true,"internal":false,"exampleValue":"My Quality Gate","maximumLength":100},{"key":"name","description":"New name of the quality gate","required":true,"internal":false,"exampleValue":"My New Quality Gate","maximumLength":100}]},{"key":"search","description":"Search for projects associated (or not) to a quality gate.\u003cbr/\u003eOnly authorized projects for the current user will be returned.","since":"4.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Field \u0027containsAiCode\u0027 response field has added.","version":"2025.1"},{"description":"Field \u0027isAiCodeAssured\u0027 response field has been removed.","version":"2025.1"},{"description":"Field \u0027aiCodeAssurance\u0027 response field has been removed.","version":"2025.1"},{"description":"Field \u0027isAiCodeAssured\u0027 response field has been deprecated. Use \u0027aiCodeAssurance\u0027 instead.","version":"10.8"},{"description":"New field \u0027aiCodeAssurance\u0027 in the response.","version":"10.8"},{"description":"deprecated \u0027more\u0027 response field has been removed","version":"10.0"},{"description":"Parameter \u0027gateId\u0027 is removed. Use \u0027gateName\u0027 instead.","version":"10.0"},{"description":"Parameter \u0027gateName\u0027 added","version":"8.4"},{"description":"Parameter \u0027gateId\u0027 is deprecated. Format changes from integer to string. Use \u0027gateName\u0027 instead.","version":"8.4"},{"description":"New field \u0027paging\u0027 in response","version":"7.9"},{"description":"New field \u0027key\u0027 returning the project key in \u0027results\u0027 response","version":"7.9"},{"description":"Field \u0027more\u0027 is deprecated in the response","version":"7.9"}],"params":[{"key":"gateName","description":"Quality Gate name","since":"8.4","required":true,"internal":false,"exampleValue":"SonarSource Way","maximumLength":100},{"key":"page","description":"Page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"2"},{"key":"pageSize","description":"Page size","required":false,"internal":false,"exampleValue":"10"},{"key":"query","description":"To search for projects containing this string. If this parameter is set, \"selected\" is set to \"all\".","required":false,"internal":false,"exampleValue":"abc"},{"key":"selected","description":"Depending on the value, show only selected items (selected\u003dselected), deselected items (selected\u003ddeselected), or all items with their selection status (selected\u003dall).","required":false,"internal":false,"defaultValue":"selected","possibleValues":["all","deselected","selected"]}]},{"key":"search_groups","description":"List the groups that are allowed to edit a Quality Gate.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer Quality Gates\u0027\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality gate\u003c/li\u003e\u003c/ul\u003e","since":"9.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"gateName","description":"Quality Gate name","required":true,"internal":false,"exampleValue":"SonarSource Way"},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0.","required":false,"internal":false,"defaultValue":"25","exampleValue":"20"},{"key":"q","description":"Limit search to group names that contain the supplied string.","required":false,"internal":false,"exampleValue":"sonar"},{"key":"selected","description":"Depending on the value, show only selected items (selected\u003dselected), deselected items (selected\u003ddeselected), or all items with their selection status (selected\u003dall).","required":false,"internal":false,"defaultValue":"selected","possibleValues":["all","deselected","selected"]}]},{"key":"search_users","description":"List the users that are allowed to edit a Quality Gate.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer Quality Gates\u0027\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality gate\u003c/li\u003e\u003c/ul\u003e","since":"9.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"gateName","description":"Quality Gate name","required":true,"internal":false,"exampleValue":"Recommended quality gate"},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0.","required":false,"internal":false,"defaultValue":"25","exampleValue":"20"},{"key":"q","description":"Limit search to names or logins that contain the supplied string.","required":false,"internal":false,"exampleValue":"freddy"},{"key":"selected","description":"Depending on the value, show only selected items (selected\u003dselected), deselected items (selected\u003ddeselected), or all items with their selection status (selected\u003dall).","required":false,"internal":false,"defaultValue":"selected","possibleValues":["all","deselected","selected"]}]},{"key":"select","description":"Associate a project to a quality gate.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer Quality Gates\u0027\u003c/li\u003e  \u003cli\u003e\u0027Administer\u0027 right on the specified project\u003c/li\u003e\u003c/ul\u003e","since":"4.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Allow to change the Quality Gate of a project flagged as containing AI code.","version":"10.8"},{"description":"It is not possible anymore to change the Quality Gate of a project flagged as containing AI code.","version":"10.7"},{"description":"Parameter \u0027gateId\u0027 is removed. Use \u0027gateName\u0027 instead.","version":"10.0"},{"description":"Parameter \u0027gateName\u0027 added","version":"8.4"},{"description":"Parameter \u0027gateId\u0027 is deprecated. Format changes from integer to string. Use \u0027gateName\u0027 instead.","version":"8.4"},{"description":"The parameter \u0027projectId\u0027 was removed","version":"8.3"}],"params":[{"key":"gateName","description":"Name of the quality gate","since":"8.4","required":true,"internal":false,"exampleValue":"SonarSource way","maximumLength":100},{"key":"projectKey","description":"Project key","since":"6.1","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"set_as_default","description":"Set a quality gate as the default quality gate.\u003cbr\u003eParameter \u0027name\u0027 must be specified. Requires the \u0027Administer Quality Gates\u0027 permission.","since":"4.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Parameter \u0027id\u0027 is removed. Use \u0027name\u0027 instead.","version":"10.0"},{"description":"Parameter \u0027name\u0027 added","version":"8.4"},{"description":"Parameter \u0027id\u0027 is deprecated. Format changes from integer to string. Use \u0027name\u0027 instead.","version":"8.4"}],"params":[{"key":"name","description":"Name of the quality gate to set as default","since":"8.4","required":true,"internal":false,"exampleValue":"SonarSource Way","maximumLength":100}]},{"key":"show","description":"Display the details of a quality gate","since":"4.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"\u0027isAiCodeSupported\u0027 field is added on quality gate","version":"10.8"},{"description":"\u0027hasMQRConditions\u0027 and \u0027hasStandardConditions\u0027 fields are added on quality gate","version":"10.8"},{"description":"\u0027isDefault\u0027 field is added to the response","version":"10.3"},{"description":"Field \u0027id\u0027 in the response has been removed","version":"10.0"},{"description":"Parameter \u0027id\u0027 is removed. Use \u0027name\u0027 instead.","version":"10.0"},{"description":"\u0027caycStatus\u0027 field is added to the response","version":"9.9"},{"description":"Parameter \u0027id\u0027 is deprecated. Format changes from integer to string. Use \u0027name\u0027 instead.","version":"8.4"},{"description":"Field \u0027id\u0027 in the response is deprecated.","version":"8.4"},{"description":"\u0027period\u0027 and \u0027warning\u0027 fields of conditions are removed from the response","version":"7.6"},{"description":"\u0027isBuiltIn\u0027 field is added to the response","version":"7.0"},{"description":"\u0027actions\u0027 field is added in the response","version":"7.0"}],"params":[{"key":"name","description":"Name of the quality gate. Either id or name must be set","required":true,"internal":false,"exampleValue":"My Quality Gate"}]},{"key":"update_condition","description":"Update a condition attached to a quality gate.\u003cbr\u003eRequires the \u0027Administer Quality Gates\u0027 permission.","since":"4.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Parameter \u0027id\u0027 format changes from integer to string. ","version":"8.4"},{"description":"Removed optional \u0027warning\u0027 and \u0027period\u0027 parameters","version":"7.6"},{"description":"Made \u0027error\u0027 parameter mandatory","version":"7.6"},{"description":"Reduced the possible values of \u0027op\u0027 parameter to LT and GT","version":"7.6"}],"params":[{"key":"error","description":"Condition error threshold","required":true,"internal":false,"exampleValue":"10","maximumLength":64},{"key":"id","description":"Condition ID","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"metric","description":"Condition metric.\u003cbr/\u003e Only metric of the following types are allowed:\u003cul\u003e\u003cli\u003eINT\u003c/li\u003e\u003cli\u003eMILLISEC\u003c/li\u003e\u003cli\u003eRATING\u003c/li\u003e\u003cli\u003eWORK_DUR\u003c/li\u003e\u003cli\u003eFLOAT\u003c/li\u003e\u003cli\u003ePERCENT\u003c/li\u003e\u003cli\u003eLEVEL\u003c/li\u003e\u003c/ul\u003eFollowing metrics are forbidden:\u003cul\u003e\u003cli\u003esecurity_hotspots\u003c/li\u003e\u003cli\u003enew_security_hotspots\u003c/li\u003e\u003cli\u003ealert_status\u003c/li\u003e\u003c/ul\u003e","required":true,"internal":false,"exampleValue":"blocker_violations, vulnerabilities, new_code_smells"},{"key":"op","description":"Condition operator:\u003cbr/\u003e\u003cul\u003e\u003cli\u003eLT \u003d is lower than\u003c/li\u003e\u003cli\u003eGT \u003d is greater than\u003c/li\u003e\u003c/ul\u003e","required":false,"internal":false,"exampleValue":"GT","possibleValues":["LT","GT"]}]}]},{"path":"api/qualityprofiles","since":"4.4","description":"Manage quality profiles.","actions":[{"key":"activate_rule","description":"Activate a rule on a Quality Profile.\u003cbr\u003e Requires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer Quality Profiles\u0027\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality profile\u003c/li\u003e\u003c/ul\u003e","since":"4.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"The parameter \u0027severity\u0027 is not deprecated anymore.","version":"10.8"},{"description":"Add new parameter \u0027impacts\u0027","version":"10.8"},{"description":"Add parameter \u0027prioritizedRule\u0027.","version":"10.6"},{"description":"Parameter \u0027severity\u0027 is now deprecated.","version":"10.2"}],"params":[{"key":"impacts","description":"Override of impact severities for the rule. Cannot be used as the same time as \u0027severity\u0027. Ignored if parameter reset is true.","required":false,"internal":false,"exampleValue":"impacts\u003dMAINTAINABILITY\u003dHIGH;SECURITY\u003dMEDIUM"},{"key":"key","description":"Quality Profile key. Can be obtained through \u003ccode\u003eapi/qualityprofiles/search\u003c/code\u003e","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"params","description":"Parameters as semi-colon list of \u003ccode\u003ekey\u003dvalue\u003c/code\u003e. Ignored if parameter reset is true.","required":false,"internal":false,"exampleValue":"params\u003dkey1\u003dv1;key2\u003dv2"},{"key":"prioritizedRule","description":"Mark activated rule as prioritized, so all corresponding Issues will have to be fixed.","since":"10.6","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"reset","description":"Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values.","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"rule","description":"Rule key","required":true,"internal":false,"exampleValue":"java:AvoidCycles"},{"key":"severity","description":"Severity. Cannot be used as the same time as \u0027impacts\u0027.Ignored if parameter reset is true.","required":false,"internal":false,"possibleValues":["INFO","MINOR","MAJOR","CRITICAL","BLOCKER"]}]},{"key":"activate_rules","description":"Bulk-activate rules on one quality profile.\u003cbr\u003e Requires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer Quality Profiles\u0027\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality profile\u003c/li\u003e\u003c/ul\u003e","since":"4.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"The parameters \u0027severities\u0027, \u0027targetSeverity\u0027, \u0027active_severities\u0027, and \u0027types\u0027  are not deprecated anymore.","version":"10.8"},{"description":"Add parameter \u0027prioritizedRule\u0027.","version":"10.6"},{"description":"Parameters \u0027severities\u0027, \u0027targetSeverity\u0027, \u0027active_severities\u0027, and \u0027types\u0027 are now deprecated.","version":"10.2"},{"description":"Parameter \u0027sansTop25\u0027 is deprecated","version":"10.0"}],"params":[{"key":"activation","description":"Filter rules that are activated or deactivated on the selected Quality profile. Ignored if the parameter \u0027qprofile\u0027 is not set.","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"active_impactSeverities","description":"Comma-separated list of Activation Software Quality Severities, i.e the impact severity of rules in Quality profiles.","since":"2025.1","required":false,"internal":false,"exampleValue":"HIGH,MEDIUM","possibleValues":["INFO","LOW","MEDIUM","HIGH","BLOCKER"]},{"key":"active_severities","description":"Comma-separated list of activation severities, i.e the severity of rules in Quality profiles.","required":false,"internal":false,"exampleValue":"CRITICAL,BLOCKER","possibleValues":["INFO","MINOR","MAJOR","CRITICAL","BLOCKER"]},{"key":"asc","description":"Ascending sort","required":false,"internal":false,"defaultValue":"true","possibleValues":["true","false","yes","no"]},{"key":"available_since","description":"Filters rules added since date. Format is yyyy-MM-dd","required":false,"internal":false,"exampleValue":"2014-06-22"},{"key":"cleanCodeAttributeCategories","description":"Comma-separated list of Clean Code Attribute Categories","since":"10.2","required":false,"internal":false,"exampleValue":"ADAPTABLE,INTENTIONAL","possibleValues":["ADAPTABLE","CONSISTENT","INTENTIONAL","RESPONSIBLE"]},{"key":"cwe","description":"Comma-separated list of CWE identifiers. Use \u0027unknown\u0027 to select rules not associated to any CWE.","required":false,"internal":false,"exampleValue":"12,125,unknown"},{"key":"impactSeverities","description":"Comma-separated list of Software Quality Severities","since":"10.2","required":false,"internal":false,"exampleValue":"HIGH,MEDIUM","possibleValues":["INFO","LOW","MEDIUM","HIGH","BLOCKER"]},{"key":"impactSoftwareQualities","description":"Comma-separated list of Software Qualities","since":"10.2","required":false,"internal":false,"exampleValue":"MAINTAINABILITY,RELIABILITY","possibleValues":["MAINTAINABILITY","RELIABILITY","SECURITY"]},{"key":"inheritance","description":"Comma-separated list of values of inheritance for a rule within a quality profile. Used only if the parameter \u0027activation\u0027 is set.","required":false,"internal":false,"exampleValue":"INHERITED,OVERRIDES","possibleValues":["NONE","INHERITED","OVERRIDES"]},{"key":"is_template","description":"Filter template rules","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"languages","description":"Comma-separated list of languages","required":false,"internal":false,"exampleValue":"java,js"},{"key":"owaspMobileTop10-2024","description":"Comma-separated list of OWASP Mobile Top 10 2024 lowercase categories.","since":"2025.4","required":false,"internal":false,"possibleValues":["m1","m2","m3","m4","m5","m6","m7","m8","m9","m10"]},{"key":"owaspTop10","description":"Comma-separated list of OWASP Top 10 2017 lowercase categories.","since":"7.3","required":false,"internal":false,"possibleValues":["a1","a2","a3","a4","a5","a6","a7","a8","a9","a10"]},{"key":"owaspTop10-2021","description":"Comma-separated list of OWASP Top 10 2021 lowercase categories.","since":"9.4","required":false,"internal":false,"possibleValues":["a1","a2","a3","a4","a5","a6","a7","a8","a9","a10"]},{"key":"prioritizedRule","description":"Mark activated rules as prioritized, so all corresponding Issues will have to be fixed.","since":"10.6","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"q","description":"UTF-8 search query","required":false,"internal":false,"exampleValue":"xpath","minimumLength":2},{"key":"qprofile","description":"Quality profile key to filter on. Only rules of the same language as this profile are returned. By default only rules activated in this profile are returned. You can change that using the \u0027activation\u0027 parameter.","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"repositories","description":"Comma-separated list of repositories","required":false,"internal":false,"exampleValue":"java,html"},{"key":"rule_key","description":"Key of rule to search for","required":false,"internal":false,"exampleValue":"java:S1144"},{"key":"s","description":"Sort field","required":false,"internal":false,"exampleValue":"name","possibleValues":["name","createdAt","updatedAt","key"]},{"key":"sansTop25","description":"Comma-separated list of SANS Top 25 categories.","since":"7.3","required":false,"internal":false,"deprecatedSince":"10.0","possibleValues":["insecure-interaction","risky-resource","porous-defenses"]},{"key":"severities","description":"Comma-separated list of default severities. Not the same than severity of rules in Quality profiles.","required":false,"internal":false,"exampleValue":"CRITICAL,BLOCKER","possibleValues":["INFO","MINOR","MAJOR","CRITICAL","BLOCKER"]},{"key":"sonarsourceSecurity","description":"Comma-separated list of SonarSource security categories. Use \u0027others\u0027 to select rules not associated with any category","since":"7.8","required":false,"internal":false,"exampleValue":"sql-injection,command-injection,others","possibleValues":["malicious-dependencies","buffer-overflow","sql-injection","rce","object-injection","command-injection","path-traversal-injection","ldap-injection","xpath-injection","log-injection","xxe","xss","dos","ssrf","csrf","http-response-splitting","open-redirect","weak-cryptography","auth","insecure-conf","file-manipulation","encrypt-data","traceability","permission","others"]},{"key":"statuses","description":"Comma-separated list of status codes","required":false,"internal":false,"exampleValue":"READY","possibleValues":["BETA","DEPRECATED","READY","REMOVED"]},{"key":"tags","description":"Comma-separated list of tags. Returned rules match any of the tags (OR operator)","required":false,"internal":false,"exampleValue":"security,java8"},{"key":"targetKey","description":"Quality Profile key on which the rule activation is done. To retrieve a quality profile key please see \u003ccode\u003eapi/qualityprofiles/search\u003c/code\u003e","required":true,"internal":false,"exampleValue":"AU-TpxcA-iU5OvuD2FL0"},{"key":"targetSeverity","description":"Severity to set on the activated rules","required":false,"internal":false,"possibleValues":["INFO","MINOR","MAJOR","CRITICAL","BLOCKER"]},{"key":"template_key","description":"Key of the template rule to filter on. Used to search for the custom rules based on this template.","required":false,"internal":false,"exampleValue":"java:S001"},{"key":"types","description":"Comma-separated list of types. Returned rules match any of the tags (OR operator)","since":"5.5","required":false,"internal":false,"exampleValue":"BUG","possibleValues":["CODE_SMELL","BUG","VULNERABILITY","SECURITY_HOTSPOT"]}]},{"key":"add_project","description":"Associate a project with a quality profile.\u003cbr\u003e Requires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer Quality Profiles\u0027\u003c/li\u003e  \u003cli\u003eAdminister right on the specified project\u003c/li\u003e\u003c/ul\u003e","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"language","description":"Quality profile language.","required":true,"internal":false,"possibleValues":["kubernetes","css","py","apex","plsql","java","xml","powershell","ipynb","text","azurepipelines","swift","yaml","cpp","vb","secrets","groovy","shell","terraform","azureresourcemanager","abap","scala","jsp","js","docker","ansible","dart","rust","jcl","web","flex","json","vbnet","postgres","cloudformation","delphi","c","go","kotlin","rpg","pli","tsql","ruby","cs","r","cobol","php","dataweave","gosu","objc","ts","githubactions"]},{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"},{"key":"qualityProfile","description":"Quality profile name.","required":true,"internal":false,"exampleValue":"Sonar way"}]},{"key":"backup","description":"Backup a quality profile in XML form. The exported profile can be restored through api/qualityprofiles/restore.","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The \u0027priority\u0027 and \u0027type\u0027 fields of the rule XML object are not deprecated anymore.","version":"10.8"},{"description":"The \u0027priority\u0027 and \u0027type\u0027 fields of the rule XML object are deprecated.","version":"10.3"}],"params":[{"key":"language","description":"Quality profile language.","required":true,"internal":false,"possibleValues":["kubernetes","css","py","apex","plsql","java","xml","powershell","ipynb","text","azurepipelines","swift","yaml","cpp","vb","secrets","groovy","shell","terraform","azureresourcemanager","abap","scala","jsp","js","docker","ansible","dart","rust","jcl","web","flex","json","vbnet","postgres","cloudformation","delphi","c","go","kotlin","rpg","pli","tsql","ruby","cs","r","cobol","php","dataweave","gosu","objc","ts","githubactions"]},{"key":"qualityProfile","description":"Quality profile name.","required":true,"internal":false,"exampleValue":"Sonar way"}]},{"key":"change_parent","description":"Change a quality profile\u0027s parent.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer Quality Profiles\u0027\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality profile\u003c/li\u003e\u003c/ul\u003e","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"language","description":"Quality profile language.","required":true,"internal":false,"possibleValues":["kubernetes","css","py","apex","plsql","java","xml","powershell","ipynb","text","azurepipelines","swift","yaml","cpp","vb","secrets","groovy","shell","terraform","azureresourcemanager","abap","scala","jsp","js","docker","ansible","dart","rust","jcl","web","flex","json","vbnet","postgres","cloudformation","delphi","c","go","kotlin","rpg","pli","tsql","ruby","cs","r","cobol","php","dataweave","gosu","objc","ts","githubactions"]},{"key":"parentQualityProfile","description":"New parent profile name. \u003cbr\u003e If no profile is provided, the inheritance link with current parent profile (if any) is broken, which deactivates all rules which come from the parent and are not overridden.","required":false,"internal":false,"exampleValue":"Sonar way"},{"key":"qualityProfile","description":"Quality profile name.","required":true,"internal":false,"exampleValue":"Sonar way"}]},{"key":"changelog","description":"Get the history of changes on a quality profile: rule activation/deactivation, change in parameters/severity/impacts. Events are ordered by date in descending order (most recent first).","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Added field \u0027prioritizedRule\u0027 to \u0027params\u0027 section of response","version":"2025.1"},{"description":"Added parameter \u0027filterMode\u0027","version":"10.8"},{"description":"Possible values \u0027INFO\u0027 and \u0027BLOCKER\u0027 for response field \u0027severity\u0027 of \u0027impacts\u0027 have been added","version":"10.8"},{"description":"Added fields \u0027cleanCodeAttributeCategory\u0027, \u0027impacts\u0027 to response","version":"10.3"},{"description":"Added fields \u0027oldCleanCodeAttribute\u0027, \u0027newCleanCodeAttribute\u0027, \u0027oldCleanCodeAttributeCategory\u0027, \u0027newCleanCodeAttributeCategory\u0027 and \u0027impactChanges\u0027 to \u0027params\u0027 section of response","version":"10.3"},{"description":"Added field \u0027sonarQubeVersion\u0027 to \u0027params\u0027 section of response","version":"10.3"},{"description":"response fields \u0027total\u0027, \u0027s\u0027, \u0027ps\u0027 have been deprecated, please use \u0027paging\u0027 object instead","version":"9.8"},{"description":"The field \u0027paging\u0027 has been added to the response","version":"9.8"}],"params":[{"key":"filterMode","description":"If specified, will return changelog events related to MQR or STANDARD mode. If not specified, all the events are returned","since":"10.8","required":false,"internal":false,"exampleValue":"MQR","possibleValues":["STANDARD","MQR"]},{"key":"language","description":"Quality profile language.","required":true,"internal":false,"possibleValues":["kubernetes","css","py","apex","plsql","java","xml","powershell","ipynb","text","azurepipelines","swift","yaml","cpp","vb","secrets","groovy","shell","terraform","azureresourcemanager","abap","scala","jsp","js","docker","ansible","dart","rust","jcl","web","flex","json","vbnet","postgres","cloudformation","delphi","c","go","kotlin","rpg","pli","tsql","ruby","cs","r","cobol","php","dataweave","gosu","objc","ts","githubactions"]},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 500","required":false,"internal":false,"defaultValue":"50","exampleValue":"20","maximumValue":500},{"key":"qualityProfile","description":"Quality profile name.","required":true,"internal":false,"exampleValue":"Sonar way"},{"key":"since","description":"Start date for the changelog (inclusive). \u003cbr\u003eEither a date (server timezone) or datetime can be provided.","required":false,"internal":false,"exampleValue":"2017-10-19 or 2017-10-19T13:00:00+0200"},{"key":"to","description":"End date for the changelog (exclusive, strictly before). \u003cbr\u003eEither a date (server timezone) or datetime can be provided.","required":false,"internal":false,"exampleValue":"2017-10-19 or 2017-10-19T13:00:00+0200"}]},{"key":"copy","description":"Copy a quality profile.\u003cbr\u003e Requires to be logged in and the \u0027Administer Quality Profiles\u0027 permission.","since":"5.2","internal":false,"post":true,"hasResponseExample":true,"changelog":[],"params":[{"key":"fromKey","description":"Quality profile key","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"toName","description":"Name for the new quality profile.","required":true,"internal":false,"exampleValue":"My Sonar way"}]},{"key":"create","description":"Create a quality profile.\u003cbr\u003eRequires to be logged in and the \u0027Administer Quality Profiles\u0027 permission.","since":"5.2","internal":false,"post":true,"hasResponseExample":true,"changelog":[],"params":[{"key":"language","description":"Quality profile language","required":true,"internal":false,"exampleValue":"js","possibleValues":["abap","ansible","apex","azurepipelines","azureresourcemanager","c","cloudformation","cobol","cpp","cs","css","dart","dataweave","delphi","docker","flex","githubactions","go","gosu","groovy","ipynb","java","jcl","js","json","jsp","kotlin","kubernetes","objc","php","pli","plsql","postgres","powershell","py","r","rpg","ruby","rust","scala","secrets","shell","swift","terraform","text","ts","tsql","vb","vbnet","web","xml","yaml"]},{"key":"name","description":"Quality profile name","required":true,"internal":false,"exampleValue":"My Sonar way","maximumLength":100}]},{"key":"deactivate_rule","description":"Deactivate a rule on a quality profile.\u003cbr\u003e Requires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer Quality Profiles\u0027\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality profile\u003c/li\u003e\u003c/ul\u003e","since":"4.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Inherited rules can be deactivated (if the global admin setting is enabled)","version":"10.3"}],"params":[{"key":"key","description":"Quality Profile key. Can be obtained through \u003ccode\u003eapi/qualityprofiles/search\u003c/code\u003e","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"rule","description":"Rule key","required":true,"internal":false,"exampleValue":"java:S1144"}]},{"key":"deactivate_rules","description":"Bulk deactivate rules on Quality profiles.\u003cbr\u003eRequires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer Quality Profiles\u0027\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality profile\u003c/li\u003e\u003c/ul\u003e","since":"4.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Parameters \u0027severities\u0027, \u0027active_severities\u0027, and \u0027types\u0027 are not deprecated anymore.","version":"10.8"},{"description":"Inherited rules can be deactivated (if the global admin setting is enabled)","version":"10.3"},{"description":"Parameters \u0027severities\u0027, \u0027active_severities\u0027, and \u0027types\u0027 are now deprecated.","version":"10.2"},{"description":"Parameter \u0027sansTop25\u0027 is deprecated","version":"10.0"}],"params":[{"key":"activation","description":"Filter rules that are activated or deactivated on the selected Quality profile. Ignored if the parameter \u0027qprofile\u0027 is not set.","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"active_impactSeverities","description":"Comma-separated list of Activation Software Quality Severities, i.e the impact severity of rules in Quality profiles.","since":"2025.1","required":false,"internal":false,"exampleValue":"HIGH,MEDIUM","possibleValues":["INFO","LOW","MEDIUM","HIGH","BLOCKER"]},{"key":"active_severities","description":"Comma-separated list of activation severities, i.e the severity of rules in Quality profiles.","required":false,"internal":false,"exampleValue":"CRITICAL,BLOCKER","possibleValues":["INFO","MINOR","MAJOR","CRITICAL","BLOCKER"]},{"key":"asc","description":"Ascending sort","required":false,"internal":false,"defaultValue":"true","possibleValues":["true","false","yes","no"]},{"key":"available_since","description":"Filters rules added since date. Format is yyyy-MM-dd","required":false,"internal":false,"exampleValue":"2014-06-22"},{"key":"cleanCodeAttributeCategories","description":"Comma-separated list of Clean Code Attribute Categories","since":"10.2","required":false,"internal":false,"exampleValue":"ADAPTABLE,INTENTIONAL","possibleValues":["ADAPTABLE","CONSISTENT","INTENTIONAL","RESPONSIBLE"]},{"key":"cwe","description":"Comma-separated list of CWE identifiers. Use \u0027unknown\u0027 to select rules not associated to any CWE.","required":false,"internal":false,"exampleValue":"12,125,unknown"},{"key":"impactSeverities","description":"Comma-separated list of Software Quality Severities","since":"10.2","required":false,"internal":false,"exampleValue":"HIGH,MEDIUM","possibleValues":["INFO","LOW","MEDIUM","HIGH","BLOCKER"]},{"key":"impactSoftwareQualities","description":"Comma-separated list of Software Qualities","since":"10.2","required":false,"internal":false,"exampleValue":"MAINTAINABILITY,RELIABILITY","possibleValues":["MAINTAINABILITY","RELIABILITY","SECURITY"]},{"key":"inheritance","description":"Comma-separated list of values of inheritance for a rule within a quality profile. Used only if the parameter \u0027activation\u0027 is set.","required":false,"internal":false,"exampleValue":"INHERITED,OVERRIDES","possibleValues":["NONE","INHERITED","OVERRIDES"]},{"key":"is_template","description":"Filter template rules","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"languages","description":"Comma-separated list of languages","required":false,"internal":false,"exampleValue":"java,js"},{"key":"owaspMobileTop10-2024","description":"Comma-separated list of OWASP Mobile Top 10 2024 lowercase categories.","since":"2025.4","required":false,"internal":false,"possibleValues":["m1","m2","m3","m4","m5","m6","m7","m8","m9","m10"]},{"key":"owaspTop10","description":"Comma-separated list of OWASP Top 10 2017 lowercase categories.","since":"7.3","required":false,"internal":false,"possibleValues":["a1","a2","a3","a4","a5","a6","a7","a8","a9","a10"]},{"key":"owaspTop10-2021","description":"Comma-separated list of OWASP Top 10 2021 lowercase categories.","since":"9.4","required":false,"internal":false,"possibleValues":["a1","a2","a3","a4","a5","a6","a7","a8","a9","a10"]},{"key":"q","description":"UTF-8 search query","required":false,"internal":false,"exampleValue":"xpath","minimumLength":2},{"key":"qprofile","description":"Quality profile key to filter on. Only rules of the same language as this profile are returned. By default only rules activated in this profile are returned. You can change that using the \u0027activation\u0027 parameter.","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"repositories","description":"Comma-separated list of repositories","required":false,"internal":false,"exampleValue":"java,html"},{"key":"rule_key","description":"Key of rule to search for","required":false,"internal":false,"exampleValue":"java:S1144"},{"key":"s","description":"Sort field","required":false,"internal":false,"exampleValue":"name","possibleValues":["name","createdAt","updatedAt","key"]},{"key":"sansTop25","description":"Comma-separated list of SANS Top 25 categories.","since":"7.3","required":false,"internal":false,"deprecatedSince":"10.0","possibleValues":["insecure-interaction","risky-resource","porous-defenses"]},{"key":"severities","description":"Comma-separated list of default severities. Not the same than severity of rules in Quality profiles.","required":false,"internal":false,"exampleValue":"CRITICAL,BLOCKER","possibleValues":["INFO","MINOR","MAJOR","CRITICAL","BLOCKER"]},{"key":"sonarsourceSecurity","description":"Comma-separated list of SonarSource security categories. Use \u0027others\u0027 to select rules not associated with any category","since":"7.8","required":false,"internal":false,"exampleValue":"sql-injection,command-injection,others","possibleValues":["malicious-dependencies","buffer-overflow","sql-injection","rce","object-injection","command-injection","path-traversal-injection","ldap-injection","xpath-injection","log-injection","xxe","xss","dos","ssrf","csrf","http-response-splitting","open-redirect","weak-cryptography","auth","insecure-conf","file-manipulation","encrypt-data","traceability","permission","others"]},{"key":"statuses","description":"Comma-separated list of status codes","required":false,"internal":false,"exampleValue":"READY","possibleValues":["BETA","DEPRECATED","READY","REMOVED"]},{"key":"tags","description":"Comma-separated list of tags. Returned rules match any of the tags (OR operator)","required":false,"internal":false,"exampleValue":"security,java8"},{"key":"targetKey","description":"Quality Profile key on which the rule deactivation is done. To retrieve a profile key please see \u003ccode\u003eapi/qualityprofiles/search\u003c/code\u003e","required":true,"internal":false,"exampleValue":"AU-TpxcA-iU5OvuD2FL1"},{"key":"template_key","description":"Key of the template rule to filter on. Used to search for the custom rules based on this template.","required":false,"internal":false,"exampleValue":"java:S001"},{"key":"types","description":"Comma-separated list of types. Returned rules match any of the tags (OR operator)","since":"5.5","required":false,"internal":false,"exampleValue":"BUG","possibleValues":["CODE_SMELL","BUG","VULNERABILITY","SECURITY_HOTSPOT"]}]},{"key":"delete","description":"Delete a quality profile and all its descendants. The default quality profile cannot be deleted.\u003cbr\u003e Requires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer Quality Profiles\u0027\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality profile\u003c/li\u003e\u003c/ul\u003e","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"language","description":"Quality profile language.","required":true,"internal":false,"possibleValues":["kubernetes","css","py","apex","plsql","java","xml","powershell","ipynb","text","azurepipelines","swift","yaml","cpp","vb","secrets","groovy","shell","terraform","azureresourcemanager","abap","scala","jsp","js","docker","ansible","dart","rust","jcl","web","flex","json","vbnet","postgres","cloudformation","delphi","c","go","kotlin","rpg","pli","tsql","ruby","cs","r","cobol","php","dataweave","gosu","objc","ts","githubactions"]},{"key":"qualityProfile","description":"Quality profile name.","required":true,"internal":false,"exampleValue":"Sonar way"}]},{"key":"export","description":"Export a quality profile.","since":"5.2","deprecatedSince":"25.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Deprecated. Use GET /api/qualityprofiles/backup instead","version":"25.4"}],"params":[{"key":"language","description":"Quality profile language","required":true,"internal":false,"exampleValue":"cs","possibleValues":["abap","ansible","apex","azurepipelines","azureresourcemanager","c","cloudformation","cobol","cpp","cs","css","dart","dataweave","delphi","docker","flex","githubactions","go","gosu","groovy","ipynb","java","jcl","js","json","jsp","kotlin","kubernetes","objc","php","pli","plsql","postgres","powershell","py","r","rpg","ruby","rust","scala","secrets","shell","swift","terraform","text","ts","tsql","vb","vbnet","web","xml","yaml"]},{"key":"qualityProfile","description":"Quality profile name to export. If left empty, the default profile for the language is exported.","required":false,"internal":false,"exampleValue":"My Sonar way"}]},{"key":"exporters","description":"Deprecated. No more custom profile exporters.","since":"5.2","deprecatedSince":"25.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[]},{"key":"importers","description":"List supported importers.","since":"5.2","deprecatedSince":"25.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[]},{"key":"inheritance","description":"Show a quality profile\u0027s ancestors and children.","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Field \u0027inactiveRuleCount\u0027 added to the response","version":"10.3"}],"params":[{"key":"language","description":"Quality profile language.","required":true,"internal":false,"possibleValues":["kubernetes","css","py","apex","plsql","java","xml","powershell","ipynb","text","azurepipelines","swift","yaml","cpp","vb","secrets","groovy","shell","terraform","azureresourcemanager","abap","scala","jsp","js","docker","ansible","dart","rust","jcl","web","flex","json","vbnet","postgres","cloudformation","delphi","c","go","kotlin","rpg","pli","tsql","ruby","cs","r","cobol","php","dataweave","gosu","objc","ts","githubactions"]},{"key":"qualityProfile","description":"Quality profile name.","required":true,"internal":false,"exampleValue":"Sonar way"}]},{"key":"projects","description":"List projects with their association status regarding a quality profile. \u003cbr/\u003eOnly projects explicitly bound to the profile are returned, those associated with the profile because it is the default one are not. \u003cbr/\u003eSee api/qualityprofiles/search in order to get the Quality Profile Key. ","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"deprecated \u0027more\u0027 response field has been removed","version":"10.0"},{"description":"deprecated \u0027id\u0027 response field has been removed","version":"8.8"},{"description":"deprecated \u0027uuid\u0027 response field has been removed","version":"8.8"},{"description":"\u0027more\u0027 response field is deprecated","version":"7.2"},{"description":"\u0027id\u0027 response field is deprecated","version":"6.5"},{"description":"\u0027uuid\u0027 response field is deprecated and replaced by \u0027id\u0027","version":"6.0"},{"description":"\u0027key\u0027 response field has been added to return the project key","version":"6.0"}],"params":[{"key":"key","description":"Quality profile key","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 500","required":false,"internal":false,"defaultValue":"100","exampleValue":"20","maximumValue":500},{"key":"q","description":"Limit search to projects that contain the supplied string.","required":false,"internal":false,"exampleValue":"sonar"},{"key":"selected","description":"Depending on the value, show only selected items (selected\u003dselected), deselected items (selected\u003ddeselected), or all items with their selection status (selected\u003dall).","required":false,"internal":false,"defaultValue":"selected","possibleValues":["all","deselected","selected"]}]},{"key":"remove_project","description":"Remove a project\u0027s association with a quality profile.\u003cbr\u003e Requires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer Quality Profiles\u0027\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality profile\u003c/li\u003e  \u003cli\u003eAdminister right on the specified project\u003c/li\u003e\u003c/ul\u003e","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"language","description":"Quality profile language.","required":true,"internal":false,"possibleValues":["kubernetes","css","py","apex","plsql","java","xml","powershell","ipynb","text","azurepipelines","swift","yaml","cpp","vb","secrets","groovy","shell","terraform","azureresourcemanager","abap","scala","jsp","js","docker","ansible","dart","rust","jcl","web","flex","json","vbnet","postgres","cloudformation","delphi","c","go","kotlin","rpg","pli","tsql","ruby","cs","r","cobol","php","dataweave","gosu","objc","ts","githubactions"]},{"key":"project","description":"Project key","required":true,"internal":false,"exampleValue":"my_project"},{"key":"qualityProfile","description":"Quality profile name.","required":true,"internal":false,"exampleValue":"Sonar way"}]},{"key":"rename","description":"Rename a quality profile.\u003cbr\u003e Requires one of the following permissions:\u003cul\u003e  \u003cli\u003e\u0027Administer Quality Profiles\u0027\u003c/li\u003e  \u003cli\u003eEdit right on the specified quality profile\u003c/li\u003e\u003c/ul\u003e","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"key","description":"Quality profile key","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"name","description":"New quality profile name","required":true,"internal":false,"exampleValue":"My Sonar way","maximumLength":100}]},{"key":"restore","description":"Restore a quality profile using an XML file. The restored profile name is taken from the backup file, so if a profile with the same name and language already exists, it will be overwritten.\u003cbr\u003e Requires to be logged in and the \u0027Administer Quality Profiles\u0027 permission.","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"The \u0027priority\u0027 and \u0027type\u0027 fields of the rule XML object are not deprecated anymore.","version":"10.8"},{"description":"The \u0027priority\u0027 and \u0027type\u0027 fields of the rule XML object are deprecated.","version":"10.3"}],"params":[{"key":"backup","description":"A profile backup file in XML format, as generated by api/qualityprofiles/backup or the former api/profiles/backup.","required":true,"internal":false}]},{"key":"search","description":"Search quality profiles","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Remove deprecated parameter \u0027project_key\u0027. Please use \u0027project\u0027 instead.","version":"10.0"},{"description":"Add available actions \u0027delete\u0027 and \u0027associateProjects\u0027","version":"7.0"},{"description":"Add available actions \u0027edit\u0027, \u0027copy\u0027 and \u0027setAsDefault\u0027 and global action \u0027create\u0027","version":"6.6"},{"description":"The parameters \u0027defaults\u0027, \u0027project\u0027 and \u0027language\u0027 can be combined without any constraint","version":"6.5"}],"params":[{"key":"defaults","description":"If set to true, return only the quality profiles marked as default for each language","required":false,"internal":false,"defaultValue":"false","possibleValues":["true","false","yes","no"]},{"key":"language","description":"Language key. If provided, only profiles for the given language are returned.","required":false,"internal":false,"possibleValues":["abap","ansible","apex","azurepipelines","azureresourcemanager","c","cloudformation","cobol","cpp","cs","css","dart","dataweave","delphi","docker","flex","githubactions","go","gosu","groovy","ipynb","java","jcl","js","json","jsp","kotlin","kubernetes","objc","php","pli","plsql","postgres","powershell","py","r","rpg","ruby","rust","scala","secrets","shell","swift","terraform","text","ts","tsql","vb","vbnet","web","xml","yaml"]},{"key":"project","description":"Project key","required":false,"internal":false,"exampleValue":"my_project"},{"key":"qualityProfile","description":"Quality profile name","required":false,"internal":false,"exampleValue":"SonarQube Way"}]},{"key":"set_default","description":"Select the default profile for a given language.\u003cbr\u003e Requires to be logged in and the \u0027Administer Quality Profiles\u0027 permission.","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"language","description":"Quality profile language.","required":true,"internal":false,"possibleValues":["kubernetes","css","py","apex","plsql","java","xml","powershell","ipynb","text","azurepipelines","swift","yaml","cpp","vb","secrets","groovy","shell","terraform","azureresourcemanager","abap","scala","jsp","js","docker","ansible","dart","rust","jcl","web","flex","json","vbnet","postgres","cloudformation","delphi","c","go","kotlin","rpg","pli","tsql","ruby","cs","r","cobol","php","dataweave","gosu","objc","ts","githubactions"]},{"key":"qualityProfile","description":"Quality profile name.","required":true,"internal":false,"exampleValue":"Sonar way"}]}]},{"path":"api/rules","description":"Get and update some details of automatic rules, and manage custom rules.","actions":[{"key":"create","description":"Create a custom rule.\u003cbr\u003eRequires the \u0027Administer Quality Profiles\u0027 permission","since":"4.4","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"The parameters \u0027type\u0027 and \u0027severity\u0027 are not deprecated anymore.","version":"10.8"},{"description":"Add \u0027impacts\u0027 and \u0027cleanCodeAttribute\u0027 parameters to the request","version":"10.4"},{"description":"Parameters \u0027type\u0027 and \u0027severity\u0027 are deprecated. Use \u0027impacts\u0027 instead.","version":"10.4"},{"description":"Parameter \u0027preventReactivation\u0027 is deprecated. Use api/rules/update endpoint instead.","version":"10.4"},{"description":"Add \u0027impacts\u0027, \u0027cleanCodeAttribute\u0027, \u0027cleanCodeAttributeCategory\u0027 fields to the response","version":"10.2"},{"description":"Fields \u0027type\u0027 and \u0027severity\u0027 are deprecated in the response. Use \u0027impacts\u0027 instead.","version":"10.2"},{"description":"Drop deprecated keys: \u0027custom_key\u0027, \u0027template_key\u0027, \u0027markdown_description\u0027, \u0027prevent_reactivation\u0027","version":"10.0"},{"description":"Creating manual rule is not more possible","version":"5.5"}],"params":[{"key":"cleanCodeAttribute","description":"Clean code attribute","since":"10.4","required":false,"internal":false,"possibleValues":["CONVENTIONAL","FORMATTED","IDENTIFIABLE","CLEAR","COMPLETE","EFFICIENT","LOGICAL","DISTINCT","FOCUSED","MODULAR","TESTED","LAWFUL","RESPECTFUL","TRUSTWORTHY"]},{"key":"customKey","description":"Key of the custom rule","required":true,"internal":false,"exampleValue":"Todo_should_not_be_used","maximumLength":200},{"key":"impacts","description":"Impacts as semi-colon list of \u0026lt;software_quality\u0026gt;\u003d\u0026lt;severity\u0026gt;","since":"10.4","required":false,"internal":false,"exampleValue":"SECURITY\u003dHIGH;MAINTAINABILITY\u003dLOW"},{"key":"markdownDescription","description":"Rule description in \u003ca href\u003d\u0027/formatting/help\u0027\u003emarkdown format\u003c/a\u003e","required":true,"internal":false,"exampleValue":"Description of my custom rule"},{"key":"name","description":"Rule name","required":true,"internal":false,"exampleValue":"My custom rule","maximumLength":200},{"key":"params","description":"Parameters as semi-colon list of \u0026lt;key\u0026gt;\u003d\u0026lt;value\u0026gt;","required":false,"internal":false,"exampleValue":"key1\u003dv1;key2\u003dv2"},{"key":"preventReactivation","description":"If set to true and if the rule has been deactivated (status \u0027REMOVED\u0027), a status 409 will be returned","required":false,"internal":false,"defaultValue":"false","deprecatedSince":"10.4","possibleValues":["true","false","yes","no"]},{"key":"severity","description":"Rule severity","required":false,"internal":false,"possibleValues":["INFO","MINOR","MAJOR","CRITICAL","BLOCKER"]},{"key":"status","description":"Rule status","required":false,"internal":false,"defaultValue":"READY","possibleValues":["BETA","DEPRECATED","READY"]},{"key":"templateKey","description":"Key of the template rule in order to create a custom rule","required":true,"internal":false,"exampleValue":"java:XPath"},{"key":"type","description":"Rule type","since":"6.7","required":false,"internal":false,"possibleValues":["CODE_SMELL","BUG","VULNERABILITY","SECURITY_HOTSPOT"]}]},{"key":"delete","description":"Delete custom rule.\u003cbr/\u003eRequires the \u0027Administer Quality Profiles\u0027 permission","since":"4.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"key","description":"Rule key","required":true,"internal":false,"exampleValue":"java:S1144"}]},{"key":"repositories","description":"List available rule repositories","since":"4.5","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"language","description":"A language key; if provided, only repositories for the given language will be returned","required":false,"internal":false,"exampleValue":"java"},{"key":"q","description":"A pattern to match repository keys/names against","required":false,"internal":false,"exampleValue":"java"}]},{"key":"search","description":"Search for a collection of relevant rules matching a specified query.\u003cbr/\u003e","since":"4.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Description-related fields in the response are obfuscated for anonymous users.","version":"2026.2"},{"description":"The facet \u0027complianceStandards\u0027 was added.","version":"2025.6"},{"description":"The parameter \u0027complianceStandards\u0027 was added.","version":"2025.6"},{"description":"The facet \u0027active_impactSeverities\u0027 has been added.","version":"2025.1"},{"description":"The deprecated field \u0027htmlDesc\u0027 is not returned anymore, even if specified in the \u0027fields\u0027 parameter.","version":"2025.1"},{"description":"Possible values \u0027INFO\u0027 and \u0027BLOCKER\u0027 for response field \u0027impactSeverities\u0027 of \u0027facets\u0027 have been added","version":"10.8"},{"description":"Possible values \u0027INFO\u0027 and \u0027BLOCKER\u0027 for response field \u0027severity\u0027 of \u0027impacts\u0027 have been added","version":"10.8"},{"description":"Parameter \u0027severities\u0027 now supports values: \u0027INFO\u0027,\u0027BLOCKER\u0027","version":"10.8"},{"description":"The field \u0027impacts\u0027 has been added to the response","version":"10.8"},{"description":"The parameters \u0027severities\u0027,\u0027types and \u0027active_severities\u0027 are not deprecated anymore.","version":"10.8"},{"description":"The values \u0027severity\u0027 and \u0027types\u0027 for the \u0027facets\u0027 parameter are not deprecated anymore.","version":"10.8"},{"description":"The fields \u0027type\u0027 and \u0027severity\u0027 in the response are not deprecated anymore.","version":"10.8"},{"description":"The value \u0027severity\u0027 for the \u0027fields\u0027 parameter is not deprecated anymore.","version":"10.8"},{"description":"Parameter \u0027prioritizedRule has been added","version":"10.6"},{"description":"Add \u0027impacts\u0027, \u0027cleanCodeAttribute\u0027, \u0027cleanCodeAttributeCategory\u0027 fields to the response","version":"10.2"},{"description":"The fields \u0027type\u0027 and \u0027severity\u0027 are deprecated in the response. Use \u0027impacts\u0027 instead.","version":"10.2"},{"description":"The field \u0027cleanCodeAttribute\u0027 has been added to the \u0027fields\u0027 parameter.","version":"10.2"},{"description":"The value \u0027severity\u0027 for the \u0027fields\u0027 parameter has been deprecated.","version":"10.2"},{"description":"The values \u0027cleanCodeAttributeCategories\u0027, \u0027impactSoftwareQualities\u0027 and \u0027impactSeverities\u0027 have been added to the \u0027facets\u0027 parameter.","version":"10.2"},{"description":"The values \u0027severity\u0027 and \u0027types\u0027 for the \u0027facets\u0027 parameter have been deprecated. Use \u0027impactSeverities\u0027 and \u0027impactSoftwareQualities\u0027 instead.","version":"10.2"},{"description":"Parameters \u0027severities\u0027, \u0027types\u0027, and \u0027active_severities\u0027 are now deprecated. Use \u0027impactSoftwareQualities\u0027 and \u0027impactSeverities\u0027 instead.","version":"10.2"},{"description":"The deprecated field \u0027effortToFixDescription\u0027 has been removed, use \u0027gapDescription\u0027 instead.","version":"10.0"},{"description":"The deprecated field \u0027debtRemFnCoeff\u0027 has been removed, use \u0027remFnGapMultiplier\u0027 instead.","version":"10.0"},{"description":"The deprecated field \u0027defaultDebtRemFnCoeff\u0027 has been removed, use \u0027defaultRemFnGapMultiplier\u0027 instead.","version":"10.0"},{"description":"The deprecated field \u0027debtRemFnOffset\u0027 has been removed, use \u0027remFnBaseEffort\u0027 instead.","version":"10.0"},{"description":"The deprecated field \u0027defaultDebtRemFnOffset\u0027 has been removed, use \u0027defaultRemFnBaseEffort\u0027 instead.","version":"10.0"},{"description":"The deprecated field \u0027debtOverloaded\u0027 has been removed, use \u0027remFnOverloaded\u0027 instead.","version":"10.0"},{"description":"The field \u0027defaultDebtRemFnType\u0027 has been deprecated, use \u0027defaultRemFnType\u0027 instead","version":"10.0"},{"description":"The field \u0027debtRemFnType\u0027 has been deprecated, use \u0027remFnType\u0027 instead","version":"10.0"},{"description":"The value \u0027debtRemFn\u0027 for the \u0027fields\u0027 parameter has been deprecated, use \u0027remFn\u0027 instead","version":"10.0"},{"description":"The value \u0027defaultDebtRemFn\u0027 for the \u0027fields\u0027 parameter has been deprecated, use \u0027defaultRemFn\u0027 instead","version":"10.0"},{"description":"The value \u0027sansTop25\u0027 for the parameter \u0027facets\u0027 has been deprecated","version":"10.0"},{"description":"Parameter \u0027sansTop25\u0027 is deprecated","version":"10.0"},{"description":"response fields \u0027total\u0027, \u0027s\u0027, \u0027pageSize\u0027 have been deprecated, please use \u0027paging\u0027 object instead","version":"9.8"},{"description":"The field \u0027paging\u0027 has been added to the response","version":"9.8"},{"description":"\u0027descriptionSections\u0027 can optionally embed a context field","version":"9.6"},{"description":"The field \u0027educationPrinciples\u0027 has been added to the \u0027fields\u0027 parameter","version":"9.6"},{"description":"The field \u0027htmlDesc\u0027 has been deprecated, use \u0027descriptionSections\u0027 instead","version":"9.5"},{"description":"The field \u0027descriptionSections\u0027 has been added to the payload","version":"9.5"},{"description":"The field \u0027descriptionSections\u0027 has been added to the \u0027fields\u0027 parameter","version":"9.5"},{"description":"The field \u0027updatedAt\u0027 has been added to the \u0027fields\u0027 parameter","version":"7.5"},{"description":"The field \u0027isExternal\u0027 has been added to the response","version":"7.2"},{"description":"The field \u0027includeExternal\u0027 has been added to the \u0027fields\u0027 parameter","version":"7.2"},{"description":"The field \u0027scope\u0027 has been added to the response","version":"7.1"},{"description":"The field \u0027scope\u0027 has been added to the \u0027fields\u0027 parameter","version":"7.1"},{"description":"The field \u0027effortToFixDescription\u0027 has been deprecated, use \u0027gapDescription\u0027 instead","version":"5.5"},{"description":"The field \u0027debtRemFnCoeff\u0027 has been deprecated, use \u0027remFnGapMultiplier\u0027 instead","version":"5.5"},{"description":"The field \u0027defaultDebtRemFnCoeff\u0027 has been deprecated, use \u0027defaultRemFnGapMultiplier\u0027 instead","version":"5.5"},{"description":"The field \u0027debtRemFnOffset\u0027 has been deprecated, use \u0027remFnBaseEffort\u0027 instead","version":"5.5"},{"description":"The field \u0027defaultDebtRemFnOffset\u0027 has been deprecated, use \u0027defaultRemFnBaseEffort\u0027 instead","version":"5.5"},{"description":"The field \u0027debtOverloaded\u0027 has been deprecated, use \u0027remFnOverloaded\u0027 instead","version":"5.5"}],"params":[{"key":"activation","description":"Filter rules that are activated or deactivated on the selected Quality profile. Ignored if the parameter \u0027qprofile\u0027 is not set.","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"active_impactSeverities","description":"Comma-separated list of Activation Software Quality Severities, i.e the impact severity of rules in Quality profiles.","since":"2025.1","required":false,"internal":false,"exampleValue":"HIGH,MEDIUM","possibleValues":["INFO","LOW","MEDIUM","HIGH","BLOCKER"]},{"key":"active_severities","description":"Comma-separated list of activation severities, i.e the severity of rules in Quality profiles.","required":false,"internal":false,"exampleValue":"CRITICAL,BLOCKER","possibleValues":["INFO","MINOR","MAJOR","CRITICAL","BLOCKER"]},{"key":"asc","description":"Ascending sort","required":false,"internal":false,"defaultValue":"true","possibleValues":["true","false","yes","no"]},{"key":"available_since","description":"Filters rules added since date. Format is yyyy-MM-dd","required":false,"internal":false,"exampleValue":"2014-06-22"},{"key":"cleanCodeAttributeCategories","description":"Comma-separated list of Clean Code Attribute Categories","since":"10.2","required":false,"internal":false,"exampleValue":"ADAPTABLE,INTENTIONAL","possibleValues":["ADAPTABLE","CONSISTENT","INTENTIONAL","RESPONSIBLE"]},{"key":"complianceStandards","description":"Comma-separated list of compliance standards","since":"2025.6","required":false,"internal":false,"exampleValue":"asvs:4.0.3\u003d6.1.2"},{"key":"cwe","description":"Comma-separated list of CWE identifiers. Use \u0027unknown\u0027 to select rules not associated to any CWE.","required":false,"internal":false,"exampleValue":"12,125,unknown"},{"key":"f","description":"Comma-separated list of additional fields to be returned in the response. All the fields are returned by default, except actives.","required":false,"internal":false,"exampleValue":"scope,isExternal","possibleValues":["actives","cleanCodeAttribute","createdAt","debtRemFn","defaultDebtRemFn","defaultRemFn","deprecatedKeys","descriptionSections","educationPrinciples","gapDescription","htmlDesc","htmlNote","internalKey","isExternal","isTemplate","lang","langName","mdDesc","mdNote","name","noteLogin","params","remFn","remFnOverloaded","repo","scope","severity","status","sysTags","tags","templateKey","updatedAt"]},{"key":"facets","description":"Comma-separated list of the facets to be computed. No facet is computed by default.","required":false,"internal":false,"exampleValue":"languages,repositories","possibleValues":["languages","repositories","tags","severities","active_severities","statuses","types","true","cwe","owaspTop10","owaspTop10-2021","owaspMobileTop10-2024","sansTop25","sonarsourceSecurity","cleanCodeAttributeCategories","impactSeverities","impactSoftwareQualities","active_impactSeverities","complianceStandards"]},{"key":"impactSeverities","description":"Comma-separated list of Software Quality Severities","since":"10.2","required":false,"internal":false,"exampleValue":"HIGH,MEDIUM","possibleValues":["INFO","LOW","MEDIUM","HIGH","BLOCKER"]},{"key":"impactSoftwareQualities","description":"Comma-separated list of Software Qualities","since":"10.2","required":false,"internal":false,"exampleValue":"MAINTAINABILITY,RELIABILITY","possibleValues":["MAINTAINABILITY","RELIABILITY","SECURITY"]},{"key":"include_external","description":"Include external engine rules in the results","since":"7.2","required":false,"internal":false,"defaultValue":"false","possibleValues":["true","false","yes","no"]},{"key":"inheritance","description":"Comma-separated list of values of inheritance for a rule within a quality profile. Used only if the parameter \u0027activation\u0027 is set.","required":false,"internal":false,"exampleValue":"INHERITED,OVERRIDES","possibleValues":["NONE","INHERITED","OVERRIDES"]},{"key":"is_template","description":"Filter template rules","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"languages","description":"Comma-separated list of languages","required":false,"internal":false,"exampleValue":"java,js"},{"key":"owaspMobileTop10-2024","description":"Comma-separated list of OWASP Mobile Top 10 2024 lowercase categories.","since":"2025.4","required":false,"internal":false,"possibleValues":["m1","m2","m3","m4","m5","m6","m7","m8","m9","m10"]},{"key":"owaspTop10","description":"Comma-separated list of OWASP Top 10 2017 lowercase categories.","since":"7.3","required":false,"internal":false,"possibleValues":["a1","a2","a3","a4","a5","a6","a7","a8","a9","a10"]},{"key":"owaspTop10-2021","description":"Comma-separated list of OWASP Top 10 2021 lowercase categories.","since":"9.4","required":false,"internal":false,"possibleValues":["a1","a2","a3","a4","a5","a6","a7","a8","a9","a10"]},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"prioritizedRule","description":"Filter on prioritized rules. Ignored if the parameter \u0027qprofile\u0027 is not set.","since":"10.6","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 500","required":false,"internal":false,"defaultValue":"100","exampleValue":"20","maximumValue":500},{"key":"q","description":"UTF-8 search query","required":false,"internal":false,"exampleValue":"xpath","minimumLength":2},{"key":"qprofile","description":"Quality profile key to filter on. Only rules of the same language as this profile are returned. By default only rules activated in this profile are returned. You can change that using the \u0027activation\u0027 parameter.","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"repositories","description":"Comma-separated list of repositories","required":false,"internal":false,"exampleValue":"java,html"},{"key":"rule_key","description":"Key of rule to search for","required":false,"internal":false,"exampleValue":"java:S1144"},{"key":"s","description":"Sort field","required":false,"internal":false,"exampleValue":"name","possibleValues":["name","createdAt","updatedAt","key"]},{"key":"sansTop25","description":"Comma-separated list of SANS Top 25 categories.","since":"7.3","required":false,"internal":false,"deprecatedSince":"10.0","possibleValues":["insecure-interaction","risky-resource","porous-defenses"]},{"key":"severities","description":"Comma-separated list of default severities. Not the same than severity of rules in Quality profiles.","required":false,"internal":false,"exampleValue":"CRITICAL,BLOCKER","possibleValues":["INFO","MINOR","MAJOR","CRITICAL","BLOCKER"]},{"key":"sonarsourceSecurity","description":"Comma-separated list of SonarSource security categories. Use \u0027others\u0027 to select rules not associated with any category","since":"7.8","required":false,"internal":false,"exampleValue":"sql-injection,command-injection,others","possibleValues":["malicious-dependencies","buffer-overflow","sql-injection","rce","object-injection","command-injection","path-traversal-injection","ldap-injection","xpath-injection","log-injection","xxe","xss","dos","ssrf","csrf","http-response-splitting","open-redirect","weak-cryptography","auth","insecure-conf","file-manipulation","encrypt-data","traceability","permission","others"]},{"key":"statuses","description":"Comma-separated list of status codes","required":false,"internal":false,"exampleValue":"READY","possibleValues":["BETA","DEPRECATED","READY","REMOVED"]},{"key":"tags","description":"Comma-separated list of tags. Returned rules match any of the tags (OR operator)","required":false,"internal":false,"exampleValue":"security,java8"},{"key":"template_key","description":"Key of the template rule to filter on. Used to search for the custom rules based on this template.","required":false,"internal":false,"exampleValue":"java:S001"},{"key":"types","description":"Comma-separated list of types. Returned rules match any of the tags (OR operator)","since":"5.5","required":false,"internal":false,"exampleValue":"BUG","possibleValues":["CODE_SMELL","BUG","VULNERABILITY","SECURITY_HOTSPOT"]}]},{"key":"show","description":"Get detailed information about a rule\u003cbr\u003e","since":"4.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The \u0027contextKey\u0027 parameter has been added.","version":"2026.5"},{"description":"Description-related fields in the response are obfuscated for anonymous users.","version":"2026.2"},{"description":"The deprecated field \u0027htmlDesc\u0027 is not returned anymore, even if specified in the \u0027fields\u0027 parameter.","version":"2025.1"},{"description":"Possible values \u0027INFO\u0027 and \u0027BLOCKER\u0027 for response field \u0027severity\u0027 of \u0027impacts\u0027 have been added.","version":"10.8"},{"description":"The field \u0027severity\u0027 and \u0027type\u0027 in the response  are not deprecated anymore.","version":"10.8"},{"description":"Add \u0027impacts\u0027, \u0027cleanCodeAttribute\u0027, \u0027cleanCodeAttributeCategory\u0027 fields to the response","version":"10.2"},{"description":"The field \u0027severity\u0027 and \u0027type\u0027 in the response have been deprecated, use \u0027impacts\u0027 instead.","version":"10.2"},{"description":"The deprecated field \u0027effortToFixDescription\u0027 has been removed, use \u0027gapDescription\u0027 instead.","version":"10.0"},{"description":"The deprecated field \u0027debtRemFnCoeff\u0027 has been removed, use \u0027remFnGapMultiplier\u0027 instead.","version":"10.0"},{"description":"The deprecated field \u0027defaultDebtRemFnCoeff\u0027 has been removed, use \u0027defaultRemFnGapMultiplier\u0027 instead.","version":"10.0"},{"description":"The deprecated field \u0027debtRemFnOffset\u0027 has been removed, use \u0027remFnBaseEffort\u0027 instead.","version":"10.0"},{"description":"The deprecated field \u0027defaultDebtRemFnOffset\u0027 has been removed, use \u0027defaultRemFnBaseEffort\u0027 instead.","version":"10.0"},{"description":"The deprecated field \u0027debtOverloaded\u0027 has been removed, use \u0027remFnOverloaded\u0027 instead.","version":"10.0"},{"description":"The field \u0027defaultDebtRemFnType\u0027 has been deprecated, use \u0027defaultRemFnType\u0027 instead","version":"10.0"},{"description":"The field \u0027debtRemFnType\u0027 has been deprecated, use \u0027remFnType\u0027 instead","version":"10.0"},{"description":"\u0027descriptionSections\u0027 can optionally embed a context field.","version":"9.6"},{"description":"\u0027educationPrinciples\u0027 has been added.","version":"9.6"},{"description":"The field \u0027htmlDesc\u0027 in the response has been deprecated, it becomes \u0027descriptionSections\u0027.","version":"9.5"},{"description":"The field \u0027descriptionSections\u0027 has been added to the payload.","version":"9.5"},{"description":"The field \u0027scope\u0027 has been added.","version":"7.1"},{"description":"The field \u0027effortToFixDescription\u0027 in the response has been deprecated, it becomes \u0027gapDescription\u0027.","version":"5.5"},{"description":"The field \u0027debtRemFnCoeff\u0027 in the response has been deprecated, it becomes \u0027remFnGapMultiplier\u0027.","version":"5.5"},{"description":"The field \u0027defaultDebtRemFnCoeff\u0027 in the response has been deprecated, it becomes \u0027defaultRemFnGapMultiplier\u0027.","version":"5.5"},{"description":"The field \u0027debtRemFnOffset\u0027 in the response has been deprecated, it becomes \u0027remFnBaseEffort\u0027.","version":"5.5"},{"description":"The field \u0027defaultDebtRemFnOffset\u0027 in the response has been deprecated, it becomes \u0027defaultRemFnBaseEffort\u0027.","version":"5.5"},{"description":"The field \u0027debtOverloaded\u0027 in the response has been deprecated, it becomes \u0027remFnOverloaded\u0027.","version":"5.5"}],"params":[{"key":"actives","description":"Show rule\u0027s activations for all profiles (\"active rules\")","required":false,"internal":false,"defaultValue":"false","possibleValues":["true","false","yes","no"]},{"key":"contextKey","description":"Return only the description sections matching the given rule-description context key, along with sections that have no context. When not set, all description sections are returned.","since":"2026.5","required":false,"internal":false,"exampleValue":"spring","maximumLength":50},{"key":"key","description":"Rule key","required":true,"internal":false,"exampleValue":"javascript:EmptyBlock"}]},{"key":"tags","description":"List rule tags","since":"4.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Max page size increased to 500","version":"9.4"}],"params":[{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 500","required":false,"internal":false,"defaultValue":"10","exampleValue":"20","maximumValue":500},{"key":"q","description":"Limit search to tags that contain the supplied string.","required":false,"internal":false,"exampleValue":"misra"}]},{"key":"update","description":"Update an existing rule.\u003cbr\u003eRequires the \u0027Administer Quality Profiles\u0027 permission","since":"4.4","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"Parameter impacts was added.","version":"10.8"},{"description":"The parameter \u0027severity\u0027 is not deprecated anymore.","version":"10.8"},{"description":"The field \u0027severity\u0027 and \u0027type\u0027 in the response are not deprecated anymore.","version":"10.8"},{"description":"The parameter \u0027severity\u0027 is deprecated.","version":"10.4"},{"description":"Updating a removed rule is now possible.","version":"10.4"},{"description":"The field \u0027severity\u0027 and \u0027type\u0027 in the response have been deprecated, use \u0027impacts\u0027 instead.","version":"10.2"},{"description":"Add \u0027impacts\u0027, \u0027cleanCodeAttribute\u0027, \u0027cleanCodeAttributeCategory\u0027 fields to the response","version":"10.2"}],"params":[{"key":"impacts","description":"Rule impacts, semicolon-separated (Only when updating a custom rule impact severity)","required":false,"internal":false,"exampleValue":"MAINTAINABILITY\u003dHIGH;SECURITY\u003dLOW"},{"key":"key","description":"Key of the rule to update","required":true,"internal":false,"exampleValue":"javascript:NullCheck","maximumLength":200},{"key":"markdownDescription","description":"Rule description (mandatory for custom rule and manual rule) in \u003ca href\u003d\u0027/formatting/help\u0027\u003emarkdown format\u003c/a\u003e","required":false,"internal":false,"exampleValue":"Description of my custom rule","deprecatedKey":"markdown_description","deprecatedKeySince":"10.2"},{"key":"markdown_note","description":"Optional note in \u003ca href\u003d\u0027/formatting/help\u0027\u003emarkdown format\u003c/a\u003e. Use empty value to remove current note. Note is not changed if the parameter is not set.","required":false,"internal":false,"exampleValue":"my *note*"},{"key":"name","description":"Rule name (mandatory for custom rule)","required":false,"internal":false,"exampleValue":"My custom rule","maximumLength":200},{"key":"params","description":"Parameters as semi-colon list of \u003ckey\u003e\u003d\u003cvalue\u003e, for example \u0027params\u003dkey1\u003dv1;key2\u003dv2\u0027 (Only when updating a custom rule)","required":false,"internal":false},{"key":"remediation_fn_base_effort","description":"Base effort of the remediation function of the rule","since":"5.5","required":false,"internal":false,"exampleValue":"1d"},{"key":"remediation_fn_type","description":"Type of the remediation function of the rule","since":"5.5","required":false,"internal":false,"possibleValues":["LINEAR","LINEAR_OFFSET","CONSTANT_ISSUE"]},{"key":"remediation_fy_gap_multiplier","description":"Gap multiplier of the remediation function of the rule","since":"5.5","required":false,"internal":false,"exampleValue":"3min"},{"key":"severity","description":"Rule severity (Only when updating a custom rule)","required":false,"internal":false,"possibleValues":["INFO","MINOR","MAJOR","CRITICAL","BLOCKER"]},{"key":"status","description":"Rule status (Only when updating a custom rule)","required":false,"internal":false,"possibleValues":["BETA","DEPRECATED","READY","REMOVED"]},{"key":"tags","description":"Optional comma-separated list of tags to set. Use blank value to remove current tags. Tags are not changed if the parameter is not set.","required":false,"internal":false,"exampleValue":"java8,security"}]}]},{"path":"api/server","actions":[{"key":"version","description":"Version of SonarQube in plain text","since":"2.10","internal":false,"post":false,"hasResponseExample":true,"changelog":[]}]},{"path":"api/settings","since":"6.1","description":"Manage settings.","actions":[{"key":"list_definitions","description":"List settings definitions.\u003cbr\u003eRequires \u0027Browse\u0027 permission when a component is specified\u003cbr/\u003eTo access licensed settings, authentication is required\u003cbr/\u003eTo access secured settings, one of the following permissions is required: \u003cul\u003e\u003cli\u003e\u0027Execute Analysis\u0027\u003c/li\u003e\u003cli\u003e\u0027Administer System\u0027\u003c/li\u003e\u003cli\u003e\u0027Administer\u0027 rights on the specified component\u003c/li\u003e\u003c/ul\u003e","since":"6.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The use of module keys in parameter \u0027component\u0027 is removed","version":"10.1"},{"description":"The use of module keys in parameter \u0027component\u0027 is deprecated","version":"7.6"}],"params":[{"key":"component","description":"Component key","required":false,"internal":false,"exampleValue":"my_project"}]},{"key":"reset","description":"Remove a setting value.\u003cbr\u003eThe settings defined in conf/sonar.properties are read-only and can\u0027t be changed.\u003cbr/\u003eRequires one of the following permissions: \u003cul\u003e\u003cli\u003e\u0027Administer System\u0027\u003c/li\u003e\u003cli\u003e\u0027Administer\u0027 rights on the specified component\u003c/li\u003e\u003c/ul\u003e","since":"6.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Param \u0027component\u0027 now only accept keys for projects, applications, portfolios or subportfolios","version":"10.1"},{"description":"Internal parameters \u0027branch\u0027 and \u0027pullRequest\u0027 were removed","version":"10.1"},{"description":"Deprecated parameter \u0027componentKey\u0027 has been removed","version":"8.8"},{"description":"The use of module keys in parameter \u0027component\u0027 is deprecated","version":"7.6"},{"description":"The settings defined in conf/sonar.properties are read-only and can\u0027t be changed","version":"7.1"}],"params":[{"key":"component","description":"Component key. Only keys for projects, applications, portfolios or subportfolios are accepted.","required":false,"internal":false,"exampleValue":"my_project"},{"key":"keys","description":"Comma-separated list of keys","required":true,"internal":false,"exampleValue":"sonar.links.scm,sonar.debt.hoursInDay"}]},{"key":"set","description":"Update a setting value.\u003cbr\u003eEither \u0027value\u0027 or \u0027values\u0027 must be provided.\u003cbr\u003e The settings defined in conf/sonar.properties are read-only and can\u0027t be changed.\u003cbr/\u003eRequires one of the following permissions: \u003cul\u003e\u003cli\u003e\u0027Administer System\u0027\u003c/li\u003e\u003cli\u003e\u0027Administer\u0027 rights on the specified component\u003c/li\u003e\u003c/ul\u003e","since":"6.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Param \u0027component\u0027 now only accept keys for projects, applications, portfolios or subportfolios","version":"10.1"},{"description":"The use of module keys in parameter \u0027component\u0027 is removed","version":"10.1"},{"description":"Deprecated parameter \u0027componentKey\u0027 has been removed","version":"8.8"},{"description":"The use of module keys in parameter \u0027component\u0027 is deprecated","version":"7.6"},{"description":"The settings defined in conf/sonar.properties are read-only and can\u0027t be changed","version":"7.1"}],"params":[{"key":"component","description":"Component key. Only keys for projects, applications, portfolios or subportfolios are accepted.","required":false,"internal":false,"exampleValue":"my_project"},{"key":"fieldValues","description":"Setting field values. To set several values, the parameter must be called once for each value.","required":false,"internal":false,"exampleValue":"fieldValues\u003d{\"firstField\":\"first value\", \"secondField\":\"second value\", \"thirdField\":\"third value\"}"},{"key":"key","description":"Setting key","required":true,"internal":false,"exampleValue":"sonar.core.serverBaseURL"},{"key":"value","description":"Setting value. To reset a value, please use the reset web service.","required":false,"internal":false,"exampleValue":"http://my-sonarqube-instance.com","maximumLength":4000},{"key":"values","description":"Setting multi value. To set several values, the parameter must be called once for each value.","required":false,"internal":false,"exampleValue":"values\u003dfirstValue\u0026values\u003dsecondValue\u0026values\u003dthirdValue"}]},{"key":"values","description":"List settings values.\u003cbr\u003eIf no value has been set for a setting, then the default value is returned.\u003cbr\u003eThe settings from conf/sonar.properties are excluded from results.\u003cbr\u003eRequires \u0027Browse\u0027 or \u0027Execute Analysis\u0027 permission when a component is specified.\u003cbr/\u003eSecured settings values are not returned by the endpoint.\u003cbr/\u003e","since":"6.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The use of module keys in parameter \u0027component\u0027 is removed","version":"10.1"},{"description":"The secured settings values are no longer returned. Secured settings keys that have a value are now returned in setSecuredSettings array.","version":"9.1"},{"description":"The use of module keys in parameter \u0027component\u0027 is deprecated","version":"7.6"},{"description":"The settings from conf/sonar.properties are excluded from results.","version":"7.1"}],"params":[{"key":"component","description":"Component key","required":false,"internal":false,"exampleValue":"my_project"},{"key":"keys","description":"List of setting keys","required":false,"internal":false,"exampleValue":"sonar.test.inclusions,sonar.exclusions"}]}]},{"path":"api/sources","since":"4.2","description":"Get details on source files. See also api/tests.","actions":[{"key":"raw","description":"Get source code as raw text. Require \u0027See Source Code\u0027 permission on file","since":"5.0","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"key","description":"File key","required":true,"internal":false,"exampleValue":"my_project:src/foo/Bar.php"}]},{"key":"scm","description":"Get SCM information of source files. Require See Source Code permission on file\u0027s project\u003cbr/\u003eEach element of the result array is composed of:\u003col\u003e\u003cli\u003eLine number\u003c/li\u003e\u003cli\u003eAuthor of the commit\u003c/li\u003e\u003cli\u003eDatetime of the commit (before 5.2 it was only the Date)\u003c/li\u003e\u003cli\u003eRevision of the commit (added in 5.2)\u003c/li\u003e\u003c/ol\u003e","since":"4.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"commits_by_line","description":"Group lines by SCM commit if value is false, else display commits for each line, even if two consecutive lines relate to the same commit.","required":false,"internal":false,"defaultValue":"false","possibleValues":["true","false","yes","no"]},{"key":"from","description":"First line to return. Starts at 1","required":false,"internal":false,"defaultValue":"1","exampleValue":"10"},{"key":"key","description":"File key","required":true,"internal":false,"exampleValue":"my_project:/src/foo/Bar.php"},{"key":"to","description":"Last line to return (inclusive)","required":false,"internal":false,"exampleValue":"20"}]},{"key":"show","description":"Get source code. Requires See Source Code permission on file\u0027s project\u003cbr/\u003eEach element of the result array is composed of:\u003col\u003e\u003cli\u003eLine number\u003c/li\u003e\u003cli\u003eContent of the line\u003c/li\u003e\u003c/ol\u003e","since":"4.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"from","description":"First line to return. Starts at 1","required":false,"internal":false,"defaultValue":"1","exampleValue":"10"},{"key":"key","description":"File key","required":true,"internal":false,"exampleValue":"my_project:/src/foo/Bar.php"},{"key":"to","description":"Last line to return (inclusive)","required":false,"internal":false,"exampleValue":"20"}]}]},{"path":"api/system","description":"Get system details, and perform some management actions, such as restarting, and initiating a database migration (as part of a system upgrade).","actions":[{"key":"change_log_level","description":"Temporarily changes level of logs. New level is not persistent and is lost when restarting server. Requires system administration permission.","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"level","description":"The new level. Be cautious: DEBUG, and even more TRACE, may have performance impacts.","required":true,"internal":false,"possibleValues":["TRACE","DEBUG","INFO"]}]},{"key":"db_migration_status","description":"Display the database migration status of SonarQube.\u003cbr/\u003eState values are:\u003cul\u003e\u003cli\u003eNO_MIGRATION: DB is up to date with current version of SonarQube.\u003c/li\u003e\u003cli\u003eNOT_SUPPORTED: Migration is not supported on embedded databases.\u003c/li\u003e\u003cli\u003eMIGRATION_RUNNING: DB migration is under go.\u003c/li\u003e\u003cli\u003eMIGRATION_SUCCEEDED: DB migration has run and has been successful.\u003c/li\u003e\u003cli\u003eMIGRATION_FAILED: DB migration has run and failed. SonarQube must be restarted in order to retry a DB migration (optionally after DB has been restored from backup).\u003c/li\u003e\u003cli\u003eMIGRATION_REQUIRED: DB migration is required.\u003c/li\u003e\u003c/ul\u003e","since":"5.2","deprecatedSince":"10.6","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"This endpoint is deprecated, please use its API v2 version /api/v2/system/migrations-status instead.","version":"10.6"}]},{"key":"health","description":"Provide health status of SonarQube.\u003cp\u003eAlthough global health is calculated based on both application and search nodes, detailed information is returned only for application nodes.\u003c/p\u003e\u003cp\u003e  \u003cul\u003e \u003cli\u003eGREEN: SonarQube is fully operational\u003c/li\u003e \u003cli\u003eYELLOW: SonarQube is usable, but it needs attention in order to be fully operational\u003c/li\u003e \u003cli\u003eRED: SonarQube is not operational\u003c/li\u003e \u003c/ul\u003e\u003c/p\u003e\u003cbr\u003eRequires the \u0027Administer System\u0027 permission or system passcode (see sonar.web.systemPasscode in sonar.properties).\u003cbr\u003eWhen SonarQube is in safe mode (waiting or running a database upgrade), only the authentication with a system passcode is supported.","since":"6.6","internal":false,"post":false,"hasResponseExample":true,"changelog":[]},{"key":"info","description":"Get detailed information about system configuration.\u003cbr/\u003eRequires \u0027Administer\u0027 permissions.","since":"5.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"\u0027Edition\u0027 field added to the response under the \u0027System\u0027 section","version":"9.8"},{"description":"\u0027Statistics\u0027 field has been removed from response","version":"9.7"},{"description":"Becomes public","version":"8.3"},{"description":"Becomes internal to easily update result","version":"5.5"}]},{"key":"logs","description":"Get system logs in plain-text format. Requires system administration permission.","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Added support for Data Center Edition for all possible values of \u0027name\u0027 except \u0027es\u0027.","version":"2025.2"},{"description":"Removed deprecated \u0027process\u0027 property.","version":"2025.2"},{"description":"Add support for deprecation logs in process property.","version":"10.4"},{"description":"Deprecate property \u0027process\u0027 in favor of \u0027name\u0027.","version":"10.4"}],"params":[{"key":"name","description":"Name of the logs to get","since":"6.2","required":false,"internal":false,"defaultValue":"app","possibleValues":["access","app","ce","deprecation","es","web"]}]},{"key":"migrate_db","description":"Migrate the database to match the current version of SonarQube.\u003cbr/\u003eSending a POST request to this URL starts the DB migration. It is strongly advised to \u003cstrong\u003emake a database backup\u003c/strong\u003e before invoking this WS.\u003cbr/\u003eState values are:\u003cul\u003e\u003cli\u003eNO_MIGRATION: DB is up to date with current version of SonarQube.\u003c/li\u003e\u003cli\u003eNOT_SUPPORTED: Migration is not supported on embedded databases.\u003c/li\u003e\u003cli\u003eMIGRATION_RUNNING: DB migration is under go.\u003c/li\u003e\u003cli\u003eMIGRATION_SUCCEEDED: DB migration has run and has been successful.\u003c/li\u003e\u003cli\u003eMIGRATION_FAILED: DB migration has run and failed. SonarQube must be restarted in order to retry a DB migration (optionally after DB has been restored from backup).\u003c/li\u003e\u003cli\u003eMIGRATION_REQUIRED: DB migration is required.\u003c/li\u003e\u003c/ul\u003e","since":"5.2","internal":false,"post":true,"hasResponseExample":true,"changelog":[]},{"key":"ping","description":"Answers \"pong\" as plain-text","since":"6.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[]},{"key":"restart","description":"Restarts server. Requires \u0027Administer System\u0027 permission. Performs a full restart of the Web, Search and Compute Engine Servers processes. Does not reload sonar.properties.","since":"4.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[]},{"key":"status","description":"Get state information about SonarQube.\u003cp\u003estatus: the running status \u003cul\u003e \u003cli\u003eSTARTING: SonarQube Web Server is up and serving some Web Services (eg. api/system/status) but initialization is still ongoing, or Elasticsearch cluster health is not GREEN or YELLOW\u003c/li\u003e \u003cli\u003eUP: SonarQube instance is up and running and Elasticsearch cluster health is GREEN or YELLOW\u003c/li\u003e \u003cli\u003eDOWN: SonarQube instance is up but not running because migration has failed (refer to WS /api/system/migrate_db for details) or some other reason (check logs).\u003c/li\u003e \u003cli\u003eRESTARTING: SonarQube instance is still up but a restart has been requested (refer to WS /api/system/restart for details).\u003c/li\u003e \u003cli\u003eDB_MIGRATION_NEEDED: database migration is required. DB migration can be started using WS /api/system/migrate_db.\u003c/li\u003e \u003cli\u003eDB_MIGRATION_RUNNING: DB migration is running (refer to WS /api/system/migrate_db for details)\u003c/li\u003e \u003c/ul\u003e\u003c/p\u003e","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Status UP requires Elasticsearch cluster to be healthy While Elasticsearch is unreachable, the status is STARTING.","version":"2026.6"}]},{"key":"upgrades","description":"Lists available upgrades for the SonarQube instance (if any) and for each one, lists incompatible plugins and plugins requiring upgrade.\u003cbr/\u003ePlugin information is retrieved from Update Center. Date and time at which Update Center was last refreshed is provided in the response.","since":"5.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The field \u0027lta\u0027 is added to each upgrade entry to indicate whether it belongs to a Long-Term Active line","version":"2026.5"},{"description":"The field \u0027documentationUrl\u0027 is added to each upgrade entry to point to the target version\u0027s documentation","version":"2026.2"},{"description":"The field \u0027ltsVersion\u0027 is deprecated from the response","version":"10.5"},{"description":"The field \u0027ltaVersion\u0027 is added to indicate the Long-Term Active Version","version":"10.5"},{"description":"The field \u0027installedVersionActive\u0027 is added to indicate if the installed version is an active version","version":"10.5"}]}]},{"path":"api/user_groups","since":"5.2","description":"Manage user groups.","actions":[{"key":"add_user","description":"Add a user to a group.\u003cbr /\u003e\u0027name\u0027 must be provided.\u003cbr /\u003eRequires the following permission: \u0027Administer System\u0027.","since":"5.2","deprecatedSince":"10.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Deprecated. Use POST /api/v2/authorizations/group-memberships instead","version":"10.4"},{"description":"Parameter \u0027id\u0027 is removed. Use \u0027name\u0027 instead.","version":"10.0"},{"description":"Parameter \u0027id\u0027 is deprecated. Format changes from integer to string. Use \u0027name\u0027 instead.","version":"8.4"}],"params":[{"key":"login","description":"User login","required":false,"internal":false,"exampleValue":"g.hopper"},{"key":"name","description":"Group name","required":true,"internal":false,"exampleValue":"sonar-administrators"}]},{"key":"create","description":"Create a group.\u003cbr\u003eRequires the following permission: \u0027Administer System\u0027.","since":"5.2","deprecatedSince":"10.4","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"Deprecated. Use POST /api/v2/authorizations/groups instead","version":"10.4"},{"description":"Field \u0027id\u0027 format in the response changes from integer to string.","version":"8.4"}],"params":[{"key":"description","description":"Description for the new group. A group description cannot be larger than 200 characters.","required":false,"internal":false,"exampleValue":"Default group for new users","maximumLength":200},{"key":"name","description":"Name for the new group. A group name cannot be larger than 255 characters and must be unique. The value \u0027anyone\u0027 (whatever the case) is reserved and cannot be used.","required":true,"internal":false,"exampleValue":"sonar-users","maximumLength":255}]},{"key":"delete","description":"Delete a group. The default groups cannot be deleted.\u003cbr/\u003e\u0027name\u0027 must be provided.\u003cbr /\u003eRequires the following permission: \u0027Administer System\u0027.","since":"5.2","deprecatedSince":"10.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Deprecated. Use DELETE /api/v2/authorizations/groups instead","version":"10.4"},{"description":"Parameter \u0027id\u0027 is removed. Use \u0027name\u0027 instead.","version":"10.0"},{"description":"Parameter \u0027id\u0027 is deprecated. Format changes from integer to string. Use \u0027name\u0027 instead.","version":"8.4"}],"params":[{"key":"name","description":"Group name","required":true,"internal":false,"exampleValue":"sonar-administrators"}]},{"key":"remove_user","description":"Remove a user from a group.\u003cbr /\u003e\u0027name\u0027 must be provided.\u003cbr\u003eRequires the following permission: \u0027Administer System\u0027.","since":"5.2","deprecatedSince":"10.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Deprecated. Use DELETE /api/v2/authorizations/group-memberships instead","version":"10.4"},{"description":"Parameter \u0027id\u0027 is removed. Use \u0027name\u0027 instead.","version":"10.0"},{"description":"Parameter \u0027id\u0027 is deprecated. Format changes from integer to string. Use \u0027name\u0027 instead.","version":"8.4"}],"params":[{"key":"login","description":"User login","required":false,"internal":false,"exampleValue":"g.hopper"},{"key":"name","description":"Group name","required":true,"internal":false,"exampleValue":"sonar-administrators"}]},{"key":"search","description":"Search for user groups.\u003cbr\u003eRequires the following permission: \u0027Administer System\u0027.","since":"5.2","deprecatedSince":"10.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Deprecated. Use GET /api/v2/authorizations/groups instead","version":"10.4"},{"description":"Field \u0027id\u0027 in the response has been removed","version":"10.0"},{"description":"New parameter \u0027managed\u0027 to optionally search by managed status","version":"10.0"},{"description":"Response includes \u0027managed\u0027 field.","version":"10.0"},{"description":"Field \u0027id\u0027 in the response is deprecated. Format changes from integer to string.","version":"8.4"},{"description":"Paging response fields moved to a Paging object","version":"6.4"},{"description":"\u0027default\u0027 response field has been added","version":"6.4"}],"params":[{"key":"f","description":"Comma-separated list of the fields to be returned in response. All the fields are returned by default.","required":false,"internal":false,"possibleValues":["name","description","membersCount","managed"]},{"key":"managed","description":"Return managed or non-managed groups. Only available for managed instances, throws for non-managed instances.","since":"10.0","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 500","required":false,"internal":false,"defaultValue":"100","exampleValue":"20","maximumValue":500},{"key":"q","description":"Limit search to names that contain the supplied string.","required":false,"internal":false,"exampleValue":"sonar-users"}]},{"key":"update","description":"Update a group.\u003cbr\u003eRequires the following permission: \u0027Administer System\u0027.","since":"5.2","deprecatedSince":"10.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Deprecated. Use PATCH /api/v2/authorizations/groups instead","version":"10.4"},{"description":"Parameter \u0027id\u0027 is removed in favor of \u0027currentName\u0027","version":"10.0"},{"description":"Parameter \u0027id\u0027 deprecated in favor of \u0027currentName\u0027","version":"8.5"},{"description":"Parameter \u0027id\u0027 format changes from integer to string","version":"8.4"},{"description":"The default group is no longer editable","version":"6.4"}],"params":[{"key":"currentName","description":"Name of the group to be updated.","since":"8.5","required":true,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy"},{"key":"description","description":"New optional description for the group. A group description cannot be larger than 200 characters. If value is not defined, then description is not changed.","required":false,"internal":false,"exampleValue":"Default group for new users","maximumLength":200},{"key":"name","description":"New optional name for the group. A group name cannot be larger than 255 characters and must be unique. Value \u0027anyone\u0027 (whatever the case) is reserved and cannot be used. If value is empty or not defined, then name is not changed.","required":false,"internal":false,"exampleValue":"my-group","maximumLength":255}]},{"key":"users","description":"Search for users with membership information with respect to a group.\u003cbr\u003eRequires the following permission: \u0027Administer System\u0027.","since":"5.2","deprecatedSince":"10.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Deprecated. Use GET /api/v2/authorizations/group-memberships instead","version":"10.4"},{"description":"Field \u0027managed\u0027 added to the payload.","version":"10.0"},{"description":"Parameter \u0027id\u0027 is removed. Use \u0027name\u0027 instead.","version":"10.0"},{"description":"response fields \u0027total\u0027, \u0027s\u0027, \u0027ps\u0027 have been deprecated, please use \u0027paging\u0027 object instead.","version":"9.8"},{"description":"The field \u0027paging\u0027 has been added to the response.","version":"9.8"},{"description":"Parameter \u0027id\u0027 is deprecated. Format changes from integer to string. Use \u0027name\u0027 instead.","version":"8.4"}],"params":[{"key":"name","description":"Group name","required":true,"internal":false,"exampleValue":"sonar-administrators"},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0.","required":false,"internal":false,"defaultValue":"25","exampleValue":"20"},{"key":"q","description":"Limit search to names or logins that contain the supplied string.","required":false,"internal":false,"exampleValue":"freddy"},{"key":"selected","description":"Depending on the value, show only selected items (selected\u003dselected), deselected items (selected\u003ddeselected), or all items with their selection status (selected\u003dall).","required":false,"internal":false,"defaultValue":"selected","possibleValues":["all","deselected","selected"]}]}]},{"path":"api/user_tokens","since":"5.3","description":"List, create, and delete a user\u0027s access tokens.","actions":[{"key":"generate","description":"Generate a user access token. \u003cbr /\u003ePlease keep your tokens secret. They enable to authenticate and analyze projects.\u003cbr /\u003eIt requires administration permissions to specify a \u0027login\u0027 and generate a token for another user. Otherwise, a token is generated for the current user.","since":"5.3","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"Response field \u0027expirationDate\u0027 added","version":"9.6"}],"params":[{"key":"expirationDate","description":"The expiration date of the token being generated, in ISO 8601 format (YYYY-MM-DD). If not set, default to no expiration.","since":"9.6","required":false,"internal":false},{"key":"login","description":"User login. If not set, the token is generated for the authenticated user.","required":false,"internal":false,"exampleValue":"g.hopper"},{"key":"name","description":"Token name","required":true,"internal":false,"exampleValue":"Project scan on Travis","maximumLength":100},{"key":"projectKey","description":"The key of the only project that can be analyzed by the PROJECT_ANALYSIS_TOKEN being generated.","since":"9.5","required":false,"internal":false},{"key":"type","description":"Token Type. If this parameters is set to PROJECT_ANALYSIS_TOKEN, it is necessary to provide the projectKey parameter too.","since":"9.5","required":false,"internal":false,"defaultValue":"USER_TOKEN","possibleValues":["USER_TOKEN","GLOBAL_ANALYSIS_TOKEN","PROJECT_ANALYSIS_TOKEN"]}]},{"key":"revoke","description":"Revoke a user access token. \u003cbr/\u003eIt requires administration permissions to specify a \u0027login\u0027 and revoke a token for another user. Otherwise, the token for the current user is revoked.","since":"5.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"login","description":"User login","required":false,"internal":false,"exampleValue":"g.hopper"},{"key":"name","description":"Token name","required":true,"internal":false,"exampleValue":"Project scan on Travis"}]},{"key":"search","description":"List the access tokens of a user.\u003cbr\u003eThe login must exist and active.\u003cbr\u003eField \u0027lastConnectionDate\u0027 is only updated every hour, so it may not be accurate, for instance when a user is using a token many times in less than one hour.\u003cbr\u003e It requires administration permissions to specify a \u0027login\u0027 and list the tokens of another user. Otherwise, tokens for the current user are listed. \u003cbr\u003e Authentication is required for this API endpoint","since":"5.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"New field \u0027expirationDate\u0027 is added to response","version":"9.6"},{"description":"New field \u0027lastConnectionDate\u0027 is added to response","version":"7.7"}],"params":[{"key":"login","description":"User login","required":false,"internal":false,"exampleValue":"g.hopper"}]}]},{"path":"api/users","since":"3.6","description":"Manage users.","actions":[{"key":"anonymize","description":"Anonymize a deactivated user. Requires Administer System permission","since":"9.7","deprecatedSince":"10.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Deprecated. Use DELETE api/v2/users-management/users/{id}?anonymize\u003dtrue instead","version":"10.4"}],"params":[{"key":"login","description":"User login","required":true,"internal":false,"exampleValue":"myuser"}]},{"key":"change_password","description":"Update a user\u0027s password. Authenticated users can change their own password, provided that the account is not linked to an external authentication system. Administer System permission is required to change another user\u0027s password.","since":"5.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"It\u0027s no more possible for the password to be the same as the previous one","version":"8.6"}],"params":[{"key":"login","description":"User login","required":true,"internal":false,"exampleValue":"myuser"},{"key":"password","description":"The password needs to fulfill the following requirements: at least 12 characters and contain at least one uppercase character, one lowercase character, one digit and one special character.","required":true,"internal":false,"exampleValue":"My_Passw0rd%","minimumLength":12},{"key":"previousPassword","description":"Previous password. Required when changing one\u0027s own password.","required":false,"internal":false,"exampleValue":"My_Previous_Passw0rd%"}]},{"key":"create","description":"Create a user.\u003cbr/\u003eIf a deactivated user account exists with the given login, it will be reactivated.\u003cbr/\u003eRequires Administer System permission","since":"3.7","deprecatedSince":"10.4","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"Deprecated. Use POST api/v2/users-management/users instead","version":"10.4"},{"description":"The password is only mandatory when creating local users, and should not be set on non local users","version":"6.3"},{"description":"The \u0027infos\u0027 message is no more returned when a user is reactivated","version":"6.3"}],"params":[{"key":"email","description":"User email","required":false,"internal":false,"exampleValue":"myname@email.com","maximumLength":100},{"key":"local","description":"Specify if the user should be authenticated from SonarQube server or from an external authentication system. Password should not be set when local is set to false.","since":"6.3","required":false,"internal":false,"defaultValue":"true","possibleValues":["true","false","yes","no"]},{"key":"login","description":"User login","required":true,"internal":false,"exampleValue":"myuser","maximumLength":255,"minimumLength":2},{"key":"name","description":"User name","required":true,"internal":false,"exampleValue":"My Name","maximumLength":200},{"key":"password","description":"User password. Only mandatory when creating local user, otherwise it should not be set","required":false,"internal":false,"exampleValue":"mypassword"},{"key":"scmAccount","description":"List of SCM accounts. To set several values, the parameter must be called once for each value.","required":false,"internal":false,"exampleValue":"scmAccount\u003dfirstValue\u0026scmAccount\u003dsecondValue\u0026scmAccount\u003dthirdValue"}]},{"key":"deactivate","description":"Deactivate a user. Requires Administer System permission","since":"3.7","deprecatedSince":"10.4","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"Deprecated. Use DELETE api/v2/users-management/users/{id} instead","version":"10.4"}],"params":[{"key":"anonymize","description":"Anonymize user in addition to deactivating it","since":"9.7","required":false,"internal":false,"defaultValue":"false","possibleValues":["true","false","yes","no"]},{"key":"login","description":"User login","required":true,"internal":false,"exampleValue":"myuser"}]},{"key":"groups","description":"Lists the groups a user belongs to. \u003cbr/\u003eRequires Administer System permission.","since":"5.2","deprecatedSince":"10.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Deprecated. Use GET api/v2/authorizations/groups-memberships?userId\u003d{} instead","version":"10.4"},{"description":"Paging response fields moved to a Paging object","version":"6.4"},{"description":"\u0027default\u0027 response field has been added","version":"6.4"}],"params":[{"key":"login","description":"A user login","required":true,"internal":false,"exampleValue":"admin"},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0.","required":false,"internal":false,"defaultValue":"25","exampleValue":"20"},{"key":"q","description":"Limit search to group names that contain the supplied string.","required":false,"internal":false,"exampleValue":"users"},{"key":"selected","description":"Depending on the value, show only selected items (selected\u003dselected), deselected items (selected\u003ddeselected), or all items with their selection status (selected\u003dall).","required":false,"internal":false,"defaultValue":"selected","possibleValues":["all","deselected","selected"]}]},{"key":"search","description":"Get a list of users. By default, only active users are returned.\u003cbr/\u003eThe following fields are only returned when user has Administer System permission or for logged-in in user :\u003cul\u003e   \u003cli\u003e\u0027email\u0027\u003c/li\u003e   \u003cli\u003e\u0027externalIdentity\u0027\u003c/li\u003e   \u003cli\u003e\u0027externalProvider\u0027\u003c/li\u003e   \u003cli\u003e\u0027groups\u0027\u003c/li\u003e   \u003cli\u003e\u0027lastConnectionDate\u0027\u003c/li\u003e   \u003cli\u003e\u0027scmAccounts\u0027\u003c/li\u003e   \u003cli\u003e\u0027sonarLintLastConnectionDate\u0027\u003c/li\u003e   \u003cli\u003e\u0027tokensCount\u0027\u003c/li\u003e\u003c/ul\u003eField \u0027lastConnectionDate\u0027 is only updated every hour, so it may not be accurate, for instance when a user authenticates many times in less than one hour.","since":"3.6","deprecatedSince":"10.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Field \u0027scmAccounts\u0027 is only returned when user has Administer System permission or for the logged-in user","version":"26.9"},{"description":"Deprecated. Use GET api/v2/users-management/users instead","version":"10.4"},{"description":"New optional parameters externalIdentity to find a user by its IdP login","version":"10.3"},{"description":"New optional parameters slLastConnectedAfter and slLastConnectedBefore to filter users by SonarLint last connection date. Only available with Administer System permission.","version":"10.1"},{"description":"New optional parameters lastConnectedAfter and lastConnectedBefore to filter users by SonarQube last connection date. Only available with Administer System permission.","version":"10.1"},{"description":"New field \u0027sonarLintLastConnectionDate\u0027 is added to response","version":"10.1"},{"description":"\u0027q\u0027 parameter values is now always performing a case insensitive match","version":"10.0"},{"description":"New parameter \u0027managed\u0027 to optionally search by managed status","version":"10.0"},{"description":"Response includes \u0027managed\u0027 field.","version":"10.0"},{"description":"New parameter \u0027deactivated\u0027 to optionally search for deactivated users","version":"9.7"},{"description":"New field \u0027lastConnectionDate\u0027 is added to response","version":"7.7"},{"description":"External identity is only returned to system administrators","version":"7.4"},{"description":"Paging response fields moved to a Paging object","version":"6.4"},{"description":"Avatar has been added to the response","version":"6.4"},{"description":"Email is only returned when user has Administer System permission","version":"6.4"}],"params":[{"key":"deactivated","description":"Return deactivated users instead of active users","since":"9.7","required":false,"internal":false,"defaultValue":"false","possibleValues":["true","false","yes","no"]},{"key":"externalIdentity","description":"Find a user by its external identity (ie. its login in the Identity Provider).\nThis is case sensitive and only available with Administer System permission.\n","since":"10.3","required":false,"internal":false},{"key":"lastConnectedAfter","description":"Filter the users based on the last connection date field.\nOnly users who interacted with this instance at or after the date will be returned.\nThe format must be ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)","since":"10.1","required":false,"internal":false,"exampleValue":"2020-01-01T00:00:00+0100"},{"key":"lastConnectedBefore","description":"Filter the users based on the last connection date field.\nOnly users that never connected or who interacted with this instance at or before the date will be returned.\nThe format must be ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)","since":"10.1","required":false,"internal":false,"exampleValue":"2020-01-01T00:00:00+0100"},{"key":"managed","description":"Return managed or non-managed users. Only available for managed instances, throws for non-managed instances.","since":"10.0","required":false,"internal":false,"possibleValues":["true","false","yes","no"]},{"key":"p","description":"1-based page number","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0 and less or equal than 500","required":false,"internal":false,"defaultValue":"50","exampleValue":"20","maximumValue":500},{"key":"q","description":"Filter on login, name and email.\u003cbr /\u003eThis parameter performs a partial match (contains), it is case insensitive.","required":false,"internal":false,"minimumLength":2},{"key":"slLastConnectedAfter","description":"Filter the users based on the sonar lint last connection date field\nOnly users who interacted with this instance using SonarLint at or after the date will be returned.\nThe format must be ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)","since":"10.1","required":false,"internal":false,"exampleValue":"2020-01-01T00:00:00+0100"},{"key":"slLastConnectedBefore","description":"Filter the users based on the sonar lint last connection date field.\nOnly users that never connected or who interacted with this instance using SonarLint at or before the date will be returned.\nThe format must be ISO 8601 datetime format (YYYY-MM-DDThh:mm:ss±hhmm)","since":"10.1","required":false,"internal":false,"exampleValue":"2020-01-01T00:00:00+0100"}]},{"key":"update","description":"Update a user.\u003cbr/\u003eRequires Administer System permission","since":"3.7","deprecatedSince":"10.4","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"Deprecated. Use PATCH api/v2/users-management/users/{id} instead","version":"10.4"},{"description":"User\u0027s password can only be changed using the \u0027change_password\u0027 action.","version":"5.2"}],"params":[{"key":"email","description":"User email","required":false,"internal":false,"exampleValue":"myname@email.com","maximumLength":100},{"key":"login","description":"User login","required":true,"internal":false,"exampleValue":"myuser","maximumLength":255},{"key":"name","description":"User name","required":false,"internal":false,"exampleValue":"My Name","maximumLength":200},{"key":"scmAccount","description":"SCM accounts. To set several values, the parameter must be called once for each value.","required":false,"internal":false,"exampleValue":"scmAccount\u003dfirstValue\u0026scmAccount\u003dsecondValue\u0026scmAccount\u003dthirdValue"}]},{"key":"update_identity_provider","description":"Update identity provider information. \u003cbr/\u003eIt\u0027s only possible to migrate to an installed identity provider. Be careful that as soon as this information has been updated for a user, the user will only be able to authenticate on the new identity provider. It is not possible to migrate external user to local one.\u003cbr/\u003eRequires Administer System permission.","since":"8.7","deprecatedSince":"10.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Deprecated. Use PATCH api/v2/users-management/users/{id} instead","version":"10.4"},{"description":"Use of \u0027sonarqube\u0027 for the value of \u0027newExternalProvider\u0027 is deprecated.","version":"9.8"}],"params":[{"key":"login","description":"User login","required":true,"internal":false},{"key":"newExternalIdentity","description":"New external identity, usually the login used in the authentication system. If not provided previous identity will be used.","required":false,"internal":false},{"key":"newExternalProvider","description":"New external provider. Only authentication system installed are available. Use \u0027LDAP\u0027 identity provider for single server LDAP setup.Use \u0027LDAP_{serverKey}\u0027 identity provider for multiple LDAP servers setup.","required":true,"internal":false}]},{"key":"update_login","description":"Update a user login. A login can be updated many times.\u003cbr/\u003eRequires Administer System permission","since":"7.6","deprecatedSince":"10.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Deprecated. Use PATCH api/v2/users-management/users/{id} instead","version":"10.4"}],"params":[{"key":"login","description":"The current login (case-sensitive)","required":true,"internal":false,"exampleValue":"mylogin"},{"key":"newLogin","description":"The new login. It must not already exist.","required":true,"internal":false,"exampleValue":"mynewlogin","maximumLength":255,"minimumLength":2}]}]},{"path":"api/views","since":"1.0","description":"Manage portfolios.","actions":[{"key":"add_application","description":"Add an existing application to a portfolio.\u003cbr\u003eAuthentication is required for this API endpoint.","since":"9.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"application","description":"Key of the application to be added","required":true,"internal":false},{"key":"portfolio","description":"Key of the portfolio where the application will be added","required":true,"internal":false}]},{"key":"add_application_branch","description":"Add a branch of an application selected in a portfolio.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the portfolio and \u0027Browse\u0027 permission for the application.","since":"9.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"application","description":"Key of the application","required":true,"internal":false,"exampleValue":"my_app"},{"key":"branch","description":"Key of the branch","required":true,"internal":false,"exampleValue":"feature/my_branch"},{"key":"key","description":"Key of the portfolio","required":true,"internal":false}]},{"key":"add_portfolio","description":"Add an existing portfolio to the structure of another portfolio.\u003cbr\u003e Authentication is required for this API endpoint.","since":"9.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"portfolio","description":"Key of the portfolio where a reference will be added","required":true,"internal":false},{"key":"reference","description":"Key of the portfolio to be added","required":true,"internal":false}]},{"key":"add_project","description":"Add a project to a portfolio.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the portfolio and \u0027Browse\u0027 permission for adding project.","since":"1.0","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Project to which user has `Browse` permission can be used in \u0027project\u0027","version":"8.3"},{"description":"This web service should not be used to add project to an application, api/applications/add_project should be used instead","version":"7.3"}],"params":[{"key":"key","description":"Key of the portfolio","required":true,"internal":false},{"key":"project","description":"Key of the project","required":true,"internal":false,"exampleValue":"my_project","deprecatedKey":"project_key","deprecatedKeySince":"7.3"}]},{"key":"add_project_branch","description":"Add a branch of a project selected in a portfolio.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the portfolio and \u0027Browse\u0027 permission for the project.","since":"9.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"branch","description":"Key of the branch","required":true,"internal":false,"exampleValue":"feature/my_branch"},{"key":"key","description":"Key of the portfolio","required":true,"internal":false},{"key":"project","description":"Key of the project","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"applications","description":"List applications which the user has access to that can be added to a portfolio. \u003cbr\u003e Authentication is required for this API endpoint","since":"9.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"portfolio","description":"Key of the would-be parent portfolio","required":true,"internal":false}]},{"key":"create","description":"Create a new portfolio.\u003cbr/\u003eRequires \u0027Administer System\u0027 permission or \u0027Create Portfolios\u0027 permission,","since":"1.0","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Parameter \u0027key\u0027 no longer accepts \u0027:\u0027 as it is reserved for portfolio references","version":"2026.6"},{"description":"This web service can\u0027t create applications. Use \u0027applications/create\u0027 instead","version":"9.3"},{"description":"Parameter \u0027parent\u0027 added to create sub-portfolios","version":"9.3"},{"description":"Add support of the new permission \u0027Create Portfolios\u0027 permission","version":"7.4"},{"description":"This web service should not be used to create an application, api/applications/create should be used instead","version":"7.3"},{"description":"The \u0027visibility\u0027 parameter is public","version":"7.1"},{"description":"Qualifier field is returned in the response","version":"2.0"}],"params":[{"key":"description","description":"Description for the new portfolio, can be left blank","required":false,"internal":false,"maximumLength":256},{"key":"key","description":"Key for the new portfolio. Allowed characters are alphanumeric, \u0027-\u0027, \u0027_\u0027 and \u0027.\u0027, with at least one non-digit. A suitable key will be generated if not provided","required":false,"internal":false,"maximumLength":400},{"key":"name","description":"Name for the new portfolio","required":true,"internal":false,"maximumLength":256},{"key":"parent","description":"Key of the parent portfolio, when creating a sub portfolio","required":false,"internal":false,"maximumLength":400},{"key":"visibility","description":"Whether the created portfolio or application should be visible to everyone, or only specific user/groups.\u003cbr/\u003eOnly applies to root portfolios. If no visibility is specified, the default visibility will be used.","since":"2.0","required":false,"internal":false,"possibleValues":["private","public"]}]},{"key":"delete","description":"Delete a portfolio definition. \u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the portfolio.","since":"1.0","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"This web service should not be used to delete references to portfolios and applications. Use \u0027views/remove_portfolio\u0027 and \u0027views/remove_application\u0027 instead","version":"9.3"},{"description":"This web service can\u0027t delete applications. Use \u0027applications/delete\u0027 instead","version":"9.3"},{"description":"This web service should not be used to delete an application, api/applications/delete should be used instead","version":"7.3"}],"params":[{"key":"key","description":"Portfolio key","required":true,"internal":false}]},{"key":"list","description":"List root portfolios. \u003cbr\u003eRequires authentication. Only portfolios with the admin permission are returned.","since":"1.0","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The applications are removed from the response","version":"10.0"},{"description":"Returning applications is now deprecated","version":"9.3"},{"description":"Qualifier field is returned in the response","version":"2.0"},{"description":"Visibility field is returned in the response","version":"2.0"}]},{"key":"move","description":"Move a portfolio. \u003cbr\u003e Authentication is required for this API endpoint.","since":"1.0","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"destination","description":"Key of the destination portfolio","required":true,"internal":false},{"key":"key","description":"Key of the portfolio to move","required":true,"internal":false}]},{"key":"move_options","description":"List possible portfolio destinations. \u003cbr\u003e Authentication is required for this API endpoint.","since":"1.0","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"key","description":"Key of the portfolio to move","required":true,"internal":false}]},{"key":"portfolios","description":"List portfolios that can be referenced. \u003cbr\u003e Authentication is required for this API endpoint.","since":"9.3","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"portfolio","description":"Key of the would-be parent portfolio","required":true,"internal":false}]},{"key":"remove_application","description":"Remove an application from a portfolio. \u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the portfolio.","since":"9.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"application","description":"Key of the application to be removed","required":true,"internal":false},{"key":"portfolio","description":"Portfolio key","required":true,"internal":false}]},{"key":"remove_application_branch","description":"Remove a branch of an application selected in a portfolio.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the portfolio and \u0027Browse\u0027 permission for the application.","since":"9.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"application","description":"Key of the project","required":true,"internal":false,"exampleValue":"my_app"},{"key":"branch","description":"Key of the branch","required":true,"internal":false,"exampleValue":"feature/my_branch"},{"key":"key","description":"Key of the portfolio","required":true,"internal":false}]},{"key":"remove_portfolio","description":"Remove a reference to a portfolio. \u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the portfolio.","since":"9.3","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"portfolio","description":"Portfolio key","required":true,"internal":false},{"key":"reference","description":"Key of the referenced portfolio to be removed","required":true,"internal":false}]},{"key":"remove_project","description":"Remove a project from a portfolio.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the portfolio.","since":"1.0","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"The `Browse` permission on a project is no longer required to remove it from a portfolio definition","version":"9.3"},{"description":"Project to which user has `Browse` permission can be used in \u0027project\u0027","version":"8.3"},{"description":"This web service should not be used on application, api/applications/remove_project should be used instead","version":"7.3"}],"params":[{"key":"key","description":"Key of the portfolio","required":true,"internal":false},{"key":"project","description":"Key of the project","required":true,"internal":false,"deprecatedKey":"project_key","deprecatedKeySince":"7.3"}]},{"key":"remove_project_branch","description":"Remove a branch of a project selected in a portfolio.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the portfolio and \u0027Browse\u0027 permission for the project.","since":"9.2","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"branch","description":"Key of the branch","required":true,"internal":false,"exampleValue":"feature/my_branch"},{"key":"key","description":"Key of the portfolio","required":true,"internal":false},{"key":"project","description":"Key of the project","required":true,"internal":false,"exampleValue":"my_project"}]},{"key":"set_manual_mode","description":"Set the projects selection mode of a portfolio on manual selection.\u003cbr/\u003eIn order to add project, please use api/view/add_project.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the portfolio.","since":"7.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"portfolio","description":"Key of the portfolio or sub-portfolio to update","required":true,"internal":false}]},{"key":"set_none_mode","description":"Set the projects selection mode of a portfolio to none.\u003cbr/\u003eAfter setting this mode portfolio will not have any projects assigned.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the portfolio.","since":"9.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"portfolio","description":"Key of the portfolio or sub-portfolio to update","required":true,"internal":false}]},{"key":"set_regexp_mode","description":"Set the projects selection mode of a portfolio on regular expression.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the portfolio.","since":"7.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Param \u0027branch\u0027 added","version":"9.2"}],"params":[{"key":"branch","description":"Selects a branch in all matched projects, instead of using their main branches","required":false,"internal":false},{"key":"portfolio","description":"Key of the portfolio or sub-portfolio to update","required":true,"internal":false},{"key":"regexp","description":"A valid regexp with respect to the JDK\u0027s ``java.util.regex.Pattern`` class","required":true,"internal":false}]},{"key":"set_remaining_projects_mode","description":"Set the projects selection mode of a portfolio on unassociated projects in hierarchy.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the portfolio.","since":"7.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Param \u0027branch\u0027 added","version":"9.2"}],"params":[{"key":"branch","description":"Selects a branch in all matched projects, instead of using their main branches","required":false,"internal":false},{"key":"portfolio","description":"Key of the portfolio or sub-portfolio to update","required":true,"internal":false}]},{"key":"set_tags_mode","description":"Set the projects selection mode of a portfolio on project tags.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the portfolio.","since":"7.4","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"Param \u0027branch\u0027 added","version":"9.2"}],"params":[{"key":"branch","description":"Selects a branch in all matched projects, instead of using their main branches","required":false,"internal":false},{"key":"portfolio","description":"Key of the portfolio or sub-portfolio to update","required":true,"internal":false},{"key":"tags","description":"Comma-separated list of tags. It\u0027s not possible to set nothing.","required":true,"internal":false}]},{"key":"show","description":"Show the details of a portfolio, including its hierarchy and project selection mode. \u003cbr\u003e Authentication is required for this API endpoint.","since":"1.0","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"The deprecated response field \u0027projects\u0027 has been removed. Use \u0027selectedProjects\u0027 instead","version":"10.1"},{"description":"This web service no longer shows applications. Use \u0027api/applications/show\u0027 instead","version":"10.0"},{"description":"Use of the web service for application is deprecated. api/applications/show should be used","version":"9.3"},{"description":"The response field \u0027projects\u0027 for each portfolio is deprecated in favor of the new field \u0027selectedProjects\u0027","version":"9.2"},{"description":"Deleted field of projects is deprecated in the response, replaced by enabled","version":"7.3"},{"description":"Qualifier field is returned in the response","version":"2.0"}],"params":[{"key":"key","description":"The key of the portfolio","required":true,"internal":false}]},{"key":"update","description":"Update a portfolio.\u003cbr/\u003eRequires \u0027Administrator\u0027 permission on the portfolio.","since":"1.0","internal":false,"post":true,"hasResponseExample":false,"changelog":[{"description":"This web service can\u0027t update applications. Use \u0027applications/update\u0027 instead","version":"9.3"},{"description":"This web service should not be used on application, api/applications/update should be used instead","version":"7.3"}],"params":[{"key":"description","description":"New description for the portfolio","required":false,"internal":false,"maximumLength":256},{"key":"key","description":"Key of the portfolio to update","required":true,"internal":false},{"key":"name","description":"New name for the portfolio","required":true,"internal":false,"maximumLength":256}]}]},{"path":"api/webhooks","since":"6.2","description":"Webhooks allow to notify external services when a project analysis is done","actions":[{"key":"create","description":"Create a Webhook.\u003cbr\u003eRequires \u0027Administer\u0027 permission on the specified project, or global \u0027Administer\u0027 permission.","since":"7.1","internal":false,"post":true,"hasResponseExample":true,"changelog":[{"description":"The minimum length of parameter \u0027secret\u0027 increased to 16.","version":"10.6"}],"params":[{"key":"name","description":"Name displayed in the administration console of webhooks","required":true,"internal":false,"exampleValue":"My Webhook","maximumLength":100},{"key":"project","description":"The key of the project that will own the webhook","required":false,"internal":false,"exampleValue":"my_project","maximumLength":400},{"key":"secret","description":"If provided, secret will be used as the key to generate the HMAC hex (lowercase) digest value in the \u0027X-Sonar-Webhook-HMAC-SHA256\u0027 header","since":"7.8","required":false,"internal":false,"exampleValue":"your_secret","maximumLength":200,"minimumLength":16},{"key":"url","description":"Server endpoint that will receive the webhook payload, for example \u0027http://my_server/foo\u0027. If HTTP Basic authentication is used, HTTPS is recommended to avoid man in the middle attacks. Example: \u0027https://myLogin:myPassword@my_server/foo\u0027","required":true,"internal":false,"exampleValue":"https://www.my-webhook-listener.com/sonar","maximumLength":512}]},{"key":"delete","description":"Delete a Webhook.\u003cbr\u003eRequires \u0027Administer\u0027 permission on the specified project, or global \u0027Administer\u0027 permission.","since":"7.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"webhook","description":"The key of the webhook to be deleted, auto-generated value can be obtained through api/webhooks/create or api/webhooks/list","required":true,"internal":false,"exampleValue":"my_project","maximumLength":40}]},{"key":"deliveries","description":"Get the recent deliveries for a specified project or Compute Engine task.\u003cbr/\u003eRequire \u0027Administer\u0027 permission on the related project.\u003cbr/\u003eNote that additional information are returned by api/webhooks/delivery.","since":"6.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"\u0027ceTaskId\u0027 and \u0027componentKey\u0027 parameters are now deprecated. These parameters won\u0027t be replaced, the deliveries related to a specific project can be obtained by fetching the webhook first, and then fetching the associated deliveries.","version":"10.7"},{"description":"\u0027ceTaskId\u0027 response field is now deprecated.","version":"10.7"}],"params":[{"key":"ceTaskId","description":"Id of the Compute Engine task","required":false,"internal":false,"exampleValue":"AU-Tpxb--iU5OvuD2FLy","deprecatedSince":"10.7"},{"key":"componentKey","description":"Key of the project","required":false,"internal":false,"exampleValue":"my-project","deprecatedSince":"10.7"},{"key":"p","description":"1-based page number","since":"7.1","required":false,"internal":false,"defaultValue":"1","exampleValue":"42"},{"key":"ps","description":"Page size. Must be greater than 0 and less than 500","since":"7.1","required":false,"internal":false,"defaultValue":"10","exampleValue":"20","maximumValue":500},{"key":"webhook","description":"Key of the webhook that triggered those deliveries, auto-generated value that can be obtained through api/webhooks/create or api/webhooks/list","since":"7.1","required":false,"internal":false,"exampleValue":"AU-TpxcA-iU5OvuD2FLz"}]},{"key":"delivery","description":"Get a webhook delivery by its id.\u003cbr/\u003eRequire \u0027Administer\u0027 permission on the related project.","since":"6.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"deliveryId","description":"Id of delivery","required":true,"internal":false,"exampleValue":"AU-TpxcA-iU5OvuD2FL3"}]},{"key":"list","description":"Search for global webhooks or project webhooks. Webhooks are ordered by name.\u003cbr\u003eRequires \u0027Administer\u0027 permission on the specified project, or global \u0027Administer\u0027 permission.","since":"7.1","internal":false,"post":false,"hasResponseExample":true,"changelog":[{"description":"Field \u0027secret\u0027 replaced by flag \u0027hasSecret\u0027 in response","version":"10.1"},{"description":"Field \u0027secret\u0027 added to response","version":"7.8"}],"params":[{"key":"project","description":"Project key","required":false,"internal":false,"exampleValue":"my_project"}]},{"key":"update","description":"Update a Webhook.\u003cbr\u003eRequires \u0027Administer\u0027 permission on the specified project, or global \u0027Administer\u0027 permission.","since":"7.1","internal":false,"post":true,"hasResponseExample":false,"changelog":[],"params":[{"key":"name","description":"new name of the webhook","required":true,"internal":false,"exampleValue":"My Webhook","maximumLength":100},{"key":"secret","description":"If provided, secret will be used as the key to generate the HMAC hex (lowercase) digest value in the \u0027X-Sonar-Webhook-HMAC-SHA256\u0027 header. If blank, any secret previously configured will be removed. If not set, the secret will remain unchanged.","since":"7.8","required":false,"internal":false,"exampleValue":"your_secret","maximumLength":200},{"key":"url","description":"new url to be called by the webhook","required":true,"internal":false,"exampleValue":"https://www.my-webhook-listener.com/sonar","maximumLength":512},{"key":"webhook","description":"The key of the webhook to be updated, auto-generated value can be obtained through api/webhooks/create or api/webhooks/list","required":true,"internal":false,"exampleValue":"my_project","maximumLength":40}]}]},{"path":"api/webservices","since":"4.2","description":"Get information on the web api supported on this instance.","actions":[{"key":"list","description":"List web services","since":"4.2","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"include_internals","description":"Include web services that are implemented for internal use only. Their forward-compatibility is not assured","required":false,"internal":false,"defaultValue":"false","possibleValues":["true","false","yes","no"]}]},{"key":"response_example","description":"Display web service response example","since":"4.4","internal":false,"post":false,"hasResponseExample":true,"changelog":[],"params":[{"key":"action","description":"Action of the web service","required":true,"internal":false,"exampleValue":"search"},{"key":"controller","description":"Controller of the web service","required":true,"internal":false,"exampleValue":"api/issues"}]}]}]}