Blueprints API

APIs to manage blueprints. Learn more about blueprints.

Retrieve all blueprints

Request

query Parameters

ordering	string Order the results by a specific field (-field for descending order), Combine Multiple with , like -created_at,-updated_at.
name	string Filter the results by name, case insensitive
name_exact	string Filter the results by name, case sensitive and matches exact name
settings__android__app_id	string <uuid> List the blueprints which have given app_id in any of the versions for android apps.
settings__android__app_version_id	string <uuid> List the blueprints which have given app_version_id in any of the versions for android apps.
settings__ios__app_id	string <uuid> List the blueprints which have given app_id in any of the versions for ios apps.
settings__ios__app_version_id	string <uuid> List the blueprints which have given app_version_id in any of the versions for ios apps.
settings__android__file_id	string <uuid> List the blueprints which have given file_id in any of the versions.
settings__android__wifi_network_id	string <uuid> List the blueprints which have given wifi_network_id in any of the versions.

Responses

200

Success

get/v2/blueprints/

Request samples

curl

Response samples

application/json

{"content": {"count": 0,
"next": "string",
"previous": "string",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"comments": "string",
"version_number": 0,
"version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",
"minor_version_number": 0,
"publish": true,
"settings": {"android": {"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"launcher_settings": {"apply_policy": "ALWAYS APPLY",
"launcher": "ESPER"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"app_permission_policy_settings": {"apply_policy": "ALWAYS APPLY",
"permission_policy": "ALLOW AUTOMATICALLY"
},
"wifi_settings": {"apply_policy": "ALWAYS APPLY",
"allow_wifi": true,
"wifi_state": "ENABLE"
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"allow_bluetooth": true,
"bluetooth_state": "ENABLE"
},
"sms_settings": {"apply_policy": "ALWAYS APPLY",
"allow_sms": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"incoming_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allowed_numbers": [null
],
"tags": [null
]
},
"outgoing_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allow_ussd_codes": false,
"allowed_numbers": [null
],
"tags": [null
]
},
"ethernet_settings": {"apply_policy": "ALWAYS APPLY",
"auth_mode": "NONE",
"ca_cert_alias": "string",
"client_cert_alias": "string",
"eap_identity": "string"
},
"adb_settings": {"apply_policy": "ALWAYS APPLY",
"allow_adb": true
},
"safe_boot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_safe_boot": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screen_timeout_settings": {"apply_policy": "ALWAYS APPLY",
"screentimeout_value": 0
},
"lock_screen_settings": {"apply_policy": "ALWAYS APPLY",
"password_quality": "NONE",
"minimum_password_length": 0,
"allow_keyguard": true
},
"brightness_settings": {"apply_policy": "ALWAYS APPLY",
"brightness_value": "string"
},
"screen_orientation_settings": {"apply_policy": "ALWAYS APPLY",
"orientation_type": "PORTRAIT"
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"notification_bar_settings": {"apply_policy": "ALWAYS APPLY",
"allow_notification_bar": true
},
"wallpaper_settings": {"homescreen": {"apply_policy": null,
"portrait": { },
"landscape": { }
},
"lockscreen": {"apply_policy": null,
"portrait": { }
}
},
"esper_settings_apps_settings": {"apply_policy": "ALWAYS APPLY",
"allow_dock": true,
"admin_mode_password": "string",
"allow_esper_settings_app": true,
"settings": {"flashlight": null,
"wifi": null,
"auto_rotation": null,
"reboot": null,
"clear_app_data": null,
"kiosk_app_selection": null,
"esper_branding": null,
"factory_reset": null,
"about": null,
"display": null,
"sound": null,
"keyboard": null,
"input_selection": null,
"accessibility": null,
"accessibility_reset_to_default": null,
"accessibility_high_contrast_text": null,
"accessibility_cc_deuteranomaly": null,
"accessibility_cc_protanomaly": null,
"accessibility_cc_tritanomaly": null,
"accessibility_mono_audio": null,
"accessibility_display_size": null,
"accessibility_talkback": null,
"accessibility_text_to_speech": null,
"mobile_data": null,
"bluetooth": null,
"language": null,
"time_and_date": null,
"storage": null,
"data_roaming": null,
"wifi_tethering": null,
"airplane_mode": null
}
},
"android_settings_app_settings": {"apply_policy": "ALWAYS APPLY",
"allow_android_settings_app": true
},
"customized_device_level_json_settings": {"apply_policy": "ALWAYS APPLY",
"customized_json": { }
},
"google_services_settings": {"afw_account_settings": {"apply_policy": null,
"allow_afw_account_addition": null
},
"personal_accounts_settings": {"apply_policy": null,
"personal_accounts_limit_value": null
},
"play_store_settings": {"apply_policy": null,
"allow_playstore": null
},
"google_assitant_settings": {"apply_policy": null,
"allow_google_assistant": null
},
"factory_reset_protection_settings": {"apply_policy": null,
"google_id": null,
"email": null
}
},
"external_device_settings": {"apply_policy": "ALWAYS APPLY",
"allow_external_device_mount": true
},
"usb_tethering_settings": {"apply_policy": "ALWAYS APPLY",
"allow_usb_tethering": true
},
"file_transfer_settings": {"apply_policy": "ALWAYS APPLY",
"allow_file_transfer": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"location_settings": {"apply_policy": "ALWAYS APPLY",
"allow_location": true
},
"sound_settings": {"alarm_settings": {"apply_policy": null,
"alarm_volume": null
},
"music_settings": {"apply_policy": null,
"music_volume": null
},
"ringtone_settings": {"apply_policy": null,
"ringtone_volume": null
},
"notification_settings": {"apply_policy": null,
"notification_volume": null
},
"voice_call_settings": {"apply_policy": null,
"voice_call_volume": null
}
},
"system_updates_settings": {"apply_policy": "ALWAYS APPLY",
"system_update_policy_type": "UPDATE AUTOMATICALLY",
"maintenance_start": "string",
"maintenance_end": "string"
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"allow_edit_time_date": true
},
"timezone_settings": {"apply_policy": "ALWAYS APPLY",
"timezone": "string"
},
"langauge_settings": {"apply_policy": "ALWAYS APPLY",
"device_locale": "string"
},
"strict_wifi_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_wifi_synchronization": true
},
"strict_app_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_app_synchronization": true
},
"apps": [{"app_id": null,
"app_version_id": null,
"package_name": null,
"installation_rule": null,
"state": null,
"managed_config": { },
"type": null,
"auto_update_mode": null
}
],
"files": [{"file_id": null,
"destination_path": null
}
],
"wifi_networks": [{"wifi_network_id": null,
"certificate_file_path": null,
"certificate_file_password": null
}
],
"saved_ap_settings": {"apply_policy": "ALWAYS APPLY",
"use_only_saved_ap": true
},
"mac_address_randomization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_mac_address_randomization": true
}
},
"ios": {"kiosk_app": {"app_id": "string",
"app_type": "VPP"
},
"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"edit_bluetooth": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"custom_device_level_profile_settings": {"apply_policy": "ALWAYS APPLY",
"custom_profile": "string"
},
"siri_settings": {"apply_policy": "ALWAYS APPLY",
"allow_siri": true
},
"tethering_settings": {"apply_policy": "ALWAYS APPLY",
"edit_hotspot": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"hide_preloaded_apps_settings": {"apply_policy": "ALWAYS APPLY",
"hide_preloaded_apps": true
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"force_automatic_time_date": false
},
"wifi_networks": [{"wifi_network_id": null
}
],
"apps": [{"app_id": null,
"app_version_id": null,
"state": null,
"app_type": null
}
],
"wallpaper_settings": {"homescreen": {"apply_policy": null,
"portrait": { }
},
"lockscreen": {"apply_policy": null,
"portrait": { }
}
},
"web_content_settings": {"apply_policy": "ALWAYS APPLY",
"url_blocklist": [null
],
"url_allowlist": [null
]
},
"defer_os_updates": {"apply_policy": "ALWAYS APPLY",
"defer_os_updates_delay": 90
}
}
},
"created_by": "string",
"updated_by": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"message": "string",
"code": 0
}
}

Create a new blueprint

Request

Request Body schema: application/json

name	string Name of the blueprint
description	string Description of the blueprint
comments	string Comments on the blueprint
	object (settingsV2)

Responses

201

Success

400

Bad Request

post/v2/blueprints/

Request samples

Payload
curl

application/json

