{
  "opencollection": "1.0.0",
  "info": {
    "name": "SonarQube Cloud Web authentication rules API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "rules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List available rule repositories",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://sonarcloud.io/api/rules/repositories",
            "params": [
              {
                "name": "language",
                "value": "java",
                "type": "query",
                "description": "A language key; if provided, only repositories for the given language will be returned"
              },
              {
                "name": "q",
                "value": "squid",
                "type": "query",
                "description": "A pattern to match repository keys/names against"
              }
            ]
          },
          "docs": "List available rule repositories"
        },
        {
          "info": {
            "name": "Search for a collection of relevant rules matching a specified query. Since 5.5, following fields in the response hav...",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://sonarcloud.io/api/rules/search",
            "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": "complianceStandards",
                "value": "owasp_asvs:urn:sonar-security-standard:owasp:asvs:5.0=15,16&sonar_standard:urn:sonar-security-standard:sonar:standard:unversioned=log-injection",
                "type": "query",
                "description": "Set of compliance standards to filter on. Categories within a standard are comma-separated and behave as an 'or'. Multiple standards are separated by an ampersand and behave as an 'and'."
              },
              {
                "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": "f",
                "value": "debtRemFn,mdDesc",
                "type": "query",
                "description": "Comma-separated list of the fields to be returned in response. All the fields are returned by default, except actives.Since 5.5, following fields have been deprecated :\"defaultDebtRemFn\" becomes \"defaultRemFn\"\"debtRemFn\" becomes \"remFn\"\"effortToFixDescription\" becomes \"gapDescription\"\"debtOverloaded\" becomes \"remFnOverloaded\""
              },
              {
                "name": "facets",
                "value": "languages,repositories",
                "type": "query",
                "description": "Comma-separated list of the facets to be computed. No facet is computed by default."
              },
              {
                "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": "include_external",
                "value": "",
                "type": "query",
                "description": "Include external engine rules in the results"
              },
              {
                "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": "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": "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:S1002,squid:S1003",
                "type": "query",
                "description": "Rule keys"
              },
              {
                "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": "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": "Search for a collection of relevant rules matching a specified query. Since 5.5, following fields in the response have been deprecated :\"effortToFixDescription\" becomes \"gapDescription\"\"debtRemFnCoeff\" becomes \"remFnGapMultiplier\"\"defaultDebtRemFnCoeff\" becomes \"defaultRemFnGapMultiplier\"\"debtRemFnOffset\" becomes \"remFnBaseEffort\"\"defaultDebtRemFnOffset\" becomes \"defaultRemFnBaseEffort\"\"debtOverloaded\" becomes \"remFnOverloaded\""
        },
        {
          "info": {
            "name": "Get detailed information about a rule Since 5.5, following fields in the response have been deprecated :\"effortToFixD...",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://sonarcloud.io/api/rules/show",
            "params": [
              {
                "name": "actives",
                "value": "",
                "type": "query",
                "description": "Show rule's activations for all profiles (\"active rules\")"
              },
              {
                "name": "key",
                "value": "javascript:EmptyBlock",
                "type": "query",
                "description": "Rule key"
              },
              {
                "name": "organization",
                "value": "my-org",
                "type": "query",
                "description": "Organization key"
              }
            ]
          },
          "docs": "Get detailed information about a rule Since 5.5, following fields in the response have been deprecated :\"effortToFixDescription\" becomes \"gapDescription\"\"debtRemFnCoeff\" becomes \"remFnGapMultiplier\"\"defaultDebtRemFnCoeff\" becomes \"defaultRemFnGapMultiplier\"\"debtRemFnOffset\" becomes \"remFnBaseEffort\"\"defaultDebtRemFnOffset\" becomes \"defaultRemFnBaseEffort\"\"debtOverloaded\" becomes \"remFnOverloaded\"In 7.1, the field 'scope' has been added."
        },
        {
          "info": {
            "name": "List rule tags",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://sonarcloud.io/api/rules/tags",
            "params": [
              {
                "name": "organization",
                "value": "my-org",
                "type": "query",
                "description": "Organization key"
              },
              {
                "name": "ps",
                "value": "20",
                "type": "query",
                "description": "Page size. Must be greater than 0 and less or equal than 100"
              },
              {
                "name": "q",
                "value": "misra",
                "type": "query",
                "description": "Limit search to tags that contain the supplied string."
              }
            ]
          },
          "docs": "List rule tags"
        },
        {
          "info": {
            "name": "Update an existing rule. Requires the 'Administer Quality Profiles' permission",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://sonarcloud.io/api/rules/update",
            "params": [
              {
                "name": "debt_sub_characteristic",
                "value": "",
                "type": "query",
                "description": "Debt characteristics are no more supported. This parameter is ignored."
              },
              {
                "name": "key",
                "value": "javascript:NullCheck",
                "type": "query",
                "description": "Key of the rule to update"
              },
              {
                "name": "markdown_description",
                "value": "Description of my custom rule",
                "type": "query",
                "description": "Rule description (mandatory for custom rule and manual rule)"
              },
              {
                "name": "markdown_note",
                "value": "my *note*",
                "type": "query",
                "description": "Optional note in markdown format. Use empty value to remove current note. Note is not changed if the parameter is not set."
              },
              {
                "name": "name",
                "value": "My custom rule",
                "type": "query",
                "description": "Rule name (mandatory for custom rule)"
              },
              {
                "name": "organization",
                "value": "my-org",
                "type": "query",
                "description": "Organization key"
              },
              {
                "name": "params",
                "value": "",
                "type": "query",
                "description": "Parameters as semi-colon list of =, for example 'params=key1=v1;key2=v2' (Only when updating a custom rule)"
              },
              {
                "name": "remediation_fn_base_effort",
                "value": "1d",
                "type": "query",
                "description": "Base effort of the remediation function of the rule"
              },
              {
                "name": "remediation_fn_type",
                "value": "",
                "type": "query",
                "description": "Type of the remediation function of the rule"
              },
              {
                "name": "remediation_fy_gap_multiplier",
                "value": "3min",
                "type": "query",
                "description": "Gap multiplier of the remediation function of the rule"
              },
              {
                "name": "severity",
                "value": "",
                "type": "query",
                "description": "Rule severity (Only when updating a custom rule)"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Rule status (Only when updating a custom rule)"
              },
              {
                "name": "tags",
                "value": "java8,security",
                "type": "query",
                "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."
              }
            ]
          },
          "docs": "Update an existing rule. Requires the 'Administer Quality Profiles' permission"
        }
      ]
    }
  ],
  "bundled": true
}