/license

Resource URI

/license

HTTP GET

Retrieves all available licenses and the current licensing mode of the system services.

GET /license

Method

Response Payload

JSON

{
  "licenses" : {
    "resources" : [
      {
        "id" : "default.lic",
        "uri" : uri="\/license\/default.lic"
      },
      {
        "id" : "temp.lic" ,
        "uri" : uri="\/license\/temp.lic"
      },
      {
        "id" : "production.lic",
        "uri" : uri="\/license\/production.lic"
      }
    ],
    "features" : [
      {
        "name" : "amr_audio_codec",
        "value" : 0
      },
      {
        "name" : "basic_audio",
        "value" : 200
      },
      {
        "name" : "hd_audio_codec",
        "value" : 200
      },
      {
        "name" : "lbr_audio_codec",
        "value" : 0
      },
      {
        "name" : "video",
        "value" : 100
      }
    ]
  }
}

Single Instance

Retrieves information for a single license resource.

GET /license/production.lic

Method

Response Payload

JSON

{
  "license" : {
    "id" : "production.lic",
    "type" : "permanent",
    "expires" : "never",
    "status" : "active",
    "features" : [
      {
        "name" : "amr_audio_codec",
        "value" : 0
      },
      {
        "name" : "basic_audio",
        "value" : 200
      },
      {
        "name" : "hd_audio_codec",
        "value" : 200
      },
      {
        "name" : "lbr_audio_codec",
        "value" : 0
      },
      {
        "name" : "video",
        "value" : 100
      }
    ]
  }
}

HTTP PUT

Modifies an individual license status.

Valid "status" values:

PUT /license/production.lic

Method Request Payload Response Payload
JSON

{
   "status" : "active"
}

{
  "license" : {
    "id" : "production.lic",
    "type" : "permanent",
    "expires" : "never",
    "status" : "active",
    "features" : [
      {
        "name" : "amr_audio_codec",
        "value" : 0
      },
      {
        "name" : "basic_audio",
        "value" : 200
      },
      {
        "name" : "hd_audio_codec",
        "value" : 200
      },
      {
        "name" : "lbr_audio_codec",
        "value" : 0
      },
      {
        "name" : "video",
        "value" : 100
      }
    ]
  }
}

HTTP POST

Uploads a new license. On completion, the license will be in an inactive state. Use PUT to activate.

POST /license/<production-new.lic>

Method Request Payload Response Payload
JSON

The request payload is the raw license file data. The mime type must be text/plain.

Content-Type: text/plain

{
  "license" : {
    "id" : "production-new.lic",
    "type" : "Permanent",
    "expires" : "never",
    "status" : "inactive",
    "features" : [
      {
        "name" : "amr_audio_codec",
        "value" : 0
      },
      {
        "name" : "basic_audio",
        "value" : 200
      },
      {
        "name" : "hd_audio_codec",
        "value" : 200
      },
      {
        "name" : "lbr_audio_codec",
        "value" : 0
      },
      {
        "name" : "video",
        "value" : 100
      }
    ]
  }
}

HTTP DELETE

Deletes a license. License must be inactive.

DELETE /license/production.lic