{"name": "string",
"description": "string",
"comments": "string",
"settings": {"android": {"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"launcher_settings": {"apply_policy": "ALWAYS APPLY",
"launcher": "ESPER"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"app_permission_policy_settings": {"apply_policy": "ALWAYS APPLY",
"permission_policy": "ALLOW AUTOMATICALLY"
},
"wifi_settings": {"apply_policy": "ALWAYS APPLY",
"allow_wifi": true,
"wifi_state": "ENABLE"
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"allow_bluetooth": true,
"bluetooth_state": "ENABLE"
},
"sms_settings": {"apply_policy": "ALWAYS APPLY",
"allow_sms": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"incoming_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allowed_numbers": ["string"
],
"tags": ["string"
]
},
"outgoing_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allow_ussd_codes": false,
"allowed_numbers": ["string"
],
"tags": ["string"
]
},
"ethernet_settings": {"apply_policy": "ALWAYS APPLY",
"auth_mode": "NONE",
"ca_cert_alias": "string",
"client_cert_alias": "string",
"eap_identity": "string"
},
"adb_settings": {"apply_policy": "ALWAYS APPLY",
"allow_adb": true
},
"safe_boot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_safe_boot": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screen_timeout_settings": {"apply_policy": "ALWAYS APPLY",
"screentimeout_value": 0
},
"lock_screen_settings": {"apply_policy": "ALWAYS APPLY",
"password_quality": "NONE",
"minimum_password_length": 0,
"allow_keyguard": true
},
"brightness_settings": {"apply_policy": "ALWAYS APPLY",
"brightness_value": "string"
},
"screen_orientation_settings": {"apply_policy": "ALWAYS APPLY",
"orientation_type": "PORTRAIT"
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"notification_bar_settings": {"apply_policy": "ALWAYS APPLY",
"allow_notification_bar": true
},
"wallpaper_settings": {"homescreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
},
"landscape": {"wallpaper_id": "string"
}
},
"lockscreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
}
},
"esper_settings_apps_settings": {"apply_policy": "ALWAYS APPLY",
"allow_dock": true,
"admin_mode_password": "string",
"allow_esper_settings_app": true,
"settings": {"flashlight": "NONE",
"wifi": "NONE",
"auto_rotation": "NONE",
"reboot": "NONE",
"clear_app_data": "NONE",
"kiosk_app_selection": "NONE",
"esper_branding": "NONE",
"factory_reset": "NONE",
"about": "NONE",
"display": "NONE",
"sound": "NONE",
"keyboard": "NONE",
"input_selection": "NONE",
"accessibility": "NONE",
"accessibility_reset_to_default": "NONE",
"accessibility_high_contrast_text": "NONE",
"accessibility_cc_deuteranomaly": "NONE",
"accessibility_cc_protanomaly": "NONE",
"accessibility_cc_tritanomaly": "NONE",
"accessibility_mono_audio": "NONE",
"accessibility_display_size": "NONE",
"accessibility_talkback": "NONE",
"accessibility_text_to_speech": "NONE",
"mobile_data": "NONE",
"bluetooth": "NONE",
"language": "NONE",
"time_and_date": "NONE",
"storage": "NONE",
"data_roaming": "NONE",
"wifi_tethering": "NONE",
"airplane_mode": "NONE"
}
},
"android_settings_app_settings": {"apply_policy": "ALWAYS APPLY",
"allow_android_settings_app": true
},
"customized_device_level_json_settings": {"apply_policy": "ALWAYS APPLY",
"customized_json": { }
},
"google_services_settings": {"afw_account_settings": {"apply_policy": "ALWAYS APPLY",
"allow_afw_account_addition": true
},
"personal_accounts_settings": {"apply_policy": "ALWAYS APPLY",
"personal_accounts_limit_value": 0
},
"play_store_settings": {"apply_policy": "ALWAYS APPLY",
"allow_playstore": true
},
"google_assitant_settings": {"apply_policy": "ALWAYS APPLY",
"allow_google_assistant": true
},
"factory_reset_protection_settings": {"apply_policy": "ALWAYS APPLY",
"google_id": "string",
"email": "string"
}
},
"external_device_settings": {"apply_policy": "ALWAYS APPLY",
"allow_external_device_mount": true
},
"usb_tethering_settings": {"apply_policy": "ALWAYS APPLY",
"allow_usb_tethering": true
},
"file_transfer_settings": {"apply_policy": "ALWAYS APPLY",
"allow_file_transfer": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"location_settings": {"apply_policy": "ALWAYS APPLY",
"allow_location": true
},
"sound_settings": {"alarm_settings": {"apply_policy": "ALWAYS APPLY",
"alarm_volume": 0
},
"music_settings": {"apply_policy": "ALWAYS APPLY",
"music_volume": 0
},
"ringtone_settings": {"apply_policy": "ALWAYS APPLY",
"ringtone_volume": 0
},
"notification_settings": {"apply_policy": "ALWAYS APPLY",
"notification_volume": 0
},
"voice_call_settings": {"apply_policy": "ALWAYS APPLY",
"voice_call_volume": 0
}
},
"system_updates_settings": {"apply_policy": "ALWAYS APPLY",
"system_update_policy_type": "UPDATE AUTOMATICALLY",
"maintenance_start": "string",
"maintenance_end": "string"
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"allow_edit_time_date": true
},
"timezone_settings": {"apply_policy": "ALWAYS APPLY",
"timezone": "string"
},
"langauge_settings": {"apply_policy": "ALWAYS APPLY",
"device_locale": "string"
},
"strict_wifi_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_wifi_synchronization": true
},
"strict_app_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_app_synchronization": true
},
"apps": [{"app_id": "string",
"app_version_id": "string",
"package_name": "string",
"installation_rule": "POST PROVISIONING",
"state": "SHOW",
"managed_config": { },
"type": "PRELOADED",
"auto_update_mode": "autoUpdateDefault"
}
],
"files": [{"file_id": "string",
"destination_path": "string"
}
],
"wifi_networks": [{"wifi_network_id": "string",
"certificate_file_path": "/storage/emulated/0/Documents",
"certificate_file_password": "abc"
}
],
"saved_ap_settings": {"apply_policy": "ALWAYS APPLY",
"use_only_saved_ap": true
},
"mac_address_randomization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_mac_address_randomization": true
}
},
"ios": {"kiosk_app": {"app_id": "string",
"app_type": "VPP"
},
"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"edit_bluetooth": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"custom_device_level_profile_settings": {"apply_policy": "ALWAYS APPLY",
"custom_profile": "string"
},
"siri_settings": {"apply_policy": "ALWAYS APPLY",
"allow_siri": true
},
"tethering_settings": {"apply_policy": "ALWAYS APPLY",
"edit_hotspot": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"hide_preloaded_apps_settings": {"apply_policy": "ALWAYS APPLY",
"hide_preloaded_apps": true
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"force_automatic_time_date": false
},
"wifi_networks": [{"wifi_network_id": "string"
}
],
"apps": [{"app_id": "string",
"app_version_id": "string",
"state": "SHOW",
"app_type": "VPP"
}
],
"wallpaper_settings": {"homescreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
},
"lockscreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
}
},
"web_content_settings": {"apply_policy": "ALWAYS APPLY",
"url_blocklist": ["string"
],
"url_allowlist": ["string"
]
},
"defer_os_updates": {"apply_policy": "ALWAYS APPLY",
"defer_os_updates_delay": 90
}
}
}
}

Response samples

application/json

