Common Headers#

The Squirro services are standard HTTP REST services.

The following table lists the common Request Headers that the Squirro web services use.




Set to the login information of a Squirro user. This header is necessary in all requests, except where otherwise noted.

See Authentication for usage information.


Specify the return format of a request.

Valid values are:

  • application/json - Returns the content in JSON. This is the recommended format.

  • text/xml - Returns the content in XML format. This output format is not actively supported.


In POST and PUT request, when data is sent in as JSON, then the Content-Type header needs to be specified as application/json. Each resource documents whether its input is form data or JSON input.