Skip to main content

Device-RMA

APIs for device maintenance activities such as Return Merchandise Authorization (RMA).

Trigger Device RMA

Request

Triggers a request to create an RMA of a device. The payload to create an RMA is different for different vendors. You will need to enter a license to create an RMA.

Security
BearerAuth
Path
virtualDeviceUuidstringrequired

Unique ID of a device

Example:877a3aa2-c49a-4af1-98a6-007424e737ae
Bodyapplication/jsonrequired

Post RMA request

versionstringrequired

Any version you want.

Example:"17.09.01a"
cloudInitFileIdstring

For a C8KV device, this is the Id of the uploaded bootstrap file. Upload your Cisco bootstrap file by calling Upload File. In the response, you'll get a fileUuid that you can enter here as cloudInitFileId. This field may be required for some vendors.

Example:"029a0bcd-0b2f-4bc5-b875-b506aa4b9738"
licenseFileIdstring

This is the Id of the uploaded license file. For a CSR1KV SDWAN device, upload your license file by calling Upload License File. In the response, you'll get a fileId that you can enter here as licenseFileId. This field may be required for some vendors.

Example:"329a0bcd-0b2f-4bc5-b875-b506aa4b9730"
tokenstring

License token. For a cluster, you will need to provide license tokens for both node0 and node1. To get the exact payload for different vendors, check the Postman script on the API Reference page of online documentation.

Example:"897gjikk888"
vendorConfigobject(RMAVendorConfig)

RMA vendor configuration

userPublicKeyobject(UserPublicKeyRequest)

An object with public key details.

Payload
{ "version": "17.09.01a", "cloudInitFileId": "029a0bcd-0b2f-4bc5-b875-b506aa4b9738", "licenseFileId": "329a0bcd-0b2f-4bc5-b875-b506aa4b9730", "token": "897gjikk888", "vendorConfig": { "siteId": "567", "systemIpAddress": "192.164.0.0", "licenseKey": "6735-vwe64568-6a91-4112-8734-bea12d91f7y7", "licenseSecret": "h5j0i45e83324pblbfca764532c4a640e7801f0", "controller1": "54.219.248.29", "adminPassword": "ZQeIDI7sUd", "activationKey": "GJUK-JM2X-59BJ-2TDJ", "provisioningKey": "provisioningKeysample", "panoramaIpAddress": "1.1.1.1", "panoramaAuthKey": "123456" }, "userPublicKey": { "username": "test-user-1", "keyName": "test-pk-2" } }

Responses

You successfully triggered an RMA request.

Response
No content
Was this page helpful?