{"content": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"comments": "string",
"version_number": 0,
"version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",
"minor_version_number": 0,
"publish": true,
"settings": {"android": {"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"launcher_settings": {"apply_policy": "ALWAYS APPLY",
"launcher": "ESPER"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"app_permission_policy_settings": {"apply_policy": "ALWAYS APPLY",
"permission_policy": "ALLOW AUTOMATICALLY"
},
"wifi_settings": {"apply_policy": "ALWAYS APPLY",
"allow_wifi": true,
"wifi_state": "ENABLE"
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"allow_bluetooth": true,
"bluetooth_state": "ENABLE"
},
"sms_settings": {"apply_policy": "ALWAYS APPLY",
"allow_sms": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"incoming_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allowed_numbers": ["string"
],
"tags": ["string"
]
},
"outgoing_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allow_ussd_codes": false,
"allowed_numbers": ["string"
],
"tags": ["string"
]
},
"ethernet_settings": {"apply_policy": "ALWAYS APPLY",
"auth_mode": "NONE",
"ca_cert_alias": "string",
"client_cert_alias": "string",
"eap_identity": "string"
},
"adb_settings": {"apply_policy": "ALWAYS APPLY",
"allow_adb": true
},
"safe_boot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_safe_boot": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screen_timeout_settings": {"apply_policy": "ALWAYS APPLY",
"screentimeout_value": 0
},
"lock_screen_settings": {"apply_policy": "ALWAYS APPLY",
"password_quality": "NONE",
"minimum_password_length": 0,
"allow_keyguard": true
},
"brightness_settings": {"apply_policy": "ALWAYS APPLY",
"brightness_value": "string"
},
"screen_orientation_settings": {"apply_policy": "ALWAYS APPLY",
"orientation_type": "PORTRAIT"
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"notification_bar_settings": {"apply_policy": "ALWAYS APPLY",
"allow_notification_bar": true
},
"wallpaper_settings": {"homescreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
},
"landscape": {"wallpaper_id": "string"
}
},
"lockscreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
}
},
"esper_settings_apps_settings": {"apply_policy": "ALWAYS APPLY",
"allow_dock": true,
"admin_mode_password": "string",
"allow_esper_settings_app": true,
"settings": {"flashlight": "NONE",
"wifi": "NONE",
"auto_rotation": "NONE",
"reboot": "NONE",
"clear_app_data": "NONE",
"kiosk_app_selection": "NONE",
"esper_branding": "NONE",
"factory_reset": "NONE",
"about": "NONE",
"display": "NONE",
"sound": "NONE",
"keyboard": "NONE",
"input_selection": "NONE",
"accessibility": "NONE",
"accessibility_reset_to_default": "NONE",
"accessibility_high_contrast_text": "NONE",
"accessibility_cc_deuteranomaly": "NONE",
"accessibility_cc_protanomaly": "NONE",
"accessibility_cc_tritanomaly": "NONE",
"accessibility_mono_audio": "NONE",
"accessibility_display_size": "NONE",
"accessibility_talkback": "NONE",
"accessibility_text_to_speech": "NONE",
"mobile_data": "NONE",
"bluetooth": "NONE",
"language": "NONE",
"time_and_date": "NONE",
"storage": "NONE",
"data_roaming": "NONE",
"wifi_tethering": "NONE",
"airplane_mode": "NONE"
}
},
"android_settings_app_settings": {"apply_policy": "ALWAYS APPLY",
"allow_android_settings_app": true
},
"customized_device_level_json_settings": {"apply_policy": "ALWAYS APPLY",
"customized_json": { }
},
"google_services_settings": {"afw_account_settings": {"apply_policy": "ALWAYS APPLY",
"allow_afw_account_addition": true
},
"personal_accounts_settings": {"apply_policy": "ALWAYS APPLY",
"personal_accounts_limit_value": 0
},
"play_store_settings": {"apply_policy": "ALWAYS APPLY",
"allow_playstore": true
},
"google_assitant_settings": {"apply_policy": "ALWAYS APPLY",
"allow_google_assistant": true
},
"factory_reset_protection_settings": {"apply_policy": "ALWAYS APPLY",
"google_id": "string",
"email": "string"
}
},
"external_device_settings": {"apply_policy": "ALWAYS APPLY",
"allow_external_device_mount": true
},
"usb_tethering_settings": {"apply_policy": "ALWAYS APPLY",
"allow_usb_tethering": true
},
"file_transfer_settings": {"apply_policy": "ALWAYS APPLY",
"allow_file_transfer": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"location_settings": {"apply_policy": "ALWAYS APPLY",
"allow_location": true
},
"sound_settings": {"alarm_settings": {"apply_policy": "ALWAYS APPLY",
"alarm_volume": 0
},
"music_settings": {"apply_policy": "ALWAYS APPLY",
"music_volume": 0
},
"ringtone_settings": {"apply_policy": "ALWAYS APPLY",
"ringtone_volume": 0
},
"notification_settings": {"apply_policy": "ALWAYS APPLY",
"notification_volume": 0
},
"voice_call_settings": {"apply_policy": "ALWAYS APPLY",
"voice_call_volume": 0
}
},
"system_updates_settings": {"apply_policy": "ALWAYS APPLY",
"system_update_policy_type": "UPDATE AUTOMATICALLY",
"maintenance_start": "string",
"maintenance_end": "string"
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"allow_edit_time_date": true
},
"timezone_settings": {"apply_policy": "ALWAYS APPLY",
"timezone": "string"
},
"langauge_settings": {"apply_policy": "ALWAYS APPLY",
"device_locale": "string"
},
"strict_wifi_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_wifi_synchronization": true
},
"strict_app_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_app_synchronization": true
},
"apps": [{"app_id": "string",
"app_version_id": "string",
"package_name": "string",
"installation_rule": "POST PROVISIONING",
"state": "SHOW",
"managed_config": { },
"type": "PRELOADED",
"auto_update_mode": "autoUpdateDefault"
}
],
"files": [{"file_id": "string",
"destination_path": "string"
}
],
"wifi_networks": [{"wifi_network_id": "string",
"certificate_file_path": "/storage/emulated/0/Documents",
"certificate_file_password": "abc"
}
],
"saved_ap_settings": {"apply_policy": "ALWAYS APPLY",
"use_only_saved_ap": true
},
"mac_address_randomization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_mac_address_randomization": true
}
},
"ios": {"kiosk_app": {"app_id": "string",
"app_type": "VPP"
},
"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"edit_bluetooth": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"custom_device_level_profile_settings": {"apply_policy": "ALWAYS APPLY",
"custom_profile": "string"
},
"siri_settings": {"apply_policy": "ALWAYS APPLY",
"allow_siri": true
},
"tethering_settings": {"apply_policy": "ALWAYS APPLY",
"edit_hotspot": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"hide_preloaded_apps_settings": {"apply_policy": "ALWAYS APPLY",
"hide_preloaded_apps": true
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"force_automatic_time_date": false
},
"wifi_networks": [{"wifi_network_id": "string"
}
],
"apps": [{"app_id": "string",
"app_version_id": "string",
"state": "SHOW",
"app_type": "VPP"
}
],
"wallpaper_settings": {"homescreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
},
"lockscreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
}
},
"web_content_settings": {"apply_policy": "ALWAYS APPLY",
"url_blocklist": ["string"
],
"url_allowlist": ["string"
]
},
"defer_os_updates": {"apply_policy": "ALWAYS APPLY",
"defer_os_updates_delay": 90
}
}
},
"created_by": "string",
"updated_by": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"message": "string",
"code": 201
}

Retrieve a blueprint by ID

Request

path Parameters

blueprint_id

required

string <uuid>

Responses

200

Success

404

Content not found

get/v2/blueprints/{blueprint_id}/

Request samples

curl

Response samples

application/json

