Get a List of Favourites

DescriptionGet the logged in user's list of favourites

URL

/api/favourites

HTTP MethodGET
Response Formatsjson | xml

Security

Authentication required

Examples

Use CaseExample Request
Get the logged in user's list of favourites

GET http://localhost:9000/api/favourites

Parameters

Parameter

Description

Required

Default ValueExample Value
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

Create a Favourite

 

DescriptionCreate a favourite

URL

/api/favourites

HTTP MethodPOST

Security

Authentication required

Examples

Use CaseExample Request
Create a favourite on project Sonar (key = org.codehaus.sonar:sonar) for the user admin/admin

curl -u admin:admin -d "key=org.codehaus.sonar:sonar" http://localhost:9000/api/favourites

Parameters

Parameter

Description

Required

Default Value

Example Value

key

id or key of the resource

Yes

None

org.codehaus.sonar:sonar

Delete a Favourite

 

DescriptionDelete a favourite

URL

/api/favourites/:key

HTTP MethodDELETE

Security

Authentication required

Examples

Use CaseExample Request
Delete the favourite flag on project Sonar (key =  org.codehaus.sonar:sonar) for the user admin/admin

curl -u admin:admin -X DELETE http://localhost:9000/api/favourites/org.codehaus.sonar:sonar

 

Parameters

Parameter

Description

Required

Default Value

Example Value

key

id or key of the resource

Yes

None

org.codehaus.sonar:sonar