f96876afe0
* Add new hugo-based website for hawkBit Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Fix broken links + wordings - , i.e. -> i.e, - , e.g. -> e.g., - hawkbit -> hawkBit - don't -> do not - isn't -> is not Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Remove old documentation and add maven integration Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Add Intellij files to ignore Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Update README Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Update Copyright header * exclude website artifacts Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Harmonize usage of i.e. and e.g. Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Add remark for windows user Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Fix indention Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Introduce review findings Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Change image in 'run hawkbit' guide Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>
78 lines
2.6 KiB
Markdown
78 lines
2.6 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/)
|
|
- [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"
|
|
}
|
|
``` |