License Types
The license types define the type of licenses of a group.
List all license types
Use this endpoint to retrieve all license types currently assigned to a group.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/groups/{uuid}/license_types
Authorization
Required role
groups.instance.license_types.list
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the group |
URL/Query parameters
| Parameter | Type | Description | Required? |
|---|---|---|---|
search | string | Used to perform a search through full_license type that look like the string passed | no |
sort | string | Allows to specify one searchable property of an license type to apply a sorting operation | no |
dir | string | When performing a sort operation, specifies the type. Allowed values are asc for ascending (default) or desc for descending | no |
page_size | integer | Used for pagination, determines the maximum number of records on one page of results (defaults to 10) | no |
page | integer | Used for pagination, determines the returned page from the collection of result pages (defaults to 1) | no |
Response
Status codes
| Parameter | Description |
|---|---|
200 | One or more license types found |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
license types | array | List containing all license types found for the group | no |
License Type Object
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Index of the license type | no |
description | string | The description | no |
name | string | The name | no |
sku | string | The sku | no |
License Format Type
Name of the license type format type.
Value in enumeration:
Example
json
{
"license_types": [
{
"description": "License 1",
"id": 1,
"name": "License 1",
"sku": "license1"
},
{
"description": "License 2",
"id": 2,
"name": "License 2",
"sku": "license2"
}
],
"page": 1,
"pages": 1,
"results": 2
}Get a specific license type
The following endpoint returns a specific license type.
Request
Endpoint
GET /api/v01/draas/{draas_instance}/groups/{uuid}/license_types/{id}
Authorization
Required role
groups.instance.license_types.read
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the group |
id | integer | Index of the license type you want to retrieve |
URL/Query parameters
N/A
Response
Status codes
| Parameter | Description |
|---|---|
200 | The license type if found |
400 | Error while processing the request |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | No license type found |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Index of the license type | no |
description | string | The description | no |
extra | object | Object containing extra data | no |
name | string | The name | no |
sku | string | The sku | no |
Example
json
{
"description": "License 1",
"extra": {},
"id": 1,
"name": "License 1",
"sku": "license1"
}Create a new license type
Use this endpoint to create a new license type
Request
Endpoint
POST /api/v01/draas/{draas_instance}/groups/{uuid}/license_types
Authorization
Required role
groups.instance.license_types.create
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the group |
URL/Query parameters
N/A
Body
| Parameter | Type | Description | Required |
|---|---|---|---|
description | string | The description | no |
extra | object | Object containing extra data | no |
name | string | The name | yes |
sku | string | The sku | yes |
Example
json
{
"description": "License 2",
"name": "License 2",
"sku": "license2"
}Response
Status codes
| Parameter | Description |
|---|---|
201 | The license type was created successfully |
400 | Error while creating the license type |
403 | The API consumer doesn't have sufficient rights to perform this action |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
id | integer | Index of the license type | no |
description | string | The description | no |
extra | object | Object containing extra data | no |
name | string | The name | no |
sku | string | The sku | no |
Example
json
{
"description": "License 2",
"extra": {},
"id": 2,
"name": "License 2",
"sku": "license2"
}Modify an existing license type
Use this endpoint to modify an existing license type.
Request
Endpoint
PUT /api/v01/draas/{draas_instance}/groups/{uuid}/license_types/{id}
Authorization
Required role
groups.instance.license_types.instance.update
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the group for which you want to modify the license type |
id | integer | Index of the license type you want to update |
<URL/Query parameters>
N/A
Body
| Parameter | Type | Description | Required |
|---|---|---|---|
description | string | The description | no |
extra | object | Object containing extra data | no |
name | string | The name | no |
sku | string | The sku | no |
Example
json
{
"description": "License 2",
"name": "License 2",
"sku": "license2"
}Response
Status codes
| Parameter | Description |
|---|---|
200 | The license type was updated successfully |
400 | Error while updating the license type |
403 | The API consumer doesn't have sufficient rights to perform this action |
404 | The license type does not exist |
500 | Uncatched error on server side |
Success
Body
| Parameter | Type | Description | Conditional? |
|---|---|---|---|
description | string | The description | no |
extra | object | Object containing extra data | no |
name | string | The name | no |
sku | string | The sku | no |
Example
json
{
"description": "License 2",
"extra": {},
"name": "License 2",
"sku": "license2"
}Delete a license type
Use this endpoint to delete an existing license type.
Request
Endpoint
DELETE /api/v01/draas/{draas_instance}/groups/{uuid}/license_types/{id}
Authorization
Required role
groups.instance.license_types.instance.delete
Path Parameters
| Parameter | Type | Description |
|---|---|---|
draas_instance | string | See common parameters |
uuid | string | A system generated unique ID (UUID) identifying the group |
id | integer | Index of the license type you want to delete |
URL/Query parameters
N/A
Body
N/A
Response
Status codes
| Parameter | Description |
|---|---|
204 | The license type was deleted successfully. If the license type didn't exist, delete will be considered as being executed successfully |
400 | Error while deleting the license type |
403 | The API consumer doesn't have sufficient rights to perform this action |
500 | Uncatched error on server side |
Success
Body
N/A