Full documentation for SonarQube has moved to a new location: http://docs.sonarqube.org/display/SONAR

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Examples

Use CaseExample Request
Get the server status

...

...

languagenone

GET

...

Response Format

Code Block
titleJSON
languagejavascript
{
  "id":"20121008095121",
  "version":"3.2",
  "status":"UP"
}

Parameters

Parameter

Description

Required

Default Value

Example Value

formatResponse formatsformat.
Possible values: xml or | json
NoxmlNone json

Get the System Properties, Server Info, etc.

 

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 role

Examples

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

...

...

languagenone

GET

...

...

Response Format

Code Block
titleJSON
languagejavascript
[
  {
    "system_info":
      {
        "System date":"Wed Oct 10 19:15:20 CEST 2012",
        "JVM Vendor":"Sun Microsystems Inc.",
        "JVM Name":"Java HotSpot(TM) Client VM",
        ...
      }
    "system_statistics":
     {
       ...
     }
    "sonar_info":
     {
       ...
     }
    "sonar_plugins":
     {
       ...
     }
    "system_properties":
     {
       ...
     }
  }
]

Parameters

Parameter

Description

Required

Default ValueExample Value
formatResponse formatsformat: jsonYesNonejson

Upgrade the Sonar Database

Description

Upgrade the Sonar database

URL

/api/server/setup

HTTP MethodPOST

Security

None

Examples

Use CaseExample Request
Upgrade the Sonar database

...

...

languagenone

curl

...

-X

...

POST

...

http://localhost:9000/api/server/setup

Response Format

Code Block
titleJSON
languagejavascript
{
  "status":"ok",
  "migration_status":"NO_MIGRATION",
  "message":"Database is up-to-date, no migration needed."
}

Parameters

Parameter

Description

Required

Default Value

Example Value

formatResponse formatsformat.
Possible values: xml or | json or | txt
NoxmlNone json