Manage licenses. See project endpoints to list and create licenses for a particular project.

Retrieve all licenses

GET
/projects/{id}/licenses

Provides a collection of licenses for a given project.

    /projects/{id}/licenses
  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create a License

/projects/{id}/licenses

Creates a new license for the given project

    /projects/{id}/licenses
  • Parameters
  • id
    string  (required) in path

    Project UUID

    license
     (required) in body

    License to create

    {
    	"description": "string",
    	"size": "number",
    	"licensee_product_id": "string"
    } 

Retrieve a license

GET
/licenses/{id}

Returns a license

    /licenses/{id}
  • 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

Update the license

PUT
/licenses/{id}

Updates the license.

    /licenses/{id}
  • Parameters
  • id
    string  (required) in path

    License UUID

    license
     (required) in body

    License to update

    {
    	"description": "string",
    	"size": "number"
    } 

Delete the license

/licenses/{id}

Deletes a license.

    /licenses/{id}
  • Parameters
  • id
    string  (required) in path

    License UUID