Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
iconfalse
titleTable of Contents

Table of Contents
maxLevel1

Get the SonarQube

...

Server Status

Description

Get the server status: UP, DOWN (generally for database connection failures), SETUP (if the server must be upgraded), MIGRATION_RUNNING (the upgrade process is currently running)

URL

/api/server

HTTP MethodGET
Response Formatsjson | xml

Security

None

...

 

DescriptionGet the system properties, server info (Java, OS), database configuration, JVM statistics and installed plugins

URL

/api/server/system

HTTP MethodGET
Response Formatsjson

Security

Requires Global Administrator roleAdminister System permission

Examples

Use CaseExample Request
Get the system properties, server info, etc.

GET http://localhost:9000/api/server/system

Response Format

...

Parameter

Description

Required

Default ValueExample Value
format

Response format can be set through:

  • Parameter format: json
  • Or the 'Accept' property in the HTTP header:
    • Accept:application/json
If nothing is set, json is used.
YesNonejson

Upgrade the SonarQube

...

Database

Description

Upgrade the SonarQube TM database

URL

/api/server/setup

HTTP MethodPOST

Security

None

...

Use CaseExample Request
Upgrade the SonarQubeTM databaseSonarQubedatabase

curl -X POST http://localhost:9000/api/server/setup

...