Logo

Converge

APIs to list and create converge actions for devices. Learn more about converge.

List converge action

API to get and filter converge action

SecurityapiKey
Request
query Parameters
device_ids
string

Filter by device IDs. Accepts comma separated values.

limit
number
offset
number
Responses
200

Converge action list for the Tenant

401

Authorization information is missing or invalid.

500

Internal server error

get/v2/converge
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Create a converge action
API to create a converge action for a device.


SecurityapiKey 
Request 
Request Body schema: application/json
required
device_id
required
string <uuid> 
ID of the device


 
converge_with_provision_option
required
boolean
 
schedule_type
string (ScheduleEnum) 
Following Schedule types are supported


* WINDOW: Schedule the command to execute within the given window ```



 Enum: "IMMEDIATE" "WINDOW"  
schedule_args
object
 
Responses 
201
Converge action successfully created.


400
Bad request


401
Authorization information is missing or invalid.


500
Internal server error


post/v2/converge
Request samples 
application/json
{
  • "device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
  • "converge_with_provision_option": true,
  • "schedule_type": "IMMEDIATE",
  • "schedule_args": { }
}
Response samples 
application/json
{
  • "content": {
    }
}
Get converge action
API to get a converge action


SecurityapiKey 
Request 
path Parameters
id
required
string
ID of the converge object


 
Responses 
200
Converge information


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/v2/converge/{id}
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
➔ Next to Converge Command