site/logo.png (GET)
Overview
Retrieve the site logo image
- REST Method: GET
- Method Access: public
Query Parameters
| Name | Type | Description |
| authenticate | bool? | Force authentication for request (default: false) |
| default | string? | Absolute uri for default image |
Implementation Notes
The Content-Disposition, Content-Length, and Content-Type headers provide information about the retrieved file. You can also use GET:site/logo to get the same response as it has the same endpoint.
Use PUT:site/logo.png to set the site logo.
C# Code Sample: Retrieve Site Logo
The following code example retrieves the site logo and saves it in the caller's temporary directory:
Sample Code
Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
DreamMessage msg = p.At("site", "logo").Get();
using (FileStream fs = System.IO.File.OpenWrite(Path.GetTempPath() + msg.ContentDisposition.FileName))
{
byte[] fileData = msg.AsBytes();
fs.Write(fileData, 0, fileData.Length);
} Curl Code Sample: Retrieve Site Logo
The following command retrieves the site logo image:
Sample Code
curl -u username:password -i http://mindtouch.address/@api/deki/site/log
Implementation notes
curl flags
- -u
- Provides external user authentication.
- -i
- Outputs the HTTP response headers. Useful for debugging.
Response
- Note that an image is returned. If the output is not directed somewhere, a bunch of junk will be printed in console.