Smart Licensing APIs

Scope of API for Smart Licensing REST Web Service

This is a web interface to the Smart Licensing REST Web Service. This web service contains Read APIs to view data for the Smart Licensing. Use the REST APIs URL to fetch, configure, and update the smart licensing-related activities in the HCM-F Smart Licensing.

URL (Base URL)

HTTPs Method

GET

POST

PUT

UPDATE

DELETE
Configure Smart Account 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/smartAccountConfig

N

Y

N

N

N
Update Smart Account by Id 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/smartAccountConfig/pkid

N

N

Y

N

N
Delete Smart AccountY 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/smartAccounts/smartAccountId

N

N

N

N

Y
Schema Smart Account Config 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/smartAccountConfig/schemameta

N

Y

N

N

N
List of Smart Accounts 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/smartAccounts

Y

N

N

N

N
Schema for Transport Settings 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/transportMode/schemameta

Y

N

N

N

N
List of VA for Smart Accounts 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/smartAccount/{pkid}/virtualAccounts

Y

N

N

N

N
List all Virtual Account 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/smartAccount/virtualAccounts

Y

N

N

N

N
Get a Virtual Account details by Id 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/smartAccount/virtualAccount/pkid

Y

N

N

N

N
Get a Virtual Account by name 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/smartAccount/virtualAccount/name/name

Y

N

N

N

N
Update a Virtual Account by ID 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/smartAccount/virtualAccount/pkid

N

N

N

Y

N
Schema for Virtual Account 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/smartAccount/virtualAccount/updateSchemameta

Y

N

N

N

N
Assign Cluster to a Virtual Account 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/assignCluster

N

Y

N

N

N
Schema for Assign Cluster to a Virtual Account 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/assignCluster/schemameta

Y

N

N

N

N
Unassign Cluster to a Virtual Account 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/unassignCluster

N

Y

N

N

N
Schema for unassign Cluster to a Virtual Account 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/unassignCluster/schemameta

Y

N

N

N

N
Sync from CSSM 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/schedule

N

Y

N

N

N
Schema for Sync request 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/schedule/schemameta

Y

N

N

N

N
Get VA info based on cluster ID 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/clusters/pkid

Y

N

N

N

N
Get VA info based on cluster name 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/clusters/name/name

Y

N

N

N

N
Unassign Cluster 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/unassignCluster

N

Y

N

N

N
Get All Subscription Details 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/subscriptions

Y

N

N

N

N
Get Subscription Details for a Customer 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/subscriptions/customer/customerId

Y

N

N

N

N
Update Subscription Details 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/subscriptions

N

N

Y

N

N
Cluster Summary 
https://HCMF_HOST_NAME:8443/sdr/rest/smartLic/clusterSummary

Y

N

N

N

N

Configure Smart Account (Client Id and Client Secret)

Title

Configure Client id and Client Secret

Root URL

 
https://HCMF_HOST_NAME:8443/sdr/rest/

URL

 
smartLic/smartAccountConfig

Method

POST

URL Params

Data Params

smartLic/smartAccountConfig/schemameta

Success Response

200

Error Response

400- Smart Account Access Error

400 – Invalid domain name / clientId / clientSecret / authGateway / serverUrl / transportMode

400 – Smart Account Does not exist

400 – Smart Account Already exist

400 – Validation Error

400 – AutoReg VA allowed only if operationalLic is enabled

400 – Enable AutoReg only when Operational Licenses are selected

400 – VAs are mandatory when Operational Licenses enabled

400 – Only one SA for AutoReg

400 – At least one SA must have Operational Licenses eenabled

412 – Sync In Progress

500 – Service down , unknown

Example

 
{
	"domainName": "hcs-intg.cisco.com",
	"clientID": "",
	"clientSecret": "",
	"serverUrl": "",
	"authGateway": "",
	"satelliteHostName": "",
	"satellitePort": 22,
	"transportMode": "proxy",
	"proxyHostName": "",
	"proxyPort":,
	"isOperationalLicenseEnabled": ,
	"isAutoRegistrationEnabled": ,
	"virtualAccOrdered": "",
	"virtualAccOperational": ""
}

