{
    "restSchemaVersion": "1.0",
    "errors": [
        {
          "error_id": "BAD_REQUEST",
          "description": "Invalid argument.",
          "http_status": "400"
        },
        {
          "error_id": "AUTH_REQUIRED",
          "description": "Authentication required.",
          "http_status": "401"
        },
        {
          "error_id": "AUTH_INVALID_CREDENTIALS",
          "description": "Make sure the user name is correct and type your password again. Be sure to use the correct case for the user name and password.",
          "http_status": "401"
        },
        {
          "error_id": "HTTP_INVALID_METHOD",
          "description": "Requested method is not available for this resource.",
          "http_status": "405"
        },
        {
          "error_id": "INTERNAL_ERROR",
          "description": "Internal error.",
          "http_status": "500"
        }
      ],
    "name": "mgmt.licenses",
    "title": "Licenses API.",
    "version": "1.0",
    "schemas": [],
    "defaultAuthorization": "required",
    "servicePath": "/api/mgmt.licenses/1.0",
    "resources": {
        "licenses": {
          "methods": {
            "Get licenses": {
              "description": "Display all downloaded licenses .",
              "response": {
                  "description":"list of downloaded licenses.",
                  "type": "array",
                  "items": {
                      "description":"license object",
                      "type": "object",
                      "properties": {
                        "key": {
                          "type": "string",
                          "description":"license key"
                        },
                        "description": {
                          "type": "string",
                          "description":"description"
                        },
                        "device serial number": {
                          "type": "string",
                          "description":"device serial number"
                        },
                        "installed date": {
                          "type": "string",
                          "description":"installation date"
                        },
                        "status": {
                          "type": "string",
                          "description":"status of license"
                        }
                      },
                      "required": [
                        "key",
                        "description",
                        "device serial number",
                        "status"
                      ]
                  },
                  "example":{
                    "Licenses": [
                      {
                        "key": "BAFBG-ABIAA-AAAAA-AAAAA-BRBK6-IAAAA-PU3NC-AK2J6", 
                        "description": "SteelCentral Virtual Flow Gateway 2M Flows Per Minute Feature Key", 
                        "device serial number": "AABA-ACAA-4W4C-QVXB", 
                        "installed date": "Thu, 24 Feb 2022 00:16:43 GMT", 
                        "status": "Valid"
                      }, 
                      {
                        "key": "SSIF1-VUDHF-7QGZJ-YUHYW-YYA5J-EK9WS-V4/W4-CC3D6", 
                        "description": "Unrecognized License", 
                        "device serial number": "AABA-ACAA-4W4C-QVXB", 
                        "installed date": "Fri, 25 Feb 2022 01:37:08 GMT", 
                        "status": "Invalid"
                      }
                    ]
                  }
                },
              "httpmethod": "GET",
              "formats": [
                "json"
              ],
              "authorization_methods": [
                "BASIC",
                "COOKIE",
                "OAUTH_2_0"
              ],
              "path": "licenses",
              "authorization": "required"
            },
            "Add licenses": {
              "description": "Add licenses.",
              "request": {
                  "description":"List of license keys to add.",
                  "type": "array",
                  "items": {
                    "type": "string",
                    "description":"License key"
                  },
                  "example":["MMZDK-ZS86U-AVVIP-U82CV-56SXK-AIXT0-VLAPI-7B574","SSIF1-VUDHF-7QGZJ-YUHYW-YYA5J-EK9WS-V4/W4-CC3D6","abcd"]
              },
              "response":{
                  "description":"list of results of each license key",
                  "type": "array",
                  "items": {
                      "type": "object",
                      "properties": {
                          "<license key>": {
                          "type": "string"
                          }
                      }
                  },
                  "example":[
                    {
                      "MMZDK-ZS86U-AVVIP-U82CV-56SXK-AIXT0-VLAPI-7B574": "success"
                    }, 
                    {
                      "SSIF1-VUDHF-7QGZJ-YUHYW-YYA5J-EK9WS-V4/W4-CC3D6": "success"
                    }, 
                    {
                      "abcd": "License key format not supported"
                    }
                  ]
              },
              "httpmethod": "POST",
              "formats": [
                "json"
              ],
              "authorization_methods": [
                "BASIC",
                "COOKIE",
                "OAUTH_2_0"
              ],
              "path": "licenses",
              "authorization": "required"
            },
            "Delete licenses":{
              "description": "Delete licenses",
              "request": {
                  "description":"List of license keys to delete.",
                  "type": "array",
                  "items": {
                    "type": "string",
                    "description":"License key"
                  },
                  "example":[
                    {
                      "MMZDK-ZS86U-AVVIP-U82CV-56SXK-AIXT0-VLAPI-7B574": "success"
                    }, 
                    {
                      "SSIF1-VUDHF-7QGZJ-YUHYW-YYA5J-EK9WS-V4/W4-CC3D": "License key format not supported"
                    }
                  ]
              },
              "response":{
                  "description":"list of results of each license key",
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                        "<license key>": {
                        "type": "string"
                        }
                    }
                },
                "example":[
                  {
                    "MMZDK-ZS86U-AVVIP-U82CV-56SXK-AIXT0-VLAPI-7B574": "success"
                  }, 
                  {
                    "SSIF1-VUDHF-7QGZJ-YUHYW-YYA5J-EK9WS-V4/W4-CC3D": "License key format not supported"
                  }
                ]
              },
              "httpmethod": "DELETE",
              "formats": [
                "json"
              ],
              "authorization_methods": [
                "BASIC",
                "COOKIE",
                "OAUTH_2_0"
              ],
              "path": "licenses",
              "authorization": "required"
            },
            "Fetch licenses":{
              "response":{
                  "type": "object",
                  "description":"Outcome of fetch operation.",
                  "properties": {
                    "Message": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "Message"
                  ],
                  "example":{
                    "Message": "Could not contact license server or there are currently no licenses available for this host."
                  }
              },
              "httpmethod": "GET",
              "formats": [
                "json"
              ],
              "authorization_methods": [
                "BASIC",
                "COOKIE",
                "OAUTH_2_0"
              ],
              "path": "licenses/fetch",
              "authorization": "required"     
            },
            "Request license activation code":{
              "request":{
                  "type": "object",
                  "description":"Enter a token that you receive when you purchase the license.",
                  "properties": {
                    "value": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "Message"
                  ],
                  "example":{"value":"abcd1234"}
              },
              "response":{
                  "type": "object",
                  "description":"Generates a license activation code token that you receive when you purchase the license.",
                  "properties": {
                    "Message": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "Message"
                  ],
                  "example":{
                    "Message": "Invalid token abcd1234"
                  }
              },
              "httpmethod": "POST",
              "formats": [
                "json"
              ],
              "authorization_methods": [
                "BASIC",
                "COOKIE",
                "OAUTH_2_0"
              ],
              "path": "licenses/request",
              "authorization": "required"     
            },
            "Get auto download value":{
              "description":"Get value of auto download feature.",
              "response":{
                  "type": "object",
                  "properties": {
                    "value": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "value"
                  ],
                  "example":{
                    "value": "true"
                  }
              },
              "httpmethod": "GET",
              "formats": [
                "json"
              ],
              "authorization_methods": [
                "BASIC",
                "COOKIE",
                "OAUTH_2_0"
              ],
              "path": "licenses/auto_download",
              "authorization": "required"
            },
            "Set auto download value":{
              "description":"Set value of auto download feature.",
              "request":{
                  "type": "object",
                  "properties": {
                    "value": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "value"
                  ],
                  "example":{"value":"true"}
              },
              "httpmethod": "POST",
              "formats": [
                "json"
              ],
              "authorization_methods": [
                "BASIC",
                "COOKIE",
                "OAUTH_2_0"
              ],
              "path": "licenses/auto_download",
              "authorization": "required"
            }
          }
        }
    },
    "description": "<h2>Overview</h2>\n\n<p>\nThe documentation pages in this section describe\nthe RESTful APIs included with NetProfiler products. It is assumed \nthat the reader has practical knowledge of\nRESTful APIs, so the documentation does not go into detail about what\nREST is and how to use it. Instead the documentation focuses on what\noperations can be performed.\n</p>\n\n<p>\nThe following operations can be performed via the API:\n</p>\n<ul>\n <li>Get downloaded licenses.</li>\n<li>Add licenses.</li>\n<li>Delete licenses.</li>\n<li>Fetch license updates.</li>\n<li>Request license token.</li>\n<li>Get auto license download value.</li>\n<li>Set auto license download value.</li>\n</ul>\n\n<p>\nDetails about REST resources can be found in the <b>Resources</b>\nsection. This overview continues with how to run these API's.\n</p>\n\n<h2>Authentication</h2>\n\n<p>\nAll REST requests must be authenticated. The <b>Authentication</b>\nsection of the Common API describes which authentication methods\nare presently supported. \n</p>\n\n"
  }