Back to top

Licenses

License Management

Retrieve all licenses
GET
/projects/{id}/licenses

Provides a collection of licenses for a given project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"licenses": [
    		{
    			"id": "string",
    			"description": "string",
    			"license_key": "string",
    			"licensee_product": {
    				"href": "string"
    			},
    			"size": "number",
    			"project": {
    				"href": "string"
    			}
    		}
    	]
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Create a License
/projects/{id}/licenses

Creates a new license for the given project

  • Parameters
  • id
    string  (required) in path

    Project UUID

    license
     (required) in body

    License to create

    {
    	"description": "string",
    	"size": "number",
    	"licensee_product_id": "string"
    }
  • Response  201   created
  • {
    	"id": "string",
    	"description": "string",
    	"license_key": "string",
    	"licensee_product": {
    		"href": "string"
    	},
    	"size": "number",
    	"project": {
    		"href": "string"
    	}
    }
  • Response  401   unauthorized
  • Response  422   unprocessable entity
  • Response  403   forbidden
  • Response  404   not found
Retrieve a license
GET
/licenses/{id}

Returns a license

  • Parameters
  • id
    string  (required) in path

    License UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"id": "string",
    	"description": "string",
    	"license_key": "string",
    	"licensee_product": {
    		"href": "string"
    	},
    	"size": "number",
    	"project": {
    		"href": "string"
    	}
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Update the license
PUT
/licenses/{id}

Updates the license.

  • Parameters
  • id
    string  (required) in path

    License UUID

    license
     (required) in body

    License to update

    {
    	"description": "string",
    	"size": "number"
    }
  • Response  200   ok
  • {
    	"id": "string",
    	"description": "string",
    	"license_key": "string",
    	"licensee_product": {
    		"href": "string"
    	},
    	"size": "number",
    	"project": {
    		"href": "string"
    	}
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Delete the license
/licenses/{id}

Deletes a license.

  • Parameters
  • id
    string  (required) in path

    License UUID

  • Response  204   no content
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found