Device Provisioning Service API Overview¶

The device provisioning service APIs provide management operations for devices in Device Provisioning Service. For more information on Device Provisioning Service, see Device Provisioning Service.

Prerequisites¶

Ensure that you have read the limitations for Device Provisioning Service. See Limitations.

API List¶

Device Provisioning Service APIs are divided into two categories according to the invokers:

Application APIs: the APIs provided by EnOS for developers to access system resources and develop various applications. Before invoking Application APIs, you need to get gateway address, authorize the service account, and prepare development environment.
Device APIs: the APIs provided by Device Provisioning Service only and invoked by devices. With Device APIs, devices can directly register themselves and get their authentication information. Device APIs utilize a special gateway address and do not need the environment preparation. For more information, see About Device APIs.

Application API List¶

Refer to the table below for the list of Application APIs, and whether they can be used by EnOS Cloud and EnOS Edge.

Version 2.5 has been added for some Application APIs in EnOS 2.4 CU2. For details, see EnOS 2.4 CU2.

Operation Name	Description	URL	EnOS Cloud	EnOS Edge
Create DPS Device	Create DPS devices	V2.5: /dps-service/v2.5/pvs/device?action=create V4.0: /dps-service/v4.0/pvs/device?action=create	√	×
Get DPS Device	Get the information of a DPS device	V2.5: /dps-service/v2.5/pvs/device?action=get V4.0: /dps-service/v4.0/pvs/device?action=get	√	×
Allocate DPS Device	Allocate and activate a DPS device	V2.5: /dps-service/v2.5/pvs/device?action=allocate V4.0: /dps-service/v4.0/pvs/device?action=allocate	√	×
Reset Device Allocation Status	Reset the allocation status of devices	V2.5: /dps-service/v2.5/pvs/device?action=resetAllocationStatus V4.0: /dps-service/v4.0/pvs/device?action=resetAllocationStatus	√	×
Search DPS Device	Search for DPS devices based on the search criteria	/dps-service/v2.5/pvs/device?action=search	√	×
Delete DPS Device	Delete DPS devices	/dps-service/v2.5/pvs/device?action=delete	√	×
Update DPS Device	Update a DPS device	/dps-service/v2.5/pvs/device?action=update	√	×
Replace DPS Device	Replace a DPS device	/dps-service/v2.5/pvs/device?action=replace	√	×

Device API List¶

Refer to the table below for the list of Device APIs, and whether they can be used by EnOS Cloud and EnOS Edge.

Operation Name	Description	URL	EnOS Cloud	EnOS Edge
Get Device Connection Info	Devices to get their triple information and protocol address	/2.4.4/get/conn	√	×
Bootstrap Device	Direct-connected devices to get their triple information and protocol address, and register themselves	/2.4.4/bootstrap	√	×