{ "opencollection": "1.0.0", "info": { "name": "SonarQube Cloud Web authentication qualityprofiles API", "version": "v1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "qualityprofiles", "type": "folder" }, "items": [ { "info": { "name": "Activate a rule on a Quality Profile. Requires one of the following permissions: 'Administer Quality Profiles' Edit r...", "type": "http" }, "http": { "method": "POST", "url": "https://sonarcloud.io/api/qualityprofiles/activate_rule", "params": [ { "name": "key", "value": "AU-Tpxb--iU5OvuD2FLy", "type": "query", "description": "Quality Profile key. Can be obtained through api/qualityprofiles/search" }, { "name": "params", "value": "params=key1=v1;key2=v2", "type": "query", "description": "Parameters as semi-colon list of key=value. Ignored if parameter reset is true." }, { "name": "reset", "value": "", "type": "query", "description": "Reset severity and parameters of activated rule. Set the values defined on parent profile or from rule default values." }, { "name": "rule", "value": "squid:AvoidCycles", "type": "query", "description": "Rule key" }, { "name": "severity", "value": "", "type": "query", "description": "Severity. Ignored if parameter reset is true." } ] }, "docs": "Activate a rule on a Quality Profile. Requires one of the following permissions: 'Administer Quality Profiles' Edit right on the specified quality profile" }, { "info": { "name": "Bulk-activate rules on one quality profile. Requires one of the following permissions: 'Administer Quality Profiles' ...", "type": "http" }, "http": { "method": "POST", "url": "https://sonarcloud.io/api/qualityprofiles/activate_rules", "params": [ { "name": "activation", "value": "", "type": "query", "description": "Filter rules that are activated or deactivated on the selected Quality profile. Ignored if the parameter 'qprofile' is not set." }, { "name": "active_severities", "value": "CRITICAL,BLOCKER", "type": "query", "description": "Comma-separated list of activation severities, i.e the severity of rules in Quality profiles." }, { "name": "asc", "value": "", "type": "query", "description": "Ascending sort" }, { "name": "available_since", "value": "2014-06-22", "type": "query", "description": "Filters rules added since date. Format is yyyy-MM-dd" }, { "name": "cleanCodeAttributeCategories", "value": "ADAPTABLE,INTENTIONAL", "type": "query", "description": "Comma-separated list of Clean Code Attribute Categories" }, { "name": "cwe", "value": "12,125,unknown", "type": "query", "description": "Comma-separated list of CWE identifiers. Use 'unknown' to select rules not associated to any CWE." }, { "name": "impactSeverities", "value": "HIGH,MEDIUM", "type": "query", "description": "Comma-separated list of Software Quality Severities" }, { "name": "impactSoftwareQualities", "value": "MAINTAINABILITY,RELIABILITY", "type": "query", "description": "Comma-separated list of Software Qualities" }, { "name": "inheritance", "value": "INHERITED,OVERRIDES", "type": "query", "description": "Comma-separated list of values of inheritance for a rule within a quality profile. Used only if the parameter 'activation' is set." }, { "name": "is_template", "value": "", "type": "query", "description": "Filter template rules" }, { "name": "languages", "value": "java,js", "type": "query", "description": "Comma-separated list of languages" }, { "name": "organization", "value": "my-org", "type": "query", "description": "Organization key" }, { "name": "owaspMobileTop10-2024", "value": "", "type": "query", "description": "Comma-separated list of OWASP Mobile Top 10 (2024) lowercase categories." }, { "name": "owaspTop10", "value": "", "type": "query", "description": "Comma-separated list of OWASP Top 10 lowercase categories." }, { "name": "owaspTop10-2021", "value": "", "type": "query", "description": "Comma-separated list of OWASP Top 10 (2021) lowercase categories." }, { "name": "q", "value": "xpath", "type": "query", "description": "UTF-8 search query" }, { "name": "qprofile", "value": "AU-Tpxb--iU5OvuD2FLy", "type": "query", "description": "Quality profile key to filter on. Used only if the parameter 'activation' is set." }, { "name": "repositories", "value": "checkstyle,findbugs", "type": "query", "description": "Comma-separated list of repositories" }, { "name": "rule_key", "value": "squid:S001", "type": "query", "description": "Key of rule to search for" }, { "name": "s", "value": "name", "type": "query", "description": "Sort field" }, { "name": "severities", "value": "CRITICAL,BLOCKER", "type": "query", "description": "Comma-separated list of default severities. Not the same than severity of rules in Quality profiles." }, { "name": "sonarsourceSecurity", "value": "sql-injection,command-injection,others", "type": "query", "description": "Comma-separated list of SonarSource security categories. Use 'others' to select rules not associated with any category" }, { "name": "statuses", "value": "READY", "type": "query", "description": "Comma-separated list of status codes" }, { "name": "tags", "value": "security,java8", "type": "query", "description": "Comma-separated list of tags. Returned rules match any of the tags (OR operator)" }, { "name": "targetKey", "value": "AU-TpxcA-iU5OvuD2FL0", "type": "query", "description": "Quality Profile key on which the rule activation is done. To retrieve a quality profile key please see api/qualityprofiles/search" }, { "name": "targetSeverity", "value": "", "type": "query", "description": "Severity to set on the activated rules" }, { "name": "template_key", "value": "java:S001", "type": "query", "description": "Key of the template rule to filter on. Used to search for the custom rules based on this template." }, { "name": "types", "value": "BUG", "type": "query", "description": "Comma-separated list of types. Returned rules match any of the tags (OR operator)" } ] }, "docs": "Bulk-activate rules on one quality profile. Requires one of the following permissions: 'Administer Quality Profiles' Edit right on the specified quality profile" }, { "info": { "name": "Associate a project with a quality profile. Requires one of the following permissions: 'Administer Quality Profiles' ...", "type": "http" }, "http": { "method": "POST", "url": "https://sonarcloud.io/api/qualityprofiles/add_project", "params": [ { "name": "key", "value": "AU-Tpxb--iU5OvuD2FLy", "type": "query", "description": "Quality profile key. Mandatory unless 'qualityProfile' and 'language' are specified." }, { "name": "language", "value": "", "type": "query", "description": "Quality profile language. Mandatory if 'key' is not set." }, { "name": "organization", "value": "my-org", "type": "query", "description": "Organization key." }, { "name": "project", "value": "my_project", "type": "query", "description": "Project key" }, { "name": "projectUuid", "value": "AU-TpxcA-iU5OvuD2FL5", "type": "query", "description": "Project ID. Either this parameter or 'project' must be set." }, { "name": "qualityProfile", "value": "Sonar way", "type": "query", "description": "Quality profile name. Mandatory if 'key' is not set." } ] }, "docs": "Associate a project with a quality profile. Requires one of the following permissions: 'Administer Quality Profiles' Edit right on the specified quality profile Administer right on the specified project" }, { "info": { "name": "Backup a quality profile in XML form. The exported profile can be restored through api/qualityprofiles/restore.", "type": "http" }, "http": { "method": "GET", "url": "https://sonarcloud.io/api/qualityprofiles/backup", "params": [ { "name": "key", "value": "AU-Tpxb--iU5OvuD2FLy", "type": "query", "description": "Quality profile key. Mandatory unless 'qualityProfile' and 'language' are specified." }, { "name": "language", "value": "", "type": "query", "description": "Quality profile language. Mandatory if 'key' is not set." }, { "name": "organization", "value": "my-org", "type": "query", "description": "Organization key." }, { "name": "qualityProfile", "value": "Sonar way", "type": "query", "description": "Quality profile name. Mandatory if 'key' is not set." } ] }, "docs": "Backup a quality profile in XML form. The exported profile can be restored through api/qualityprofiles/restore." }, { "info": { "name": "Change a quality profile's parent. Requires one of the following permissions: 'Administer Quality Profiles' Edit righ...", "type": "http" }, "http": { "method": "POST", "url": "https://sonarcloud.io/api/qualityprofiles/change_parent", "params": [ { "name": "key", "value": "AU-Tpxb--iU5OvuD2FLy", "type": "query", "description": "Quality profile key. Mandatory unless 'qualityProfile' and 'language' are specified." }, { "name": "language", "value": "", "type": "query", "description": "Quality profile language. Mandatory if 'key' is not set." }, { "name": "organization", "value": "my-org", "type": "query", "description": "Organization key." }, { "name": "parentKey", "value": "AU-TpxcA-iU5OvuD2FLz", "type": "query", "description": "New parent profile key. 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." }, { "name": "parentQualityProfile", "value": "Sonar way", "type": "query", "description": "Quality profile name. If this parameter is set, 'parentKey' must not be set and 'language' must be set to disambiguate." }, { "name": "qualityProfile", "value": "Sonar way", "type": "query", "description": "Quality profile name. Mandatory if 'key' is not set." } ] }, "docs": "Change a quality profile's parent. Requires one of the following permissions: 'Administer Quality Profiles' Edit right on the specified quality profile" }, { "info": { "name": "Get the history of changes on a quality profile: rule activation/deactivation, change in parameters/severity. Events ...", "type": "http" }, "http": { "method": "GET", "url": "https://sonarcloud.io/api/qualityprofiles/changelog", "params": [ { "name": "key", "value": "AU-Tpxb--iU5OvuD2FLy", "type": "query", "description": "Quality profile key. Mandatory unless 'qualityProfile' and 'language' are specified." }, { "name": "language", "value": "", "type": "query", "description": "Quality profile language. Mandatory if 'key' is not set." }, { "name": "organization", "value": "my-org", "type": "query", "description": "Organization key." }, { "name": "p", "value": "42", "type": "query", "description": "1-based page number" }, { "name": "ps", "value": "20", "type": "query", "description": "Page size. Must be greater than 0 and less or equal than 500" }, { "name": "qualityProfile", "value": "Sonar way", "type": "query", "description": "Quality profile name. Mandatory if 'key' is not set." }, { "name": "since", "value": "2017-10-19 or 2017-10-19T13:00:00+0200", "type": "query", "description": "Start date for the changelog. Either a date (server timezone) or datetime can be provided." }, { "name": "to", "value": "2017-10-19 or 2017-10-19T13:00:00+0200", "type": "query", "description": "End date for the changelog. Either a date (server timezone) or datetime can be provided." } ] }, "docs": "Get the history of changes on a quality profile: rule activation/deactivation, change in parameters/severity. Events are ordered by date in descending order (most recent first)." }, { "info": { "name": "Copy a quality profile. Requires to be logged in and the 'Administer Quality Profiles' permission.", "type": "http" }, "http": { "method": "POST", "url": "https://sonarcloud.io/api/qualityprofiles/copy", "params": [ { "name": "fromKey", "value": "AU-Tpxb--iU5OvuD2FLy", "type": "query", "description": "Quality profile key" }, { "name": "toName", "value": "My Sonar way", "type": "query", "description": "Name for the new quality profile." } ] }, "docs": "Copy a quality profile. Requires to be logged in and the 'Administer Quality Profiles' permission." }, { "info": { "name": "Create a quality profile. Requires to be logged in and the 'Administer Quality Profiles' permission.", "type": "http" }, "http": { "method": "POST", "url": "https://sonarcloud.io/api/qualityprofiles/create", "params": [ { "name": "language", "value": "js", "type": "query", "description": "Quality profile language" }, { "name": "name", "value": "My Sonar way", "type": "query", "description": "Quality profile name" }, { "name": "organization", "value": "my-org", "type": "query", "description": "Organization key." } ] }, "docs": "Create a quality profile. Requires to be logged in and the 'Administer Quality Profiles' permission." }, { "info": { "name": "Deactivate a rule on a quality profile. Requires one of the following permissions: 'Administer Quality Profiles' Edit...", "type": "http" }, "http": { "method": "POST", "url": "https://sonarcloud.io/api/qualityprofiles/deactivate_rule", "params": [ { "name": "key", "value": "AU-Tpxb--iU5OvuD2FLy", "type": "query", "description": "Quality Profile key. Can be obtained through api/qualityprofiles/search" }, { "name": "rule", "value": "squid:AvoidCycles", "type": "query", "description": "Rule key" } ] }, "docs": "Deactivate a rule on a quality profile. Requires one of the following permissions: 'Administer Quality Profiles' Edit right on the specified quality profile" }, { "info": { "name": "Bulk deactivate rules on Quality profiles. Requires one of the following permissions: 'Administer Quality Profiles' E...", "type": "http" }, "http": { "method": "POST", "url": "https://sonarcloud.io/api/qualityprofiles/deactivate_rules", "params": [ { "name": "activation", "value": "", "type": "query", "description": "Filter rules that are activated or deactivated on the selected Quality profile. Ignored if the parameter 'qprofile' is not set." }, { "name": "active_severities", "value": "CRITICAL,BLOCKER", "type": "query", "description": "Comma-separated list of activation severities, i.e the severity of rules in Quality profiles." }, { "name": "asc", "value": "", "type": "query", "description": "Ascending sort" }, { "name": "available_since", "value": "2014-06-22", "type": "query", "description": "Filters rules added since date. Format is yyyy-MM-dd" }, { "name": "cleanCodeAttributeCategories", "value": "ADAPTABLE,INTENTIONAL", "type": "query", "description": "Comma-separated list of Clean Code Attribute Categories" }, { "name": "cwe", "value": "12,125,unknown", "type": "query", "description": "Comma-separated list of CWE identifiers. Use 'unknown' to select rules not associated to any CWE." }, { "name": "impactSeverities", "value": "HIGH,MEDIUM", "type": "query", "description": "Comma-separated list of Software Quality Severities" }, { "name": "impactSoftwareQualities", "value": "MAINTAINABILITY,RELIABILITY", "type": "query", "description": "Comma-separated list of Software Qualities" }, { "name": "inheritance", "value": "INHERITED,OVERRIDES", "type": "query", "description": "Comma-separated list of values of inheritance for a rule within a quality profile. Used only if the parameter 'activation' is set." }, { "name": "is_template", "value": "", "type": "query", "description": "Filter template rules" }, { "name": "languages", "value": "java,js", "type": "query", "description": "Comma-separated list of languages" }, { "name": "organization", "value": "my-org", "type": "query", "description": "Organization key" }, { "name": "owaspMobileTop10-2024", "value": "", "type": "query", "description": "Comma-separated list of OWASP Mobile Top 10 (2024) lowercase categories." }, { "name": "owaspTop10", "value": "", "type": "query", "description": "Comma-separated list of OWASP Top 10 lowercase categories." }, { "name": "owaspTop10-2021", "value": "", "type": "query", "description": "Comma-separated list of OWASP Top 10 (2021) lowercase categories." }, { "name": "q", "value": "xpath", "type": "query", "description": "UTF-8 search query" }, { "name": "qprofile", "value": "AU-Tpxb--iU5OvuD2FLy", "type": "query", "description": "Quality profile key to filter on. Used only if the parameter 'activation' is set." }, { "name": "repositories", "value": "checkstyle,findbugs", "type": "query", "description": "Comma-separated list of repositories" }, { "name": "rule_key", "value": "squid:S001", "type": "query", "description": "Key of rule to search for" }, { "name": "rule_keys", "value": "squid:AvoidCycles,java:S1234", "type": "query", "description": "Comma-separated list of rule keys to deactivate. When provided, other search filter parameters are ignored." }, { "name": "s", "value": "name", "type": "query", "description": "Sort field" }, { "name": "severities", "value": "CRITICAL,BLOCKER", "type": "query", "description": "Comma-separated list of default severities. Not the same than severity of rules in Quality profiles." }, { "name": "sonarsourceSecurity", "value": "sql-injection,command-injection,others", "type": "query", "description": "Comma-separated list of SonarSource security categories. Use 'others' to select rules not associated with any category" }, { "name": "statuses", "value": "READY", "type": "query", "description": "Comma-separated list of status codes" }, { "name": "tags", "value": "security,java8", "type": "query", "description": "Comma-separated list of tags. Returned rules match any of the tags (OR operator)" }, { "name": "targetKey", "value": "AU-TpxcA-iU5OvuD2FL1", "type": "query", "description": "Quality Profile key on which the rule deactivation is done. To retrieve a profile key please see api/qualityprofiles/search" }, { "name": "template_key", "value": "java:S001", "type": "query", "description": "Key of the template rule to filter on. Used to search for the custom rules based on this template." }, { "name": "types", "value": "BUG", "type": "query", "description": "Comma-separated list of types. Returned rules match any of the tags (OR operator)" } ] }, "docs": "Bulk deactivate rules on Quality profiles. Requires one of the following permissions: 'Administer Quality Profiles' Edit right on the specified quality profile" }, { "info": { "name": "Delete a quality profile and all its descendants. The default quality profile cannot be deleted. Requires one of the ...", "type": "http" }, "http": { "method": "POST", "url": "https://sonarcloud.io/api/qualityprofiles/delete", "params": [ { "name": "key", "value": "AU-Tpxb--iU5OvuD2FLy", "type": "query", "description": "Quality profile key. Mandatory unless 'qualityProfile' and 'language' are specified." }, { "name": "language", "value": "", "type": "query", "description": "Quality profile language. Mandatory if 'key' is not set." }, { "name": "organization", "value": "my-org", "type": "query", "description": "Organization key." }, { "name": "qualityProfile", "value": "Sonar way", "type": "query", "description": "Quality profile name. Mandatory if 'key' is not set." } ] }, "docs": "Delete a quality profile and all its descendants. The default quality profile cannot be deleted. Requires one of the following permissions: 'Administer Quality Profiles' Edit right on the specified quality profile" }, { "info": { "name": "Deprecated. Use GET /api/qualityprofiles/backup instead", "type": "http" }, "http": { "method": "GET", "url": "https://sonarcloud.io/api/qualityprofiles/export", "params": [ { "name": "key", "value": "AU-Tpxb--iU5OvuD2FLy", "type": "query", "description": "Quality profile key" }, { "name": "language", "value": "abap", "type": "query", "description": "Quality profile language" }, { "name": "organization", "value": "my-org", "type": "query", "description": "Organization key." }, { "name": "qualityProfile", "value": "My Sonar way", "type": "query", "description": "Quality profile name to export. If left empty, the default profile for the language is exported." } ] }, "docs": "Deprecated. Use GET /api/qualityprofiles/backup instead" }, { "info": { "name": "Deprecated. No more custom profile exporters.", "type": "http" }, "http": { "method": "GET", "url": "https://sonarcloud.io/api/qualityprofiles/exporters" }, "docs": "Deprecated. No more custom profile exporters." }, { "info": { "name": "Deprecated. No more custom profile importers.", "type": "http" }, "http": { "method": "GET", "url": "https://sonarcloud.io/api/qualityprofiles/importers" }, "docs": "Deprecated. No more custom profile importers." }, { "info": { "name": "Show a quality profile's ancestors and children.", "type": "http" }, "http": { "method": "GET", "url": "https://sonarcloud.io/api/qualityprofiles/inheritance", "params": [ { "name": "key", "value": "AU-Tpxb--iU5OvuD2FLy", "type": "query", "description": "Quality profile key. Mandatory unless 'qualityProfile' and 'language' are specified." }, { "name": "language", "value": "", "type": "query", "description": "Quality profile language. Mandatory if 'key' is not set." }, { "name": "organization", "value": "my-org", "type": "query", "description": "Organization key." }, { "name": "qualityProfile", "value": "Sonar way", "type": "query", "description": "Quality profile name. Mandatory if 'key' is not set." } ] }, "docs": "Show a quality profile's ancestors and children." }, { "info": { "name": "List projects with their association status regarding a quality profile", "type": "http" }, "http": { "method": "GET", "url": "https://sonarcloud.io/api/qualityprofiles/projects", "params": [ { "name": "key", "value": "AU-Tpxb--iU5OvuD2FLy", "type": "query", "description": "Quality profile key" }, { "name": "p", "value": "42", "type": "query", "description": "1-based page number" }, { "name": "ps", "value": "20", "type": "query", "description": "Page size. Must be greater than 0 and less or equal than 500" }, { "name": "q", "value": "sonar", "type": "query", "description": "Limit search to projects that contain the supplied string." }, { "name": "selected", "value": "", "type": "query", "description": "Depending on the value, show only selected items (selected=selected), deselected items (selected=deselected), or all items with their selection status (selected=all)." } ] }, "docs": "List projects with their association status regarding a quality profile" }, { "info": { "name": "Remove a project's association with a quality profile. Requires one of the following permissions: 'Administer Quality...", "type": "http" }, "http": { "method": "POST", "url": "https://sonarcloud.io/api/qualityprofiles/remove_project", "params": [ { "name": "key", "value": "AU-Tpxb--iU5OvuD2FLy", "type": "query", "description": "Quality profile key. Mandatory unless 'qualityProfile' and 'language' are specified." }, { "name": "language", "value": "", "type": "query", "description": "Quality profile language. Mandatory if 'key' is not set." }, { "name": "organization", "value": "my-org", "type": "query", "description": "Organization key." }, { "name": "project", "value": "my_project", "type": "query", "description": "Project key" }, { "name": "projectUuid", "value": "AU-TpxcB-iU5OvuD2FL6", "type": "query", "description": "Project ID. Either this parameter, or 'project' must be set." }, { "name": "qualityProfile", "value": "Sonar way", "type": "query", "description": "Quality profile name. Mandatory if 'key' is not set." } ] }, "docs": "Remove a project's association with a quality profile. Requires one of the following permissions: 'Administer Quality Profiles' Edit right on the specified quality profile Administer right on the specified project" }, { "info": { "name": "Rename a quality profile. Requires one of the following permissions: 'Administer Quality Profiles' Edit right on the ...", "type": "http" }, "http": { "method": "POST", "url": "https://sonarcloud.io/api/qualityprofiles/rename", "params": [ { "name": "key", "value": "AU-Tpxb--iU5OvuD2FLy", "type": "query", "description": "Quality profile key" }, { "name": "name", "value": "My Sonar way", "type": "query", "description": "New quality profile name" } ] }, "docs": "Rename a quality profile. Requires one of the following permissions: 'Administer Quality Profiles' Edit right on the specified quality profile" }, { "info": { "name": "Restore a quality profile using an XML file. The restored profile name is taken from the backup file, so if a profile...", "type": "http" }, "http": { "method": "POST", "url": "https://sonarcloud.io/api/qualityprofiles/restore", "params": [ { "name": "backup", "value": "", "type": "query", "description": "A profile backup file in XML format, as generated by api/qualityprofiles/backup or the former api/profiles/backup." }, { "name": "organization", "value": "my-org", "type": "query", "description": "Organization key." } ] }, "docs": "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. Requires to be logged in and the 'Administer Quality Profiles' permission." }, { "info": { "name": "This web service has no effect since 6.4. It's no more possible to restore built-in quality profiles because they are...", "type": "http" }, "http": { "method": "POST", "url": "https://sonarcloud.io/api/qualityprofiles/restore_built_in" }, "docs": "This web service has no effect since 6.4. It's no more possible to restore built-in quality profiles because they are automatically updated and read only. Returns HTTP code 410." }, { "info": { "name": "Search quality profiles", "type": "http" }, "http": { "method": "GET", "url": "https://sonarcloud.io/api/qualityprofiles/search", "params": [ { "name": "defaults", "value": "", "type": "query", "description": "If set to true, return only the quality profiles marked as default for each language" }, { "name": "language", "value": "", "type": "query", "description": "Language key. If provided, only profiles for the given language are returned." }, { "name": "organization", "value": "my-org", "type": "query", "description": "Organization key." }, { "name": "project", "value": "my_project", "type": "query", "description": "Project key" }, { "name": "qualityProfile", "value": "SonarQube Way", "type": "query", "description": "Quality profile name" } ] }, "docs": "Search quality profiles" }, { "info": { "name": "Select the default profile for a given language. Requires to be logged in and the 'Administer Quality Profiles' permi...", "type": "http" }, "http": { "method": "POST", "url": "https://sonarcloud.io/api/qualityprofiles/set_default", "params": [ { "name": "key", "value": "AU-Tpxb--iU5OvuD2FLy", "type": "query", "description": "Quality profile key. Mandatory unless 'qualityProfile' and 'language' are specified." }, { "name": "language", "value": "", "type": "query", "description": "Quality profile language. Mandatory if 'key' is not set." }, { "name": "organization", "value": "my-org", "type": "query", "description": "Organization key." }, { "name": "qualityProfile", "value": "Sonar way", "type": "query", "description": "Quality profile name. Mandatory if 'key' is not set." } ] }, "docs": "Select the default profile for a given language. Requires to be logged in and the 'Administer Quality Profiles' permission." } ] } ], "bundled": true }