API docs by Redocly

hawkBit REST APIs (v1)

Download OpenAPI specification:Download

Eclipse hawkBit™ is a domain-independent back-end framework for rolling out software updates to constrained edge devices as well as more powerful controllers and gateways connected to IP based networking infrastructure.

Distribution Sets

REST Resource handling for DistributionSet CRUD operations.

Return single Distribution Set

Handles the GET request of retrieving a single distribution set. Required permission: READ_REPOSITORY

path Parameters
distributionSetId
required
integer <int64>

Responses

Response samples

Content type
{
  • "createdBy": "bumlux",
  • "createdAt": 1682408574924,
  • "lastModifiedBy": "bumlux",
  • "lastModifiedAt": 1682408574925,
  • "name": "DS",
  • "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
  • "version": "1.0",
  • "modules": [
    ],
  • "requiredMigrationStep": false,
  • "type": "test_default_ds_type",
  • "typeName": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
  • "complete": true,
  • "deleted": false,
  • "valid": true,
  • "_links": {},
  • "id": 6
}

Update Distribution Set

Handles the UPDATE request for a single Distribution Set. Required permission: UPDATE_REPOSITORY

path Parameters
distributionSetId
required
integer <int64>
Request Body schema:
required
name
string

The name of the entity

description
string

The description of the entity

version
string

Package version

locked
boolean

Should be set only if change of locked state is requested. If put, the distribution set locked flag will be set to the requested. Note: unlock (i.e. set this property to false) with extreme care! In general once distribution set is locked it shall not be unlocked. Note that it could have been assigned / deployed to targets.

requiredMigrationStep
boolean

True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled when another DS is assigned (note: updatable only if DS is not yet assigned to a target)

Responses

Request samples

Content type
{
  • "name": "dsOne",
  • "description": "Description of the distribution set.",
  • "version": "1.0.0",
  • "locked": true,
  • "requiredMigrationStep": false
}

Response samples

Content type
{
  • "createdBy": "bumlux",
  • "createdAt": 1682408574924,
  • "lastModifiedBy": "bumlux",
  • "lastModifiedAt": 1682408574925,
  • "name": "DS",
  • "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
  • "version": "1.0",
  • "modules": [
    ],
  • "requiredMigrationStep": false,
  • "type": "test_default_ds_type",
  • "typeName": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
  • "complete": true,
  • "deleted": false,
  • "valid": true,
  • "_links": {},
  • "id": 6
}

Delete Distribution Set by Id

Handles the DELETE request for a single Distribution Set. Required permission: DELETE_REPOSITORY

path Parameters
distributionSetId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return single meta data value for a specific key of a Distribution Set

Get a single meta data value for a meta data key. Required permission: READ_REPOSITORY

path Parameters
distributionSetId
required
integer <int64>
metadataKey
required
string

Responses

Response samples

Content type
application/json
{
  • "key": "someKnownKey",
  • "value": "someKnownKeyValue"
}

Update single meta data value of a distribution set

Update a single meta data value for speficic key. Required permission: UPDATE_REPOSITORY

path Parameters
distributionSetId
required
integer <int64>
metadataKey
required
string
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "someValue"
}

Response samples

Content type
{
  • "key": "someKnownKey",
  • "value": "someKnownKeyValue"
}

Delete a single meta data entry from the distribution set

Delete a single meta data. Required permission: UPDATE_REPOSITORY

path Parameters
distributionSetId
required
integer <int64>
metadataKey
required
string

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return all Distribution Sets

Handles the GET request of retrieving all distribution sets. Required permission: READ_REPOSITORY

query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{
  • "content": [
    ],
  • "total": 0,
  • "size": 0,
  • "_links": {
    }
}

Creates new Distribution Sets

Handles the POST request of creating new distribution sets within Hawkbit. The request body must always be a list of sets. Required permission: CREATE_REPOSITORY

Request Body schema:
required
Array
name
string

The name of the entity

description
string

The description of the entity

version
string

Package version

locked
boolean

Should be set only if change of locked state is requested. If put, the distribution set locked flag will be set to the requested. Note: unlock (i.e. set this property to false) with extreme care! In general once distribution set is locked it shall not be unlocked. Note that it could have been assigned / deployed to targets.

requiredMigrationStep
boolean

True if DS is a required migration step for another DS. As a result the DS’s assignment will not be cancelled when another DS is assigned (note: updatable only if DS is not yet assigned to a target)

Array of objects (MgmtSoftwareModuleAssigment)
type
string

The type of the distribution set

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Return meta data for Distribution Set

Get a paged list of meta data for a distribution set. Required permission: READ_REPOSITORY

path Parameters
distributionSetId
required
integer <int64>
query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{
  • "content": [
    ],
  • "total": 0,
  • "size": 0,
  • "_links": {
    }
}

Create a list of meta data for a specific distribution set

Create a list of meta data entries Required permissions: READ_REPOSITORY and UPDATE_TARGET

path Parameters
distributionSetId
required
integer <int64>
Request Body schema:
required
Array
key
required
string

Metadata property key

value
string

Metadata property value

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Invalidate a distribution set

Invalidate a distribution set. Once a distribution set is invalidated, it can not be valid again. An invalidated distribution set cannot be assigned to targets anymore. The distribution set that is going to be invalidated will be removed from all auto assignments. Furthermore, the user can choose to cancel all rollouts and (force) cancel all actions connected to this distribution set. Required permission: UPDATE_REPOSITORY, UPDATE_TARGET

path Parameters
distributionSetId
required
integer <int64>
Request Body schema:
required
actionCancelationType
required
string
Enum: "soft" "force" "none"

Type of cancelation for actions referring to the given distribution set

cancelRollouts
boolean

Defines if rollouts referring to this distribution set should be canceled

Responses

Request samples

Content type
{
  • "actionCancelationType": "soft",
  • "cancelRollouts": true
}

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return assigned targets to a specific distribution set

Handles the GET request for retrieving assigned targets of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET

path Parameters
distributionSetId
required
integer <int64>
query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{}

Assigning multiple targets to a single distribution set

Handles the POST request for assigning multiple targets to a distribution set.The request body must always be a list of target IDs. Non-existing targets are silently ignored resulting in a valid response. Required permissions: READ_REPOSITORY and UPDATE_TARGET

