New Awasu API entry points
This page lists the new API entry points added in Awasu 3.0.1.
General
Returns information about Awasu.
Parameters:
| format (f) | Format to return the results in (xml|json|html). The default format is xml. |
| quiet | Flags 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. |
| token | API token. This parameter must match what has been configured in the Advanced page of Awasu's Program Options. |
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. |
| quiet | Flags 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. |
| token | API token. This parameter must match what has been configured in the Advanced page of Awasu's Program Options. |
Returns the Awasu activity log.
Parameters:
| lines (l) |
Controls the maximum number of lines to return (optional). |
| quiet | Flags 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. |
| token | API token. This parameter must match what has been configured in the Advanced page of Awasu's Program Options. |
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). |
| quiet | Flags 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. |
| token | API token. This parameter must match what has been configured in the Advanced page of Awasu's Program Options. |
Channels
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. |
| quiet | Flags 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. |
| token | API token. This parameter must match what has been configured in the Advanced page of Awasu's Program Options. |
Returns the error log for one or more channels.
Parameters:
| id | Comma-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. |
| filter | Comma-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). |
| folderId | Comma-separated list of channel folder ID's. |
| folderName | Comma-separated list of channel folder names. |
| subFolders | Flags 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. |
| quiet | Flags 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. |
| token | API token. This parameter must match what has been configured in the Advanced page of Awasu's Program Options. |
Returns the channel folder tree.
Parameters:
| format (f) | Format to return the results in (xml|json). The default format is xml. |
| quiet | Flags 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. |
| token | API token. This parameter must match what has been configured in the Advanced page of Awasu's Program Options. |
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. |
| quiet | Flags 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. |
| token | API token. This parameter must match what has been configured in the Advanced page of Awasu's Program Options. |
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. |
| quiet | Flags 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. |
| token | API token. This parameter must match what has been configured in the Advanced page of Awasu's Program Options. |
Workpads
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. |
| quiet | Flags 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. |
| token | API token. This parameter must match what has been configured in the Advanced page of Awasu's Program Options. |
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:
| id | Comma-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. |
| quiet | Flags 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. |
| token | API token. This parameter must match what has been configured in the Advanced page of Awasu's Program Options. |
Deletes workpads.
Parameters:
| id | Comma-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. |
| quiet | Flags 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. |
| token | API token. This parameter must match what has been configured in the Advanced page of Awasu's Program Options. |
|