{"content": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"comments": "string",
"version_number": 0,
"version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",
"minor_version_number": 0,
"publish": true,
"settings": {"android": {"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"launcher_settings": {"apply_policy": "ALWAYS APPLY",
"launcher": "ESPER"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"app_permission_policy_settings": {"apply_policy": "ALWAYS APPLY",
"permission_policy": "ALLOW AUTOMATICALLY"
},
"wifi_settings": {"apply_policy": "ALWAYS APPLY",
"allow_wifi": true,
"wifi_state": "ENABLE"
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"allow_bluetooth": true,
"bluetooth_state": "ENABLE"
},
"sms_settings": {"apply_policy": "ALWAYS APPLY",
"allow_sms": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"incoming_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allowed_numbers": ["string"
],
"tags": ["string"
]
},
"outgoing_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allow_ussd_codes": false,
"allowed_numbers": ["string"
],
"tags": ["string"
]
},
"ethernet_settings": {"apply_policy": "ALWAYS APPLY",
"auth_mode": "NONE",
"ca_cert_alias": "string",
"client_cert_alias": "string",
"eap_identity": "string"
},
"adb_settings": {"apply_policy": "ALWAYS APPLY",
"allow_adb": true
},
"safe_boot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_safe_boot": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screen_timeout_settings": {"apply_policy": "ALWAYS APPLY",
"screentimeout_value": 0
},
"lock_screen_settings": {"apply_policy": "ALWAYS APPLY",
"password_quality": "NONE",
"minimum_password_length": 0,
"allow_keyguard": true
},
"brightness_settings": {"apply_policy": "ALWAYS APPLY",
"brightness_value": "string"
},
"screen_orientation_settings": {"apply_policy": "ALWAYS APPLY",
"orientation_type": "PORTRAIT"
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"notification_bar_settings": {"apply_policy": "ALWAYS APPLY",
"allow_notification_bar": true
},
"wallpaper_settings": {"homescreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
},
"landscape": {"wallpaper_id": "string"
}
},
"lockscreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
}
},
"esper_settings_apps_settings": {"apply_policy": "ALWAYS APPLY",
"allow_dock": true,
"admin_mode_password": "string",
"allow_esper_settings_app": true,
"settings": {"flashlight": "NONE",
"wifi": "NONE",
"auto_rotation": "NONE",
"reboot": "NONE",
"clear_app_data": "NONE",
"kiosk_app_selection": "NONE",
"esper_branding": "NONE",
"factory_reset": "NONE",
"about": "NONE",
"display": "NONE",
"sound": "NONE",
"keyboard": "NONE",
"input_selection": "NONE",
"accessibility": "NONE",
"accessibility_reset_to_default": "NONE",
"accessibility_high_contrast_text": "NONE",
"accessibility_cc_deuteranomaly": "NONE",
"accessibility_cc_protanomaly": "NONE",
"accessibility_cc_tritanomaly": "NONE",
"accessibility_mono_audio": "NONE",
"accessibility_display_size": "NONE",
"accessibility_talkback": "NONE",
"accessibility_text_to_speech": "NONE",
"mobile_data": "NONE",
"bluetooth": "NONE",
"language": "NONE",
"time_and_date": "NONE",
"storage": "NONE",
"data_roaming": "NONE",
"wifi_tethering": "NONE",
"airplane_mode": "NONE"
}
},
"android_settings_app_settings": {"apply_policy": "ALWAYS APPLY",
"allow_android_settings_app": true
},
"customized_device_level_json_settings": {"apply_policy": "ALWAYS APPLY",
"customized_json": { }
},
"google_services_settings": {"afw_account_settings": {"apply_policy": "ALWAYS APPLY",
"allow_afw_account_addition": true
},
"personal_accounts_settings": {"apply_policy": "ALWAYS APPLY",
"personal_accounts_limit_value": 0
},
"play_store_settings": {"apply_policy": "ALWAYS APPLY",
"allow_playstore": true
},
"google_assitant_settings": {"apply_policy": "ALWAYS APPLY",
"allow_google_assistant": true
},
"factory_reset_protection_settings": {"apply_policy": "ALWAYS APPLY",
"google_id": "string",
"email": "string"
}
},
"external_device_settings": {"apply_policy": "ALWAYS APPLY",
"allow_external_device_mount": true
},
"usb_tethering_settings": {"apply_policy": "ALWAYS APPLY",
"allow_usb_tethering": true
},
"file_transfer_settings": {"apply_policy": "ALWAYS APPLY",
"allow_file_transfer": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"location_settings": {"apply_policy": "ALWAYS APPLY",
"allow_location": true
},
"sound_settings": {"alarm_settings": {"apply_policy": "ALWAYS APPLY",
"alarm_volume": 0
},
"music_settings": {"apply_policy": "ALWAYS APPLY",
"music_volume": 0
},
"ringtone_settings": {"apply_policy": "ALWAYS APPLY",
"ringtone_volume": 0
},
"notification_settings": {"apply_policy": "ALWAYS APPLY",
"notification_volume": 0
},
"voice_call_settings": {"apply_policy": "ALWAYS APPLY",
"voice_call_volume": 0
}
},
"system_updates_settings": {"apply_policy": "ALWAYS APPLY",
"system_update_policy_type": "UPDATE AUTOMATICALLY",
"maintenance_start": "string",
"maintenance_end": "string"
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"allow_edit_time_date": true
},
"timezone_settings": {"apply_policy": "ALWAYS APPLY",
"timezone": "string"
},
"langauge_settings": {"apply_policy": "ALWAYS APPLY",
"device_locale": "string"
},
"strict_wifi_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_wifi_synchronization": true
},
"strict_app_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_app_synchronization": true
},
"apps": [{"app_id": "string",
"app_version_id": "string",
"package_name": "string",
"installation_rule": "POST PROVISIONING",
"state": "SHOW",
"managed_config": { },
"type": "PRELOADED",
"auto_update_mode": "autoUpdateDefault"
}
],
"files": [{"file_id": "string",
"destination_path": "string"
}
],
"wifi_networks": [{"wifi_network_id": "string",
"certificate_file_path": "/storage/emulated/0/Documents",
"certificate_file_password": "abc"
}
],
"saved_ap_settings": {"apply_policy": "ALWAYS APPLY",
"use_only_saved_ap": true
},
"mac_address_randomization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_mac_address_randomization": true
}
},
"ios": {"kiosk_app": {"app_id": "string",
"app_type": "VPP"
},
"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"edit_bluetooth": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"custom_device_level_profile_settings": {"apply_policy": "ALWAYS APPLY",
"custom_profile": "string"
},
"siri_settings": {"apply_policy": "ALWAYS APPLY",
"allow_siri": true
},
"tethering_settings": {"apply_policy": "ALWAYS APPLY",
"edit_hotspot": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"hide_preloaded_apps_settings": {"apply_policy": "ALWAYS APPLY",
"hide_preloaded_apps": true
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"force_automatic_time_date": false
},
"wifi_networks": [{"wifi_network_id": "string"
}
],
"apps": [{"app_id": "string",
"app_version_id": "string",
"state": "SHOW",
"app_type": "VPP"
}
],
"wallpaper_settings": {"homescreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
},
"lockscreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
}
},
"web_content_settings": {"apply_policy": "ALWAYS APPLY",
"url_blocklist": ["string"
],
"url_allowlist": ["string"
]
},
"defer_os_updates": {"apply_policy": "ALWAYS APPLY",
"defer_os_updates_delay": 90
}
}
},
"created_by": "string",
"updated_by": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"message": "string",
"code": 201
}

Update a blueprint by ID

Request

path Parameters

blueprint_id

required

string <uuid>

Request Body schema: application/json
required

name	string Name of the blueprint
description	string Description of the blueprint
comments	string Comments on the blueprint
	object (settingsV2)

Responses

200

Success

400

Bad Request

404

Resource not found

put/v2/blueprints/{blueprint_id}/

Request samples

Payload
curl

application/json

{"name": "string",
"description": "string",
"comments": "string",
"settings": {"android": {"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"launcher_settings": {"apply_policy": "ALWAYS APPLY",
"launcher": "ESPER"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"app_permission_policy_settings": {"apply_policy": "ALWAYS APPLY",
"permission_policy": "ALLOW AUTOMATICALLY"
},
"wifi_settings": {"apply_policy": "ALWAYS APPLY",
"allow_wifi": true,
"wifi_state": "ENABLE"
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"allow_bluetooth": true,
"bluetooth_state": "ENABLE"
},
"sms_settings": {"apply_policy": "ALWAYS APPLY",
"allow_sms": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"incoming_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allowed_numbers": ["string"
],
"tags": ["string"
]
},
"outgoing_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allow_ussd_codes": false,
"allowed_numbers": ["string"
],
"tags": ["string"
]
},
"ethernet_settings": {"apply_policy": "ALWAYS APPLY",
"auth_mode": "NONE",
"ca_cert_alias": "string",
"client_cert_alias": "string",
"eap_identity": "string"
},
"adb_settings": {"apply_policy": "ALWAYS APPLY",
"allow_adb": true
},
"safe_boot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_safe_boot": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screen_timeout_settings": {"apply_policy": "ALWAYS APPLY",
"screentimeout_value": 0
},
"lock_screen_settings": {"apply_policy": "ALWAYS APPLY",
"password_quality": "NONE",
"minimum_password_length": 0,
"allow_keyguard": true
},
"brightness_settings": {"apply_policy": "ALWAYS APPLY",
"brightness_value": "string"
},
"screen_orientation_settings": {"apply_policy": "ALWAYS APPLY",
"orientation_type": "PORTRAIT"
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"notification_bar_settings": {"apply_policy": "ALWAYS APPLY",
"allow_notification_bar": true
},
"wallpaper_settings": {"homescreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
},
"landscape": {"wallpaper_id": "string"
}
},
"lockscreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
}
},
"esper_settings_apps_settings": {"apply_policy": "ALWAYS APPLY",
"allow_dock": true,
"admin_mode_password": "string",
"allow_esper_settings_app": true,
"settings": {"flashlight": "NONE",
"wifi": "NONE",
"auto_rotation": "NONE",
"reboot": "NONE",
"clear_app_data": "NONE",
"kiosk_app_selection": "NONE",
"esper_branding": "NONE",
"factory_reset": "NONE",
"about": "NONE",
"display": "NONE",
"sound": "NONE",
"keyboard": "NONE",
"input_selection": "NONE",
"accessibility": "NONE",
"accessibility_reset_to_default": "NONE",
"accessibility_high_contrast_text": "NONE",
"accessibility_cc_deuteranomaly": "NONE",
"accessibility_cc_protanomaly": "NONE",
"accessibility_cc_tritanomaly": "NONE",
"accessibility_mono_audio": "NONE",
"accessibility_display_size": "NONE",
"accessibility_talkback": "NONE",
"accessibility_text_to_speech": "NONE",
"mobile_data": "NONE",
"bluetooth": "NONE",
"language": "NONE",
"time_and_date": "NONE",
"storage": "NONE",
"data_roaming": "NONE",
"wifi_tethering": "NONE",
"airplane_mode": "NONE"
}
},
"android_settings_app_settings": {"apply_policy": "ALWAYS APPLY",
"allow_android_settings_app": true
},
"customized_device_level_json_settings": {"apply_policy": "ALWAYS APPLY",
"customized_json": { }
},
"google_services_settings": {"afw_account_settings": {"apply_policy": "ALWAYS APPLY",
"allow_afw_account_addition": true
},
"personal_accounts_settings": {"apply_policy": "ALWAYS APPLY",
"personal_accounts_limit_value": 0
},
"play_store_settings": {"apply_policy": "ALWAYS APPLY",
"allow_playstore": true
},
"google_assitant_settings": {"apply_policy": "ALWAYS APPLY",
"allow_google_assistant": true
},
"factory_reset_protection_settings": {"apply_policy": "ALWAYS APPLY",
"google_id": "string",
"email": "string"
}
},
"external_device_settings": {"apply_policy": "ALWAYS APPLY",
"allow_external_device_mount": true
},
"usb_tethering_settings": {"apply_policy": "ALWAYS APPLY",
"allow_usb_tethering": true
},
"file_transfer_settings": {"apply_policy": "ALWAYS APPLY",
"allow_file_transfer": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"location_settings": {"apply_policy": "ALWAYS APPLY",
"allow_location": true
},
"sound_settings": {"alarm_settings": {"apply_policy": "ALWAYS APPLY",
"alarm_volume": 0
},
"music_settings": {"apply_policy": "ALWAYS APPLY",
"music_volume": 0
},
"ringtone_settings": {"apply_policy": "ALWAYS APPLY",
"ringtone_volume": 0
},
"notification_settings": {"apply_policy": "ALWAYS APPLY",
"notification_volume": 0
},
"voice_call_settings": {"apply_policy": "ALWAYS APPLY",
"voice_call_volume": 0
}
},
"system_updates_settings": {"apply_policy": "ALWAYS APPLY",
"system_update_policy_type": "UPDATE AUTOMATICALLY",
"maintenance_start": "string",
"maintenance_end": "string"
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"allow_edit_time_date": true
},
"timezone_settings": {"apply_policy": "ALWAYS APPLY",
"timezone": "string"
},
"langauge_settings": {"apply_policy": "ALWAYS APPLY",
"device_locale": "string"
},
"strict_wifi_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_wifi_synchronization": true
},
"strict_app_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_app_synchronization": true
},
"apps": [{"app_id": "string",
"app_version_id": "string",
"package_name": "string",
"installation_rule": "POST PROVISIONING",
"state": "SHOW",
"managed_config": { },
"type": "PRELOADED",
"auto_update_mode": "autoUpdateDefault"
}
],
"files": [{"file_id": "string",
"destination_path": "string"
}
],
"wifi_networks": [{"wifi_network_id": "string",
"certificate_file_path": "/storage/emulated/0/Documents",
"certificate_file_password": "abc"
}
],
"saved_ap_settings": {"apply_policy": "ALWAYS APPLY",
"use_only_saved_ap": true
},
"mac_address_randomization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_mac_address_randomization": true
}
},
"ios": {"kiosk_app": {"app_id": "string",
"app_type": "VPP"
},
"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"edit_bluetooth": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"custom_device_level_profile_settings": {"apply_policy": "ALWAYS APPLY",
"custom_profile": "string"
},
"siri_settings": {"apply_policy": "ALWAYS APPLY",
"allow_siri": true
},
"tethering_settings": {"apply_policy": "ALWAYS APPLY",
"edit_hotspot": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"hide_preloaded_apps_settings": {"apply_policy": "ALWAYS APPLY",
"hide_preloaded_apps": true
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"force_automatic_time_date": false
},
"wifi_networks": [{"wifi_network_id": "string"
}
],
"apps": [{"app_id": "string",
"app_version_id": "string",
"state": "SHOW",
"app_type": "VPP"
}
],
"wallpaper_settings": {"homescreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
},
"lockscreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
}
},
"web_content_settings": {"apply_policy": "ALWAYS APPLY",
"url_blocklist": ["string"
],
"url_allowlist": ["string"
]
},
"defer_os_updates": {"apply_policy": "ALWAYS APPLY",
"defer_os_updates_delay": 90
}
}
},
"publish": true
}

