Articles on: Kiosk Browser Remote Management - REST API

API Endpoint: Profile

A Profile stores all Kiosk Browser related settings within Remote Management.

GET
/api/profile - get all profiles on account
/api/profile/1 - get profile with id of 1

PATCH
/api/profile/1 - patch (update) profile with id of 1

When using PATCH only the supplied values are updated. If for example you supply no value for the device name, it will not change within remote management. Include json in the request body as per examples below:

Properties: kioskurl (string), filegroupid (integer optional if set to zero an existing filegroup link will be removed)

{\"kioskurl\":\"http://www.google.com\"}
{\"kioskurl\":\"http://www.google.com\",\"filegroupid\": 1}

When the Url is changed, the change is automatically pushed to all devices using the profile.

POST
/api/profile - create profile (copy from existing profile), include json in the request body as per below:
{\"templateprofileid\":1,\"name\":\"My Profile\",\"description\":\"My Profile Description\"}

Updated on: 06/05/2018

Was this article helpful?

Share your feedback

Cancel

Thank you!