{ "webServices": [ { "path": "api/analysis_reports", "description": "Get details about Compute Engine tasks.", "actions": [ { "key": "is_queue_empty", "description": "Check if the queue of Compute Engine is empty", "since": "5.1", "internal": true, "post": false, "hasResponseExample": true, "changelog": [] } ] }, { "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.
Requires the system administration permission, or project administration permission if componentId is set.", "since": "5.2", "internal": false, "post": false, "hasResponseExample": true, "changelog": [ { "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's no more possible to specify the page parameter.", "version": "5.5" } ], "params": [ { "key": "componentId", "description": "Id of the component (project) to filter on", "required": false, "internal": false, "exampleValue": "AU-TpxcA-iU5OvuD2FL0" }, { "key": "componentQuery", "description": "Limit search to: Must not be set together with componentId.
Deprecated and replaced by 'q'", "required": false, "internal": false, "exampleValue": "Apache", "deprecatedSince": "5.5" }, { "key": "maxExecutedAt", "description": "Maximum date of end of task processing (inclusive)", "required": false, "internal": false, "exampleValue": "2017-11-10T10:01:57+0100" }, { "key": "minSubmittedAt", "description": "Minimum date of task submission (inclusive)", "required": false, "internal": false, "exampleValue": "2017-11-10T10:01:57+0100" }, { "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": "Deprecated parameter", "required": false, "internal": false, "deprecatedSince": "5.5", "deprecatedKey": "pageIndex", "deprecatedKeySince": "5.4" }, { "key": "ps", "description": "Page size. Must be greater than 0 and less than 1000", "required": false, "internal": false, "defaultValue": "100", "exampleValue": "20", "deprecatedKey": "pageSize", "deprecatedKeySince": "5.2", "maximumValue": 1000 }, { "key": "q", "description": "Limit search to: Must not be set together with componentId", "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" ] } ] }, { "key": "activity_status", "description": "Return CE activity related metrics.
Requires 'Administer System' permission or 'Administer' rights on the specified project.", "since": "5.5", "internal": true, "post": false, "hasResponseExample": true, "changelog": [ { "description": "New field 'inProgress' in response", "version": "6.6" } ], "params": [ { "key": "componentId", "description": "Id of the component (project) to filter on", "required": false, "internal": false, "exampleValue": "AU-TpxcA-iU5OvuD2FL0" }, { "key": "componentKey", "description": "Key of the component (project) to filter on", "required": false, "internal": false, "exampleValue": "my_project" } ] }, { "key": "cancel", "description": "Cancels a pending task.
In-progress tasks cannot be canceled.
Requires one of the following permissions:", "since": "5.2", "internal": true, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "id", "description": "Id of the task to cancel.", "required": true, "internal": false, "exampleValue": "AU-Tpxb--iU5OvuD2FLy" } ] }, { "key": "cancel_all", "description": "Cancels all pending tasks. Requires system administration permission. In-progress tasks are not canceled.", "since": "5.2", "internal": true, "post": true, "hasResponseExample": false, "changelog": [] }, { "key": "component", "description": "Get the pending tasks, in-progress tasks and the last executed task of a given component (usually a project).
Requires the following permission: 'Browse' on the specified component.
Either 'componentId' or 'component' must be provided.", "since": "5.2", "internal": false, "post": false, "hasResponseExample": true, "changelog": [ { "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": false, "internal": false, "exampleValue": "my_project", "deprecatedKey": "componentKey", "deprecatedKeySince": "6.6" }, { "key": "componentId", "required": false, "internal": false, "exampleValue": "AU-Tpxb--iU5OvuD2FLy", "deprecatedSince": "6.6" } ] }, { "key": "submit", "description": "Submits a scanner report to the queue. Report is processed asynchronously. Requires analysis permission. If the project does not exist, then the provisioning permission is also required.", "since": "5.2", "internal": true, "post": true, "hasResponseExample": true, "changelog": [], "params": [ { "key": "characteristic", "description": "Optional characteristic of the analysis. Can be repeated to define multiple characteristics.", "since": "6.6", "required": false, "internal": false, "exampleValue": "branchType=long" }, { "key": "organization", "description": "Key of the organization the project belongs to", "since": "6.3", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "projectBranch", "description": "Optional branch of project", "required": false, "internal": false, "exampleValue": "branch-1.x" }, { "key": "projectKey", "description": "Key of project", "required": true, "internal": false, "exampleValue": "my_project", "maximumLength": 400 }, { "key": "projectName", "description": "Optional name of the project, used only if the project does not exist yet.", "required": false, "internal": false, "exampleValue": "My Project", "maximumLength": 2000 }, { "key": "report", "description": "Report file. Format is not an API, it changes among SonarQube versions.", "required": true, "internal": false } ] }, { "key": "task", "description": "Give Compute Engine task details such as type, status, duration and associated component.
Requires 'Administer System' or 'Execute Analysis' permission.
Since 6.1, field \"logs\" is deprecated and its value is always false.", "since": "5.2", "internal": false, "post": false, "hasResponseExample": true, "changelog": [ { "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" ] }, { "key": "id", "description": "Id of task", "required": true, "internal": false, "exampleValue": "AU-Tpxb--iU5OvuD2FLy" } ] }, { "key": "task_types", "description": "List available task types", "since": "5.5", "internal": true, "post": false, "hasResponseExample": true, "changelog": [] }, { "key": "worker_count", "description": "Return number of Compute Engine workers.
Requires the system administration permission", "since": "6.5", "internal": true, "post": false, "hasResponseExample": true, "changelog": [] } ] }, { "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": "app", "description": "Coverage data required for rendering the component viewer.
Requires the following permission: 'Browse'.", "since": "4.4", "internal": true, "post": false, "hasResponseExample": true, "changelog": [], "params": [ { "key": "branch", "description": "Branch key", "since": "6.6", "required": false, "internal": true, "exampleValue": "feature/my_branch" }, { "key": "component", "description": "Component key", "since": "6.4", "required": false, "internal": false, "exampleValue": "my_project" }, { "key": "componentId", "description": "Component ID", "required": false, "internal": false, "exampleValue": "AU-Tpxb--iU5OvuD2FLy", "deprecatedSince": "6.4", "deprecatedKey": "uuid", "deprecatedKeySince": "6.4" } ] }, { "key": "search", "description": "Search for components", "since": "6.3", "internal": false, "post": false, "hasResponseExample": true, "changelog": [], "params": [ { "key": "language", "description": "Language key. If provided, only components for the given language are returned.", "required": false, "internal": false, "exampleValue": "" }, { "key": "organization", "description": "Organization key", "since": "6.3", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "p", "description": "1-based page number", "required": false, "internal": false, "defaultValue": "1", "exampleValue": "42", "deprecatedKey": "pageIndex", "deprecatedKeySince": "5.2" }, { "key": "ps", "description": "Page size. Must be greater than 0.", "required": false, "internal": false, "defaultValue": "100", "exampleValue": "20", "deprecatedKey": "pageSize", "deprecatedKeySince": "5.2" }, { "key": "q", "description": "Limit search to: ", "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:", "required": true, "internal": false, "possibleValues": [ "BRC", "DIR", "FIL", "TRK", "UTS" ] } ] }, { "key": "search_projects", "description": "Search for projects", "since": "6.2", "internal": true, "post": false, "hasResponseExample": true, "changelog": [ { "description": "The 'filter' parameter now allows 'NO_DATA' as value for numeric metrics", "version": "6.5" }, { "description": "Added the option 'analysisDate' for the 'sort' parameter", "version": "6.5" }, { "description": "Value 'leakPeriodDate' is added to parameter 'f'", "version": "6.5" }, { "description": "The 'languages' parameter accepts 'filter' to filter by language", "version": "6.4" }, { "description": "The 'visibility' field is added", "version": "6.4" } ], "params": [ { "key": "asc", "description": "Ascending sort", "required": false, "internal": false, "defaultValue": "true", "possibleValues": [ "true", "false", "yes", "no" ] }, { "key": "f", "description": "Comma-separated list of the fields to be returned in response", "since": "6.4", "required": false, "internal": false, "possibleValues": [ "analysisDate", "leakPeriodDate" ] }, { "key": "facets", "description": "Comma-separated list of the facets to be computed. No facet is computed by default.", "required": false, "internal": false, "possibleValues": [ "alert_status", "coverage", "duplicated_lines_density", "languages", "ncloc", "new_coverage", "new_duplicated_lines_density", "new_lines", "new_maintainability_rating", "new_reliability_rating", "new_security_rating", "reliability_rating", "security_rating", "sqale_rating", "tags" ] }, { "key": "filter", "description": "Filter of projects on name, key, measure value, quality gate, language, tag or whether a project is a favorite or not.
The filter must be encoded to form a valid URL (for example '=' must be replaced by '%3D').
Examples of use:To filter on project name or key, use the 'query' keyword, for instance : filter='query = \"Sonar\"'.

To filter on a numeric metric, provide the metric key.
These are the supported metric keys:

To filter on a rating, provide the corresponding metric key (ex: reliability_rating for reliability rating).
The possible values are:To filter on a Quality Gate status use the metric key 'alert_status'. Only the '=' operator can be used.
The possible values are:To filter on language keys use the language key: Use the WS api/languages/list to find the key of a language.
To filter on tags use the 'tag' keyword:", "required": false, "internal": false }, { "key": "organization", "description": "the organization to search projects in", "since": "6.3", "required": false, "internal": true }, { "key": "p", "description": "1-based page number", "required": false, "internal": false, "defaultValue": "1", "exampleValue": "42", "deprecatedKey": "pageIndex", "deprecatedKeySince": "5.2" }, { "key": "ps", "description": "Page size. Must be greater than 0 and less than 500", "required": false, "internal": false, "defaultValue": "100", "exampleValue": "20", "deprecatedKey": "pageSize", "deprecatedKeySince": "5.2", "maximumValue": 500 }, { "key": "s", "description": "Sort projects by numeric metric key, quality gate status (using 'alert_status'), last analysis date (using 'analysisDate'), or by project name.", "since": "6.4", "required": false, "internal": false, "defaultValue": "name", "possibleValues": [ "alert_status", "analysisDate", "coverage", "duplicated_lines_density", "lines", "name", "ncloc", "ncloc_language_distribution", "new_coverage", "new_duplicated_lines_density", "new_lines", "new_maintainability_rating", "new_reliability_rating", "new_security_rating", "reliability_rating", "security_rating", "sqale_rating" ] } ] }, { "key": "show", "description": "Returns a component (file, directory, project, view…) and its ancestors. The ancestors are ordered from the parent to the root project. The 'componentId' or 'component' parameter must be provided.
Requires the following permission: 'Browse' on the project of the specified component.", "since": "5.4", "internal": false, "post": false, "hasResponseExample": true, "changelog": [ { "description": "'branch' is added to the response", "version": "6.6" }, { "description": "'version' is added to the response", "version": "6.6" }, { "description": "Leak period date is added to the response", "version": "6.5" }, { "description": "Analysis date has been added to the response", "version": "6.4" }, { "description": "The field 'id' is deprecated in the response", "version": "6.4" }, { "description": "The 'visibility' field is added to the response", "version": "6.4" } ], "params": [ { "key": "branch", "description": "Branch key", "since": "6.6", "required": false, "internal": true, "exampleValue": "feature/my_branch" }, { "key": "component", "description": "Component key", "required": false, "internal": false, "exampleValue": "my_project", "deprecatedKey": "key", "deprecatedKeySince": "6.4" }, { "key": "componentId", "description": "Component id", "required": false, "internal": false, "exampleValue": "AU-Tpxb--iU5OvuD2FLy", "deprecatedSince": "6.4", "deprecatedKey": "id", "deprecatedKeySince": "6.4" } ] }, { "key": "suggestions", "description": "Internal WS for the top-right search engine. The result will contain component search results, grouped by their qualifiers.

Each result contains:

", "since": "4.2", "internal": true, "post": false, "hasResponseExample": true, "changelog": [ { "description": "Parameter 's' is optional", "version": "6.4" } ], "params": [ { "key": "more", "description": "Category, for which to display the next 20 results (skipping the first 6 results)", "since": "6.4", "required": false, "internal": false, "possibleValues": [ "VW", "SVW", "APP", "TRK", "BRC", "FIL", "UTS" ] }, { "key": "recentlyBrowsed", "description": "Comma separated list of component keys, that have recently been browsed by the user. Only the first 50 items will be used. Order is not taken into account.", "since": "6.4", "required": false, "internal": false, "exampleValue": "org.sonarsource:sonarqube,some.other:project", "maxValuesAllowed": 50 }, { "key": "s", "description": "Search query with a minimum of two characters. Can contain several search tokens, separated by spaces. Search tokens with only one character will be ignored.", "required": false, "internal": false, "exampleValue": "sonar" } ] }, { "key": "tree", "description": "Navigate through components based on the chosen strategy. The componentId or the component parameter must be provided.
Requires the following permission: 'Browse' on the specified project.
When limiting search with the q parameter, directories are not returned.", "since": "5.4", "internal": false, "post": false, "hasResponseExample": true, "changelog": [ { "description": "The field 'id' is deprecated in the response", "version": "6.4" } ], "params": [ { "key": "asc", "description": "Ascending sort", "required": false, "internal": false, "defaultValue": "true", "possibleValues": [ "true", "false", "yes", "no" ] }, { "key": "branch", "description": "Branch key", "since": "6.6", "required": false, "internal": true, "exampleValue": "feature/my_branch" }, { "key": "component", "description": "Base component key. The search is based on this component.", "required": false, "internal": false, "exampleValue": "my_project", "deprecatedKey": "baseComponentKey", "deprecatedKeySince": "6.4" }, { "key": "componentId", "description": "Base component id. The search is based on this component.", "required": false, "internal": false, "exampleValue": "AU-TpxcA-iU5OvuD2FLz", "deprecatedSince": "6.4", "deprecatedKey": "baseComponentId", "deprecatedKeySince": "6.4" }, { "key": "p", "description": "1-based page number", "required": false, "internal": false, "defaultValue": "1", "exampleValue": "42", "deprecatedKey": "pageIndex", "deprecatedKeySince": "5.2" }, { "key": "ps", "description": "Page size. Must be greater than 0 and less than 500", "required": false, "internal": false, "defaultValue": "100", "exampleValue": "20", "deprecatedKey": "pageSize", "deprecatedKeySince": "5.2", "maximumValue": 500 }, { "key": "q", "description": "Limit search to: Must have at least 3 characters", "required": false, "internal": false, "exampleValue": "FILE_NAM" }, { "key": "qualifiers", "description": "Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:", "required": false, "internal": false, "possibleValues": [ "BRC", "DIR", "FIL", "TRK", "UTS" ] }, { "key": "s", "description": "Comma-separated list of sort fields", "required": false, "internal": false, "defaultValue": "name", "exampleValue": "name, path", "deprecatedKey": "sort", "deprecatedKeySince": "5.4", "possibleValues": [ "name", "path", "qualifier" ] }, { "key": "strategy", "description": "Strategy to search for base component descendants:", "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's project", "since": "4.4", "internal": false, "post": false, "hasResponseExample": true, "changelog": [ { "description": "The fields 'uuid', 'projectUuid', 'subProjectUuid' are deprecated in the response.", "version": "6.5" } ], "params": [ { "key": "branch", "description": "Branch key", "required": false, "internal": true, "exampleValue": "feature/my_branch" }, { "key": "key", "description": "File key", "required": false, "internal": false, "exampleValue": "my_project:/src/foo/Bar.php" }, { "key": "uuid", "description": "File ID. If provided, 'key' must not be provided.", "required": false, "internal": false, "exampleValue": "584a89f2-8037-4f7b-b82c-8b45d2d63fb2", "deprecatedSince": "6.5" } ] } ] }, { "path": "api/editions", "since": "6.7", "description": "Manage SonarSource commercial editions.", "actions": [ { "key": "apply_license", "description": "Apply changes to SonarQube to match the specified license. Clear error message of previous automatic install of an edition, if there is any. Require 'Administer System' permission.", "since": "6.7", "internal": false, "post": true, "hasResponseExample": true, "changelog": [], "params": [ { "key": "license", "description": "the license", "since": "6.7", "required": true, "internal": false } ] }, { "key": "clear_error_message", "description": "Clear error message of last install of an edition (if any). Require 'Administer System' permission.", "since": "6.7", "internal": false, "post": true, "hasResponseExample": false, "changelog": [] }, { "key": "form_data", "description": "Provide data to prefill license request forms: the server ID and the total number of lines of code.", "since": "6.7", "internal": true, "post": false, "hasResponseExample": true, "changelog": [] }, { "key": "preview", "description": "Preview the changes to SonarQube to match the specified license. Requires 'Administer System' permission.", "since": "6.7", "internal": false, "post": true, "hasResponseExample": true, "changelog": [], "params": [ { "key": "license", "description": "the license", "since": "6.7", "required": true, "internal": false } ] }, { "key": "status", "description": "Provide status of SonarSource commercial edition of the current SonarQube. Requires 'Administer System' permission.", "since": "6.7", "internal": false, "post": false, "hasResponseExample": true, "changelog": [] }, { "key": "uninstall", "description": "Uninstall the currently installed edition. Requires 'Administer System' permission.", "since": "6.7", "internal": false, "post": true, "hasResponseExample": false, "changelog": [] } ] }, { "path": "api/emails", "since": "6.1", "description": "Manage emails", "actions": [ { "key": "send", "description": "Test email configuration by sending an email
Requires 'Administer System' permission.", "since": "6.1", "internal": true, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "message", "description": "Content of the email", "required": true, "internal": false }, { "key": "subject", "description": "Subject of the email", "required": false, "internal": false, "exampleValue": "Test Message from SonarQube" }, { "key": "to", "description": "Email address", "required": true, "internal": false, "exampleValue": "john@doo.com" } ] } ] }, { "path": "api/favorites", "since": "6.3", "description": "Manage user favorites", "actions": [ { "key": "add", "description": "Add a component (project, directory, file etc.) as favorite for the authenticated user.
Requires authentication and the following permission: 'Browse' on the project of the specified component.", "since": "6.3", "internal": false, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "component", "description": "Component key", "required": true, "internal": false, "exampleValue": "my_project:/src/foo/Bar.php" } ] }, { "key": "remove", "description": "Remove a component (project, directory, file etc.) as favorite for the authenticated user.
Requires authentication.", "since": "6.3", "internal": false, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "component", "description": "Component key", "required": true, "internal": false, "exampleValue": "my_project" } ] }, { "key": "search", "description": "Search for the authenticated user favorites.
Requires 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", "deprecatedKey": "pageIndex", "deprecatedKeySince": "5.2" }, { "key": "ps", "description": "Page size. Must be greater than 0 and less than 500", "required": false, "internal": false, "defaultValue": "100", "exampleValue": "20", "deprecatedKey": "pageSize", "deprecatedKeySince": "5.2", "maximumValue": 500 } ] } ] }, { "path": "api/favourites", "since": "2.6", "description": "Removed since 6.3, please use api/favorites instead", "actions": [ { "key": "index", "description": "The web service is removed and you're invited to use api/favorites instead", "since": "2.6", "deprecatedSince": "6.3", "internal": false, "post": false, "hasResponseExample": true, "changelog": [] } ] }, { "path": "api/issues", "since": "3.6", "description": "Read and update issues.", "actions": [ { "key": "add_comment", "description": "Add a comment.
Requires authentication and the following permission: 'Browse' on the project of the specified issue.", "since": "3.6", "internal": false, "post": true, "hasResponseExample": true, "changelog": [ { "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't fix because it doesn't 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 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 '_me' 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": "me", "description": "(deprecated) Assign the issue to the logged-in user. Replaced by the parameter assignee=_me", "required": false, "internal": false, "deprecatedSince": "5.2", "possibleValues": [ "true", "false", "yes", "no" ] } ] }, { "key": "authors", "description": "Search SCM accounts which match a given query", "since": "5.1", "internal": false, "post": false, "hasResponseExample": true, "changelog": [], "params": [ { "key": "ps", "description": "The size of the list to return", "required": false, "internal": false, "defaultValue": "10", "exampleValue": "25" }, { "key": "q", "description": "A pattern to match SCM accounts against", "required": false, "internal": false, "exampleValue": "luke" } ] }, { "key": "bulk_change", "description": "Bulk change on issues.
Requires authentication.", "since": "3.7", "internal": false, "post": true, "hasResponseExample": true, "changelog": [ { "description": "'actions' parameter is ignored", "version": "6.3" } ], "params": [ { "key": "add_tags", "description": "Add tags", "required": false, "internal": false, "exampleValue": "security,java8", "deprecatedKey": "add_tags.tags", "deprecatedKeySince": "6.2" }, { "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", "deprecatedKey": "assign.assignee", "deprecatedKeySince": "6.2" }, { "key": "comment", "description": "To add a comment to a list of issues", "required": false, "internal": false, "exampleValue": "Here is my comment" }, { "key": "do_transition", "description": "Transition", "required": false, "internal": false, "exampleValue": "reopen", "deprecatedKey": "do_transition.transition", "deprecatedKeySince": "6.2", "possibleValues": [ "confirm", "unconfirm", "reopen", "resolve", "falsepositive", "wontfix", "close" ] }, { "key": "issues", "description": "Comma-separated list of issue keys", "required": true, "internal": false, "exampleValue": "AU-Tpxb--iU5OvuD2FLy,AU-TpxcA-iU5OvuD2FLz" }, { "key": "plan", "description": "In 5.5, action plans are dropped. Has no effect. To plan the list of issues to a specific action plan (key), or unlink all the issues from an action plan", "required": false, "internal": false, "deprecatedSince": "5.5" }, { "key": "remove_tags", "description": "Remove tags", "required": false, "internal": false, "exampleValue": "security,java8", "deprecatedKey": "remove_tags.tags", "deprecatedKeySince": "6.2" }, { "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", "deprecatedKey": "set_severity.severity", "deprecatedKeySince": "6.2", "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", "deprecatedKey": "set_type.type", "deprecatedKeySince": "6.2", "possibleValues": [ "CODE_SMELL", "BUG", "VULNERABILITY" ] } ] }, { "key": "changelog", "description": "Display changelog of an issue.
Requires the 'Browse' permission on the project of the specified issue.", "since": "4.1", "internal": false, "post": false, "hasResponseExample": true, "changelog": [ { "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": "component_tags", "description": "List tags for the issues under a given component (including issues on the descendants of the component)", "since": "5.1", "internal": true, "post": false, "hasResponseExample": true, "changelog": [], "params": [ { "key": "componentUuid", "description": "A component UUID", "required": true, "internal": false, "exampleValue": "7d8749e8-3070-4903-9188-bdd82933bb92" }, { "key": "createdAfter", "description": "To retrieve tags on issues created after the given date (inclusive).
Either 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": "ps", "description": "The maximum size of the list to return", "required": false, "internal": false, "defaultValue": "10", "exampleValue": "25" } ] }, { "key": "delete_comment", "description": "Delete a comment.
Requires authentication and the following permission: 'Browse' on the project of the specified issue.", "since": "3.6", "internal": false, "post": true, "hasResponseExample": true, "changelog": [ { "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 'key' parameter is renamed 'comment'", "version": "6.3" } ], "params": [ { "key": "comment", "description": "Comment key", "since": "6.3", "required": true, "internal": false, "exampleValue": "AU-Tpxb--iU5OvuD2FLy", "deprecatedKey": "key", "deprecatedKeySince": "6.3" } ] }, { "key": "do_transition", "description": "Do workflow transition on an issue. Requires authentication and Browse permission on project.
The transitions 'wontfix' and 'falsepositive' require the permission 'Administer Issues'.", "since": "3.6", "internal": false, "post": true, "hasResponseExample": true, "changelog": [ { "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", "close" ] } ] }, { "key": "edit_comment", "description": "Edit a comment.
Requires authentication and the following permission: 'Browse' on the project of the specified issue.", "since": "3.6", "internal": false, "post": true, "hasResponseExample": true, "changelog": [ { "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 'key' 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", "deprecatedKey": "key", "deprecatedKeySince": "6.3" }, { "key": "text", "description": "Comment text", "required": true, "internal": false, "exampleValue": "Won't fix because it doesn't apply to the context" } ] }, { "key": "search", "description": "Search for issues.
At most one of the following parameters can be provided at the same time: componentKeys, componentUuids, components, componentRootUuids, componentRoots.
Requires the 'Browse' permission on the specified project(s).", "since": "3.6", "internal": false, "post": false, "hasResponseExample": true, "changelog": [ { "description": "parameters 'projects', 'projectUuids', 'moduleUuids', 'directories', 'fileUuids' are marked as internal", "version": "6.5" }, { "description": "response field 'email' is renamed 'avatar'", "version": "6.3" }, { "description": "response fields 'reporter' and 'actionPlan' are removed (drop of action plan and manual issue features)", "version": "5.5" }, { "description": "parameters 'reporters', 'actionPlans' and 'planned' are dropped and therefore ignored (drop of action plan and manual issue features)", "version": "5.5" }, { "description": "response field 'debt' is renamed 'effort'", "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", "actionPlans", "rules", "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 '__me__' can be used as a placeholder for user who performs the request", "required": false, "internal": false, "exampleValue": "admin,usera,__me__" }, { "key": "authors", "description": "Comma-separated list of SCM accounts", "required": false, "internal": false, "exampleValue": "torvalds@linux-foundation.org" }, { "key": "branch", "description": "Branch key", "since": "6.6", "required": false, "internal": true, "exampleValue": "feature/my_branch" }, { "key": "componentKeys", "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" }, { "key": "componentRootUuids", "description": "If used, will have the same meaning as componentUuids AND onComponentOnly=false.", "required": false, "internal": false, "deprecatedSince": "5.1" }, { "key": "componentRoots", "description": "If used, will have the same meaning as componentKeys AND onComponentOnly=false.", "required": false, "internal": false, "deprecatedSince": "5.1" }, { "key": "componentUuids", "description": "To retrieve issues associated to a specific list of components their sub-components (comma-separated list of component IDs). This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter. A component can be a project, module, directory or file.", "required": false, "internal": false, "exampleValue": "584a89f2-8037-4f7b-b82c-8b45d2d63fb2", "deprecatedSince": "6.5" }, { "key": "components", "description": "If used, will have the same meaning as componentKeys AND onComponentOnly=true.", "required": false, "internal": false, "deprecatedSince": "5.1" }, { "key": "createdAfter", "description": "To retrieve issues created after the given date (inclusive).
Either a date (server timezone) or datetime can be provided.
If 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 (inclusive).
Either 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": "createdInLast", "description": "To retrieve issues created during a time span before the current time (exclusive). Accepted units are 'y' for year, 'm' for month, 'w' for week and 'd' for day. If this parameter is set, createdAfter must not be set", "required": false, "internal": false, "exampleValue": "1m2w (1 month 2 weeks)" }, { "key": "directories", "description": "To retrieve issues associated to a specific list of directories (comma-separated list of directory paths). This parameter is only meaningful when a module is selected. This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter. ", "since": "5.1", "required": false, "internal": true, "exampleValue": "src/main/java/org/sonar/server/" }, { "key": "facetMode", "description": "Choose the returned value for facet items, either count of issues or sum of debt.
Since 5.5, 'debt' mode is deprecated and replaced by 'effort'", "required": false, "internal": false, "defaultValue": "count", "possibleValues": [ "count", "effort", "debt" ] }, { "key": "facets", "description": "Comma-separated list of the facets to be computed. No facet is computed by default.
Since 5.5, facet 'actionPlans' is deprecated.
Since 5.5, facet 'reporters' is deprecated.", "required": false, "internal": false, "possibleValues": [ "severities", "statuses", "resolutions", "actionPlans", "projectUuids", "rules", "assignees", "assigned_to_me", "reporters", "authors", "moduleUuids", "fileUuids", "directories", "languages", "tags", "types", "createdAt" ] }, { "key": "fileUuids", "description": "To retrieve issues associated to a specific list of files (comma-separated list of file IDs). This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter. ", "required": false, "internal": true, "exampleValue": "bdd82933-3070-4903-9188-7d8749e8bb92" }, { "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": "moduleUuids", "description": "To retrieve issues associated to a specific list of modules (comma-separated list of module IDs). This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter. ", "required": false, "internal": true, "exampleValue": "7d8749e8-3070-4903-9188-bdd82933bb92" }, { "key": "onComponentOnly", "description": "Return only issues at a component's level, not on its descendants (modules, directories, files, etc). This parameter is only considered when componentKeys or componentUuids is set. Using the deprecated componentRoots or componentRootUuids parameters will set this parameter to false. Using the deprecated components parameter will set this parameter to true.", "required": false, "internal": false, "defaultValue": "false", "possibleValues": [ "true", "false", "yes", "no" ] }, { "key": "organization", "description": "Organization key", "since": "6.4", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "p", "description": "1-based page number", "required": false, "internal": false, "defaultValue": "1", "exampleValue": "42", "deprecatedKey": "pageIndex", "deprecatedKeySince": "5.2" }, { "key": "projectUuids", "description": "To retrieve issues associated to a specific list of projects (comma-separated list of project IDs). This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter. Portfolios are not supported. If this parameter is set, 'projects' must not be set.", "required": false, "internal": true, "exampleValue": "7d8749e8-3070-4903-9188-bdd82933bb92" }, { "key": "projects", "description": "To retrieve issues associated to a specific list of projects (comma-separated list of project keys). This parameter is mostly used by the Issues page, please prefer usage of the componentKeys parameter. If this parameter is set, projectUuids must not be set.", "required": false, "internal": true, "exampleValue": "my_project", "deprecatedKey": "projectKeys", "deprecatedKeySince": "6.5" }, { "key": "ps", "description": "Page size. Must be greater than 0 and less than 500", "required": false, "internal": false, "defaultValue": "100", "exampleValue": "20", "deprecatedKey": "pageSize", "deprecatedKeySince": "5.2", "maximumValue": 500 }, { "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 <repository>:<rule>", "required": false, "internal": false, "exampleValue": "squid:AvoidCycles" }, { "key": "s", "description": "Sort field", "required": false, "internal": false, "deprecatedKey": "sort", "deprecatedKeySince": "5.4", "possibleValues": [ "CREATION_DATE", "UPDATE_DATE", "CLOSE_DATE", "ASSIGNEE", "SEVERITY", "STATUS", "FILE_LINE" ] }, { "key": "severities", "description": "Comma-separated list of severities", "required": false, "internal": false, "exampleValue": "BLOCKER,CRITICAL", "possibleValues": [ "INFO", "MINOR", "MAJOR", "CRITICAL", "BLOCKER" ] }, { "key": "inNewCodePeriod", "description": "To retrieve issues created since the leak period.
If this parameter is set to a truthy value, createdAfter must not be set and one component id or key must be provided.", "required": false, "internal": false, "defaultValue": "false", "possibleValues": [ "true", "false", "yes", "no" ] }, { "key": "statuses", "description": "Comma-separated list of statuses", "required": false, "internal": false, "exampleValue": "OPEN,REOPENED", "possibleValues": [ "OPEN", "CONFIRMED", "REOPENED", "RESOLVED", "CLOSED" ] }, { "key": "tags", "description": "Comma-separated list of tags.", "required": false, "internal": false, "exampleValue": "security,convention" }, { "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.
Requires the following permissions:", "since": "3.6", "internal": false, "post": true, "hasResponseExample": true, "changelog": [ { "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": "severity", "description": "New severity", "required": true, "internal": false, "possibleValues": [ "INFO", "MINOR", "MAJOR", "CRITICAL", "BLOCKER" ] } ] }, { "key": "set_tags", "description": "Set tags on an issue.
Requires authentication and Browse permission on project", "since": "5.1", "internal": false, "post": true, "hasResponseExample": true, "changelog": [ { "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", "deprecatedKey": "key", "deprecatedKeySince": "6.3" }, { "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 'code smell' to 'bug'.
Requires the following permissions:", "since": "5.5", "internal": false, "post": true, "hasResponseExample": true, "changelog": [ { "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": [], "params": [ { "key": "organization", "description": "Organization key", "since": "6.4", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "ps", "description": "Page size. Must be greater than 0 and less than 100", "required": false, "internal": false, "defaultValue": "10", "exampleValue": "20", "deprecatedKey": "pageSize", "deprecatedKeySince": "5.2", "maximumValue": 100 }, { "key": "q", "description": "Limit search to tags that contain the supplied string.", "required": false, "internal": false, "exampleValue": "misra" } ] } ] }, { "path": "api/l10n", "since": "4.4", "description": "Manage localization.", "actions": [ { "key": "index", "description": "Get all localization messages for a given locale", "since": "4.4", "internal": true, "post": false, "hasResponseExample": true, "changelog": [], "params": [ { "key": "locale", "description": "BCP47 language tag, used to override the browser Accept-Language header", "required": false, "internal": false, "defaultValue": "en", "exampleValue": "fr-CH" }, { "key": "ts", "description": "Date of the last cache update.", "required": false, "internal": false, "exampleValue": "2014-06-04T09:31:42+0000" } ] } ] }, { "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. The componentId or the component parameter must be provided.
Requires the following permission: 'Browse' on the project of specified component.", "since": "5.4", "internal": false, "post": false, "hasResponseExample": true, "changelog": [ { "description": "the response field id is deprecated. Use key instead.", "version": "6.6" }, { "description": "the response field refId is deprecated. Use refKey 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": "periods,metrics", "possibleValues": [ "metrics", "periods" ] }, { "key": "branch", "description": "Branch key", "since": "6.6", "required": false, "internal": true, "exampleValue": "feature/my_branch" }, { "key": "component", "description": "Component key", "required": false, "internal": false, "exampleValue": "my_project", "deprecatedKey": "componentKey", "deprecatedKeySince": "6.6" }, { "key": "componentId", "description": "Component id", "required": false, "internal": false, "exampleValue": "AU-Tpxb--iU5OvuD2FLy", "deprecatedSince": "6.6" }, { "key": "developerId", "description": "Deprecated parameter, used previously with the Developer Cockpit plugin. No measures are returned if parameter is set.", "required": false, "internal": false, "deprecatedSince": "6.4" }, { "key": "developerKey", "description": "Deprecated parameter, used previously with the Developer Cockpit plugin. No measures are returned if parameter is set.", "required": false, "internal": false, "deprecatedSince": "6.4" }, { "key": "metricKeys", "description": "Metric keys", "required": true, "internal": false, "exampleValue": "ncloc,complexity,violations" } ] }, { "key": "component_tree", "description": "Navigate through components based on the chosen strategy with specified measures. The baseComponentId or the component parameter must be provided.
Requires the following permission: 'Browse' on the specified project.
When limiting search with the q parameter, directories are not returned.", "since": "5.4", "internal": false, "post": false, "hasResponseExample": true, "changelog": [ { "description": "the response field id is deprecated. Use key instead.", "version": "6.6" }, { "description": "the response field refId is deprecated. Use refKey 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": "periods,metrics", "possibleValues": [ "metrics", "periods" ] }, { "key": "asc", "description": "Ascending sort", "required": false, "internal": false, "defaultValue": "true", "possibleValues": [ "true", "false", "yes", "no" ] }, { "key": "baseComponentId", "description": "Base component id. The search is based on this component.", "required": false, "internal": false, "exampleValue": "AU-TpxcA-iU5OvuD2FLz", "deprecatedSince": "6.6" }, { "key": "branch", "description": "Branch key", "since": "6.6", "required": false, "internal": true, "exampleValue": "feature/my_branch" }, { "key": "component", "description": "Component key. The search is based on this component.", "required": false, "internal": false, "exampleValue": "my_project", "deprecatedKey": "baseComponentKey", "deprecatedKeySince": "6.6" }, { "key": "developerId", "description": "Deprecated parameter, used previously with the Developer Cockpit plugin. No measures are returned if parameter is set.", "required": false, "internal": false, "deprecatedSince": "6.4" }, { "key": "developerKey", "description": "Deprecated parameter, used previously with the Developer Cockpit plugin. No measures are returned if parameter is set.", "required": false, "internal": false, "deprecatedSince": "6.4" }, { "key": "metricKeys", "description": "Metric keys. Types DISTRIB, DATA are not allowed", "required": true, "internal": false, "exampleValue": "ncloc,complexity,violations", "maxValuesAllowed": 15 }, { "key": "metricPeriodSort", "description": "Sort measures by leak period or not ?. The 's' parameter must contain the 'metricPeriod' value.", "since": "5.5", "required": false, "internal": false, "possibleValues": [ "1" ] }, { "key": "metricSort", "description": "Metric key to sort by. The 's' parameter must contain the 'metric' or 'metricPeriod' value. It must be part of the 'metricKeys' parameter", "required": false, "internal": false, "exampleValue": "ncloc" }, { "key": "metricSortFilter", "description": "Filter components. Sort must be on a metric. Possible values are: ", "required": false, "internal": false, "defaultValue": "all", "possibleValues": [ "all", "withMeasuresOnly" ] }, { "key": "p", "description": "1-based page number", "required": false, "internal": false, "defaultValue": "1", "exampleValue": "42", "deprecatedKey": "pageIndex", "deprecatedKeySince": "5.2" }, { "key": "ps", "description": "Page size. Must be greater than 0 and less than 500", "required": false, "internal": false, "defaultValue": "100", "exampleValue": "20", "deprecatedKey": "pageSize", "deprecatedKeySince": "5.2", "maximumValue": 500 }, { "key": "q", "description": "Limit search to: Must have at least 3 characters.", "required": false, "internal": false, "exampleValue": "FILE_NAM" }, { "key": "qualifiers", "description": "Comma-separated list of component qualifiers. Filter the results with the specified qualifiers. Possible values are:", "required": false, "internal": false, "possibleValues": [ "BRC", "DIR", "FIL", "TRK", "UTS" ] }, { "key": "s", "description": "Comma-separated list of sort fields", "required": false, "internal": false, "defaultValue": "name", "exampleValue": "name,path", "deprecatedKey": "sort", "deprecatedKeySince": "5.4", "possibleValues": [ "metric", "metricPeriod", "name", "path", "qualifier" ] }, { "key": "strategy", "description": "Strategy to search for base component descendants:", "required": false, "internal": false, "defaultValue": "all", "possibleValues": [ "all", "children", "leaves" ] } ] }, { "key": "search", "description": "Search for project measures ordered by project names.
At most 100 projects can be provided.
Returns the projects with the 'Browse' permission.", "since": "6.2", "internal": true, "post": false, "hasResponseExample": true, "changelog": [], "params": [ { "key": "metricKeys", "description": "Metric keys", "required": true, "internal": false, "exampleValue": "ncloc,complexity,violations" }, { "key": "projectKeys", "description": "Comma-separated list of project, view or sub-view keys", "required": true, "internal": false, "exampleValue": "my_project,another_project" } ] }, { "key": "search_history", "description": "Search measures history of a component.
Measures are ordered chronologically.
Pagination applies to the number of measures for each metric.
Requires the following permission: 'Browse' on the specified component", "since": "6.3", "internal": false, "post": false, "hasResponseExample": true, "changelog": [], "params": [ { "key": "branch", "description": "Branch key", "since": "6.6", "required": false, "internal": true, "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).
Either 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", "deprecatedKey": "pageIndex", "deprecatedKeySince": "5.2" }, { "key": "ps", "description": "Page size. Must be greater than 0 and less than 1000", "required": false, "internal": false, "defaultValue": "100", "exampleValue": "20", "deprecatedKey": "pageSize", "deprecatedKeySince": "5.2", "maximumValue": 1000 }, { "key": "to", "description": "Filter measures created before the given date (inclusive).
Either 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, and manage metrics.", "actions": [ { "key": "search", "description": "Search for metrics", "since": "5.2", "internal": false, "post": false, "hasResponseExample": true, "changelog": [], "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", "domain", "direction", "qualitative", "hidden", "custom", "decimalScale" ] }, { "key": "isCustom", "description": "Choose custom metrics following 3 cases:", "required": false, "internal": false, "exampleValue": "true" }, { "key": "p", "description": "1-based page number", "required": false, "internal": false, "defaultValue": "1", "exampleValue": "42", "deprecatedKey": "pageIndex", "deprecatedKeySince": "5.2" }, { "key": "ps", "description": "Page size. Must be greater than 0 and less than 500", "required": false, "internal": false, "defaultValue": "100", "exampleValue": "20", "deprecatedKey": "pageSize", "deprecatedKeySince": "5.2", "maximumValue": 500 } ] }, { "key": "types", "description": "List all available metric types.", "since": "5.2", "internal": false, "post": false, "hasResponseExample": true, "changelog": [] } ] }, { "path": "api/navigation", "since": "5.2", "description": "Get information required to build navigation UI components", "actions": [ { "key": "component", "description": "Get information concerning component navigation for the current user. Requires the 'Browse' permission on the component's project.", "since": "5.2", "internal": true, "post": false, "hasResponseExample": true, "changelog": [ { "description": "The 'visibility' field is added", "version": "6.4" } ], "params": [ { "key": "branch", "description": "Branch key", "required": false, "internal": true, "exampleValue": "feature/my_branch" }, { "key": "component", "description": "A component key.", "required": false, "internal": false, "exampleValue": "my_project", "deprecatedKey": "componentKey", "deprecatedKeySince": "6.4" } ] }, { "key": "global", "description": "Get information concerning global navigation for the current user.", "since": "5.2", "internal": true, "post": false, "hasResponseExample": true, "changelog": [] }, { "key": "organization", "description": "Get information concerning organization navigation for the current user", "since": "6.3", "internal": true, "post": false, "hasResponseExample": true, "changelog": [ { "description": "The field 'projectVisibility' is added", "version": "6.4" } ], "params": [ { "key": "organization", "description": "the organization key", "required": true, "internal": false, "exampleValue": "my-org" } ] }, { "key": "settings", "description": "Get configuration information for the settings page:", "since": "5.2", "internal": true, "post": false, "hasResponseExample": true, "changelog": [] } ] }, { "path": "api/notifications", "since": "6.3", "description": "Manage notifications of the authenticated user", "actions": [ { "key": "add", "description": "Add a notification for the authenticated user.
Requires one of the following permissions:", "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:", "required": true, "internal": false, "exampleValue": "SQ-MyNewIssues" } ] }, { "key": "list", "description": "List notifications of the authenticated user.
Requires one of the following permissions:", "since": "6.3", "internal": false, "post": false, "hasResponseExample": true, "changelog": [], "params": [ { "key": "login", "description": "User login", "since": "6.4", "required": false, "internal": false } ] }, { "key": "remove", "description": "Remove a notification for the authenticated user.
Requires one of the following permissions:", "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:", "required": true, "internal": false, "exampleValue": "SQ-MyNewIssues" } ] } ] }, { "path": "api/orchestrator", "description": "Orchestrator web service", "actions": [ { "key": "reset", "description": "Reset data", "since": "Orchestrator 3.4", "internal": true, "post": true, "hasResponseExample": false, "changelog": [] } ] }, { "path": "api/organizations", "since": "6.2", "description": "Manage organizations.", "actions": [ { "key": "add_member", "description": "Add a user as a member of an organization.
Requires 'Administer System' permission on the specified organization.", "since": "6.4", "internal": true, "post": true, "hasResponseExample": true, "changelog": [], "params": [ { "key": "login", "description": "User login", "required": true, "internal": false, "exampleValue": "ray.bradbury" }, { "key": "organization", "description": "Organization key", "required": true, "internal": false, "exampleValue": "my-org" } ] }, { "key": "create", "description": "Create an organization.
Requires 'Administer System' permission unless any logged in user is allowed to create an organization (see appropriate setting). Organization support must be enabled.", "since": "6.2", "internal": true, "post": true, "hasResponseExample": true, "changelog": [], "params": [ { "key": "avatar", "description": "URL of the organization avatar.
It must be less than 256 chars long.", "required": false, "internal": false, "exampleValue": "https://www.foo.com/foo.png", "maximumLength": 256 }, { "key": "description", "description": "Description of the organization.
It must be less than 256 chars long.", "required": false, "internal": false, "exampleValue": "The Foo company produces quality software for Bar.", "maximumLength": 256 }, { "key": "key", "description": "Key of the organization.
The key is unique to the whole SonarQube.
When not specified, the key is computed from the name.
Otherwise, it must be between 2 and 32 chars long. All chars must be lower-case letters (a to z), digits or dash (but dash can neither be trailing nor heading)", "required": false, "internal": false, "exampleValue": "foo-company", "maximumLength": 32 }, { "key": "name", "description": "Name of the organization.
It must be between 2 and 64 chars longs.", "required": true, "internal": false, "exampleValue": "Foo Company", "maximumLength": 64 }, { "key": "url", "description": "URL of the organization.
It must be less than 256 chars long.", "required": false, "internal": false, "exampleValue": "https://www.foo.com", "maximumLength": 256 } ] }, { "key": "delete", "description": "Delete an organization.
Require 'Administer System' permission on the specified organization. Organization support must be enabled.", "since": "6.2", "internal": true, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "organization", "description": "Organization key", "required": true, "internal": false, "exampleValue": "foo-company", "deprecatedKey": "key", "deprecatedKeySince": "6.4" } ] }, { "key": "enable_support", "description": "Enable support of organizations.
'Administer System' permission is required. The logged-in user will be flagged as root and will be able to manage organizations and other root users.", "since": "6.3", "internal": true, "post": true, "hasResponseExample": false, "changelog": [ { "description": "Create default 'Members' group", "version": "6.4" } ] }, { "key": "remove_member", "description": "Remove a member from an organization.
Requires 'Administer System' permission on the specified organization.", "since": "6.4", "internal": true, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "login", "description": "User login", "required": true, "internal": false, "exampleValue": "ray.bradbury" }, { "key": "organization", "description": "Organization key", "required": true, "internal": false, "exampleValue": "my-org" } ] }, { "key": "search", "description": "Search for organizations", "since": "6.2", "internal": true, "post": false, "hasResponseExample": true, "changelog": [ { "description": "Paging fields have been added to the response", "version": "6.4" } ], "params": [ { "key": "organizations", "description": "Comma-separated list of organization keys", "since": "6.3", "required": false, "internal": false, "exampleValue": "my-org-1,foocorp" }, { "key": "p", "description": "1-based page number", "required": false, "internal": false, "defaultValue": "1", "exampleValue": "42", "deprecatedKey": "pageIndex", "deprecatedKeySince": "5.2" }, { "key": "ps", "description": "Page size. Must be greater than 0.", "required": false, "internal": false, "defaultValue": "25", "exampleValue": "20", "deprecatedKey": "pageSize", "deprecatedKeySince": "5.2" } ] }, { "key": "search_members", "description": "Search members of an organization", "since": "6.4", "internal": true, "post": false, "hasResponseExample": true, "changelog": [], "params": [ { "key": "organization", "description": "Organization key", "required": false, "internal": true }, { "key": "p", "description": "1-based page number", "required": false, "internal": false, "defaultValue": "1", "exampleValue": "42", "deprecatedKey": "pageIndex", "deprecatedKeySince": "5.2" }, { "key": "ps", "description": "Page size. Must be greater than 0 and less than 500", "required": false, "internal": false, "defaultValue": "50", "exampleValue": "20", "deprecatedKey": "pageSize", "deprecatedKeySince": "5.2", "maximumValue": 500 }, { "key": "q", "description": "Limit search to names or logins that contain the supplied string.", "required": false, "internal": false, "exampleValue": "orwe" }, { "key": "selected", "description": "Depending on the value, show only selected items (selected=selected) or deselected items (selected=deselected).", "required": false, "internal": true, "defaultValue": "selected", "possibleValues": [ "selected", "deselected" ] } ] }, { "key": "search_my_organizations", "description": "List keys of the organizations for which the currently authenticated user has the System Administer permission for.", "since": "6.3", "internal": true, "post": false, "hasResponseExample": true, "changelog": [] }, { "key": "update", "description": "Update an organization.
Require 'Administer System' permission. Organization support must be enabled.", "since": "6.2", "internal": true, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "avatar", "description": "URL of the organization avatar.
It must be less than 256 chars long.", "required": false, "internal": false, "exampleValue": "https://www.foo.com/foo.png", "maximumLength": 256 }, { "key": "description", "description": "Description of the organization.
It must be less than 256 chars long.", "required": false, "internal": false, "exampleValue": "The Foo company produces quality software for Bar.", "maximumLength": 256 }, { "key": "key", "description": "Organization key", "required": true, "internal": false, "exampleValue": "foo-company" }, { "key": "name", "description": "Name of the organization.
It must be between 2 and 64 chars longs.", "required": false, "internal": false, "exampleValue": "Foo Company", "maximumLength": 64 }, { "key": "url", "description": "URL of the organization.
It must be less than 256 chars long.", "required": false, "internal": false, "exampleValue": "https://www.foo.com", "maximumLength": 256 } ] }, { "key": "update_project_visibility", "description": "Update the default visibility for new projects of the specified organization.", "since": "6.4", "internal": true, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "organization", "description": "Organization key", "required": true, "internal": false, "exampleValue": "foo-company" }, { "key": "projectVisibility", "description": "Default visibility for projects", "required": true, "internal": false, "possibleValues": [ "private", "public" ] } ] } ] }, { "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 permission to a group.
This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.
The group name or group id must be provided.
Requires one of the following permissions:", "since": "5.2", "internal": false, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "groupId", "description": "Group id", "required": false, "internal": false, "exampleValue": "42" }, { "key": "groupName", "description": "Group name or 'anyone' (case insensitive)", "required": false, "internal": false, "exampleValue": "sonar-administrators" }, { "key": "organization", "description": "Key of organization, used when group name is set", "since": "6.2", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "permission", "description": "Permission", "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.
The group id or group name must be provided.
Requires the following permission: 'Administer System'.", "since": "5.2", "internal": false, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "groupId", "description": "Group id", "required": false, "internal": false, "exampleValue": "42" }, { "key": "groupName", "description": "Group name or 'anyone' (case insensitive)", "required": false, "internal": false, "exampleValue": "sonar-administrators" }, { "key": "organization", "description": "Key of organization, used when group name is set", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "permission", "description": "Permission", "required": true, "internal": false, "possibleValues": [ "admin", "codeviewer", "issueadmin", "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.
Requires the following permission: 'Administer System'.", "since": "6.0", "internal": false, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "organization", "description": "Key of organization, used when group name is set", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "permission", "description": "Permission", "required": true, "internal": false, "possibleValues": [ "admin", "codeviewer", "issueadmin", "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.
This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.
Requires one of the following permissions:", "since": "5.2", "internal": false, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "login", "description": "User login", "required": true, "internal": false, "exampleValue": "g.hopper" }, { "key": "organization", "description": "Key of organization, cannot be used at the same time with projectId and projectKey", "since": "6.2", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "permission", "description": "Permission", "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.
Requires the following permission: 'Administer System'.", "since": "5.2", "internal": false, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "login", "description": "User login", "required": true, "internal": false, "exampleValue": "g.hopper" }, { "key": "organization", "description": "Key of organization, used when group name is set", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "permission", "description": "Permission", "required": true, "internal": false, "possibleValues": [ "admin", "codeviewer", "issueadmin", "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.
The project id or project key must be provided.
The template id or name must be provided.
Requires the following permission: 'Administer System'.", "since": "5.2", "internal": false, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "organization", "description": "Key of organization, used when group name is set", "required": false, "internal": true, "exampleValue": "my-org" }, { "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 projects.
The template id or name must be provided.
Requires the following permission: 'Administer System'.", "since": "5.5", "internal": false, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "analyzedBefore", "description": "Filter the projects for which last analysis is older than the given date (exclusive).
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": "organization", "description": "Key of organization, used when group name is set", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "projects", "description": "Comma-separated list of project keys", "since": "6.6", "required": false, "internal": false, "exampleValue": "my_project,another_project" }, { "key": "q", "description": "Limit search to: ", "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:", "required": false, "internal": false, "defaultValue": "TRK", "deprecatedKey": "qualifier", "deprecatedKeySince": "6.6", "possibleValues": [ "TRK" ] }, { "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": "visibility", "description": "Filter the projects that should be visible to everyone (public), or only specific user/groups (private).
If no visibility is specified, the default project visibility of the organization will be used.", "since": "6.6", "required": false, "internal": true, "possibleValues": [ "private", "public" ] } ] }, { "key": "create_template", "description": "Create a permission template.
Requires the following permission: 'Administer System'.", "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": "organization", "description": "Key of organization, used when group name is set", "since": "6.2", "required": false, "internal": true, "exampleValue": "my-org" }, { "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.
Requires the following permission: 'Administer System'.", "since": "5.2", "internal": false, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "organization", "description": "Key of organization, used when group name is set", "required": false, "internal": true, "exampleValue": "my-org" }, { "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": "groups", "description": "Limit search to group names that contain the supplied string. Must have at least 3 characters.
When this parameter is not set, only groups having at least one permission are returned.", "since": "5.2", "internal": true, "post": false, "hasResponseExample": true, "changelog": [], "params": [ { "key": "organization", "description": "Key of organization, used when group name is set", "since": "6.2", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "p", "description": "1-based page number", "required": false, "internal": false, "defaultValue": "1", "exampleValue": "42", "deprecatedKey": "pageIndex", "deprecatedKeySince": "5.2" }, { "key": "permission", "description": "Permission", "required": false, "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": "ps", "description": "Page size. Must be greater than 0 and less than 100", "required": false, "internal": false, "defaultValue": "20", "exampleValue": "20", "deprecatedKey": "pageSize", "deprecatedKeySince": "5.2", "maximumValue": 100 }, { "key": "q", "description": "Limit search to names that contain the supplied string.", "required": false, "internal": false, "exampleValue": "sonar" } ] }, { "key": "remove_group", "description": "Remove a permission from a group.
This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.
The group id or group name must be provided, not both.
Requires one of the following permissions:", "since": "5.2", "internal": false, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "groupId", "description": "Group id", "required": false, "internal": false, "exampleValue": "42" }, { "key": "groupName", "description": "Group name or 'anyone' (case insensitive)", "required": false, "internal": false, "exampleValue": "sonar-administrators" }, { "key": "organization", "description": "Key of organization, used when group name is set", "since": "6.2", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "permission", "description": "Permission", "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.
The group id or group name must be provided.
Requires the following permission: 'Administer System'.", "since": "5.2", "internal": false, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "groupId", "description": "Group id", "required": false, "internal": false, "exampleValue": "42" }, { "key": "groupName", "description": "Group name or 'anyone' (case insensitive)", "required": false, "internal": false, "exampleValue": "sonar-administrators" }, { "key": "organization", "description": "Key of organization, used when group name is set", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "permission", "description": "Permission", "required": true, "internal": false, "possibleValues": [ "admin", "codeviewer", "issueadmin", "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.
Requires the following permission: 'Administer System'.", "since": "6.0", "internal": false, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "organization", "description": "Key of organization, used when group name is set", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "permission", "description": "Permission", "required": true, "internal": false, "possibleValues": [ "admin", "codeviewer", "issueadmin", "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.
This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.
Requires one of the following permissions:", "since": "5.2", "internal": false, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "login", "description": "User login", "required": true, "internal": false, "exampleValue": "g.hopper" }, { "key": "organization", "description": "Key of organization, used when group name is set", "since": "6.2", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "permission", "description": "Permission", "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.
Requires the following permission: 'Administer System'.", "since": "5.2", "internal": false, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "login", "description": "User login", "required": true, "internal": false, "exampleValue": "g.hopper" }, { "key": "organization", "description": "Key of organization, used when group name is set", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "permission", "description": "Permission", "required": true, "internal": false, "possibleValues": [ "admin", "codeviewer", "issueadmin", "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.
Requires the following permission: 'Administer System'.", "since": "5.2", "internal": false, "post": false, "hasResponseExample": true, "changelog": [], "params": [ { "key": "organization", "description": "Key of organization, used when group name is set", "since": "6.2", "required": false, "internal": true, "exampleValue": "my-org" }, { "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.
Requires the following permission: 'Administer System'.", "since": "5.2", "internal": false, "post": true, "hasResponseExample": false, "changelog": [], "params": [ { "key": "organization", "description": "Key of organization, used when group name is set", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "qualifier", "description": "Project qualifier. Filter the results with the specified qualifier. Possible values are:", "required": false, "internal": false, "defaultValue": "TRK", "possibleValues": [ "TRK" ] }, { "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": "template_groups", "description": "Lists the groups with their permission as individual groups rather than through user affiliation on the chosen template.
This service defaults to all groups, but can be limited to groups with a specific permission by providing the desired permission.
Requires the following permission: 'Administer System'.", "since": "5.2", "internal": true, "post": false, "hasResponseExample": true, "changelog": [], "params": [ { "key": "organization", "description": "Key of organization, used when group name is set", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "p", "description": "1-based page number", "required": false, "internal": false, "defaultValue": "1", "exampleValue": "42", "deprecatedKey": "pageIndex", "deprecatedKeySince": "5.2" }, { "key": "permission", "description": "Permission", "required": true, "internal": false, "possibleValues": [ "admin", "codeviewer", "issueadmin", "scan", "user" ] }, { "key": "ps", "description": "Page size. Must be greater than 0 and less than 100", "required": false, "internal": false, "defaultValue": "20", "exampleValue": "20", "deprecatedKey": "pageSize", "deprecatedKeySince": "5.2", "maximumValue": 100 }, { "key": "q", "description": "Limit search to group names that contain the supplied string. Must have at least 3 characters.
When this parameter is not set, only group having at least one permission are returned.", "required": false, "internal": false, "exampleValue": "eri" }, { "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": "template_users", "description": "Lists the users with their permission as individual users rather than through group affiliation on the chosen template.
This service defaults to all users, but can be limited to users with a specific permission by providing the desired permission.
Requires the following permission: 'Administer System'.", "since": "5.2", "internal": true, "post": false, "hasResponseExample": true, "changelog": [], "params": [ { "key": "organization", "description": "Key of organization, used when group name is set", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "p", "description": "1-based page number", "required": false, "internal": false, "defaultValue": "1", "exampleValue": "42", "deprecatedKey": "pageIndex", "deprecatedKeySince": "5.2" }, { "key": "permission", "description": "Permission", "required": false, "internal": false, "possibleValues": [ "admin", "codeviewer", "issueadmin", "scan", "user" ] }, { "key": "ps", "description": "Page size. Must be greater than 0 and less than 100", "required": false, "internal": false, "defaultValue": "20", "exampleValue": "20", "deprecatedKey": "pageSize", "deprecatedKeySince": "5.2", "maximumValue": 100 }, { "key": "q", "description": "Limit search to user names that contain the supplied string. Must have at least 3 characters.
When this parameter is not set, only users having at least one permission are returned.", "required": false, "internal": false, "exampleValue": "eri" }, { "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.
Requires the following permission: 'Administer System'.", "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\\..*" } ] }, { "key": "users", "description": "Lists the users with their permissions as individual users rather than through group affiliation.
This service defaults to global permissions, but can be limited to project permissions by providing project id or project key.
This service defaults to all users, but can be limited to users with a specific permission by providing the desired permission.
Requires one of the following permissions:", "since": "5.2", "internal": true, "post": false, "hasResponseExample": true, "changelog": [], "params": [ { "key": "organization", "description": "Key of organization, used when group name is set", "since": "6.2", "required": false, "internal": true, "exampleValue": "my-org" }, { "key": "p", "description": "1-based page number", "required": false, "internal": false, "defaultValue": "1", "exampleValue": "42", "deprecatedKey": "pageIndex", "deprecatedKeySince": "5.2" }, { "key": "permission", "description": "Permission", "required": false, "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": "ps", "description": "Page size. Must be greater than 0 and less than 100", "required": false, "internal": false, "defaultValue": "20", "exampleValue": "20", "deprecatedKey": "pageSize", "deprecatedKeySince": "5.2", "maximumValue": 100 }, { "key": "q", "description": "Limit search to user names that contain the supplied string. Must have at least 3 characters.
When this parameter is not set, only users having at least one permission are returned.", "required": false, "internal": false, "exampleValue": "eri" } ] } ] }, { "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.
Plugin information is retrieved from Update Center. Date and time at which Update Center was last refreshed is provided in the response.
Update status values are: Require 'Administer System' 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)
Requires 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.
Plugin information is retrieved from Update Center.
Requires 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.", "since": "5.2", "internal": false, "post": false, "hasResponseExample": true, "changelog": [ { "description": "The 'filename' field is added", "version": "6.6" }, { "description": "The 'fileHash' field is added", "version": "6.6" }, { "description": "The 'sonarLintSupported' field is added", "version": "6.6" }, { "description": "The 'updatedAt' 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: