Skip to content

Create a converge action
Stable

Request

POST converge (V2). Assigns a device to a specific blueprint (and blueprint version) and triggers the converge workflow. Converge brings the device into alignment with the selected blueprint configuration, including apps, files, restrictions, and platform settings. What this endpoint does Assigns the device to the provided blueprint_id. Targets a specific blueprint_version_id. Queues a converge action (status: QUEUED) for execution. Optionally applies provisioning-related behavior via converge_with_provision_option. Workflow Use Get all blueprints (V2) to retrieve the desired blueprint_id and blueprint_version_id. Use a device listing endpoint to retrieve the device_id or group_id. Send a POST request to /api/v2/converge with the required identifiers. Monitor the converge/command status to confirm successful application.

Security
drift_apiKey
Bodyapplication/jsonrequired
device_idstring, (uuid)required

ID of the device

converge_with_provision_optionbooleanrequired
schedule_typestring(drift_ScheduleEnum)

Following Schedule types are supported

* WINDOW: Schedule the command to execute within the given window ```
Enum:"IMMEDIATE""WINDOW"
schedule_argsobject
cURL
curl -i -X POST \
  https://api.esper.io/_mock/openapi/v2/converge \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
    "converge_with_provision_option": true,
    "schedule_type": "IMMEDIATE",
    "schedule_args": {}
  }'

Responses

Converge action successfully created.

Bodyapplication/json
contentobject(drift_Converge)
Response
{
  "content": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
    "converge_with_provision_option": true,
    "blueprint_info": { … },
    "schedule_type": "IMMEDIATE",
    "schedule_args": {},
    "status": "QUEUED",
    "reason": "string",
    "created_by": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}