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.
Comment: Migrated to Confluence 5.3
DescriptionGet a list of events from a project

URL

/api/events

HTTP MethodGET
Response Formatsjson | xml

Security

Requires User role to get the list of events for a specific project

 

Examples

Use CaseExample Request
Get all the versions from project org.codehaus.sonar:sonar

GET http://nemo.sonarsource.org/api/events?resource=org.codehaus.sonar:sonar&categories=Version

Get all the versions and alerts from project org.codehaus.sonar:sonar between January 1st, 2012 and August 31st, 2012

GET http://nemo.sonarsource.org/api/events?resource=org.codehaus.sonar:sonar&categories=Alert,Version&fromDate=2012-01-01&toDate=2012-08-31

Response Format

Code Block
titleJSON
languagejavascript
[
  {
     "id":"573318",
     "rk":"org.codehaus.sonar:sonar",
     "n":"3.3-SNAPSHOT",
     "c":"Version",
     "dt":"2012-10-05T22:15:38+0000"
  },
  ...
]

Parameters

Parameter

Description

Required

Default Value

Example Value

resource

id or key of the project

Yes

None

org.codehaus.sonar:sonar

categories

Comma-separated list of category filters (case-sensitive)

No

None

Version,Alert

fromDateTime

ISO-8601 datetime (inclusive)

No

None

2010-12-25T23:59:59+0100

toDateTime

ISO-8601 datetime (inclusive)

No

None

2010-12-25T23:59:59+0100

fromDate

Date (inclusive)

No

None

2010-12-25

toDate

Date (inclusive)

No

None

2010-12-25

format

Response format can be set through:

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