Response samples

application/json

{"content": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"comments": "string",
"version_number": 0,
"version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",
"minor_version_number": 0,
"publish": true,
"settings": {"android": {"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"launcher_settings": {"apply_policy": "ALWAYS APPLY",
"launcher": "ESPER"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"app_permission_policy_settings": {"apply_policy": "ALWAYS APPLY",
"permission_policy": "ALLOW AUTOMATICALLY"
},
"wifi_settings": {"apply_policy": "ALWAYS APPLY",
"allow_wifi": true,
"wifi_state": "ENABLE"
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"allow_bluetooth": true,
"bluetooth_state": "ENABLE"
},
"sms_settings": {"apply_policy": "ALWAYS APPLY",
"allow_sms": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"incoming_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allowed_numbers": ["string"
],
"tags": ["string"
]
},
"outgoing_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allow_ussd_codes": false,
"allowed_numbers": ["string"
],
"tags": ["string"
]
},
"ethernet_settings": {"apply_policy": "ALWAYS APPLY",
"auth_mode": "NONE",
"ca_cert_alias": "string",
"client_cert_alias": "string",
"eap_identity": "string"
},
"adb_settings": {"apply_policy": "ALWAYS APPLY",
"allow_adb": true
},
"safe_boot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_safe_boot": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screen_timeout_settings": {"apply_policy": "ALWAYS APPLY",
"screentimeout_value": 0
},
"lock_screen_settings": {"apply_policy": "ALWAYS APPLY",
"password_quality": "NONE",
"minimum_password_length": 0,
"allow_keyguard": true
},
"brightness_settings": {"apply_policy": "ALWAYS APPLY",
"brightness_value": "string"
},
"screen_orientation_settings": {"apply_policy": "ALWAYS APPLY",
"orientation_type": "PORTRAIT"
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"notification_bar_settings": {"apply_policy": "ALWAYS APPLY",
"allow_notification_bar": true
},
"wallpaper_settings": {"homescreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
},
"landscape": {"wallpaper_id": "string"
}
},
"lockscreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
}
},
"esper_settings_apps_settings": {"apply_policy": "ALWAYS APPLY",
"allow_dock": true,
"admin_mode_password": "string",
"allow_esper_settings_app": true,
"settings": {"flashlight": "NONE",
"wifi": "NONE",
"auto_rotation": "NONE",
"reboot": "NONE",
"clear_app_data": "NONE",
"kiosk_app_selection": "NONE",
"esper_branding": "NONE",
"factory_reset": "NONE",
"about": "NONE",
"display": "NONE",
"sound": "NONE",
"keyboard": "NONE",
"input_selection": "NONE",
"accessibility": "NONE",
"accessibility_reset_to_default": "NONE",
"accessibility_high_contrast_text": "NONE",
"accessibility_cc_deuteranomaly": "NONE",
"accessibility_cc_protanomaly": "NONE",
"accessibility_cc_tritanomaly": "NONE",
"accessibility_mono_audio": "NONE",
"accessibility_display_size": "NONE",
"accessibility_talkback": "NONE",
"accessibility_text_to_speech": "NONE",
"mobile_data": "NONE",
"bluetooth": "NONE",
"language": "NONE",
"time_and_date": "NONE",
"storage": "NONE",
"data_roaming": "NONE",
"wifi_tethering": "NONE",
"airplane_mode": "NONE"
}
},
"android_settings_app_settings": {"apply_policy": "ALWAYS APPLY",
"allow_android_settings_app": true
},
"customized_device_level_json_settings": {"apply_policy": "ALWAYS APPLY",
"customized_json": { }
},
"google_services_settings": {"afw_account_settings": {"apply_policy": "ALWAYS APPLY",
"allow_afw_account_addition": true
},
"personal_accounts_settings": {"apply_policy": "ALWAYS APPLY",
"personal_accounts_limit_value": 0
},
"play_store_settings": {"apply_policy": "ALWAYS APPLY",
"allow_playstore": true
},
"google_assitant_settings": {"apply_policy": "ALWAYS APPLY",
"allow_google_assistant": true
},
"factory_reset_protection_settings": {"apply_policy": "ALWAYS APPLY",
"google_id": "string",
"email": "string"
}
},
"external_device_settings": {"apply_policy": "ALWAYS APPLY",
"allow_external_device_mount": true
},
"usb_tethering_settings": {"apply_policy": "ALWAYS APPLY",
"allow_usb_tethering": true
},
"file_transfer_settings": {"apply_policy": "ALWAYS APPLY",
"allow_file_transfer": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"location_settings": {"apply_policy": "ALWAYS APPLY",
"allow_location": true
},
"sound_settings": {"alarm_settings": {"apply_policy": "ALWAYS APPLY",
"alarm_volume": 0
},
"music_settings": {"apply_policy": "ALWAYS APPLY",
"music_volume": 0
},
"ringtone_settings": {"apply_policy": "ALWAYS APPLY",
"ringtone_volume": 0
},
"notification_settings": {"apply_policy": "ALWAYS APPLY",
"notification_volume": 0
},
"voice_call_settings": {"apply_policy": "ALWAYS APPLY",
"voice_call_volume": 0
}
},
"system_updates_settings": {"apply_policy": "ALWAYS APPLY",
"system_update_policy_type": "UPDATE AUTOMATICALLY",
"maintenance_start": "string",
"maintenance_end": "string"
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"allow_edit_time_date": true
},
"timezone_settings": {"apply_policy": "ALWAYS APPLY",
"timezone": "string"
},
"langauge_settings": {"apply_policy": "ALWAYS APPLY",
"device_locale": "string"
},
"strict_wifi_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_wifi_synchronization": true
},
"strict_app_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_app_synchronization": true
},
"apps": [{"app_id": "string",
"app_version_id": "string",
"package_name": "string",
"installation_rule": "POST PROVISIONING",
"state": "SHOW",
"managed_config": { },
"type": "PRELOADED",
"auto_update_mode": "autoUpdateDefault"
}
],
"files": [{"file_id": "string",
"destination_path": "string"
}
],
"wifi_networks": [{"wifi_network_id": "string",
"certificate_file_path": "/storage/emulated/0/Documents",
"certificate_file_password": "abc"
}
],
"saved_ap_settings": {"apply_policy": "ALWAYS APPLY",
"use_only_saved_ap": true
},
"mac_address_randomization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_mac_address_randomization": true
}
},
"ios": {"kiosk_app": {"app_id": "string",
"app_type": "VPP"
},
"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"edit_bluetooth": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"custom_device_level_profile_settings": {"apply_policy": "ALWAYS APPLY",
"custom_profile": "string"
},
"siri_settings": {"apply_policy": "ALWAYS APPLY",
"allow_siri": true
},
"tethering_settings": {"apply_policy": "ALWAYS APPLY",
"edit_hotspot": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"hide_preloaded_apps_settings": {"apply_policy": "ALWAYS APPLY",
"hide_preloaded_apps": true
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"force_automatic_time_date": false
},
"wifi_networks": [{"wifi_network_id": "string"
}
],
"apps": [{"app_id": "string",
"app_version_id": "string",
"state": "SHOW",
"app_type": "VPP"
}
],
"wallpaper_settings": {"homescreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
},
"lockscreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
}
},
"web_content_settings": {"apply_policy": "ALWAYS APPLY",
"url_blocklist": ["string"
],
"url_allowlist": ["string"
]
},
"defer_os_updates": {"apply_policy": "ALWAYS APPLY",
"defer_os_updates_delay": 90
}
}
},
"created_by": "string",
"updated_by": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"message": "string",
"code": 201
}