path Parameters
distributionSetId
required
integer <int64>
query Parameters
offline
boolean
Request Body schema:
required
Array
id
required
string

The technical identifier of the entity

forcetime
integer <int64>

Forcetime in milliseconds

type
string
Enum: "soft" "forced" "timeforced" "downloadonly"

The type of the assignment

object (MgmtMaintenanceWindowRequestBody)

Separation of download and install by defining a maintenance window for the installation

weight
integer <int32>

Importance of the assignment

confirmationRequired
boolean

(Available with user consent flow active) Defines, if the confirmation is required for an action. Confirmation is required per default

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "alreadyAssigned": 0,
  • "assignedActions": [
    ],
  • "_links": {
    },
  • "assigned": 0,
  • "total": 0
}

Return the assigned software modules of a specific distribution set

Handles the GET request of retrieving a single distribution set. Required permission: READ_REPOSITORY

path Parameters
distributionSetId
required
integer <int64>
query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

Responses

Response samples

Content type
{}

Assign a list of software modules to a distribution set

Handles the POST request for assigning multiple software modules to a distribution set.The request body must always be a list of software module IDs. Required permissions: READ_REPOSITORY and UPDATE_REPOSITORY

path Parameters
distributionSetId
required
integer <int64>
Request Body schema:
required
Array
id
integer <int64>

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return Rollouts, Actions and Auto Assignments counts by Status for Distribution Set

Handles the GET request of retrieving Rollouts, Actions and Auto Assignments counts by Status for Distribution Set

path Parameters
distributionSetId
required
integer <int64>

Responses

Response samples

Content type
{
  • "totalAutoAssignments": 0,
  • "actions": {
    },
  • "rollouts": {
    }
}

Return Rollouts count by status for Distribution Set

Handles the GET request of retrieving Rollouts count by Status for Distribution Set

path Parameters
distributionSetId
required
integer <int64>

Responses

Response samples

Content type
{
  • "totalAutoAssignments": 0,
  • "actions": {
    },
  • "rollouts": {
    }
}

Return Auto Assignments count for Distribution Set

Handles the GET request of retrieving Auto Assignments count for Distribution Set

path Parameters
distributionSetId
required
integer <int64>

Responses

Response samples

Content type
{
  • "totalAutoAssignments": 0,
  • "actions": {
    },
  • "rollouts": {
    }
}

Return Actions count by status for Distribution Set

Handles the GET request of retrieving Actions count by Status for Distribution Set

path Parameters
distributionSetId
required
integer <int64>

Responses

Response samples

Content type
{
  • "totalAutoAssignments": 0,
  • "actions": {
    },
  • "rollouts": {
    }
}

Return installed targets to a specific distribution set

Handles the GET request for retrieving installed targets of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET

path Parameters
distributionSetId
required
integer <int64>
query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{}

Return target filter queries that have the given distribution set as auto assign DS

Handles the GET request for retrieving assigned target filter queries of a single distribution set. Required permissions: READ_REPOSITORY and READ_TARGET

path Parameters
distributionSetId
required
integer <int64>
query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{
  • "content": [],
  • "total": 0,
  • "size": 0,
  • "_links": {
    }
}

Delete the assignment of the software module from the distribution set

Delete an assignment. Required permission: UPDATE_REPOSITORY

path Parameters
distributionSetId
required
integer <int64>
softwareModuleId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Targets

REST API for Target CRUD operations.

Return target by id

Handles the GET request of retrieving a single target. Required Permission: READ_TARGET.

path Parameters
targetId
required
string

Responses

Response samples

Content type
{}

Update target by id

Handles the PUT request of updating a target. Required Permission: UPDATE_TARGET

path Parameters
targetId
required
string
Request Body schema:
required
name
required
string

The name of the entity

description
string

The description of the entity

controllerId
required
string

Controller ID

address
string

The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp

securityToken
string

Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings

requestAttributes
boolean

Request re-transmission of target attributes

targetType
integer <int64>

ID of the target type

Responses

Request samples

Content type
{
  • "name": "controllerName",
  • "description": "Example description of a target",
  • "controllerId": "123",
  • "address": "https://192.168.0.1",
  • "securityToken": "2345678DGGDGFTDzztgf",
  • "requestAttributes": true,
  • "targetType": 10
}

Response samples

Content type
{}

Delete target by id

Handles the DELETE request of deleting a single target. Required Permission: DELETE_TARGET

path Parameters
targetId
required
string

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return single metadata value for a specific key of a target

Get a single meta data value for a meta data key. Required permission: READ_REPOSITORY

path Parameters
targetId
required
string
metadataKey
required
string

Responses

Response samples

Content type
application/json
{
  • "key": "someKnownKey",
  • "value": "someKnownKeyValue"
}

Updates a single meta data value of a target

Update a single meta data value for speficic key. Required permission: UPDATE_REPOSITORY

path Parameters
targetId
required
string
metadataKey
required
string
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "someValue"
}

Response samples

Content type
{
  • "key": "someKnownKey",
  • "value": "someKnownKeyValue"
}

Deletes a single meta data entry from a target

Delete a single meta data. Required permission: UPDATE_REPOSITORY

path Parameters
targetId
required
string
metadataKey
required
string

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return action by id of a specific target

Handles the GET request of retrieving a specific action on a specific target. Required Permission: READ_TARGET

path Parameters
targetId
required
string
actionId
required
integer <int64>

Responses

Response samples

Content type
{}

Switch an action from soft to forced

Handles the PUT request to switch an action from soft to forced. Required Permission: UPDATE_TARGET.

path Parameters
targetId
required
string
actionId
required
integer <int64>
Request Body schema:
required
forceType
string
Enum: "soft" "forced" "timeforced" "downloadonly"

Responses

Request samples

Content type
{
  • "forceType": "soft"
}

Response samples

Content type
{}

Cancel action for a specific target

Cancels an active action, only active actions can be deleted. Required Permission: UPDATE_TARGET

path Parameters
targetId
required
string
actionId
required
integer <int64>
query Parameters
force
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return all targets

Handles the GET request of retrieving all targets. Required permission: READ_TARGET

