Skip to content

/v2/blueprints/
Stable

Request

Create a new blueprint

Bodyapplication/json
namestring

Name of the blueprint

descriptionstring

Description of the blueprint

commentsstring

Comments on the blueprint

settingsobject(settingsV2)
cURL
curl -i -X POST \
  https://develop-api.esper.io/_mock/openapi/v2/blueprints/ \
  -H 'Content-Type: application/json' \
  -d '{
    "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",
          "drift_policy": "IGNORE"
        },
        "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_font_scale": "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"
        },
        "language_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
        },
        "esper_edgebox_settings": {
          "apply_policy": "ALWAYS APPLY",
          "allow_esper_edgebox": true
        },
        "app_layout_setting": {
          "apply_policy": "ALWAYS APPLY",
          "brand_logo_position": "BOTTOM_LEFT",
          "device_name_position": "BOTTOM_LEFT",
          "app_icon_size": "SMALL_ICON",
          "app_name_size": "SMALL_TEXT",
          "device_name_and_id_display_policy": "NONE",
          "device_name_size": "SMALL_TEXT",
          "device_alias_size": "SMALL_TEXT",
          "custom_app_icon_size": 20,
          "custom_device_name_size": 20,
          "custom_device_alias_size": 20,
          "custom_app_name_size": 20
        },
        "app_order_setting": {
          "apply_policy": "ALWAYS APPLY",
          "app_order_list": [
            {
              "type": "SINGLE_APP",
              "name": "string"
            }
          ]
        }
      },
      "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",
            "base64_app_config": "string"
          }
        ],
        "provisioning_profiles": [
          {
            "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",
            "profile_version_id": "726fc2c8-661f-4125-9715-e56910a6b008"
          }
        ],
        "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": 0
        }
      },
      "linux": {
        "custom_shell_scripts_multiple": {
          "shell_scripts": [
            {
              "apply_policy": "ALWAYS APPLY",
              "script": "string",
              "interpreter": "string",
              "alias": "string",
              "description": "string"
            }
          ]
        },
        "custom_actions_multiple": {
          "custom_actions": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "options_key": "3412fc60-c4a6-49a4-a995-c788ceac0a42",
              "apply_policy": "ALWAYS APPLY"
            }
          ]
        },
        "files": [
          {
            "file_id": 0,
            "destination_path": "/tmp"
          }
        ]
      },
      "windows": {
        "active_hours_settings": {
          "active_hours_start": {
            "apply_policy": "ALWAYS APPLY",
            "time": 8
          },
          "active_hours_end": {
            "apply_policy": "ALWAYS APPLY",
            "time": 17
          }
        },
        "apps": [
          {
            "app_id": "string",
            "app_version_id": "string",
            "state": "SHOW",
            "app_type": "TENANT_WINDOWS",
            "base64_app_config": "string"
          }
        ],
        "auto_update_settings": {
          "apply_policy": "ALWAYS APPLY",
          "auto_update_type": "DEFAULT"
        },
        "bluetooth_settings": {
          "apply_policy": "ALWAYS APPLY",
          "allow_bluetooth": true,
          "bluetooth_state": "ENABLE",
          "drift_policy": "IGNORE"
        },
        "camera_settings": {
          "apply_policy": "ALWAYS APPLY",
          "allow_camera_access": true
        },
        "custom_shell_scripts_multiple": {
          "shell_scripts": [
            {
              "apply_policy": "ALWAYS APPLY",
              "script": "string",
              "interpreter": "string",
              "alias": "string",
              "description": "string"
            }
          ]
        },
        "device_mode_settings": {
          "apply_policy": "ALWAYS APPLY",
          "device_mode": "KIOSK"
        },
        "defer_os_updates": {
          "quality_updates": {
            "apply_policy": "ALWAYS APPLY",
            "defer_days": 0
          },
          "feature_updates": {
            "apply_policy": "ALWAYS APPLY",
            "defer_days": 0
          }
        },
        "factory_reset_settings": {
          "apply_policy": "ALWAYS APPLY",
          "allow_factory_reset": true
        },
        "kiosk_settings": {
          "win32_single_app_config": {
            "name": "string",
            "desktop_app_path": "string",
            "auto_launch": true,
            "auto_launch_arguments": "",
            "hide_taskbar": true,
            "hide_start_recommended_section": true,
            "hide_power_button": false
          }
        },
        "pause_os_updates": {
          "apply_policy": "ALWAYS APPLY",
          "pause_os_updates": false
        },
        "timezone_settings": {
          "apply_policy": "ALWAYS APPLY",
          "timezone": "string"
        },
        "unenrollment_settings": {
          "apply_policy": "ALWAYS APPLY",
          "allow_unenrollment_from_device": true
        },
        "wallpaper_settings": {
          "homescreen": {
            "apply_policy": "ALWAYS APPLY",
            "landscape": {
              "wallpaper_id": "d5a4b22a-efdd-4a96-a11c-bdb1cc56c9b0"
            }
          },
          "lockscreen": {
            "apply_policy": "ALWAYS APPLY",
            "landscape": {
              "wallpaper_id": "d5a4b22a-efdd-4a96-a11c-bdb1cc56c9b0"
            }
          }
        },
        "wifi_networks": [
          {
            "wifi_network_id": "string"
          }
        ]
      }
    }
  }'

Responses

Success

Bodyapplication/json
contentobject(BlueprintV2)
messagestring
codeinteger
Value:201
Response
{ "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": {}, "created_by": "string", "updated_by": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "message": "string", "code": 201 }