License Requirements

Workflows

Workflow: Configure a CSR License Using a Downloaded License File

1.blank.gif Verify that there is a license on the CSR.

2.blank.gif If using a cloned VM, obtain a new UDI.

POST /api/v1/license/udi

See Requesting a New license UDI.

3.blank.gif Accept the EULA.

POST /api/v1/license/eula

See Accepting the EULA.

4.blank.gif Install the license.

POST /api/v1/license/install

See Installing a License Obtained Out-of-Band.

5.blank.gif (Optional) Change the technology package.

PUT /api/v1/license/boot

See Technology License Package.

Workflow: Configure a CSR License Using Call-Home

1.blank.gif Verify that there is a license on the CSR.

2.blank.gif If using a cloned VM, obtain a new UDI.

POST /api/v1/license/udi

See Requesting a New license UDI.

3.blank.gif Accept the EULA.

POST /api/v1/license/eula

See Accepting the EULA.

4.blank.gif Install the license.

POST /api/v1/license/call-home

See Installing a License Through the Call-home Feature.

5.blank.gif (Optional) Change the technology package.

PUT /api/v1/license/boot

See Technology License Package.

Resource Summary for Licenses

 

HTTP Method
Resource
URL (BaseURL)
GET
POST
PUT
DELETE

EULA

/api/v1/license/eula

Y

Y

N

N

License installation

/api/v1/license/install

N

Y

N

N

License call-home

/api/v1/license/call-home

N

Y

N

N

License UDI

/api/v1/license/udi

Y

Y

N

N

License detail

/api/v1/license?detail={Boolean}

Y

N

N

N

Technology License Package

/api/v1/license/boot

Y

N

Y

N

Smart License

/api/v1/smart-license

Y

N

Y

N

Smart License renew

/api/v1/smart-license/renew

N

N

Y

N

Smart License register

/api/v1/smart-license/register

N

N

Y

N

Smart License deregister

/api/v1/smart-license/deregister

N

N

Y

N

Call-home

/api/v1/call-home

Y

N

Y

N

Call-home profile

/api/v1/call-home/profile

Y

Y

N

N

/api/v1/call-home/profile/{name}

Y

N

Y

Y

Installing a License Through the Call-home Feature

History

 

Release
Modification

IOS XE 3.10

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

Properties

 

Property
Type
Required for POST and PUT
Value Rules

username

string

Mandatory

N/A

password

string

Mandatory

N/A

license-server-url

string

Mandatory

N/A

pak-id

string

Mandatory

N/A

send-to-email-id

string

Mandatory

N/A

Resource URI

 

Verb
URI

POST

/api/v1/license/call-home

Example

JSON Request

POST /api/v1/license/call-home
 
Content-Type: application/json
Accept: application/json
 
{
"username": "{string}",
"password": "{string}",
"license-server-url": "https://tools-stage-was5.cisco.com/SWIFT/Licensing/",
"pak-id": "{string}",
"send-to-mail-id": "{string}"
}
 

JSON Response

204 No Content

Installing a License Obtained Out-of-Band

History

 

Release
Modification

IOS XE 3.10

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

Properties

 

Property
Type
Required?
Value Rules

license-location

string

Y

The location where the license is stored outside of the device.

Example (for Cisco CSR 1000V): tftp://user@linux-box.cisco.com/home/user/csr.lic

bootflash: Install from bootflash: file system
flash: Install from flash: file system
ftp: Install from ftp: file system
http: Install from http: file system
https: Install from https: file system
null: Install from null: file system
nvram: Install from nvram: file system
pram: Install from pram: file system
rcp: Install from rcp: file system
scp: Install from scp: file system
syslog: Install from syslog: file system
system: Install from system: file system
tftp: Install from tftp: file system
tmpsys: Install from tmpsys: file system

Resource URI

 

Verb
URI

POST

/api/v1/license/install

Example

JSON Request

POST /api/v1/license/install
Content-Type: application/json
Accept: application/json
 
{
"license-location": "tftp://user@linuxbox.cisco.com/home/user/csr.lic"
}

JSON Response

204 No Content

Retrieving License Information

History

 

Release
Modification

IOS XE 3.10

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

The following API is not supported:

/api/v1/license/udi

Properties

 

Property
Type
Required for POST and PUT
Value Rules

detail

boolean

Mandatory

“true” to show the details

“false” to show a summary

Resource URI

 

Verb
URI

GET

/api/v1/license?detail={Boolean}

Example

JSON Request

GET /api/v1/license?detail=TRUE

JSON Response

200 OK
 
Content-Type: application/json
 
{
"kind": "collection#licenses",
"items": [
{
"kind": "object#license",
"index": "1"
"feature": "csr1kv_50m",
"version": "1.0"
"license-type": "Paid Subscription",
"start-date" : "0000-00-00",
"end-date" : "2013-12-17",
"license-state" : "Active, Not in Use",
"lock-type": "Node locked",
"vendor-info":
{
"product-id": "CSR1000V",
"serial-number": "9DHICRRBJEL",
"udi": "CSR1000V:9DHICRRBJEL"
},
"license-addition": "exclusive",
"license-generation-version": "0x8200000",
"license-count": 0,
"license-priority": "medium",
"store-index": 0,
"storage-name": "primary license storage"
},
{
"kind": "object#license",
"index": 1,
"feature": "csr1kv_eval",
"version": 1.0,
"license-type": "evaluation",
"license-state" : "Active, In Use",
"evaluation-period": "P0Y0M8W4D",
"evaluation-period-left": "P0Y0M8W3D",
"evaluation-period-used": "P0Y0M0DT3H6M",
"evaluation-expiry-date" : "2013-02-03T16:35:58",
"lock-type": "Node locked",
"license-generation-version": "0x8200000",
"license-count": 0,
"license-priority": "medium",
"store-index": 0,
"storage-name": "primary license storage"
}
]
}

Properties

 

Property
Type
Description

Storage-name

string

storage name; for example, Primary License Storage

version

number

Version of license.

store-index

number

Index of the license line in the license storage

feature

name

Name of feature

license-type

string

Type of license; for example, Paid Subscription or Evaluation

start-date

string

Starting date of a non-evaluation license in YYYY-MM-DD forma

end-date

string

Ending date of a non-evaluation license in YYYY-MM-DD format

license-state

string

Status of the license; for example, “Active, In Use”

evaluation-period

string

Evaluation license’s total period per the ISO 8601 format: PnYnMnDTnHnMnS

evaluation-period-left

string

How much time the evaluation license has left in IOS 8601 format: PnYnMnDTnHnMnS

evaluation-period-used

string

How much time the evaluation license has used so far in ISO 8601 format: PnYnMnDTnHnMnS

evaluation-expiry-date

string

An evaluation license’s expiration date in YYYY-MM-DDTHH:MM:SS format per ISO 8601

lock-type

string

Association of a license to a specific device; for example, Node locked

vendor-info

string

Information about the vendor associated with the device UDI

serial-number

string

The device serial number

product-id

string

The device product ID

udi

string

The device UDI

license-addition

string

Additive or exclusive status of the license; for example, Additive

license-generation-version

string

Version of license generated in hex

license-count

number

Number of available count and in use.

license-priority

string

Priority of the license; for example, high, medium, or low.

Retrieving a License UDI

A GET request on the license UDI returns the UDI in the desired format.

Resource URI

 

Verb
URI

GET

/api/v1/license/udi

See History for platform limitations.

Example

JSON Request

GET /api/v1/license/udi
 
Accept: application/json
 

JSON Response

200 Ok
 
Content-Type: application/json
 
{
"kind": "object#license-udi",
"udi": "AS54XM-AC-RPS:JAE948QT6R"
}

Requesting a New license UDI

A POST request on a new license UDI returns a new UDI in the desired format.

Resource URI

 

Verb
URI

POST

/api/v1/license/udi

See History for platform limitations.

Example

JSON Request

POST /api/v1/license/udi
 
Accept: application/json
 
{
"request": "udi"
}

JSON Response

200 ok
 
Content-Type: application/json
 
{
"kind": "object#license-udi",
"udi": "CSRXM-AC-RPS:JAE948QX12"
}
 

Accepting the End-user Agreement

Use GET to view the end-user agreement license (EULA). Use POST to accept the EULA.

History

 

Release
Modification

IOS XE 3.10

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

Properties

 

Property
Type
Required for POST and PUT
Value Rules

eula-uri

string

Mandatory

Link to the EULA object. It is the GET EULA request URI. For example “/api/v1/license/eula”

eula-accept

boolean

Mandatory

“true” or “false” to indicate whether the user accepts the EULA terms.

Retrieving the License EULA

Resource URI

 

Verb
URI

GET

/api/v1/license/eula

Example

JSON Request

GET /api/v1/license/eula
 
Accept: application/json
 

JSON Response

200 OK
 
Content-Type: application/json
 
{
"kind": "object#license-eula",
"features": [
{
"feature-name": "csr",
"eula-accepted": true
}
]
"EULA": "PLEASE READ THE FOLLOWING TERMS CAREFULLY. INSTALLING THE LICENSE OR
LICENSE KEY PROVIDED FOR ANY CISCO PRODUCT FEATURE OR USING SUCH
PRODUCT FEATURE CONSTITUTES YOUR FULL ACCEPTANCE OF THE FOLLOWING
TERMS. YOU MUST NOT PROCEED FURTHER IF YOU ARE NOT WILLING TO BE BOUND
BY ALL THE TERMS SET FORTH HEREIN.
 
You hereby acknowledge and agree that the product feature license
is terminable and that the product feature enabled by such license
may be shut down or terminated by Cisco after expiration of the
applicable term of the license (e.g., 30-day trial period). Cisco
reserves the right to terminate or shut down any such product feature
electronically or by any other means available. While alerts or such
messages may be provided, it is your sole responsibility to monitor
your terminable usage of any product feature enabled by the license
and to ensure that your systems and networks are prepared for the shut
down of the product feature. You acknowledge and agree that Cisco will
not have any liability whatsoever for any damages, including, but not
limited to, direct, indirect, special, or consequential damages related
to any product feature being shutdown or terminated. By clicking the
"accept" button or typing "yes" you are indicating you have read and

agree to be bound by all the terms provided herein."

Accepting the EULA

A POST request creates an acceptance of the end-user license agreement (EULA).

The user must enter in the POST request the link to the GET request for the EULA and indicate whether it accepts the EULA via true or false. Providing these two pieces of information would be the user’s acknowledgment of the content of the EULA and acceptance of the EULA (if true is entered for the EULA-accept attribute).

Resource URI

 

Verb
URI

POST

/api/v1/license/eula

Example

JSON Request

POST /api/v1/license/eula
 
Content-Type: application/json
Accept: application/json
 
{
"eula-uri": "/api/v1/license/eula",
"eula-accept": true
}
 

JSON Response

204 No Content

Technology License Package

The technology license package feature allows changing between license types:

  • Standard
  • Advanced
  • Premium

For example, after beginning with a one type of license, it is possible to upgrade to a more advanced license type.

History

 

Release
Modification

IOS XE 3.10

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

Properties

 

Property
Type
Required for POST and PUT
Value Rules

kind

string

Mandatory

Object type: "object#license-boot"

level

string

Mandatory

Standard, Advanced, or Premium

Retrieving the License Type

Resource URI

 

Verb
URI

GET

/api/v1/license/boot

Example

JSON Request

GET /api/v1/license/boot
Accept: application/json

JSON Response

200 OK
Content-Type: application/json
 
{
"kind": "object#license-boot"
"level": "premium"
}

Setting the License Type

Resource URI

 

Verb
URI

PUT

/api/v1/license/boot

Example

JSON Request

PUT /api/v1/license/boot
Content-Type: application/json
 
{
"level": "premium",
}

JSON Response

204 No Content

 

Smart License Resource

History

 

Release
Modification

IOS XE 3.12

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

Properties

 

Property
Type
Required for POST and PUT
Description

kind

string

Not applicable

Object type: "object#smart-license".

enable

boolean

Mandatory

Enable or disable Smart License feature.

profile

string

Optional

Call Home profile to use with Smart Licensing.

state

string

Not applicable

State of the smart call home registration.

JSON Representation

{
"kind" : "object#smart-license",
"enable" : {boolean},
"profile": {string},
"state" : {string}
}

Retrieve Smart License

Resource URI

 

Verb
URI

GET

/api/v1/smart-license

Example

JSON Request

GET /api/v1/smart-license
Accept: application/json

JSON Response

200 OK
Content-Type: application/json
 
{
"kind" : "object#smart-license",
"enable" : true,
"state" : "Unidentified"
"profile" : "CiscoTAC-1"
}

Modify Smart License

Resource URI

 

Verb
URI

PUT

/api/v1/smart-license

Example

JSON Request

PUT /api/v1/smart-license
Content-Type: application/json
 
{
"enable" : true,
"profile": "CiscoTAC-1"
}

JSON Response

204 No Content

Smart License Registration Resource

History

 

Release
Modification

IOS XE 3.12

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

Properties

 

Property
Type
Required for POST and PUT
Description

idtoken

string

Mandatory

Token used to register with Cisco Smart Licensing.

JSON Representation

{
"idtoken" : {string}
}

Smart License Registration

Resource URI

 

Verb
URI

PUT

/api/v1/smart-license/register

Example

JSON Request

PUT /api/v1/smart-license/register
Content-Type: application/json
 
{
"idtoken" : "QXN123"
}

JSON Response

204 No Content

Smart License Deregister

Resource URI

 

Verb
URI

PUT

/api/v1/smart-license/deregister

Example

JSON Request

PUT /api/v1/smart-license/deregister
Content-Type: application/json
{
}
 

JSON Response

204 No Content
 

Smart License Renew Resource

History

 

Release
Modification

IOS XE 3.12

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

Properties

 

Property
Type
Required for POST and PUT
Description

id

boolean

Optional

Renew id

authorization

boolean

Optional

Renew Authorization

JSON Representation

{
"id" : {boolean},
"authorization" : {boolean}
}

Smart License Renew

Resource URI

 

Verb
URI

PUT

/api/v1/smart-license/renew

Example

JSON Request

PUT /api/v1/smart-license/renew
Content-Type: application/json
 
{
"id" : true,
"authorization" : true
}

JSON Response

204 No Content

Call-Home Resource

History

 

Release
Modification

IOS XE 3.12

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

Properties

 

Property
Type
Required for POST and PUT
Description

kind

string

Not applicable

Object type: "object#call-home"

aaa-authorization

boolean

Optional

AAA authorization

aaa-authorization-username

string

Optional

AAA authorization username

contact-email

string

Optional

Email address

data-privacy

object

Optional

Data privacy

level

enum-
erated list

Mandatory

(sub-property of data-privacy)

Options: normal, high

hostname

boolean

Mandatory

Enables/disables hostname privacy

http-proxy

object

Optional

HTTP Proxy

server-address

string

Mandatory

(sub-property of http-proxy)

http proxy server address

server-port

number

Mandatory

(sub-property of http-proxy)

16-bit port number

Range: 1 to 65535

rate-limit

number

Optional

Rate limit messages.

Range: 1 to 60

JSON Representation

{
kind : object#call-home,
aaa-authorization : {boolean},
aaa-authorization-username : {string},
contact-email : {string},
data-privacy : {
level: [normal, high],
hostname: {boolean
},
http-proxy : {
server-address: {string},
server-port : {number}
},
rate-limit : {number}
}

Retrieve Call-Home Resource

Resource URI

 

Verb
URI

GET

/api/v1/call-home

Example

JSON Request

GET /api/v1/call-home
Accept: application/json

JSON Response

200 OK
Content-Type: application/json
 
{
"kind" : "object#call-home",
"aaa-authorization" : true
"aaa-authorization-username" : "cisco",
"contact-email" : "test@cisco.com",
"data-privacy" : {
"level" : "high",
"hostname" : false
},
"http-proxy" : {
server-address : "cisco-proxy",
server-port : 8080
},
"rate-limit" : 30
}

Modify Call-Home Resource

Resource URI

 

Verb
URI

PUT

/api/v1/call-home

Example

JSON Request

PUT /api/v1/call-home
Content-Type: application/json
 
{
"aaa-authorization" : true
"aaa-authorization-username": "cisco",
"contact-email" : "test@cisco.com",
"data-privacy" : {
"level" : "high",
"hostname" : false
},
"http-proxy" : {
server-address : "cisco-proxy",
server-port : 8080
},
"rate-limit" : 30
}

JSON Response

204 No Content

Call-Home Profile Resource

History

 

Release
Modification

IOS XE 3.12

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

Properties

 

Property
Type
Required for POST and PUT
Description

kind

string

Not applicable

Object type: "object#call-home-profile"

name

string

Mandatory

Name of the call-home profile

active

boolean

Optional

Enable or disable the profile.

Default: Active

anonymous-reporting-only

boolean

Optional

Call home anonymous reporting

destination-transport-email

boolean

Optional

Use email for transport

destination-transport-http

boolean

Optional

Use HTTP for transport

destination-address

object

Optional

Object to hold URL and email addresses

urls

array

Optional

(sub-property of destination-address)

Array or url strings

emails

array

Optional

(sub-property of destination-address)

Array of email address strings

subscribe-group-all

object

Optional

Subscribe to group "all"

severity

enum-
erated list

Mandatory

(sub-property of subscribe-group-all)

[catastrophic, critical, debugging, disaster, fatal, major, minor, normal, notification, event]

subscribe-group-syslog

object

Optional

Subscribe to group "syslog"

severity

enum-
erated list

Mandatory

(sub-property of subscribe-group-syslog)

[catastrophic, critical, debugging, disaster, fatal, major, minor, normal, notification, event]

subscribe-group-configuration

object

Optional

One of the following objects:

[daily, weekly, monthly]

subscribe-group-inventory

object

Optional

One of the following objects:

[daily, weekly, monthly]

subscribe-group-snapshot

object

Optional

One of the following objects:

[daily, weekly, monthly, interval, hourly]

daily

object

 

Period is daily.

Applicable to:

  • subscribe-group-configuration
  • subscribe-group-inventory
  • subscribe-group-snapshot

time

string

Mandatory

(sub-property of daily)

Time

Format: hh:mm

weekly

object

 

Period is weekly.

Applicable to:

  • subscribe-group-configuration
  • subscribe-group-inventory
  • subscribe-group-snapshot

day

enum-
erated list

Mandatory

(sub-property of weekly)

Day of the week: [sun, mon, tues, wed, thurs, fri, sat]

time

string

Mandatory

(sub-property of weekly)

Time

Format: hh:mm

monthly

object

 

Period is monthly.

Applicable to:

  • subscribe-group-configuration
  • subscribe-group-inventory
  • subscribe-group-snapshot

day

number

Mandatory

(sub-property of monthly)

Day of the month: 1 to 31

time

string

Mandatory

(sub-property of monthly)

Time

Format: hh:mm

interval

object

 

Period is at an interval.

Applicable to:

  • subscribe-group-snapshot

minute

number

Mandatory

(sub-property of interval)

Minutes: 1 to 60

hourly

object

 

Period is hourly.

Applicable to:

  • subscribe-group-snapshot

minute

number

Mandatory

(sub-property of hourly)

Minutes: 0 to 59

JSON Representation

{
"kind" : "object#call-home-profile",
"name" : {string},
"active" : {boolean},
"anonymous-reporting-only" : {boolean},
"destination-transport-email" : {boolean},
"destination-transport-http" : {boolean},
"destination-address" : {
"urls" : [{string}],
"emails" : [{string}]
},
"subscribe-group-all" : { "severity" : {string} },
"subscribe-group-configuration" : { "daily" : {
"time" : {string}
}
},
"subscribe-group-inventory" : { "weekly" : {
"day" : {string},
"time" : {string}
}
},
"subscribe-group-snapshot" : { "interval" : {
"minute" : {string}
}
},
"subscribe-group-syslog" : { "severity" : {string} }
}

Create a Call-Home Profile

Resource URI

 

Verb
URI

POST

/api/v1/call-home/profile

Example

JSON Request

POST /api/v1/call-home/profile
Content-Type: application/json
 
{
"name" : "test"
"active" : false,
"anonymous-reporting-only" : false,
"destination-transport-email" : true,
"destination-transport-http" : true,
"destination-address" : {
url : []
email : [ "test@cisco.com" ]
},
"subscribe-group-all" : { "severity" : "minor"},
"subscribe-group-inventory" : { "daily" : {
"time" : "23:00"
}
}
}

JSON Response

201 Created
Location: https://host/api/v1/call-home/profile/test

Retrieve Call-Home Profile

Resource URI

 

Verb
URI

GET

/api/v1/call-home/profile/{profile-name}

Example

JSON Request

GET /api/v1/call-home/profile/CiscoTest
Accept: application/json

JSON Response

200 OK
Content-Type: application/json
 
{
"kind" : "object#call-home-profile",
"name" : "CiscoTest"
"active" : true,
"anonymous-reporting-only" : true,
"destination-transpor-email": true,
"destination-transpor-http" : false,
"destination-address" : {
urls : [ "http://cisco.com" ]
emails: [ "test@cisco.com" ]
},
"subscribe-group-all" : {},
"subscribe-group-configuration" : {},
"subscribe-group-inventory" : {},
"subscribe-group-snapshot" : {},
"subscribe-group-syslog" : {},
}

Modify Call-Home Profile

Resource URI

 

Verb
URI

PUT

/api/v1/call-home/profile/{profile-name}

Example

JSON Request

PUT /api/v1/call-home/profile/CiscoTest
Content-Type: application/json
 
{
"active" : true,
"anonymous-reporting-only" : true,
"destination-transport-email" : false,
"destination-transport-http" : true,
"destination-address" : {
url : [ "http://cisco.com" ]
email: [ "test@cisco.com" ]
}
}
 

JSON Response

204 No Content

Delete Call-Home Profile

Resource URI

 

Verb
URI

DELETE

/api/v1/call-home/profile/{profile-name}

Example

JSON Request

DELETE /api/v1/call-home/profile/CiscoTest

JSON Response

204 No Content

Retrieve All Call-Home Profiles

Properties for Retrieve All

 

Property
Type
Required for POST and PUT
Description

kind

string

Not applicable

Object type: "collection#call-home-profile"

items

array

Not applicable

Array of object#call-home-profile

JSON Representation for Retrieve All

{
"kind" : "collection#call-home-profile",
"items" : [ {object#call-home-profile} ]
}
 

Example

JSON Request

GET /api/v1/call-home/profile
Accept: application/json

JSON Response

200 OK
Content-Type: application/json
 
{
"kind" : "collection#call-home-profile",
"items" : [
{
"kind" : "object#call-home-profile",
"name" : "CiscoTest"
"active" : true,
"anonymous-reporting-only" : true,
"destination-transport-email" : true,
"destination-transport-http" : false,
"destination-address" : {
url : [ "http://cisco.com" ]
email : [ "test@cisco.com" ]
},
"subscribe-group-all" : {},
"subscribe-group-configuration" : {},
"subscribe-group-inventory" : {},
"subscribe-group-snapshot" : {},
"subscribe-group-syslog" : {}
},
{
"kind" : "object#call-home-profile",
"name" : "test"
"active" : false,
"anonymous-reporting-only" : false,
"destination-transport-email" : true,
"destination-transport-http" : true,
"destination-address" : {
url : []
email : [ "test@cisco.com" ]
},
"subscribe-group-all" : {},
"subscribe-group-configuration" : {},
"subscribe-group-inventory" : {},
"subscribe-group-snapshot" : {},
"subscribe-group-syslog" : {}
}
]
}

Throughput Resource

History

 

Release
Modification

IOS XE 3.12

Introduced for the CSR1000V platform

IOS XE 3.14

Introduced for ASR1001-X and ASR1002-X platforms

Properties

 

Property
Type
Required for POST and PUT
Description

kind

string

Not applicable

Object type. "object#license-throughput"

level

number

Mandatory

Throughput

Values: 10, 100, 1000, 25 250, 50, 500

JSON Representation

{
"kind" : "object#smart-license",
"level" : {number}
}

Retrieve Throughput

Resource URI

 

Verb
URI

GET

/api/v1/license/throughput

Example

JSON Request

GET /api/v1/license/throughput
Accept: application/json

JSON Response

200 OK
Content-Type: application/json
 
{
"kind" : "object#license-throughput",
"level" : 10
}

Modify Throughput

Resource URI

 

Verb
URI

PUT

/api/v1/license/throughput

Example

JSON Request

PUT /api/v1/license/throughput
Content-Type: application/json
 
{
"level" : 10
}

JSON Response

204 No Content