Re-include devices into a deployment
POST
/api/v1/deployments/{id}/targets/include
const url = 'http://localhost:3000/api/v1/deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/targets/include';const options = { method: 'POST', headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'}, body: '{"deviceIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:3000/api/v1/deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/targets/include \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <X-API-Key>' \ --data '{ "deviceIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'Makes devices that were removed from the deployment ordinary targets again. They return to the device desired state on its next poll.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
Deployment UUID
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
deviceIds
required
Previously removed devices to make ordinary targets of the deployment again
Array<string>
Examplegenerated
{ "deviceIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ]}Responses
Section titled “Responses”Devices re-included
Media typeapplication/json
object
includedDeviceIds
required
Devices that are ordinary targets again
Array<string>
Examplegenerated
{ "includedDeviceIds": [ "example" ]}A device was not removed from this deployment
Forbidden — caller lacks required permission
Deployment not found, or the device is not a target