query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{}

Create target(s)

Handles the POST request of creating new targets. The request body must always be a list of targets. Required Permission: CREATE_TARGET

Request Body schema:
required
Array
name
required
string

The name of the entity

description
string

The description of the entity

controllerId
required
string

Controller ID

address
string

The last known address URI of the target. Includes information of the target is connected either directly (DDI) through HTTP or indirectly (DMF) through amqp

securityToken
string

Pre-Shared key that allows targets to authenticate at Direct Device Integration API if enabled in the tenant settings

requestAttributes
boolean

Request re-transmission of target attributes

targetType
integer <int64>

ID of the target type

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[]

Assign target type to a target

Assign or update the target type of a target. Required permission: UPDATE_TARGET

path Parameters
targetId
required
string
Request Body schema:
required
id
integer <int64>

Responses

Request samples

Content type
{
  • "id": 108
}

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Unassign target type from target.

Remove the target type from a target. The target type will be set to null. Required permission: UPDATE_TARGET

path Parameters
targetId
required
string

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return metadata for specific target

Get a paged list of meta data for a target. Required permission: READ_REPOSITORY

path Parameters
targetId
required
string
query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{
  • "content": [
    ],
  • "total": 0,
  • "size": 0,
  • "_links": {
    }
}

Create a list of meta data for a specific target

Create a list of meta data entries Required permissions: READ_REPOSITORY and UPDATE_TARGET

path Parameters
targetId
required
string
Request Body schema:
required
Array
key
required
string

Metadata property key

value
string

Metadata property value

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Deactivate auto-confirm on a specific target

Handles the POST request to deactivate auto-confirmation for a specific target. All active actions will remain unchanged while all future actions need to be confirmed, before processing with the deployment. Required Permission: UPDATE_TARGET

path Parameters
targetId
required
string

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Activate auto-confirm on a specific target

Handles the POST request to activate auto-confirmation for a specific target. As a result all current active as well as future actions will automatically be confirmed by mentioning the initiator as triggered person. Actions will be automatically confirmed, as long as auto-confirmation is active. Required Permission: UPDATE_TARGET

path Parameters
targetId
required
string
Request Body schema: application/json
initiator
string

(Optional) Initiator set on activation

remark
string

(Optional) Remark set on activation

Responses

Request samples

Content type
application/json
{
  • "initiator": "custom_initiator_value",
  • "remark": "custom_remark"
}

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return the assigned distribution set of a specific target

Handles the GET request of retrieving the assigned distribution set of an specific target. Required Permission: READ_TARGET

path Parameters
targetId
required
string

Responses

Response samples

Content type
{
  • "createdBy": "bumlux",
  • "createdAt": 1682408574924,
  • "lastModifiedBy": "bumlux",
  • "lastModifiedAt": 1682408574925,
  • "name": "DS",
  • "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
  • "version": "1.0",
  • "modules": [
    ],
  • "requiredMigrationStep": false,
  • "type": "test_default_ds_type",
  • "typeName": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
  • "complete": true,
  • "deleted": false,
  • "valid": true,
  • "_links": {},
  • "id": 6
}

Assigns a distribution set to a specific target

Handles the POST request for assigning a distribution set to a specific target. Required Permission: READ_REPOSITORY and UPDATE_TARGET

path Parameters
targetId
required
string
query Parameters
offline
string

Offline update (set param to true) that is only reported but not managed by the service, e.g. defaults set in factory, manual updates or migrations from other update systems. A completed action is added to the history of the target(s). Target is set to IN_SYNC state as both assigned and installed DS are set. Note: only executed if the target has currently no running update

Request Body schema:
required
Array
id
required
integer <int64>
forcetime
integer <int64>

Forcetime in milliseconds

weight
integer <int32>

Importance of the assignment

confirmationRequired
boolean

(Available with user consent flow active) Specifies if the confirmation by the device is required for this action

type
string
Enum: "soft" "forced" "timeforced" "downloadonly"

The type of the assignment

object (MgmtMaintenanceWindowRequestBody)

Separation of download and install by defining a maintenance window for the installation

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "alreadyAssigned": 0,
  • "assignedActions": [
    ],
  • "_links": {
    },
  • "assigned": 0,
  • "total": 0
}

Return tags for specific target

Get a paged list of tags for a target. Required permission: READ_REPOSITORY

path Parameters
targetId
required
string

Responses

Response samples

Content type
[]

Return installed distribution set of a specific target

Handles the GET request of retrieving the installed distribution set of an specific target. Required Permission: READ_TARGET

path Parameters
targetId
required
string

Responses

Response samples

Content type
{
  • "createdBy": "bumlux",
  • "createdAt": 1682408574924,
  • "lastModifiedBy": "bumlux",
  • "lastModifiedAt": 1682408574925,
  • "name": "DS",
  • "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
  • "version": "1.0",
  • "modules": [
    ],
  • "requiredMigrationStep": false,
  • "type": "test_default_ds_type",
  • "typeName": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
  • "complete": true,
  • "deleted": false,
  • "valid": true,
  • "_links": {},
  • "id": 6
}

Return the current auto-confitm state for a specific target

Handles the GET request to check the current auto-confirmation state of a target. Required Permission: READ_TARGET

path Parameters
targetId
required
string

Responses

Response samples

Content type
{}

Return attributes of a specific target

Handles the GET request of retrieving the attributes of a specific target. Reponse is a key/value list. Required Permission: READ_TARGET

path Parameters
targetId
required
string

Responses

Response samples

Content type
{
  • "property1": "string",
  • "property2": "string"
}

Return actions for a specific target

Handles the GET request of retrieving the full action history of a specific target. Required Permission: READ_TARGET

path Parameters
targetId
required
string
query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{}

Return status of a specific action on a specific target

Handles the GET request of retrieving a specific action on a specific target. Required Permission: READ_TARGET

path Parameters
targetId
required
string
actionId
required
integer <int64>
query Parameters
offset
integer <int32>
Default: 0
limit
integer <int32>
Default: 50
sort
string

Responses

Response samples

Content type
{
  • "content": [
    ],
  • "total": 0,
  • "size": 0,
  • "_links": {
    }
}

Actions

