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 |
| Method | GET |
Security | None |
Examples
Get the server status:
Parameters
Parameter | Description | Required | Default Value | Value |
|---|---|---|---|---|
| format | Response formats: xml or json | No | xml |
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 |
| Method | GET |
Security | Requires Global Administrator role |
Examples
Get the system properties, server info, etc.:
Parameters
Parameter | Description | Required | Default Value |
|---|---|---|---|
| format | Response formats: json | Yes | None |
Upgrade the Sonar Database
| Description | Upgrade the Sonar database |
URL | /api/server/setup |
| Method | POST |
Security | None |
Examples
Upgrade the Sonar database:
Parameters
Parameter | Description | Required | Default Value | Value |
|---|---|---|---|---|
| format | Response formats: xml or json or txt | No | xml |
Labels
