v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
blueprints_Blueprints API

Creates a new blueprint in the enterprise. Blueprints define device configuration and management rules (for example, kiosk/device mode settings, app/file payloads, Wi-Fi networks, and OS-specific restrictions). After you create a blueprint, you can publish versions and then assign/apply it to devices through separate workflows. Creating a blueprint doesn’t affect devices by itself. Devices won’t change until the blueprint (and typically a specific version) is assigned/applied via a separate endpoint/workflow. Because the create response is list-shaped, you should read the new blueprint ID from content.results[0].id. If your workflow relies on versioning, capture both the blueprint id and the returned version_id (if present in your create response), since later calls may require one or the other. Workflow: After creating a bluerprint, assign a device or group to it using POST https://{foo}-api.esper.cloud/api/v2/converge

post/v2/blueprints/

Request body

idstring uuid
namestring

Name of the blueprint

descriptionstring

Description of the blueprint

commentsstring

Comments on the blueprint

version_numberinteger
version_idstring uuid
minor_version_numberinteger
publishboolean
created_bystring

ID of the user who created the blueprint

updated_bystring

ID of the user who updated the blueprint

created_atstring date-time
updated_atstring date-time

Response

Success

messagestring
code201