Move Devices to a Customer

1. Log in to the REST API server (api.ezcloudx.com) using MSP Power Admin privileges. You must also forward the credentials with each API call.
2. Get the list of all APs or switches to determine the serial number and the current state of the device that you want to assign or reassign.

   • To get an access point serial number and view its state:

     

     GET HTTP://ipAddress/v1/state/aps

   • To get a switch serial number and view its state:

     

     GET HTTP://ipAddress/v1/state/switches

3. Get the customer accountName and custId:
   

   GET HTTP://ipAddress/v1/customers

4. Create or update the device registration.

   Use the POST method to register an unassigned device:

   • 

     POST HTTP://ipAddress/management/v1/deviceregistration/ap/MspEndCustomer-tenantId

   • 

     POST HTTP://ipAddress/management/v1/deviceregistration/switch/MspEndCustomer-tenantId

   Use the PUT method to move a device from one customer to another customer:

   • 

     PUT HTTP://ipAddress/management/v1/deviceregistration/ap/MspEndCustomer-tenantId

   • 

     PUT HTTP://ipAddress/managementv1/deviceregistration/switch/MspEndCustomer-tenantId

   When you POST or PUT data to the REST API, at minimum set the Content-Type header to application/json. However, you should generally specify two headers when you post the log in request.

   Example:

   • 

     content-type: application/json ;charset=UTF-8
     

   • 

     accept: application/json, text/plain, */*

   Any of the following Accept headers are allowed with the Content-Type header request header:

   • accept: application/json
   • accept-encoding: gzip, deflate, br
   • accept-language: en-US,en;q=0.8,und;q=0.6

   

   Request Attributes: DeviceRegistrationElement

   Attribute	Data Type	Description
   description	String	Identifies the hardware part number of the device. For access points (APs), the part number provides critical information regarding the regulatory domain the AP is to operate in and provides a way to infer the number of radios in the AP and their capabilities. "WS-AP3935i-ROW" is an example of a valid description. Valid character set : Alphanumeric and special characters, except semi-colon, colon, and ampersand.
   deviceName	String	A user-defined, human friendly name for the device. The attribute defaults to the serial number but, unlike serialNumber, an administrator with write privileges can change this attribute at any time. Validations: A not null and non-empty string having maximum of 255 characters. Valid character set Alphanumeric and special characters, except semi-colon, colon, and ampersand.
   lan1Mac	String	The MAC layer address of one of the device's physical wired interfaces. This is usually the interface through which the device will be managed. In the case of Extreme Networks access points, one of the MAC address of one of the wired interfaces of the AP is used. The MAC address is optional but useful. The MAC address is a sequence of 12 ASCII-encode hexadecimal digits without separators. Validations: A not null and non-empty hexadecimal string with no separators. Valid character set: Alphanumeric and special characters, except semi-colon, colon, and ampersand.
   lan2Mac	String	The MAC address of the second wired physical wired interface, if it has one. This MAC address is optional, but useful to know. The MAC address is a sequence of 12 ASCII-encoded hexadecimal digits without separators. "a1b2c3d41621" is an example of a correctly formatted MAC address. Validations: A not null and non-empty hexadecimal string with no separators. Valid character set: Alphanumeric and special characters, except semi-colon, colon, and ampersand.
   manufacturingLot	String	(Optional) The manufacturer's lot number. This can be helpful in the event that the device belongs to a batch that is known to be faulty. In the case of Extreme Network access points, the lot number is embedded in the device serial number. Valid character set: Alphanumeric and special characters except semi-colon, colon, and ampersand.
   serialNumber	String	The globally unique serial number of the device being registered. The serial number is represented as a string. The actual length and format of the string depends on the type of device being registered. This is the only attribute of the device that must not be null. Senao refers to this field as 'Prog#' on the label. "1507Y-1000100000" is an example of a valid serial number. Validations: A not null and non-empty string having exactly 16 characters for APs. Valid character set: Alphanumeric and special characters, except semi-colon, colon, and ampersand.
   wan1Mac	String	(Optional) The MAC layer address of one of an access point's physical wireless interfaces. The MAC address is a sequence of 12 ASCII-encode hexadecimal digits without separators. "a1b2c3d41621" is an example of a correctly formatted MAC address. Validations: A not null and non-empty hexadecimal string with no separators. Valid character set: Alphanumeric and special characters, except semi-colon, colon, and ampersand.
   wan2Mac	String	(Optional) The MAC layer address of one of an access point's physical wireless interfaces. Physical switches will not have these interfaces. The MAC address is a sequence of 12 ASCII-encode hexadecimal digits without separators. "a1b2c3d41621" is an example of a correctly formatted MAC address. Validations: A not null and non-empty hexadecimal string with no separators. Valid character set: Alphanumeric and special characters, except semi-colon, colon, and ampersand.

Example: PUT Request

{"userid":"msp-01@test.com",
"siteRegistration":{"siteName":"",
	"country":null,
	"timeZone":null,
	"latitude":null,
	"longitude":null},
"devices":[{"serialNumber":"0000N-00000",
	"deviceName":"0000N-00000",
	"description":"X440G2-12t-10G4",
	"lan1Mac":null,
	"lan2Mac":null,
	"wan1Mac":null,
	"wan2Mac":null,"manufacturingLot":""}]}

Example: Response

{"userid":"msp-01@test.com",
"siteRegistration":{"siteName":"",
	"country":null,
	"timeZone":null,
	"latitude":null,
	"longitude":null},
"devices":[{"serialNumber":"0000N-00000",
	"deviceName":"0000N-00000",
	"description":"X440G2-12t-10G4",
	"lan1Mac":null,
	"lan2Mac":null,
	"wan1Mac":null,
	"wan2Mac":null,"manufacturingLot":""}]}