Skip to content

Create a converge action

Request

API to create a converge action for a device.

Security
apiKey
Bodyapplication/jsonrequired
device_idstring, (uuid)required

ID of the device

converge_with_provision_optionbooleanrequired
schedule_typestring(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://develop-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(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"
  }
}