site/functions (GET)
Overview
Get list of available extensions
- REST Method: GET
- Method Access: public
Query Parameters
| Name | Type | Description |
| authenticate | bool? | Force authentication for request (default: false) |
| format | {html, body, xml}? | output format (default: html) |
Return Codes
| Name | Value | Description |
| OK | 200 | The request completed successfully |
| Bad Request | 400 | Invalid input parameter or request body |
| Forbidden | 403 | User must be logged in |
Message Format
Output:
Content-type=text/plain if format=body is specfied
Content-type=text/html if format=html is specfied
Implementation Notes
A function is a service feature that is enabled through the editor.
C# Code Sample: Retrieve Extensions List
The following code example retrieves an html document with all registered extensions on the site:
Sample Code
Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
p.At("site", "functions").Get(); Curl Code Sample: Retrieve Extensions List
The following command outputs a list of all available built in functions and registered extensions:
Sample Code
curl -u admin:password -i http://mindtouch.address/@api/deki/site/functions
Implementation notes
curl flags
- -u
- Provides external user authentication.
- -i
- Outputs the HTTP response headers. Useful for debugging.
Permissions
- ADMIN permission is required to execute above command.