REST API providing (read-only) access to actions.

Return all actions

Handles the GET request of retrieving all actions.

query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

representation
string

The representation mode. Can be "full" or "compact". Defaults to "compact"

Responses

Response samples

Content type
{}

Return action by id

Handles the GET request of retrieving a single action by actionId.

path Parameters
actionId
required
integer <int64>

Responses

Response samples

Content type
{}

Basic Authentication

API for basic auth user validation.

validateBasicAuth

Responses

Response samples

Content type
{
  • "tenant": "string",
  • "username": "string"
}

Software Module Types

REST API for SoftwareModuleTypes CRUD operations.

Return single Software Module Type

Handles the GET request of retrieving a single software module type. Required Permission: READ_REPOSITORY

path Parameters
softwareModuleTypeId
required
integer <int64>

Responses

Response samples

Content type
{
  • "createdBy": "system",
  • "createdAt": 1682408579390,
  • "lastModifiedBy": "bumlux",
  • "lastModifiedAt": 1682408579394,
  • "name": "Application",
  • "description": "Updated description.",
  • "key": "application",
  • "maxAssignments": 2147483647,
  • "deleted": false,
  • "_links": {},
  • "id": 4
}

Update Software Module Type

Handles the PUT request for a single software module type. Required Permission: UPDATE_REPOSITORY

path Parameters
softwareModuleTypeId
required
integer <int64>
Request Body schema:
required
description
string
colour
string

Responses

Request samples

Content type
{
  • "description": "Example description",
  • "colour": "rgb(0,0,255"
}

Response samples

Content type
{
  • "createdBy": "system",
  • "createdAt": 1682408579390,
  • "lastModifiedBy": "bumlux",
  • "lastModifiedAt": 1682408579394,
  • "name": "Application",
  • "description": "Updated description.",
  • "key": "application",
  • "maxAssignments": 2147483647,
  • "deleted": false,
  • "_links": {},
  • "id": 4
}

Delete Software Module Type by Id

Handles the DELETE request for a single software module type. Required Permission: DELETE_REPOSITORY

path Parameters
softwareModuleTypeId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return all Software Module Types

Handles the GET request of retrieving all software module types. Required Permission: READ_REPOSITORY

query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{
  • "content": [
    ],
  • "total": 0,
  • "size": 0,
  • "_links": {
    }
}

Creates new Software Module Types

Handles the POST request of creating new software module types. The request body must always be a list of module types. Required Permission: CREATE_REPOSITORY

Request Body schema:
required
Array
description
string
colour
string
name
required
string
key
required
string
maxAssignments
integer <int32>

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Rollouts

REST API for Rollout CRUD operations.

Return single Rollout

Handles the GET request of retrieving a single rollout. Required Permission: READ_ROLLOUT

path Parameters
rolloutId
required
integer <int64>

Responses

Response samples

Content type
{}

Update Rollout

Handles the UPDATE request for a single Rollout. Required permission: UPDATE_ROLLOUT

path Parameters
rolloutId
required
integer <int64>
Request Body schema:
required
name
required
string
description
string
object (Links)

Responses

Request samples

Content type
{
  • "name": "exampleRollout",
  • "description": "Rollout for all named targets"
}

Response samples

Content type
{}

Delete a Rollout

Handles the DELETE request of deleting a rollout. Required Permission: DELETE_ROLLOUT

path Parameters
rolloutId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return all Rollouts

Handles the GET request of retrieving all rollouts. Required Permission: READ_ROLLOUT

query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

representation
string
Default: "compact"

Responses

Response samples

Content type
{}

Create a new Rollout

Handles the POST request of creating new rollout. Required Permission: CREATE_ROLLOUT

Request Body schema:
required
name
required
string
description
string
object (MgmtRolloutCondition)

The error condition which takes in place to evaluate if a rollout group encounter errors

object (MgmtRolloutSuccessAction)

The success action which takes in place to execute in case the success action is fulfilled

object (MgmtRolloutCondition)

The error condition which takes in place to evaluate if a rollout group encounter errors

object (MgmtRolloutErrorAction)

The error action which is executed if the error condition is fulfilled

targetFilterQuery
string

Target filter query language expression

distributionSetId
integer <int64>

The ID of distribution set of this rollout

amountGroups
integer <int32>

The amount of groups the rollout should split targets into

forcetime
integer <int64>

Force time in milliseconds

startAt
integer <int64>

Start at timestamp of Rollout

weight
integer <int32>

Weight of the resulting Actions

dynamic
boolean
object (MgmtDynamicRolloutGroupTemplate)

Template for dynamic groups (only if dynamic flag is true)

confirmationRequired
boolean

(Available with user consent flow active) If the confirmation is required for this rollout. Value will be used if confirmation options are missing in the rollout group definitions. Confirmation is required per default

type
string
Enum: "soft" "forced" "timeforced" "downloadonly"

The type of this rollout

Array of objects (MgmtRolloutGroup)

The list of group definitions

object (Links)

Responses

Request samples

Content type
{
  • "distributionSetId": 6,
  • "targetFilterQuery": "id==targets-*",
  • "description": "Rollout for all named targets",
  • "amountGroups": 5,
  • "type": "forced",
  • "successCondition": {
    },
  • "successAction": {
    },
  • "name": "exampleRollout",
  • "forcetime": 1682408571791,
  • "errorAction": {
    },
  • "confirmationRequired": false,
  • "errorCondition": {
    },
  • "startAt": 1682408570791
}

Response samples

Content type
{}

Force trigger processing next group of a Rollout

Handles the POST request of triggering the next group of a rollout. Required Permission: UPDATE_ROLLOUT

path Parameters
rolloutId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Start a Rollout

Handles the POST request of starting a created rollout. Required Permission: HANDLE_ROLLOUT

path Parameters
rolloutId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Retry a rollout

Handles the POST request of retrying a rollout. Required Permission: CREATE_ROLLOUT

path Parameters
rolloutId
required
integer <int64>

Responses

Response samples

Content type
{}

Resume a Rollout

Handles the POST request of resuming a paused rollout. Required Permission: HANDLE_ROLLOUT

path Parameters
rolloutId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Pause a Rollout

Handles the POST request of pausing a running rollout. Required Permission: HANDLE_ROLLOUT