Delete a blueprint by ID

Request

path Parameters

blueprint_id

required

string <uuid>

Responses

204

Success

404

Resource not found

delete/v2/blueprints/{blueprint_id}/

Request samples

curl

Response samples

application/json

{"content": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"comments": "string",
"version_number": 0,
"version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",
"minor_version_number": 0,
"publish": true,
"settings": {"android": {"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"launcher_settings": {"apply_policy": "ALWAYS APPLY",
"launcher": "ESPER"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"app_permission_policy_settings": {"apply_policy": "ALWAYS APPLY",
"permission_policy": "ALLOW AUTOMATICALLY"
},
"wifi_settings": {"apply_policy": "ALWAYS APPLY",
"allow_wifi": true,
"wifi_state": "ENABLE"
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"allow_bluetooth": true,
"bluetooth_state": "ENABLE"
},
"sms_settings": {"apply_policy": "ALWAYS APPLY",
"allow_sms": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"incoming_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allowed_numbers": ["string"
],
"tags": ["string"
]
},
"outgoing_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allow_ussd_codes": false,
"allowed_numbers": ["string"
],
"tags": ["string"
]
},
"ethernet_settings": {"apply_policy": "ALWAYS APPLY",
"auth_mode": "NONE",
"ca_cert_alias": "string",
"client_cert_alias": "string",
"eap_identity": "string"
},
"adb_settings": {"apply_policy": "ALWAYS APPLY",
"allow_adb": true
},
"safe_boot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_safe_boot": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screen_timeout_settings": {"apply_policy": "ALWAYS APPLY",
"screentimeout_value": 0
},
"lock_screen_settings": {"apply_policy": "ALWAYS APPLY",
"password_quality": "NONE",
"minimum_password_length": 0,
"allow_keyguard": true
},
"brightness_settings": {"apply_policy": "ALWAYS APPLY",
"brightness_value": "string"
},
"screen_orientation_settings": {"apply_policy": "ALWAYS APPLY",
"orientation_type": "PORTRAIT"
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"notification_bar_settings": {"apply_policy": "ALWAYS APPLY",
"allow_notification_bar": true
},
"wallpaper_settings": {"homescreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
},
"landscape": {"wallpaper_id": "string"
}
},
"lockscreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
}
},
"esper_settings_apps_settings": {"apply_policy": "ALWAYS APPLY",
"allow_dock": true,
"admin_mode_password": "string",
"allow_esper_settings_app": true,
"settings": {"flashlight": "NONE",
"wifi": "NONE",
"auto_rotation": "NONE",
"reboot": "NONE",
"clear_app_data": "NONE",
"kiosk_app_selection": "NONE",
"esper_branding": "NONE",
"factory_reset": "NONE",
"about": "NONE",
"display": "NONE",
"sound": "NONE",
"keyboard": "NONE",
"input_selection": "NONE",
"accessibility": "NONE",
"accessibility_reset_to_default": "NONE",
"accessibility_high_contrast_text": "NONE",
"accessibility_cc_deuteranomaly": "NONE",
"accessibility_cc_protanomaly": "NONE",
"accessibility_cc_tritanomaly": "NONE",
"accessibility_mono_audio": "NONE",
"accessibility_display_size": "NONE",
"accessibility_talkback": "NONE",
"accessibility_text_to_speech": "NONE",
"mobile_data": "NONE",
"bluetooth": "NONE",
"language": "NONE",
"time_and_date": "NONE",
"storage": "NONE",
"data_roaming": "NONE",
"wifi_tethering": "NONE",
"airplane_mode": "NONE"
}
},
"android_settings_app_settings": {"apply_policy": "ALWAYS APPLY",
"allow_android_settings_app": true
},
"customized_device_level_json_settings": {"apply_policy": "ALWAYS APPLY",
"customized_json": { }
},
"google_services_settings": {"afw_account_settings": {"apply_policy": "ALWAYS APPLY",
"allow_afw_account_addition": true
},
"personal_accounts_settings": {"apply_policy": "ALWAYS APPLY",
"personal_accounts_limit_value": 0
},
"play_store_settings": {"apply_policy": "ALWAYS APPLY",
"allow_playstore": true
},
"google_assitant_settings": {"apply_policy": "ALWAYS APPLY",
"allow_google_assistant": true
},
"factory_reset_protection_settings": {"apply_policy": "ALWAYS APPLY",
"google_id": "string",
"email": "string"
}
},
"external_device_settings": {"apply_policy": "ALWAYS APPLY",
"allow_external_device_mount": true
},
"usb_tethering_settings": {"apply_policy": "ALWAYS APPLY",
"allow_usb_tethering": true
},
"file_transfer_settings": {"apply_policy": "ALWAYS APPLY",
"allow_file_transfer": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"location_settings": {"apply_policy": "ALWAYS APPLY",
"allow_location": true
},
"sound_settings": {"alarm_settings": {"apply_policy": "ALWAYS APPLY",
"alarm_volume": 0
},
"music_settings": {"apply_policy": "ALWAYS APPLY",
"music_volume": 0
},
"ringtone_settings": {"apply_policy": "ALWAYS APPLY",
"ringtone_volume": 0
},
"notification_settings": {"apply_policy": "ALWAYS APPLY",
"notification_volume": 0
},
"voice_call_settings": {"apply_policy": "ALWAYS APPLY",
"voice_call_volume": 0
}
},
"system_updates_settings": {"apply_policy": "ALWAYS APPLY",
"system_update_policy_type": "UPDATE AUTOMATICALLY",
"maintenance_start": "string",
"maintenance_end": "string"
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"allow_edit_time_date": true
},
"timezone_settings": {"apply_policy": "ALWAYS APPLY",
"timezone": "string"
},
"langauge_settings": {"apply_policy": "ALWAYS APPLY",
"device_locale": "string"
},
"strict_wifi_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_wifi_synchronization": true
},
"strict_app_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_app_synchronization": true
},
"apps": [{"app_id": "string",
"app_version_id": "string",
"package_name": "string",
"installation_rule": "POST PROVISIONING",
"state": "SHOW",
"managed_config": { },
"type": "PRELOADED",
"auto_update_mode": "autoUpdateDefault"
}
],
"files": [{"file_id": "string",
"destination_path": "string"
}
],
"wifi_networks": [{"wifi_network_id": "string",
"certificate_file_path": "/storage/emulated/0/Documents",
"certificate_file_password": "abc"
}
],
"saved_ap_settings": {"apply_policy": "ALWAYS APPLY",
"use_only_saved_ap": true
},
"mac_address_randomization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_mac_address_randomization": true
}
},
"ios": {"kiosk_app": {"app_id": "string",
"app_type": "VPP"
},
"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"edit_bluetooth": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"custom_device_level_profile_settings": {"apply_policy": "ALWAYS APPLY",
"custom_profile": "string"
},
"siri_settings": {"apply_policy": "ALWAYS APPLY",
"allow_siri": true
},
"tethering_settings": {"apply_policy": "ALWAYS APPLY",
"edit_hotspot": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"hide_preloaded_apps_settings": {"apply_policy": "ALWAYS APPLY",
"hide_preloaded_apps": true
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"force_automatic_time_date": false
},
"wifi_networks": [{"wifi_network_id": "string"
}
],
"apps": [{"app_id": "string",
"app_version_id": "string",
"state": "SHOW",
"app_type": "VPP"
}
],
"wallpaper_settings": {"homescreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
},
"lockscreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
}
},
"web_content_settings": {"apply_policy": "ALWAYS APPLY",
"url_blocklist": ["string"
],
"url_allowlist": ["string"
]
},
"defer_os_updates": {"apply_policy": "ALWAYS APPLY",
"defer_os_updates_delay": 90
}
}
},
"created_by": "string",
"updated_by": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"message": "string",
"code": 201
}

