Endpoint Configuration (1.0.0)

Download OpenAPI specification:Download

Endpoint Configuration

Array

name required	string Endpoint name
description	string Endpoint description
type required	string Enum: "MQTT" "HTTP-POST" "AWS" "AZURE" "KEYBOARD-EMULATION" Endpoint type
required	MQTT (object) or HTTP Post (object) or AWS (object) or AZURE (object) or KEYBOARD-EMULATION (object)
	object

{"name": "AWS #1",
"description": "AWS Dev Zebra",
"type": "AWS",
"configuration": {"connectionParams": {"deviceEndpoint": "a2zfe1kcf0rw55-ats.iot.ap-south-1.amazonaws.com",
"port": 8883,
"clientId": "test-e48dee74-2449-47bd-a6b7-0632dd932067",
"debug": false
},
"security": {"useLocalCerts": true,
"certificates": {"certificatePath": "/apps/AWS/Demo_Thing1.cert.pem",
"certAlgorithm": "RS256",
"certFormat": "PEM",
"privateKeyPath": "/apps/AWS/Demo_Thing1.private.key",
"CACertificatePath": "/apps/AWS/root-CA.crt"
},
"verifyServerCertificate": true
},
"topics": {"tagEvents": {"topic": "events",
"qos": 0,
"retain": true
},
"managementEvents": {"topic": "asynevents",
"qos": 0,
"retain": true
},
"management": {"command": {"topic": "commands",
"qos": 0,
"retain": true
},
"response": {"topic": "responses",
"qos": 0,
"retain": true
}
},
"control": {"command": {"topic": "commands",
"qos": 0,
"retain": true
},
"response": {"topic": "responses",
"qos": 0,
"retain": true
}
}
}
}
}

Interface to Endpoint Mapping

required	object control interface to endpoint mapping
data required	Array of strings [ 0 .. 2 ] items Endpoint Configuration tobe used for Tag Data Events Interface
event required	Array of strings Endpoint Configuration tobe used for Management Events Interface
required	object management interface to endpoint mapping

{"control": {"enableLocalRest": false,
"endpoints": ["string"
]
},
"data": ["string"
],
"event": ["string"
],
"management": {"enableLocalRest": false,
"endpoints": ["MQTT #1"
]
}
}