path Parameters
rolloutId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Deny a Rollout

Handles the POST request of denying a created rollout. Only possible if approval workflow is enabled in system configuration and rollout is in state WAITING_FOR_APPROVAL. Required Permission: APPROVE_ROLLOUT

path Parameters
rolloutId
required
integer <int64>
query Parameters
remark
string

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Approve a Rollout

Handles the POST request of approving a created rollout. Only possible if approval workflow is enabled in system configuration and rollout is in state WAITING_FOR_APPROVAL. Required Permission: APPROVE_ROLLOUT

path Parameters
rolloutId
required
integer <int64>
query Parameters
remark
string

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return all rollout groups referred to a Rollout

Handles the GET request of retrieving all deploy groups of a specific rollout. Required Permission: READ_ROLLOUT

path Parameters
rolloutId
required
integer <int64>
query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

representation
string
Default: "compact"

Responses

Response samples

Content type
{
  • "content": [
    ],
  • "total": 0,
  • "size": 0,
  • "_links": {
    }
}

Return single rollout group

Handles the GET request of a single deploy group of a specific rollout. Required Permission: READ_ROLLOUT

path Parameters
rolloutId
required
integer <int64>
groupId
required
integer <int64>

Responses

Response samples

Content type
{
  • "createdBy": "bumlux",
  • "createdAt": 1682408569768,
  • "lastModifiedBy": "bumlux",
  • "lastModifiedAt": 1682408569795,
  • "name": "group-1",
  • "description": "group-1",
  • "successCondition": {
    },
  • "successAction": {
    },
  • "errorCondition": {
    },
  • "errorAction": {
    },
  • "targetFilterQuery": "",
  • "targetPercentage": 20,
  • "confirmationRequired": false,
  • "status": "ready",
  • "totalTargets": 4,
  • "totalTargetsPerStatus": {
    },
  • "_links": {},
  • "id": 78
}

Return all targets related to a specific rollout group

Handles the GET request of retrieving all targets of a single deploy group of a specific rollout. Required Permissions: READ_ROLLOUT, READ_TARGET.

path Parameters
rolloutId
required
integer <int64>
groupId
required
integer <int64>
query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{}

Target Types

REST API for Target Type CRUD operations.

Return target type by id

Handles the GET request of retrieving a single target type

path Parameters
targetTypeId
required
integer <int64>

Responses

Response samples

Content type
{}

Update target type by id

Handles the PUT request for a single target type. Required Permission: UPDATE_TARGET

path Parameters
targetTypeId
required
integer <int64>
Request Body schema:
required
name
required
string

The name of the entity

description
string

The description of the entity

colour
string

The colour of the entity

Responses

Request samples

Content type
{
  • "name": "updatedTypeName",
  • "description": "an updated description",
  • "colour": "#aaafff"
}

Response samples

Content type
{}

Delete target type by id

Handles the DELETE request for a single target type. Required Permission: DELETE_TARGET

path Parameters
targetTypeId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return all target types

Handles the GET request of retrieving all target types.

query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{
  • "content": [],
  • "total": 0,
  • "size": 0,
  • "_links": {
    }
}

Create target types

Handles the POST request for creating new target types. The request body must always be a list of types. Required Permission: CREATE_TARGET

Request Body schema:
required
Array
name
required
string

The name of the entity

description
string

The description of the entity

colour
string

The colour of the entity

key
string

Target type key

Array of objects (MgmtDistributionSetTypeAssignment)

Array of distribution set types that are compatible to that target type

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[]

Return list of compatible distribution set types

Handles the GET request of retrieving the list of compatible distribution set types in that target type. Required Permission: READ_TARGET, READ_REPOSITORY

path Parameters
targetTypeId
required
integer <int64>

Responses

Response samples

Content type
[]

Adding compatibility of a distribution set type to a target type

Handles the POST request for adding compatible distribution set types to a target type. Required Permission: UPDATE_TARGET and READ_REPOSITORY

path Parameters
targetTypeId
required
integer <int64>
Request Body schema:
required
Array
id
integer <int64>

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Remove compatibility of distribution set type from the target type

Handles the DELETE request for removing a distribution set type from a single target type. Required Permission: UPDATE_TARGET and READ_REPOSITORY

path Parameters
targetTypeId
required
integer <int64>
distributionSetTypeId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Software Modules

REST API for SoftwareModule and related Artifact CRUD operations.

Return Software Module by id

Handles the GET request of retrieving a single softwaremodule. Required Permission: READ_REPOSITORY

path Parameters
softwareModuleId
required
integer <int64>

Responses

Response samples

Content type
{}

Update Software Module

Handles the PUT request for a single softwaremodule within Hawkbit. Required Permission: UPDATE_REPOSITORY

path Parameters
softwareModuleId
required
integer <int64>
Request Body schema:
required
description
string
vendor
string
locked
boolean

Should be set only if change of locked state is requested. If put, the software module locked flag will be set to the requested. Note: unlock (i.e. set this property to false) with extreme care! In general once software module is locked it shall not be unlocked. Note that it could have been assigned / deployed to targets.

Responses

Request samples

Content type
{
  • "description": "SM Description",
  • "vendor": "SM Vendor Name",
  • "locked": true
}

Response samples

Content type
{}

Delete Software Module by Id

Handles the DELETE request for a single softwaremodule within Hawkbit. Required Permission: DELETE_REPOSITORY

path Parameters
softwareModuleId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return single meta data value for a specific key of a Software Module

Get a single meta data value for a meta data key. Required Permission: READ_REPOSITORY

path Parameters
softwareModuleId
required
integer <int64>
metadataKey
required
string

Responses

Response samples

Content type
{
  • "key": "someKnownKey",
  • "value": "someKnownValue",
  • "targetVisible": false
}

Update a single meta data value of a Software Module

Update a single meta data value for speficic key. Required Permission: UPDATE_REPOSITORY

path Parameters
softwareModuleId
required
integer <int64>
metadataKey
required
string
Request Body schema: application/json
required
value
string
targetVisible
boolean

Responses

Request samples

Content type
application/json
{
  • "value": "newValue",
  • "targetVisible": true
}

Response samples

