Licenses API (v1)

http://localhost:9130/licenses/

Table of contents

mod-licenses API

This documents the API calls that can be made to query and manage licenses

/licenses

GET /licenses/licenses

List current licenses

GET /licenses/licenses

Response 200

OK

POST /licenses/licenses

Create a new license

POST /licenses/licenses
Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "A license",
  "additionalProperties": true,
  "properties": {
    "id": {
      "description": "The ID of the license",
      "type": "string"
    },
    "tags": {
      "description": "Tags are not a string",
      "type": "string"
    },
    "name": {
      "description": "Name of license",
      "type": "string"
    },
    "description": {
      "description": "Description of license",
      "type": "string"
    },
    "customProperties": {
      "description": "Custom properties",
      "type": "string"
    }
  },
  "required": [
    "name"
  ]
}

GET /licenses/licenses/{licenseId}

Retrieve a specific license

GET /licenses/licenses/{licenseId}
URI Parameters
  • licenseId: required (string)

PUT /licenses/licenses/{licenseId}

Update a specific license

PUT /licenses/licenses/{licenseId}
URI Parameters
  • licenseId: required (string)