Retrieve all versions of a blueprint

Request

path Parameters

blueprint_id

required

string <uuid>

query Parameters

ordering	string Order the results by a specific field (-field for descending order), Combine Multiple with , like -version_number,-minor_version_number.
version_number	string Filter the results by version_number
publish	string Filter the results by publish
settings__android__app_id	string <uuid> List the versions which have given app_id.
settings__android__app_version_id	string <uuid> List the versions which have given app_version_id.
settings__android__file_id	string <uuid> List the blueprints which have given file_id.
settings__android__wifi_network_id	string <uuid> List the blueprints which have given wifi_network_id.

Responses

200

Success

get/v2/blueprints/{blueprint_id}/versions/

Request samples

curl

Response samples

application/json

{"content": {"count": 0,
"next": "string",
"previous": "string",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"comments": "string",
"version_number": 0,
"version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",
"minor_version_number": 0,
"publish": true,
"settings": {"android": {"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"launcher_settings": {"apply_policy": "ALWAYS APPLY",
"launcher": "ESPER"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"app_permission_policy_settings": {"apply_policy": "ALWAYS APPLY",
"permission_policy": "ALLOW AUTOMATICALLY"
},
"wifi_settings": {"apply_policy": "ALWAYS APPLY",
"allow_wifi": true,
"wifi_state": "ENABLE"
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"allow_bluetooth": true,
"bluetooth_state": "ENABLE"
},
"sms_settings": {"apply_policy": "ALWAYS APPLY",
"allow_sms": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"incoming_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allowed_numbers": [null
],
"tags": [null
]
},
"outgoing_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allow_ussd_codes": false,
"allowed_numbers": [null
],
"tags": [null
]
},
"ethernet_settings": {"apply_policy": "ALWAYS APPLY",
"auth_mode": "NONE",
"ca_cert_alias": "string",
"client_cert_alias": "string",
"eap_identity": "string"
},
"adb_settings": {"apply_policy": "ALWAYS APPLY",
"allow_adb": true
},
"safe_boot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_safe_boot": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screen_timeout_settings": {"apply_policy": "ALWAYS APPLY",
"screentimeout_value": 0
},
"lock_screen_settings": {"apply_policy": "ALWAYS APPLY",
"password_quality": "NONE",
"minimum_password_length": 0,
"allow_keyguard": true
},
"brightness_settings": {"apply_policy": "ALWAYS APPLY",
"brightness_value": "string"
},
"screen_orientation_settings": {"apply_policy": "ALWAYS APPLY",
"orientation_type": "PORTRAIT"
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"notification_bar_settings": {"apply_policy": "ALWAYS APPLY",
"allow_notification_bar": true
},
"wallpaper_settings": {"homescreen": {"apply_policy": null,
"portrait": { },
"landscape": { }
},
"lockscreen": {"apply_policy": null,
"portrait": { }
}
},
"esper_settings_apps_settings": {"apply_policy": "ALWAYS APPLY",
"allow_dock": true,
"admin_mode_password": "string",
"allow_esper_settings_app": true,
"settings": {"flashlight": null,
"wifi": null,
"auto_rotation": null,
"reboot": null,
"clear_app_data": null,
"kiosk_app_selection": null,
"esper_branding": null,
"factory_reset": null,
"about": null,
"display": null,
"sound": null,
"keyboard": null,
"input_selection": null,
"accessibility": null,
"accessibility_reset_to_default": null,
"accessibility_high_contrast_text": null,
"accessibility_cc_deuteranomaly": null,
"accessibility_cc_protanomaly": null,
"accessibility_cc_tritanomaly": null,
"accessibility_mono_audio": null,
"accessibility_display_size": null,
"accessibility_talkback": null,
"accessibility_text_to_speech": null,
"mobile_data": null,
"bluetooth": null,
"language": null,
"time_and_date": null,
"storage": null,
"data_roaming": null,
"wifi_tethering": null,
"airplane_mode": null
}
},
"android_settings_app_settings": {"apply_policy": "ALWAYS APPLY",
"allow_android_settings_app": true
},
"customized_device_level_json_settings": {"apply_policy": "ALWAYS APPLY",
"customized_json": { }
},
"google_services_settings": {"afw_account_settings": {"apply_policy": null,
"allow_afw_account_addition": null
},
"personal_accounts_settings": {"apply_policy": null,
"personal_accounts_limit_value": null
},
"play_store_settings": {"apply_policy": null,
"allow_playstore": null
},
"google_assitant_settings": {"apply_policy": null,
"allow_google_assistant": null
},
"factory_reset_protection_settings": {"apply_policy": null,
"google_id": null,
"email": null
}
},
"external_device_settings": {"apply_policy": "ALWAYS APPLY",
"allow_external_device_mount": true
},
"usb_tethering_settings": {"apply_policy": "ALWAYS APPLY",
"allow_usb_tethering": true
},
"file_transfer_settings": {"apply_policy": "ALWAYS APPLY",
"allow_file_transfer": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"location_settings": {"apply_policy": "ALWAYS APPLY",
"allow_location": true
},
"sound_settings": {"alarm_settings": {"apply_policy": null,
"alarm_volume": null
},
"music_settings": {"apply_policy": null,
"music_volume": null
},
"ringtone_settings": {"apply_policy": null,
"ringtone_volume": null
},
"notification_settings": {"apply_policy": null,
"notification_volume": null
},
"voice_call_settings": {"apply_policy": null,
"voice_call_volume": null
}
},
"system_updates_settings": {"apply_policy": "ALWAYS APPLY",
"system_update_policy_type": "UPDATE AUTOMATICALLY",
"maintenance_start": "string",
"maintenance_end": "string"
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"allow_edit_time_date": true
},
"timezone_settings": {"apply_policy": "ALWAYS APPLY",
"timezone": "string"
},
"langauge_settings": {"apply_policy": "ALWAYS APPLY",
"device_locale": "string"
},
"strict_wifi_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_wifi_synchronization": true
},
"strict_app_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_app_synchronization": true
},
"apps": [{"app_id": null,
"app_version_id": null,
"package_name": null,
"installation_rule": null,
"state": null,
"managed_config": { },
"type": null,
"auto_update_mode": null
}
],
"files": [{"file_id": null,
"destination_path": null
}
],
"wifi_networks": [{"wifi_network_id": null,
"certificate_file_path": null,
"certificate_file_password": null
}
],
"saved_ap_settings": {"apply_policy": "ALWAYS APPLY",
"use_only_saved_ap": true
},
"mac_address_randomization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_mac_address_randomization": true
}
},
"ios": {"kiosk_app": {"app_id": "string",
"app_type": "VPP"
},
"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"edit_bluetooth": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"custom_device_level_profile_settings": {"apply_policy": "ALWAYS APPLY",
"custom_profile": "string"
},
"siri_settings": {"apply_policy": "ALWAYS APPLY",
"allow_siri": true
},
"tethering_settings": {"apply_policy": "ALWAYS APPLY",
"edit_hotspot": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"hide_preloaded_apps_settings": {"apply_policy": "ALWAYS APPLY",
"hide_preloaded_apps": true
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"force_automatic_time_date": false
},
"wifi_networks": [{"wifi_network_id": null
}
],
"apps": [{"app_id": null,
"app_version_id": null,
"state": null,
"app_type": null
}
],
"wallpaper_settings": {"homescreen": {"apply_policy": null,
"portrait": { }
},
"lockscreen": {"apply_policy": null,
"portrait": { }
}
},
"web_content_settings": {"apply_policy": "ALWAYS APPLY",
"url_blocklist": [null
],
"url_allowlist": [null
]
},
"defer_os_updates": {"apply_policy": "ALWAYS APPLY",
"defer_os_updates_delay": 90
}
}
},
"created_by": "string",
"updated_by": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"message": "string",
"code": 0
}
}

Retrieve a specific version of the blueprint

Request

path Parameters

blueprint_id required	string <uuid>
version_id required	string <uuid>

Responses

200

Success

404

Resouce not found

get/v2/blueprints/{blueprint_id}/versions/{version_id}/

Request samples

curl

Response samples

application/json