Content type
{
  • "key": "someKnownKey",
  • "value": "someKnownValue",
  • "targetVisible": false
}

Delete single meta data entry from the software module

Delete a single meta data. Required Permission: UPDATE_REPOSITORY

path Parameters
softwareModuleId
required
integer <int64>
metadataKey
required
string

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return all Software modules

Handles the GET request of retrieving all softwaremodules. Required Permission: READ_REPOSITORY

query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{}

Create Software Module(s)

Handles the POST request of creating new software modules. The request body must always be a list of modules. Required Permission: CREATE_REPOSITORY

Request Body schema:
required
Array
name
required
string
version
required
string
type
required
string
description
string
vendor
string
encrypted
boolean

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[]

Return meta data for a Software Module

Get a paged list of meta data for a software module. Required Permission: READ_REPOSITORY

path Parameters
softwareModuleId
required
integer <int64>
query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{
  • "content": [
    ],
  • "total": 0,
  • "size": 0,
  • "_links": {
    }
}

Creates a list of meta data for a specific Software Module

Create a list of meta data entries Required Permission: UPDATE_REPOSITORY

path Parameters
softwareModuleId
required
integer <int64>
Request Body schema:
required
Array
key
required
string

Metadata property key

value
string

Metadata property value

targetVisible
boolean

Metadata property is visible to targets as part of software update action

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Return all meta data of artifacts assigned to a software module

Handles the GET request of retrieving all meta data of artifacts assigned to a software module. Required Permission: READ_REPOSITORY

path Parameters
softwareModuleId
required
integer <int64>
query Parameters
representation
string
Default: "compact"
useartifacturlhandler
boolean

Responses

Response samples

Content type
[]

Upload artifact

Handles POST request for artifact upload. Required Permission: CREATE_REPOSITORY

path Parameters
softwareModuleId
required
integer <int64>
query Parameters
filename
string
md5sum
string
sha1sum
string
sha256sum
string
Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
{}

Return single Artifact meta data

Handles the GET request of retrieving a single Artifact meta data request. Required Permission: READ_REPOSITORY

path Parameters
softwareModuleId
required
integer <int64>
artifactId
required
integer <int64>
query Parameters
useartifacturlhandler
boolean

Responses

Response samples

Content type
{}

Delete artifact by Id

Handles the DELETE request for a single Artifact assigned to a SoftwareModule. Required Permission: DELETE_REPOSITORY

path Parameters
softwareModuleId
required
integer <int64>
artifactId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Target Tags

REST API for Target Tag CRUD operations.

Return target tag by id

Handles the GET request of retrieving a single target tag.

path Parameters
targetTagId
required
integer <int64>

Responses

Response samples

Content type
{}

Update target tag by id

Handles the PUT request of updating a target tag.

path Parameters
targetTagId
required
integer <int64>
Request Body schema:
required
name
string

The name of the entity

description
string

The description of the entity

colour
string

The colour of the entity

Responses

Request samples

Content type
{
  • "name": "Example name",
  • "description": "Example description",
  • "colour": "rgb(0,255,0)"
}

Response samples

Content type
{}

Delete target tag by id

Handles the DELETE request of deleting a single target tag.

path Parameters
targetTagId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return assigned targets for tag

Handles the GET request of retrieving a list of assigned targets.

path Parameters
targetTagId
required
integer <int64>
query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{}

Assign target(s) to given tagId

Handles the POST request of target assignment. Already assigned target will be ignored.

path Parameters
targetTagId
required
integer <int64>
query Parameters
onNotFoundPolicy
string
Default: "FAIL"
Enum: "FAIL" "ON_WHAT_FOUND_AND_FAIL" "ON_WHAT_FOUND_AND_SUCCESS"
Request Body schema:
required
string

List of controller ids to be assigned

Responses

Request samples

Content type
[
  • "controllerId1",
  • "controllerId2"
]

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

[DEPRECATED] Assign target(s) to given tagId and return targets

Handles the POST request of target assignment. Already assigned target will be ignored.

path Parameters
targetTagId
required
integer <int64>
Request Body schema:
required
Array
controllerId
required
string

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[]

Unassign targets from a given tagId

Handles the DELETE request to unassign the given targets.

path Parameters
targetTagId
required
integer <int64>
query Parameters
onNotFoundPolicy
string
Default: "FAIL"
Enum: "FAIL" "ON_WHAT_FOUND_AND_FAIL" "ON_WHAT_FOUND_AND_SUCCESS"
Request Body schema:
required
string

List of controller ids to be unassigned

Responses

Request samples

Content type
[
  • "controllerId1",
  • "controllerId2"
]

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return all target tags

Handles the GET request of retrieving all target tags.

query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{
  • "content": [],
  • "total": 0,
  • "size": 0,
  • "_links": {
    }
}

Create target tag(s)

Handles the POST request of creating new target tag. The request body must always be a list of target tags.

Request Body schema:
required
Array
name
string

The name of the entity

description
string

The description of the entity

colour
string

The colour of the entity

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[]

Assign target(s) to given tagId

Handles the POST request of target assignment. Already assigned target will be ignored.

path Parameters
targetTagId
required
integer <int64>
controllerId
required
string

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Unassign target from a given tagId

Handles the DELETE request to unassign the given target.

path Parameters
targetTagId
required
integer <int64>
controllerId
required
string

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

[DEPRECATED] Toggles target tag assignment

Handles the POST request of toggle target assignment. The request body must always be a list of controller ids.

path Parameters
targetTagId
required
integer <int64>
Request Body schema:
required
Array
controllerId
required
string

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{}

Target Filter Queries

REST API for Target Filter Queries CRUD operations.

Return target filter query by id

Handles the GET request of retrieving a single target filter query. Required permission: READ_TARGET

path Parameters
filterId
required
integer <int64>

Responses

Response samples

Content type
{}

Updates target filter query by id

Handles the PUT request of updating a target filter query. Required permission: UPDATE_TARGET

path Parameters
filterId
required
integer <int64>
Request Body schema:
required
name
required
string
query
required
string

Responses

Request samples

Content type
{
  • "name": "filterName",
  • "query": "controllerId==example-target-*"
}

Response samples

Content type
{}

Delete target filter by id