Notes

Update Smart Account by Id

Title

Update Smart Accounts

Root URL

 
https://HCMF_HOST_NAME:8443/sdr/rest/

URL

 
smartLic/smartAccountConfig/pkid

Method

PUT

URL Params

Pkid – integer

Pkid – Smart Account identifier

Data Params

Success Response

200

Error Response

400- Smart Account Access Error

400 – Invalid domain name / clientId / clientSecret

400 – Smart Account Does not exist

400 – Validation Error

400 – Invalid pkid

412 – Sync In Progress

500 – Unknown, service down

Example

For Direct Mode:

{
	"clientID": "",
	"clientSecret": "",
	"isOperationalLicenseEnabled": true,
	"isAutoRegistrationEnabled": false,
	"virtualAccOrdered": "",
	"virtualAccOperational": ""
}

For Proxy Mode:

{
	"clientID": "",
	"clientSecret": "",
	"proxyHostName": "",
	"proxyPort": ,
	"isOperationalLicenseEnabled": true,
	"isAutoRegistrationEnabled": false,
	"virtualAccOrdered": "",
	"virtualAccOperational": ""
}

For Satellite Mode:

{
"clientID": "",
	"clientSecret": "",
	"serverUrl": "",
	"authGateway": "",
	"satelliteHostName": "10.78.89.169",
	"satellitePort": ,
	"proxyHostName": "",
	"proxyPort": 0,
	"isOperationalLicenseEnabled": false,
	"isAutoRegistrationEnabled": true,
	"virtualAccOrdered": "",
	"virtualAccOperational": ""
}

Notes

Delete Smart Account

Title

Delete Smart Account

Root URL

 
https://HCMF_HOST_NAME:8443/sdr/rest/

URL

 
smartLic/smartAccounts/smartAccountId

Method

DELETE

URL Params

smartAccountId

Data Params

smartLic/smartAccountConfig/schemameta

Success Response

200

Error Response

400 -Smart account does not exist

400-Validation error

400 -Smart Account cannot be deleted

412-Sync in progress

500 - Unknown, service down

Example

Notes

Schema Smart Account Config

Title

Schema for Smart Account Config

Root URL

 
https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/smartAccountConfig/schemameta

Method

 
GET

URL Params

Data Params

Success Response

200

Error Response

404- Resource not found

Example

Notes

List of Smart Accounts

Title

Get List of Smart Accounts

Root URL

 
https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/smartAccounts

Method

 
GET

URL Params

Data Params

Success Response

200

Error Response

500 – Unknown, service down

Example

Notes

Schema for Transport Settings

Title

Assign a Cluster to a Virtual Account

Root URL

 
https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/transportMode/schemameta

Method

 
GET

URL Params

Data Params

Success Response

200

Error Response

404- Resource not found

Example

Notes

List of Virtual Accounts for Smart Accounts

Title

Get List of Virtual Account for a Smart Account

Root URL

 
https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/smartAccount/pkid/virtualAccounts

Method

GET

URL Params

Pkid = integer

Pkid = Smart Account identifier

Data Params

Success Response

200

Error Response

404- Invalid KID found

500 – Unknown Errors, Service Down

Example

Notes

List all Virtual Account

Title

Get all the Virtual Accounts

Root URL

 
https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/smartAccount/virtualAccounts

Method

GET

URL Params

Data Params

Success Response

200

Error Response

500 – Unknown Errors, Service Down

Example

Notes

Get a Virtual Account Details by ID

Title

Get all the Virtual Accounts

Root URL

 
https://HCMF_HOST_NAME:8443/sdr/rest/

URL

 
smartLic/smartAccount/virtualAccount/pkid

