Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

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 MethodGET
Response Formatsjson | xml

Security

None

Examples

Use CaseExample Request
Get the server status

GET http://nemo.sonarsource.org/api/server

Response Format

JSON

Parameters

Parameter

Description

Required

Default Value

Example Value

formatResponse format.
Possible values: xml | json
NoNonejson

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.

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

Response Format

JSON

Parameters

Parameter

Description

Required

Default ValueExample Value
formatResponse format: 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

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

Response Format

JSON

Parameters

Parameter

Description

Required

Default Value

Example Value

formatResponse format.
Possible values: xml | json | txt
NoNonejson
  • No labels