Handles the DELETE request of deleting a target filter query. Required permission: DELETE_TARGET

path Parameters
filterId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return all target filter queries

Handles the GET request of retrieving all target filter queries. Required permission: READ_TARGET

query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

representation
string
Default: "compact"

Responses

Response samples

Content type
{
  • "content": [],
  • "total": 0,
  • "size": 0,
  • "_links": {
    }
}

Create target filter

Handles the POST request to create a new target filter query. Required permission: CREATE_TARGET

Request Body schema:
required
name
required
string
query
required
string

Responses

Request samples

Content type
{
  • "name": "filterName",
  • "query": "controllerId==example-target-*"
}

Response samples

Content type
{}

Return distribution set for auto assignment of a specific target filter

Handles the GET request of retrieving the auto assign distribution set. Required permission: READ_TARGET

path Parameters
filterId
required
integer <int64>

Responses

Response samples

Content type
{
  • "createdBy": "bumlux",
  • "createdAt": 1682408574924,
  • "lastModifiedBy": "bumlux",
  • "lastModifiedAt": 1682408574925,
  • "name": "DS",
  • "description": "Updated Desc: 2LaONizh7WZp0on6XEOZI9AwEYIjj77YZskEmA2LVrKtAOXj9vvqACopEghLMqt6DIWpIahn6XM4jUlRZ1T5SZS2NWMuWHGoFIg1",
  • "version": "1.0",
  • "modules": [
    ],
  • "requiredMigrationStep": false,
  • "type": "test_default_ds_type",
  • "typeName": "OS (FW) mandatory, runtime (FW) and app (SW) optional",
  • "complete": true,
  • "deleted": false,
  • "valid": true,
  • "_links": {},
  • "id": 6
}

Set auto assignment of distribution set for a target filter query

Handles the POST request of setting the auto assign distribution set for a target filter query. Required permissions: UPDATE_TARGET and READ_REPOSITORY

path Parameters
filterId
required
integer <int64>
Request Body schema:
required
id
integer <int64>
type
string
Enum: "soft" "forced" "timeforced" "downloadonly"
weight
integer <int32>
confirmationRequired
boolean

Responses

Request samples

Content type
{
  • "id": 108,
  • "type": "soft",
  • "weight": 0,
  • "confirmationRequired": true
}

Response samples

Content type
{}

Remove Distribution Set for auto assignment of a target filter

Removes the auto assign distribution set from the target filter query. Required permission: UPDATE_TARGET

path Parameters
filterId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Download artifact

API to download artifacts.

downloadArtifact_1

path Parameters
softwareModuleId
required
integer <int64>
artifactId
required
integer <int64>

Responses

Distribution Set Tags

REST Resource handling for DistributionSetTag CRUD operations.

Return single Distribution Set Tag

Handles the GET request of retrieving a single distribution set tag.

path Parameters
distributionsetTagId
required
integer <int64>

Responses

Response samples

Content type
{}

Update Distribution Set Tag

Handles the PUT request of updating a distribution set tag.

path Parameters
distributionsetTagId
required
integer <int64>
Request Body schema:
required
name
string

The name of the entity

description
string

The description of the entity

colour
string

The colour of the entity

Responses

Request samples

Content type
{
  • "name": "Example name",
  • "description": "Example description",
  • "colour": "rgb(0,255,0)"
}

Response samples

Content type
{}

Delete a single distribution set tag

Handles the DELETE request of deleting a single distribution set tag.

path Parameters
distributionsetTagId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return all assigned distribution sets by given tag Id

Handles the GET request of retrieving a list of assigned distributions.

path Parameters
distributionsetTagId
required
integer <int64>
query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{
  • "content": [
    ],
  • "total": 0,
  • "size": 0,
  • "_links": {
    }
}

Assign distribution sets to the given tag id

Handles the POST request of distribution assignment. Already assigned distribution will be ignored.

path Parameters
distributionsetTagId
required
integer <int64>
Request Body schema:
required
Array
integer <int64>

Responses

Request samples

Content type
[
  • 0
]

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

[DEPRECATED] Assign distribution sets to the given tag id

Handles the POST request of distribution assignment. Already assigned distribution will be ignored.

path Parameters
distributionsetTagId
required
integer <int64>
Request Body schema:
required
Array
id
required
integer <int64>

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[
  • {
    }
]

Unassign multiple distribution sets from the given tag id

Handles the DELETE request of unassign the given distribution.

path Parameters
distributionsetTagId
required
integer <int64>
Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return all Distribution Set Tags

Handles the GET request of retrieving all distribution set tags.

query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{
  • "content": [],
  • "total": 0,
  • "size": 0,
  • "_links": {
    }
}

Creates new Distribution Set Tags

Handles the POST request of creating new distribution set tag. The request body must always be a list of distribution set tags.

Request Body schema:
required
Array
name
string

The name of the entity

description
string

The description of the entity

colour
string

The colour of the entity

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[]

Assign distribution set to the given tag id

Handles the POST request of distribution assignment. Already assigned distribution will be ignored.

path Parameters
distributionsetTagId
required
integer <int64>
distributionsetId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Unassign one distribution set from the given tag id

Handles the DELETE request of unassign the given distribution.

path Parameters
distributionsetTagId
required
integer <int64>
distributionsetId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

[DEPRECATED] Toggle the assignment of distribution sets by the given tag id

Handles the POST request of toggle distribution assignment. The request body must always be a list of distribution set ids.

path Parameters
distributionsetTagId
required
integer <int64>
Request Body schema: application/json
required
Array
id
required
integer <int64>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Distribution Set Types

REST Resource handling for DistributionSetType CRUD operations.

Return single Distribution Set Type

Handles the GET request of retrieving a single distribution set type. Required Permission: READ_REPOSITORY

path Parameters
distributionSetTypeId
required
integer <int64>

Responses

Response samples

Content type
{}

Update Distribution Set Type

Handles the PUT request for a single distribution set type. Required Permission: UPDATE_REPOSITORY

path Parameters
distributionSetTypeId
required
integer <int64>
Request Body schema:
required
description
string

The description of the entity

colour
string

The colour of the entity

Responses

Request samples