Method

GET

URL Params

Pkid = integer

Pkid = Virtual Account identifier

Data Params

Success Response

200

Error Response

404- SmartLic Data Issue

500 – Unknown, Service Down

Example

Notes

Get a Virtual Account by Name

Title

Update the License mode of Virtual account based on name

Root URL

https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/smartAccount/virtualAccount/name/name

Method

 GET

URL Params

Name = String

name = Name of the Virtual Account

Data Params

Success Response

200

Error Response

404- Data Issue

500 – Unknown , Service Down

Example

Notes

Only License Mode update is allowed.

Update a Virtual Account by Id

Title

Update the License mode of Virtual account based on ID

Root URL

https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/smartAccount/virtualAccount/pkid

Method

 UPDATE

URL Params

Pkid = integer

Pkid = Virtual Account identifier

Data Params

smartLic/smartAccount/virtualAccount/updateSchemameta

Success Response

200

Error Response

400- SmartLic Data issue

404 - Invalid KID found

412 – Deployment Mode cannot be changed

500 – Unknown , Service Down

Example

Notes

Only License mode updation is allowed

Update a Virtual Account by Name

Title

Update the License mode of Virtual account based on name

Root URL

https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/smartAccount/virtualAccount/name/{name}

Method

 
UPDATE

URL Params

Name = String

name – Name of the Virtual Account

Data Params

smartLic/smartAccount/virtualAccount/updateSchemameta

Success Response

200

Error Response

400- SmartLic Data issue

412 – Deployment Mode cannot be changed

500 – Unknown , Service Down

Example

 
{
	"licMode": "HCS/HCS_LE/ENTERPRISE"
}

Notes

Only License mode updation is allowed

Schema for Virtual Account

Title

Schema for Virtual account

Root URL

 
https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/smartAccount/virtualAccount/updateSchemameta

Method

 GET

URL Params

Data Params

Success Response

200

Error Response

404- Resource not found

Example

Notes

Only License Mode update is allowed.

Assign Cluster to a Virtual Account

Assignment of Expressway C and E Clusters

Assign Expressway E and C clusters from the Virtual Account. Smart Software Manager Cisco SSM On-Prem server 7.2 or later supports assigning Expressway E and C Clusters. They are assigned only if all the subordinate peers are added in the HCMF application, else the assignment is not accepted. Ensure to enter Correct credentials, network address and proxy details during assignment.

Title

Assign a Cluster to a Virtual Account

Root URL

 
https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/assignCluster

Method

 
POST

URL Params

Data Params

smartLic/assignCluster/schemameta

Success Response

200

Error Response

400- Virtual Account Invalid

400 – Cluster Invalid

412 –Deployment Mode not set

412 – Cluster Validation Failed

412 – Cluster InUse

400 – Cluster type not supported

412 – Cluster not having platform credentials

412 – Cluster version incorrect

412 – Cluster not having admin credentials

412 – Cluster not having publisher

412 – Cluster already assigned

500 –Unknown, service down

Example

 
{
"clusterName": "cucm-cluster",
"virtualAccountName": "TEST_ACCOUNT",
}

Notes

Schema to Assign Cluster to a Virtual Account

Title

Schema for Assignment

Root URL

https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/assignCluster/schemameta

Method

 
GET

URL Params

Data Params

Success Response

200

Error Response

404- Resource not found

Example

Notes

Unassign Cluster to a Virtual Account

Title

Unassign a Cluster from a Virtual Account

Root URL

https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/unassignCluster

Method

 
POST

URL Params

Data Params

smartLic/unassignCluster/schemameta

Success Response

200

Error Response

400- Cluster Invalid

412 – Cluster Validation Failed

412 – Cluster Inuse

400 – Cluster Type Not supported

412 – Cluster Not having platform Cred

412 – Cluster Version Incorrect

412 – Cluster not having admin Credentials

412 –Cluster not having publisher

