Cisco Cisco Prime Home 6.3 Developer's Guide

 

OL-28558-01   v5.1

 

26 

GET 

- 

(device) 

 

 

Endpoint: 

… /prime-home/api/v1/devices   

The TOC for devices, used to create new future devices.  

See also: 

.../prime-home/api/v1/templates/devices

. 

The minimum required fields for creating a new future device are:  

•  oui 

and 

sn  

• 

OR: 

provisioningCode

  

• 

OR: 

cpProvisioningId

 

POST 

(device) 

(device) 

 

 

 

Note: For the following four endpoints which include

 deviceId; deviceId

 can be 

represented as:

 

      

a.  A numberic ID (as seen in the URL of the Customer Support Page)

 

      

b.  <oui>:<serial number>, for example: 

/devices/001A2B:001A2B987654

 

     

c.  sn:<serial number>, if you are sure your serial numbers are all unique. 

 

 

                     e.g.  

/devices/sn:001A2B987654

 

 

 

Endpoint: 

… /prime-home/api/v1/devices/deviceId 

Represents a single device. This particular endpoint cannot be modified. 

GET 

- 

(device) 

DELETE 

- 

- 

 
 

Endpoint: 

… /prime-home/api/v1/devices/deviceId/data 

This document contains information about the device itself and the configuration of 

each application on that device. 

GET 

- 

{device-data}

 

PUT 

{device-data}

 

{device-data}

 

 

Endpoint: 

… /prime-home/api/v1/devices/deviceId/actions 

This document contains the state of actions to be performed on the device, such as 

synchronizing applications or enabling services. 

GET 

- 

{device-action}

 

PUT 

{device-action}

 

{device-action}