You are viewing an old version of this page. View the current version.
Compare with Current ·
View Page History
| Table of Contents |
Get the Sonar 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 Method | GET |
| Response Formats | json | xml |
Security | None |
Examples
| Use Case | Example Request |
|---|---|
| Get the server status |
Response Format
JSON
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
| format | Response format. Possible values: xml | json | No | None | json |
Get the System Properties, Server Info, etc.
| Description | Get the system properties, server info (Java, OS), database configuration, JVM statistics and installed plugins |
URL | /api/server/system |
| HTTP Method | GET |
| Response Formats | json |
Security | Requires Global Administrator role |
Examples
| Use Case | Example Request |
|---|---|
| Get the system properties, server info, etc. |
Response Format
JSON
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
| format | Response format: json | Yes | None | json |
Upgrade the Sonar Database
| Description | Upgrade the Sonar database |
URL | /api/server/setup |
| HTTP Method | POST |
Security | None |
Examples
| Use Case | Example Request |
|---|---|
| Upgrade the Sonar database |
|
Response Format
JSON
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
| format | Response format. Possible values: xml | json | txt | No | None | json |
Labels