Content type
{
  • "description": "Example description",
  • "colour": "rgb(86,37,99)"
}

Response samples

Content type
{}

Delete Distribution Set Type by Id

Handles the DELETE request for a single distribution set type. Required Permission: DELETE_REPOSITORY

path Parameters
distributionSetTypeId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return all Distribution Set Types

Handles the GET request of retrieving all distribution set types. Required Permission: READ_REPOSITORY

query Parameters
offset
string

The paging offset (default is 0)

limit
string

The maximum number of entries in a page (default is 50)

sort
string

The query parameter sort allows to define the sort order for the result of a query. A sort criteria consists of the name of a field and the sort direction (ASC for ascending and DESC descending). The sequence of the sort criteria (multiple can be used) defines the sort order of the entities in the result.

q
string

Query fields based on the Feed Item Query Language (FIQL). See Entity Definitions for available fields.

Responses

Response samples

Content type
{}

Create new distribution set types

Handles the POST request for creating new distribution set types. The request body must always be a list of types. Required Permission: CREATE_REPOSITORY

Request Body schema:
required
Array
description
string

The description of the entity

colour
string

The colour of the entity

name
required
string

The name of the entity

key
required
string

Functional key of the distribution set type

Array of objects (MgmtSoftwareModuleTypeAssigment)

Mandatory module type IDs

Array of objects (MgmtSoftwareModuleTypeAssigment)

Optional module type IDs

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
[]

Return optional Software Module Types in a Distribution Set Type

Handles the GET request of retrieving the list of optional software module types in that distribution set type. Required Permission: READ_REPOSITORY

path Parameters
distributionSetTypeId
required
integer <int64>

Responses

Response samples

Content type
[
  • {
    }
]

Add optional Software Module Type to a Distribution Set Type

Handles the POST request for adding an optional software module type to a distribution set type.Note that a DS type cannot be changed after it has been used by a DS. Required Permission: UPDATE_REPOSITORY and READ_REPOSITORY

path Parameters
distributionSetTypeId
required
integer <int64>
Request Body schema:
required
id
integer <int64>

Responses

Request samples

Content type
{
  • "id": 108
}

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return mandatory Software Module Types in a Distribution Set Type

Handles the GET request of retrieving the list of mandatory software module types in that distribution set type. Required Permission: READ_REPOSITORY

path Parameters
distributionSetTypeId
required
integer <int64>

Responses

Response samples

Content type
[
  • {
    }
]

Add mandatory Software Module Type to a Distribution Set Type

Handles the POST request for adding a mandatory software module type to a distribution set type.Note that a DS type cannot be changed after it has been used by a DS. Required Permission: UPDATE_REPOSITORY and READ_REPOSITORY

path Parameters
distributionSetTypeId
required
integer <int64>
Request Body schema:
required
id
integer <int64>

Responses

Request samples

Content type
{
  • "id": 108
}

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return single optional Software Module Type in a Distribution Set Type

Handles the GET request of retrieving the single optional software module type in that distribution set type. Required Permission: READ_REPOSITORY

path Parameters
distributionSetTypeId
required
integer <int64>
softwareModuleTypeId
required
integer <int64>

Responses

Response samples

Content type
{
  • "createdBy": "system",
  • "createdAt": 1682408579390,
  • "lastModifiedBy": "bumlux",
  • "lastModifiedAt": 1682408579394,
  • "name": "Application",
  • "description": "Updated description.",
  • "key": "application",
  • "maxAssignments": 2147483647,
  • "deleted": false,
  • "_links": {},
  • "id": 4
}

Delete an optional module from a Distribution Set Type

Handles DELETE request for removing an optional module from the distribution set type. Note that a DS type cannot be changed after it has been used by a DS. Required Permission: UPDATE_REPOSITORY and READ_REPOSITORY

path Parameters
distributionSetTypeId
required
integer <int64>
softwareModuleTypeId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

Return single mandatory Software Module Type in a Distribution Set Type

Handles the GET request of retrieving the single mandatory software module type in that distribution set type. Required Permission: READ_REPOSITORY

path Parameters
distributionSetTypeId
required
integer <int64>
softwareModuleTypeId
required
integer <int64>

Responses

Response samples

Content type
{
  • "createdBy": "system",
  • "createdAt": 1682408579390,
  • "lastModifiedBy": "bumlux",
  • "lastModifiedAt": 1682408579394,
  • "name": "Application",
  • "description": "Updated description.",
  • "key": "application",
  • "maxAssignments": 2147483647,
  • "deleted": false,
  • "_links": {},
  • "id": 4
}

Delete a mandatory module from a Distribution Set Type

Handles the DELETE request for removing a software module type from a single distribution set type. Required Permission: DELETE_REPOSITORY

path Parameters
distributionSetTypeId
required
integer <int64>
softwareModuleTypeId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}

System Configuration

REST API for handling tenant specific configuration operations.

Return all tenant specific configuration values

The GET request returns a list of all possible configuration keys for the tenant. Required Permission: READ_TENANT_CONFIGURATION

Responses

Response samples

Content type
{}

Batch update of tenant configuration.

The PUT request updates the whole configuration for the tenant. Required Permission: TENANT_CONFIGURATION

Request Body schema:
required
property name*
additional property
object

Responses

Request samples

Content type
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
[]

Return a tenant specific configuration value

The GET request returns the configuration value of a specific configuration key for the tenant. Required Permission: READ_TENANT_CONFIGURATION

path Parameters
keyName
required
string

Responses

Response samples

Content type
{}

Update a tenant specific configuration value.

The PUT request changes a configuration value of a specific configuration key for the tenant. Required Permission: TENANT_CONFIGURATION

path Parameters
keyName
required
string
Request Body schema:
required
value
required
object

Current value of of configuration parameter

Responses

Request samples

Content type
{
  • "value": "exampleToken"
}

Response samples

Content type
{}

Delete a tenant specific configuration value

The DELETE request removes a tenant specific configuration value for the tenant. Afterwards the global default value is used. Required Permission: TENANT_CONFIGURATION

path Parameters
keyName
required
string

Responses

Response samples

Content type
application/json
{
  • "exceptionClass": "string",
  • "errorCode": "string",
  • "message": "string",
  • "info": {
    }
}