Table of Contents

Get a List of Events

Description	Get a list of events from a project or a list of global events
URL	/api/events
HTTP Method	GET
Response Formats	json \| xml
Security	Requires User role to get the list of events for a specific project Requires Global Administrator role to get the list of global events

Use Case	Example Request
Get all the versions from project Sonar (key = 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 Sonar (key = org.codehaus.sonar:sonar) between January 1^st, 2012 and August 31^st, 2012	GET http://nemo.sonarsource.org/api/events?resource=org.codehaus.sonar:sonar&categories=Alert,Version&fromDate=2012-01-01&toDate=2012-08-31
Get global events from October 8^th, 2012	GET http://localhost:9000/api/events?fromDate=2012-10-08

JSON

Parameter	Description	Required	Default Value	Example Value
resource	id or key of the project	No	Get global events if not set	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. Possible values: xml \| json	No	None	json

Create an Event

Description	Create an event
URL	/api/events
HTTP Method	POST
Security	Requires Project Administrator role

Create an event on project Sonar (key = org.codehaus.sonar:sonar) with administrator admin/admin:
- Category: Alert
- Name: myAlertName
- Description: myAlertDescription

Parameter	Description	Required	Default Value	Value
resource	id or key of the project	Yes	None	org.codehaus.sonar:sonar
category	Event category	Yes	None	Alert
name	Event name	Yes	None
description	Event description	No	None