3fa1dd1be4
* Added Target Type model Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added Target Type JPA model Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added Target Type repository model classes Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Removed the name entity from Target Type Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Refactored the Target Type models Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added the DB migration script and updated the Target Type models Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added target type in target Mapper Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Changed the target type ID to Long Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added MYSQL DB migration script and removed the deleted column for target type Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Updated the DB migration script for target table Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added manyToMany reltation between target type and Ds type Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added POSTGRESQL DB migration script Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added MSSQL SERVER DB migration script Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added DB2 DB migration script Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added missing license header and java docs Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added on delete cascade in DB migration script Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added Target Type specification Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Removed the delete cascade and Added type API Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * fixed API doc build Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added target type management test Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added target type events test Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added target type update and unassign to target Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added API tests for assigning target type to target Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added missing license header Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added missing docs Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Fixed sonar issues Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Fixed license header build issue Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Updated the attribute name to target type Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Fixed the review comments Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Removed unused error status variable Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added target API to assign target type Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Added the tests for assigning target type to target Signed-off-by: Anand kumar <anand.kumar@bosch-si.com> * Fixed the review comments for null check Signed-off-by: Anand kumar <anand.kumar@bosch-si.com>
79 lines
2.7 KiB
Markdown
79 lines
2.7 KiB
Markdown
---
|
|
title: Management API
|
|
parent: API
|
|
weight: 81
|
|
---
|
|
|
|
The Management API is a RESTful API that enables to perform Create/Read/Update/Delete operations for provisioning targets (i.e. devices) and repository content (i.e. software).
|
|
<!--more-->
|
|
|
|
Based on the Management API you can manage and monitor software update operations via HTTP/HTTPS. The _Management API_ supports JSON payload with hypermedia as well as filtering, sorting and paging. Furthermore the Management API provides permission based access control and standard roles as well as custom role creation.
|
|
|
|
The API is protected and needs authentication and authorization based on the security concept.
|
|
|
|
## API Version
|
|
|
|
hawkBit provides an consistent Management API interface that guarantees backwards compatibility for future releases by version control.
|
|
|
|
The current version of the Management API is `version 1 (v1)` with the URI http://localhost:8080/rest/v1/
|
|
|
|
## API Resources
|
|
|
|
Supported HTTP-methods are:
|
|
|
|
- GET
|
|
- POST
|
|
- PUT
|
|
- DELETE
|
|
|
|
Available Management APIs resources are:
|
|
|
|
- [Targets](/hawkbit/apis/mgmt/targets/)
|
|
- [Target types](/hawkbit/apis/mgmt/targettypess/)
|
|
- [Distribution sets](/hawkbit/apis/mgmt/distributionsets/)
|
|
- [Distribution set types](/hawkbit/apis/mgmt/distributionsettypes/)
|
|
- [Software modules](/hawkbit/apis/mgmt/softwaremodules/)
|
|
- [Software module types](/hawkbit/apis/mgmt/softwaremoduletypes/)
|
|
- [Target tag](/hawkbit/apis/mgmt/targettag/)
|
|
- [Distribution set tag](/hawkbit/apis/mgmt/distributionsettag/)
|
|
- [Rollouts](/hawkbit/apis/mgmt/rollouts/)
|
|
- [Target filters](/hawkbit/apis/mgmt/targetfilters/)
|
|
- [System configuration](/hawkbit/apis/mgmt/tenant/)
|
|
|
|
|
|
## Headers
|
|
|
|
For all requests an `Authorization` header has to be set.
|
|
|
|
* Username: `Tenant\username`
|
|
* Password: `password`
|
|
|
|
Also have a look to the [Security](../../concepts/authentication/) chapter.
|
|
|
|
In addition, for POST and PUT requests the `Content-Type` header has to be set. Accepted content-types are.
|
|
|
|
* `application/json`
|
|
* `application/hal+json`
|
|
|
|
## Request Body
|
|
|
|
Besides the relevant data (name, description, createdBy etc.) of a resource entity, a resource entity also has URIs (`_links`) to linked resource entities.
|
|
|
|
A _Distribution Set_ entity may have for example URIs to artifacts, _Software Modules_, _Software Module Types_ and metadata.
|
|
|
|
|
|
```json
|
|
"_links": {
|
|
"artifacts": {
|
|
"href": "http://localhost:8080/rest/v1/softwaremodules/83/artifacts"
|
|
},
|
|
"self": {
|
|
"href": "http://localhost:8080/rest/v1/softwaremodules/83"
|
|
},
|
|
"type": {
|
|
"href": "http://localhost:8080/rest/v1/softwaremoduletypes/43"
|
|
},
|
|
"metadata": {
|
|
"href": "http://localhost:8080/rest/v1/softwaremodules/83/metadata?offset=0&limit=50"
|
|
}
|
|
``` |