Register a component as installed on a device.
POST/devices/:device_id/components
This endpoint allows a device to report that it has a specific component installed.
The component can be identified either by its catalogId, or by a combination of name and version.
- Use
catalogIdwhen it is known (usually from the server). - Use
nameandversionwhencatalogIdis not available.
The agent will associate the component with the given device. If the component does not yet exist, the agent may create a new one based on the provided data.
Request
Path Parameters
device_id stringrequired
ID of the device to retrieve components for
- application/json
Body
required
- MOD1
- MOD2
oneOf
name stringrequired
version stringrequired
catalogId stringrequired
Responses
- 200
- 500
- application/json
- Schema
- Example (from schema)
Schema
message stringrequired
name stringrequired
statusCode int32required
{
"message": "string",
"name": "string",
"statusCode": 0
}
Loading...