412 – Cluster already unassigned

500 – Unknown, service down

Example

Notes

Schema to Unassign Cluster to a Virtual Account

Title

Schema for unassignment

Root URL

https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/unassignCluster/schemameta

Method

 
GET

URL Params

Data Params

Success Response

200

Error Response

404- Resource not found

Example

 
{
"clusterName": "cucm-cluster",
}

Notes

Sync from CSSM

Title

Sync fulfillment data with CSSM

Root URL

 
https://HCMF_HOST_NAME:8443/sdr/rest/

URL

 
smartLic/schedule/smartAccountId

Method

 
POST

URL Params

smartAccountId – Integer

smartAccountId – SmartAccount identifier

Data Params

smartLic/schedule/schemameta

Success Response

200

Error Response

412- Scheduler already running

400 – SmartAccount does not exist

400 – Invalid SmartAccount Id

500 – Unknown, service down

Example

Notes

Schema for Sync Request

Title

Schema for Sync Request

Root URL

 
https://HCMF_HOST_NAME:8443/sdr/rest/

URL

 
smartLic/schedule/schemameta

Method

 
GET

URL Params

Data Params

Success Response

200

Error Response

404- Resource not found

Example

Notes

Get Virtual Account Info Based on Cluster ID

Title

Get the VA info for cluster Id

Root URL

https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/clusters/pkid

Method

 
GET

URL Params

Pkid- Integer

Pkid of the cluster

Data Params

Success Response

200

Error Response

404- Data Issue

404 - Invalid KID

500 – Unknown, Service Down

Example

Notes

Get Virtual Account Info Based on Cluster Name

Title

Get the VA info for cluster name

Root URL

https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/clusters/name/name

Method

 
GET

URL Params

name- String

name of the cluster

Data Params

Success Response

200

Error Response

404- Data Issue

500 – Unknown , Service Down

Example

Notes

Unassign Cluster

Title

Unassign cluster from a Virtual Account

Root URL

https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/unassignCluster

Method

 
POST

URL Params

Data Params

Success Response

200

Error Response

400 – Cluster Invalid

412 – Cluster Validation Failed

412 – Cluster In Use

400 – Cluster type not supported

412 – No Platform/Admin credentials found for cluster

412 – Cluster version incorrect

412 – Publisher not found for cluster

412 – Cluster already unassigned

500 – Unknown , Service Down

Example

 
{
	"clusterId": "1",
	"clusterName": "",
	"virtualAccountId": ""
}

Notes

Get All Subscription Details

Title

Get subscription details for all Smart Accounts including satellite

Root URL

https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/subscriptions

Method

 
GET

URL Params

Data Params

Success Response

200

Error Response

404 - Resource not found

500 – Unknown , Service Down

Example

Notes

Get Subscription Details for a Customer

Title

Get subscription details for a customer

Root URL

https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/subscriptions/customer/customerId

Method

 
GET

URL Params

customerId – Integer

customerId – Customer identifier

Data Params

Success Response

200

Error Response

400 – Data issue

400 – Invalid KID

400 – Validation error

500 – Unknown , Service Down

Example

Notes

Update Subscription Details

Title

Update subscription details for a customer

Root URL

https://HCMF_HOST_NAME:8443/sdr/rest/

URL

smartLic/subscriptions

Method

 
PUT

URL Params

Data Params

Success Response

200

Error Response

400 – Data Issue

400 – Invalid License Model

400 – Validation error

400 – Invalid KID

500 – Unknown , Service Down

Example

 
{
"subscriptionId" : "" ,
"customerId":"",
"licenseModel": ""
}

Notes

Cluster Summary

Title

Cluster Summary

Root URL

 
https://HCMF_IP_Adress/sdr/rest/

URL

smartLic/clusterSummary

Method

 
GET

URL Params

Data Params

Success Response

200

Error Response

500 – Unknown , Service Down

Example

Notes