Get Logo
Obtain the configured logo that is shown to users. By default logo-main.png is returned, which is the logo that is displayed in the header.
GET https://instance.securid.com/aveksa/command.submit?cmd=getLogo
tip
Any image that has been uploaded via Admin > User Interface > Files can be retrieved using this API.
Request
Parameters
| getLogo | |
| format | properties - (Default) key=value. most useful when requesting a single object. If multiple objects are returned, values is a csv. ie key=value1,value2,value3 where value1 is the value for the first object, value2 is the value for the 2nd object, etc.json - Useful format for parsing into javascript or other languages. See www.json.org for details. |
| name | The name of the logo to return. (Default) logo-main.png |
Headers
Bearer token | |
| Accept | application/json |
| Content-Type | application/json |
Response
Parameters
Binary image representing the requested logo (Content-Type : image/png).
Examples
Request
- Curl
- Python
- Node.js
curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=getLogo&format=json&name=logo-main.png" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-o logo-main.png
import requests
url = "https://instance.securid.com/aveksa/command.submit"
params = {
"cmd": "getLogo",
"format": "json",
"name": "logo-main.png"
}
headers = {
'Authorization': 'Bearer <token>',
'Content-Type': 'application/json'
}
response = requests.get(url, params=params, headers=headers)
if response.status_code == 200:
content_type = response.headers.get('Content-Type')
if content_type == 'image/png':
image_data = response.content
with open('logo-main.png', 'wb') as f:
f.write(image_data)
print("Image saved to 'logo-main.png'")
else:
print("Response does not contain PNG image data.")
else:
print(f"Request failed with status code {response.status_code}")
const axios = require('axios');
const fs = require('fs');
const url = "https://instance.securid.com/aveksa/command.submit";
const params = {
cmd: "getLogo",
format: "json",
name: "logo-main.png"
};
const headers = {
'Authorization': 'Bearer <token>',
'Content-Type': 'application/json'
};
axios.get(url, { params, headers, responseType: 'arraybuffer' })
.then(response => {
if (response.status === 200) {
const content_type = response.headers['content-type'];
if (content_type === 'image/png') {
const image_data = response.data;
fs.writeFileSync('logo-main.png', image_data, 'binary');
console.log("Image saved to 'logo-main.png'");
} else {
console.log("Response does not contain PNG image data.");
}
} else {
console.log(`Request failed with status code ${response.status}`);
}
})
.catch(error => {
console.error('Error:', error);
});
Response
- 200
- 412 Invalid Parameters
Binary image data
<html>
<head>
<title>Error</title>
</head>
<body>Logo named 'img' could not be found. Query String=cmd=getLogo&format=json&name=saad</body>
</html>