settings/overlayicon

A list of details for the overlay icon. For information about overlay icons, see Uploading and retrieving overlay icons.

GET

Returns an array of all settings associated with the overlay icon.

Example request

Request

CODE

curl -b c.txt -c c.txt -X GET https://bc.qwe.com/mocana-app-control/rest/settings/overlayicon

Response

CODE

{
  "message": "", 
  "settings": [{
    "blob_data": "https://bc.qwe.com/mocana-app-control/rest/files/df840df6-2771-4b5b-8742-ceb765b9d509",
    "blob_hash": "df840df6-2771-4b5b-8742-ceb765b9d509", 
    "code": "OPT_CODE_OVERLAY_ICON_CUSTOM", 
    "string_data": "48x48" 
  }]
  "status": "OK" 
}

POST

Uploads a PNG file to use as an overlay icon.

Parameters

Parameter

Description

PNG

Required. The binary data for the PNG file you want to use. The file must be sent as raw multipart data.

In the request (in cURL) below: --data-binary @assets/qwe_logo.png

filename

Optional. The name to give the icon. This name is used when you download the overlay icon from the policy console. Unlike most other POST parameters, the filename must be appended to the URL in your request.

In the example below: ...settings/overlayicon?filename=icon.png

Example request

Request

CODE

curl --data-binary @assets/qwe_logo.png -L -b c.txt -c c.txt -X POST \
 https://bc.qwe.com/mocana-app-control/rest/settings/overlayicon?filename=icon.png

Response

CODE

{
  "message": "", 
  "settings": [{
    "blob_data": "https://bc.qwe.com/mocana-app-control/rest/files/b8458fff-4bbd-4cc3-a193-d22a07d56b50",
    "blob_hash": "b8458fff-4bbd-4cc3-a193-d22a07d56b50",
    "code": "OPT_CODE_OVERLAY_ICON_CUSTOM",
    "string_data": "32x32" 
  }],
  "status": "OK"
}

DELETE

Removes any custom overlay icon you've uploaded.

When there's no custom overlay icon in the system, the policy console applies the default overlay when securing an app.

Example request

Request

CODE

curl -v -L -b c.txt -c c.txt -X DELETE https://bc.qwe.com/mocana-app-control/rest/settings/overlayicon

Response

CODE

{
  "message": "",
  "settings": [{
    "blob_data": "https://bc.qwe.com/mocana-app-control/rest/files/1812138b-3334-4dd7-b273-952bcce5a1ff",
    "blob_hash": "1812138b-3334-4dd7-b273-952bcce5a1ff",
    "code": "OPT_CODE_OVERLAY_ICON_DEFAULT", 
    "string_data": "48x48" 
  }],
  "status": "OK"
}