New Awasu API entry points

This page lists the new API entry points added in Awasu 3.0.1.

General

$/stats
Returns information about Awasu.
Parameters:
format (f)Format to return the results in (xml|json|html).
The default format is xml.
quietFlags if a quiet response (HTTP 204) should be returned (off by default).
A "HTTP 204 No Response" will cause most browsers to stay on the current page, allowing links to be clicked with no visible effect.
outputFile (of)File to store the response in.
This parameter refers to a file on the machine that Awasu is running on. It is intended for use by calls made via the awasu:// protocol since there is no other way to return a response.
tokenAPI token.
This parameter must match what has been configured in the Advanced page of Awasu's Program Options.
$/userInfo
Returns information about the user account Awasu is running under.
Parameters:
format (f)Format to return the results in (xml|json|html).
The default format is xml.
quietFlags if a quiet response (HTTP 204) should be returned (off by default).
A "HTTP 204 No Response" will cause most browsers to stay on the current page, allowing links to be clicked with no visible effect.
outputFile (of)File to store the response in.
This parameter refers to a file on the machine that Awasu is running on. It is intended for use by calls made via the awasu:// protocol since there is no other way to return a response.
tokenAPI token.
This parameter must match what has been configured in the Advanced page of Awasu's Program Options.
$/logs/activity
Returns the Awasu activity log.
Parameters:
lines (l) Controls the maximum number of lines to return (optional).
quietFlags if a quiet response (HTTP 204) should be returned (off by default).
A "HTTP 204 No Response" will cause most browsers to stay on the current page, allowing links to be clicked with no visible effect.
outputFile (of)File to store the response in.
This parameter refers to a file on the machine that Awasu is running on. It is intended for use by calls made via the awasu:// protocol since there is no other way to return a response.
tokenAPI token.
This parameter must match what has been configured in the Advanced page of Awasu's Program Options.
$/logs/error
Returns the Awasu error log.
This entry point is not available in Awasu Server.
Parameters:
lines (l) Controls the maximum number of lines to return (optional).
quietFlags if a quiet response (HTTP 204) should be returned (off by default).
A "HTTP 204 No Response" will cause most browsers to stay on the current page, allowing links to be clicked with no visible effect.
outputFile (of)File to store the response in.
This parameter refers to a file on the machine that Awasu is running on. It is intended for use by calls made via the awasu:// protocol since there is no other way to return a response.
tokenAPI token.
This parameter must match what has been configured in the Advanced page of Awasu's Program Options.

Channels

$/channels/cleanup
Returns channels that are eligible for cleanup.
Parameters:
expired (x) Controls whether or not to include channels that have expired.
error (e) Controls whether or not to include channels that have had too many update errors.
dormant (d) Specifies the number of days a channel can go without receiving new content before it is considered dormant (defaults to 30).
allowDups (dup) Controls whether or not channels can be included in more than one cleanup list (on by default).
format (f)Format to return the results in (xml|json|html).
The default format is xml.
quietFlags if a quiet response (HTTP 204) should be returned (off by default).
A "HTTP 204 No Response" will cause most browsers to stay on the current page, allowing links to be clicked with no visible effect.
outputFile (of)File to store the response in.
This parameter refers to a file on the machine that Awasu is running on. It is intended for use by calls made via the awasu:// protocol since there is no other way to return a response.
tokenAPI token.
This parameter must match what has been configured in the Advanced page of Awasu's Program Options.
$/channels/errors
Returns the error log for one or more channels.
Parameters:
idComma-separated list of channel ID's.
Use * to open all channels.
name (n)Comma-separated list of channel names.
Use * to open all channels. Enable the regex switch to use regular expressions.
filterComma-separated list of channel filter names.
Enable the regex switch to use regular expressions.
regex (re)Flags if channel names and channel filter names should be interpreted as regular expressions (off by default).
Special characters such as , and & can be hex-encoded e.g. \x2C or \x26 respectively).
folderIdComma-separated list of channel folder ID's.
folderNameComma-separated list of channel folder names.
subFoldersFlags if channels in sub-folders of a targeted folder should be returned (off by default).
Only applies to the folderId and folderName parameters.
format (f)Format to return the results in (xml|json).
The default format is xml.
quietFlags if a quiet response (HTTP 204) should be returned (on by default).
A "HTTP 204 No Response" will cause most browsers to stay on the current page, allowing links to be clicked with no visible effect.
outputFile (of)File to store the response in.
This parameter refers to a file on the machine that Awasu is running on. It is intended for use by calls made via the awasu:// protocol since there is no other way to return a response.
tokenAPI token.
This parameter must match what has been configured in the Advanced page of Awasu's Program Options.
$/channels/folders/tree
Returns the channel folder tree.
Parameters:
format (f)Format to return the results in (xml|json).
The default format is xml.
quietFlags if a quiet response (HTTP 204) should be returned (off by default).
A "HTTP 204 No Response" will cause most browsers to stay on the current page, allowing links to be clicked with no visible effect.
outputFile (of)File to store the response in.
This parameter refers to a file on the machine that Awasu is running on. It is intended for use by calls made via the awasu:// protocol since there is no other way to return a response.
tokenAPI token.
This parameter must match what has been configured in the Advanced page of Awasu's Program Options.
$/channels/folders/create
Creates a new channel folder.
Parameters:
name (n) The name of the new channel folder.
parent (p) The GUID of the parent folder (optional).
after (a) The GUID of the folder to insert the new folder after (optional).
format (f)Format to return the results in (xml|json|html).
The default format is xml.
quietFlags if a quiet response (HTTP 204) should be returned (off by default).
A "HTTP 204 No Response" will cause most browsers to stay on the current page, allowing links to be clicked with no visible effect.
outputFile (of)File to store the response in.
This parameter refers to a file on the machine that Awasu is running on. It is intended for use by calls made via the awasu:// protocol since there is no other way to return a response.
tokenAPI token.
This parameter must match what has been configured in the Advanced page of Awasu's Program Options.
$/channels/folders/delete
Deletes a channel folder.
Parameters:
id The GUID of the channel folder to delete.
format (f)Format to return the results in (xml|json|html).
The default format is xml.
quietFlags if a quiet response (HTTP 204) should be returned (off by default).
A "HTTP 204 No Response" will cause most browsers to stay on the current page, allowing links to be clicked with no visible effect.
outputFile (of)File to store the response in.
This parameter refers to a file on the machine that Awasu is running on. It is intended for use by calls made via the awasu:// protocol since there is no other way to return a response.
tokenAPI token.
This parameter must match what has been configured in the Advanced page of Awasu's Program Options.