{"content": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"comments": "string",
"version_number": 0,
"version_id": "9e94c502-ca41-4342-a7f7-af96b444512c",
"minor_version_number": 0,
"publish": true,
"settings": {"android": {"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"launcher_settings": {"apply_policy": "ALWAYS APPLY",
"launcher": "ESPER"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"app_permission_policy_settings": {"apply_policy": "ALWAYS APPLY",
"permission_policy": "ALLOW AUTOMATICALLY"
},
"wifi_settings": {"apply_policy": "ALWAYS APPLY",
"allow_wifi": true,
"wifi_state": "ENABLE"
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"allow_bluetooth": true,
"bluetooth_state": "ENABLE"
},
"sms_settings": {"apply_policy": "ALWAYS APPLY",
"allow_sms": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"incoming_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allowed_numbers": ["string"
],
"tags": ["string"
]
},
"outgoing_numbers_settings": {"apply_policy": "ALWAYS APPLY",
"allow_all_numbers": true,
"allow_ussd_codes": false,
"allowed_numbers": ["string"
],
"tags": ["string"
]
},
"ethernet_settings": {"apply_policy": "ALWAYS APPLY",
"auth_mode": "NONE",
"ca_cert_alias": "string",
"client_cert_alias": "string",
"eap_identity": "string"
},
"adb_settings": {"apply_policy": "ALWAYS APPLY",
"allow_adb": true
},
"safe_boot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_safe_boot": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screen_timeout_settings": {"apply_policy": "ALWAYS APPLY",
"screentimeout_value": 0
},
"lock_screen_settings": {"apply_policy": "ALWAYS APPLY",
"password_quality": "NONE",
"minimum_password_length": 0,
"allow_keyguard": true
},
"brightness_settings": {"apply_policy": "ALWAYS APPLY",
"brightness_value": "string"
},
"screen_orientation_settings": {"apply_policy": "ALWAYS APPLY",
"orientation_type": "PORTRAIT"
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"notification_bar_settings": {"apply_policy": "ALWAYS APPLY",
"allow_notification_bar": true
},
"wallpaper_settings": {"homescreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
},
"landscape": {"wallpaper_id": "string"
}
},
"lockscreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
}
},
"esper_settings_apps_settings": {"apply_policy": "ALWAYS APPLY",
"allow_dock": true,
"admin_mode_password": "string",
"allow_esper_settings_app": true,
"settings": {"flashlight": "NONE",
"wifi": "NONE",
"auto_rotation": "NONE",
"reboot": "NONE",
"clear_app_data": "NONE",
"kiosk_app_selection": "NONE",
"esper_branding": "NONE",
"factory_reset": "NONE",
"about": "NONE",
"display": "NONE",
"sound": "NONE",
"keyboard": "NONE",
"input_selection": "NONE",
"accessibility": "NONE",
"accessibility_reset_to_default": "NONE",
"accessibility_high_contrast_text": "NONE",
"accessibility_cc_deuteranomaly": "NONE",
"accessibility_cc_protanomaly": "NONE",
"accessibility_cc_tritanomaly": "NONE",
"accessibility_mono_audio": "NONE",
"accessibility_display_size": "NONE",
"accessibility_talkback": "NONE",
"accessibility_text_to_speech": "NONE",
"mobile_data": "NONE",
"bluetooth": "NONE",
"language": "NONE",
"time_and_date": "NONE",
"storage": "NONE",
"data_roaming": "NONE",
"wifi_tethering": "NONE",
"airplane_mode": "NONE"
}
},
"android_settings_app_settings": {"apply_policy": "ALWAYS APPLY",
"allow_android_settings_app": true
},
"customized_device_level_json_settings": {"apply_policy": "ALWAYS APPLY",
"customized_json": { }
},
"google_services_settings": {"afw_account_settings": {"apply_policy": "ALWAYS APPLY",
"allow_afw_account_addition": true
},
"personal_accounts_settings": {"apply_policy": "ALWAYS APPLY",
"personal_accounts_limit_value": 0
},
"play_store_settings": {"apply_policy": "ALWAYS APPLY",
"allow_playstore": true
},
"google_assitant_settings": {"apply_policy": "ALWAYS APPLY",
"allow_google_assistant": true
},
"factory_reset_protection_settings": {"apply_policy": "ALWAYS APPLY",
"google_id": "string",
"email": "string"
}
},
"external_device_settings": {"apply_policy": "ALWAYS APPLY",
"allow_external_device_mount": true
},
"usb_tethering_settings": {"apply_policy": "ALWAYS APPLY",
"allow_usb_tethering": true
},
"file_transfer_settings": {"apply_policy": "ALWAYS APPLY",
"allow_file_transfer": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"location_settings": {"apply_policy": "ALWAYS APPLY",
"allow_location": true
},
"sound_settings": {"alarm_settings": {"apply_policy": "ALWAYS APPLY",
"alarm_volume": 0
},
"music_settings": {"apply_policy": "ALWAYS APPLY",
"music_volume": 0
},
"ringtone_settings": {"apply_policy": "ALWAYS APPLY",
"ringtone_volume": 0
},
"notification_settings": {"apply_policy": "ALWAYS APPLY",
"notification_volume": 0
},
"voice_call_settings": {"apply_policy": "ALWAYS APPLY",
"voice_call_volume": 0
}
},
"system_updates_settings": {"apply_policy": "ALWAYS APPLY",
"system_update_policy_type": "UPDATE AUTOMATICALLY",
"maintenance_start": "string",
"maintenance_end": "string"
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"allow_edit_time_date": true
},
"timezone_settings": {"apply_policy": "ALWAYS APPLY",
"timezone": "string"
},
"langauge_settings": {"apply_policy": "ALWAYS APPLY",
"device_locale": "string"
},
"strict_wifi_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_wifi_synchronization": true
},
"strict_app_synchronization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_strict_app_synchronization": true
},
"apps": [{"app_id": "string",
"app_version_id": "string",
"package_name": "string",
"installation_rule": "POST PROVISIONING",
"state": "SHOW",
"managed_config": { },
"type": "PRELOADED",
"auto_update_mode": "autoUpdateDefault"
}
],
"files": [{"file_id": "string",
"destination_path": "string"
}
],
"wifi_networks": [{"wifi_network_id": "string",
"certificate_file_path": "/storage/emulated/0/Documents",
"certificate_file_password": "abc"
}
],
"saved_ap_settings": {"apply_policy": "ALWAYS APPLY",
"use_only_saved_ap": true
},
"mac_address_randomization_settings": {"apply_policy": "ALWAYS APPLY",
"allow_mac_address_randomization": true
}
},
"ios": {"kiosk_app": {"app_id": "string",
"app_type": "VPP"
},
"device_mode_settings": {"apply_policy": "ALWAYS APPLY",
"device_mode": "KIOSK"
},
"local_app_install_settings": {"apply_policy": "ALWAYS APPLY",
"allow_local_app_install": true
},
"app_uninstall_settings": {"apply_policy": "ALWAYS APPLY",
"allow_app_uninstallation": true
},
"bluetooth_settings": {"apply_policy": "ALWAYS APPLY",
"edit_bluetooth": true
},
"nfc_settings": {"apply_policy": "ALWAYS APPLY",
"allow_nfc": true
},
"factory_reset_settings": {"apply_policy": "ALWAYS APPLY",
"allow_factory_reset": true
},
"screenshot_settings": {"apply_policy": "ALWAYS APPLY",
"allow_screenshot": true
},
"custom_device_level_profile_settings": {"apply_policy": "ALWAYS APPLY",
"custom_profile": "string"
},
"siri_settings": {"apply_policy": "ALWAYS APPLY",
"allow_siri": true
},
"tethering_settings": {"apply_policy": "ALWAYS APPLY",
"edit_hotspot": true
},
"camera_settings": {"apply_policy": "ALWAYS APPLY",
"allow_camera_access": true
},
"hide_preloaded_apps_settings": {"apply_policy": "ALWAYS APPLY",
"hide_preloaded_apps": true
},
"time_date_settings": {"apply_policy": "ALWAYS APPLY",
"force_automatic_time_date": false
},
"wifi_networks": [{"wifi_network_id": "string"
}
],
"apps": [{"app_id": "string",
"app_version_id": "string",
"state": "SHOW",
"app_type": "VPP"
}
],
"wallpaper_settings": {"homescreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
},
"lockscreen": {"apply_policy": "ALWAYS APPLY",
"portrait": {"wallpaper_id": "string"
}
}
},
"web_content_settings": {"apply_policy": "ALWAYS APPLY",
"url_blocklist": ["string"
],
"url_allowlist": ["string"
]
},
"defer_os_updates": {"apply_policy": "ALWAYS APPLY",
"defer_os_updates_delay": 90
}
}
},
"created_by": "string",
"updated_by": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"message": "string",
"code": 201
}

➔ Next to System Status Code

Blueprints API

Retrieve all blueprints

query Parameters

Create a new blueprint

Request Body schema: application/json

Retrieve a blueprint by ID

path Parameters

Update a blueprint by ID

path Parameters

Request Body schema: application/jsonrequired

Delete a blueprint by ID

path Parameters

Retrieve all versions of a blueprint

path Parameters

query Parameters

Retrieve a specific version of the blueprint

path Parameters

Request Body schema: application/json
required