Workpads

$/workpads/create
Creates a new workpad.
The workpad configuration must be passed in as the POST data. The format is the same as that returned by $/workpads/list.
Parameters:
format (f)Format to return the results in (xml|json|html).
The default format is xml.
quietFlags if a quiet response (HTTP 204) should be returned (off by default).
A "HTTP 204 No Response" will cause most browsers to stay on the current page, allowing links to be clicked with no visible effect.
outputFile (of)File to store the response in.
This parameter refers to a file on the machine that Awasu is running on. It is intended for use by calls made via the awasu:// protocol since there is no other way to return a response.
tokenAPI token.
This parameter must match what has been configured in the Advanced page of Awasu's Program Options.
$/workpads/update
Updates the configuration for workpads.
The workpad configuration must be passed in as the POST data. The format is the same as that returned by $/workpads/list.
Parameters:
idComma-separated list of workpad ID's.
Use * to update all workpads or @ for the default workpad.
name (n)Comma-separated list of workpad names.
Use * to update all workpads or @ for the default workpad. Enable the regex switch to use regular expressions.
regex (re)Flags if workpad names should be interpreted as regular expressions (off by default).
Special characters such as , and & can be hex-encoded e.g. \x2C or \x26 respectively).
format (f)Format to return the results in (xml|json).
The default format is xml.
quietFlags if a quiet response (HTTP 204) should be returned (off by default).
A "HTTP 204 No Response" will cause most browsers to stay on the current page, allowing links to be clicked with no visible effect.
outputFile (of)File to store the response in.
This parameter refers to a file on the machine that Awasu is running on. It is intended for use by calls made via the awasu:// protocol since there is no other way to return a response.
tokenAPI token.
This parameter must match what has been configured in the Advanced page of Awasu's Program Options.
$/workpads/delete
Deletes workpads.
Parameters:
idComma-separated list of workpad ID's.
Use * to delete all workpads or @ for the default workpad.
name (n)Comma-separated list of workpad names.
Use * to delete all workpads or @ for the default workpad. Enable the regex switch to use regular expressions.
regex (re)Flags if workpad names should be interpreted as regular expressions (off by default).
Special characters such as , and & can be hex-encoded e.g. \x2C or \x26 respectively).
format (f)Format to return the results in (xml|json).
The default format is xml.
quietFlags if a quiet response (HTTP 204) should be returned (off by default).
A "HTTP 204 No Response" will cause most browsers to stay on the current page, allowing links to be clicked with no visible effect.
outputFile (of)File to store the response in.
This parameter refers to a file on the machine that Awasu is running on. It is intended for use by calls made via the awasu:// protocol since there is no other way to return a response.
tokenAPI token.
This parameter must match what has been configured in the Advanced page of Awasu's Program Options.