Profiles
Actions in the profiles namespace of the Nexigon Hub API.
Badges mark actions of the Device API and the Admin API, whose compatibility differs from other actions.
profiles_Query
POST/api/v1/actions/invoke/profiles_Query
- Unstable (feature
device_profiles)
List the device profiles of a project.
Request QueryDeviceProfilesAction
projectIdstringProjectId
Response QueryDeviceProfilesOutput
profilesarray<object>DeviceProfileSummary6 fields
profileIdstringDeviceProfileIdprojectIdstringProjectIddisplayNamestringDisplay name, which does not have to be unique.
descriptionstringoptionalrevisionintegerLatest revision. Devices always use the latest revision.
deviceCountintegerNumber of devices the profile is assigned to.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{"projectId":"<project-id>"}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/profiles_Query{
"profiles": [
{
"profileId": "<device-profile-id>",
"projectId": "<project-id>",
"displayName": "<display-name>",
"revision": 1,
"deviceCount": 1
}
]
}profiles_Get
POST/api/v1/actions/invoke/profiles_Get
- Unstable (feature
device_profiles)
Get a device profile with the property values of its latest revision.
Request GetDeviceProfileAction
projectIdstringProjectIdprofileIdstringDeviceProfileId
Response GetDeviceProfileOutput
One of the following, identified by result:
result: "NotFound"The profile does not exist in the project.
result: "Found"The profile was found.
profileIdstringDeviceProfileIdprojectIdstringProjectIddisplayNamestringDisplay name, which does not have to be unique.
descriptionstringoptionalrevisionintegerLatest revision. Devices always use the latest revision.
propertiesmap<string, object>DeviceProfilePropertyProperty values of the latest revision.
2 fields
valueanyJsonValueValue of the property.
Nexigon Hub rejects values larger than the instance's limit, 64 KiB by default.
protectedbooleanIndicates whether devices are prevented from changing the property.
deviceCountintegerNumber of devices the profile is assigned to.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"profileId": "<device-profile-id>"
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/profiles_Get{
"result": "Found",
"profileId": "<device-profile-id>",
"projectId": "<project-id>",
"displayName": "<display-name>",
"revision": 1,
"properties": {
"<key>": {
"value": {},
"protected": true
}
},
"deviceCount": 1
}profiles_Create
POST/api/v1/actions/invoke/profiles_Create
- Unstable (feature
device_profiles)
Create a device profile with its first revision.
Request CreateDeviceProfileAction
projectIdstringProjectIddisplayNamestring- Profile name must be between 1 and 128 characters.
descriptionstringoptional- Profile description must be at most 4096 characters.
propertiesmap<string, object>DeviceProfilePropertyProperty values of the first revision.
2 fields
valueanyJsonValueValue of the property.
Nexigon Hub rejects values larger than the instance's limit, 64 KiB by default.
protectedbooleanIndicates whether devices are prevented from changing the property.
Response DeviceProfile
profileIdstringDeviceProfileIdprojectIdstringProjectIddisplayNamestringDisplay name, which does not have to be unique.
descriptionstringoptionalrevisionintegerLatest revision. Devices always use the latest revision.
propertiesmap<string, object>DeviceProfilePropertyProperty values of the latest revision.
2 fields
valueanyJsonValueValue of the property.
Nexigon Hub rejects values larger than the instance's limit, 64 KiB by default.
protectedbooleanIndicates whether devices are prevented from changing the property.
deviceCountintegerNumber of devices the profile is assigned to.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"displayName": "<display-name>",
"properties": {
"<key>": {
"value": {},
"protected": true
}
}
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/profiles_Create{
"profileId": "<device-profile-id>",
"projectId": "<project-id>",
"displayName": "<display-name>",
"revision": 1,
"properties": {
"<key>": {
"value": {},
"protected": true
}
},
"deviceCount": 1
}profiles_Update
POST/api/v1/actions/invoke/profiles_Update
- Unstable (feature
device_profiles)
Replace the display name and description of a device profile.
Does not create a revision and does not change any device property.
Request UpdateDeviceProfileAction
projectIdstringProjectIdprofileIdstringDeviceProfileIddisplayNamestring- Profile name must be between 1 and 128 characters.
descriptionstringoptional- Profile description must be at most 4096 characters.
Response Empty
No fields. The response is an empty JSON object.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"profileId": "<device-profile-id>",
"displayName": "<display-name>"
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/profiles_Update{}profiles_Delete
POST/api/v1/actions/invoke/profiles_Delete
- Unstable (feature
device_profiles)
Delete a device profile and remove it from every device.
Request DeleteDeviceProfileAction
projectIdstringProjectIdprofileIdstringDeviceProfileId
Response Empty
No fields. The response is an empty JSON object.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"profileId": "<device-profile-id>"
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/profiles_Delete{}profiles_SaveRevision
POST/api/v1/actions/invoke/profiles_SaveRevision
- Unstable (feature
device_profiles)
Save new property values of a device profile as its next revision.
Every device that has the profile in Latest mode applies the new values
right away.
Request SaveDeviceProfileRevisionAction
projectIdstringProjectIdprofileIdstringDeviceProfileIdexpectedRevisionintegerRevision the new values are based on. The save fails with
RevisionConflictif this is not the latest revision.propertiesmap<string, object>DeviceProfilePropertyProperty values of the new revision.
2 fields
valueanyJsonValueValue of the property.
Nexigon Hub rejects values larger than the instance's limit, 64 KiB by default.
protectedbooleanIndicates whether devices are prevented from changing the property.
Response SaveDeviceProfileRevisionOutput
One of the following, identified by result:
result: "Saved"The revision was saved.
revisioninteger
result: "RevisionConflict"The revision was not saved because another revision was saved in the meantime.
currentRevisionintegerThe latest revision of the profile.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"profileId": "<device-profile-id>",
"expectedRevision": 1,
"properties": {
"<key>": {
"value": {},
"protected": true
}
}
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/profiles_SaveRevision{
"result": "Saved",
"revision": 1
}profiles_AssignDevices
POST/api/v1/actions/invoke/profiles_AssignDevices
- Unstable (feature
device_profiles)
Assign a device profile to the devices of its project that match group conditions.
Applies once to the devices that match now; devices that match later do not receive the profile. The profile applies after a device's other profiles, and devices that already have it keep its position but take the given mode. Devices that already have the maximum number of profiles are skipped. Requires permission to change the profiles of every matching device.
Request AssignDeviceProfileDevicesAction
projectIdstringProjectIdprofileIdstringDeviceProfileIdgroupsobjectDeviceGroupSelectoroptionalGroup conditions that devices must satisfy. Without conditions, every device of the project matches.
3 fields
allarray<string>DeviceGroupIdoptionalEvery listed group must be present. Empty or absent imposes no condition.
anyarray<string>DeviceGroupIdoptionalAt least one listed group must be present. Empty matches no devices; absence imposes no condition.
nonearray<string>DeviceGroupIdoptionalEvery listed group must be absent. Empty or absent imposes no condition.
modeobjectDeviceProfileModeoptionalMode of the profile on the devices. Defaults to
Latest.3 variants
One of the following, identified by
mode:mode: "Latest"Use every revision as soon as it is saved.
mode: "Pinned"Use one specific revision.
revisioninteger
mode: "Rollout"Use the revision of the profile's rollout once the rollout reaches the device. The device then applies the revision, even if it already uses it.
A device that switches to this mode keeps its current revision until then. A device that gets the profile in this mode has no revision until then, so that the profile sets no values on it.
Response AssignDeviceProfileDevicesOutput
assignedintegerNumber of devices that got the profile or, if they already had it, the mode.
unchangedintegerNumber of matching devices that already had the profile in the mode.
skippedintegerNumber of matching devices skipped because they already have the maximum number of profiles.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"profileId": "<device-profile-id>"
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/profiles_AssignDevices{
"assigned": 1,
"unchanged": 1,
"skipped": 1
}profiles_UnassignDevices
POST/api/v1/actions/invoke/profiles_UnassignDevices
- Unstable (feature
device_profiles)
Remove a device profile from the devices of its project that match group conditions.
Requires permission to change the profiles of every matching device that has the profile.
Request UnassignDeviceProfileDevicesAction
projectIdstringProjectIdprofileIdstringDeviceProfileIdgroupsobjectDeviceGroupSelectoroptionalGroup conditions that devices must satisfy. Without conditions, every device of the project matches.
3 fields
allarray<string>DeviceGroupIdoptionalEvery listed group must be present. Empty or absent imposes no condition.
anyarray<string>DeviceGroupIdoptionalAt least one listed group must be present. Empty matches no devices; absence imposes no condition.
nonearray<string>DeviceGroupIdoptionalEvery listed group must be absent. Empty or absent imposes no condition.
Response UnassignDeviceProfileDevicesOutput
removedintegerNumber of devices the profile was removed from.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"profileId": "<device-profile-id>"
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/profiles_UnassignDevices{
"removed": 1
}profiles_QueryRevisions
POST/api/v1/actions/invoke/profiles_QueryRevisions
- Unstable (feature
device_profiles)
List the revisions of a device profile, newest first.
Request QueryDeviceProfileRevisionsAction
projectIdstringProjectIdprofileIdstringDeviceProfileIdpageobjectPageRequestoptionalPage to return. Without this field, the first page is returned.
2 fields
limitintegeroptionalMaximum number of items. The default depends on the endpoint and the ceiling is configured by the Hub operator (1000 by default).
- Page limit must be positive.
cursorstringPageCursoroptionalContinue the same endpoint, scope, filters, and ordering.
Response QueryDeviceProfileRevisionsOutput
revisionsarray<object>DeviceProfileRevisionRevisions on this page, newest first.
3 fields
revisionintegercreatedAtstring (date-time)TimestampTime when the revision was saved.
propertiesmap<string, object>DeviceProfilePropertyProperty values of the revision.
2 fields
valueanyJsonValueValue of the property.
Nexigon Hub rejects values larger than the instance's limit, 64 KiB by default.
protectedbooleanIndicates whether devices are prevented from changing the property.
pageobjectPageInfoContinuation of the traversal.
1 field
nextCursorstringPageCursoroptionalCursor for the next page; absent when no more matching rows were visible.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"profileId": "<device-profile-id>"
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/profiles_QueryRevisions{
"revisions": [
{
"revision": 1,
"createdAt": "2026-01-01T12:00:00Z",
"properties": {
"<key>": {
"value": {},
"protected": true
}
}
}
],
"page": {}
}profiles_StartRollout
POST/api/v1/actions/invoke/profiles_StartRollout
- Unstable (feature
device_profiles)
Start a rollout of a profile revision to the profile's devices in rollout mode, replacing the profile's current rollout.
Releases the first stage right away. The new rollout runs even if the rollout it replaces was halted. Every device of the rollout applies the revision once the rollout reaches it, even if the device already uses the revision.
Request StartDeviceProfileRolloutAction
projectIdstringProjectIdprofileIdstringDeviceProfileIdrevisionintegerRevision to roll out.
stagesarray<object>RolloutStageStages in the order of their release.
- A rollout must have between 1 and 20 stages.
5 fields
namestring- Stage name must be between 1 and 128 characters.
groupsobjectDeviceGroupSelectoroptionalGroup conditions that the stage's devices satisfy. Without conditions, every device satisfies them.
3 fields
allarray<string>DeviceGroupIdoptionalEvery listed group must be present. Empty or absent imposes no condition.
anyarray<string>DeviceGroupIdoptionalAt least one listed group must be present. Empty matches no devices; absence imposes no condition.
nonearray<string>DeviceGroupIdoptionalEvery listed group must be absent. Empty or absent imposes no condition.
percentagenumberoptionalShare of the devices that satisfy the conditions, by their position in the rollout, in percent. May have a fraction, such as 0.5. Defaults to 100.
A device belongs to the first stage whose conditions it satisfies and whose percentage is above its position.
- Stage percentage must be greater than 0 and at most 100.
spreadSecsintegeroptionalTime over which the stage's devices become active, in seconds. Defaults to 0.
- Spread must be at most 30 days.
guardobjectRolloutGuardoptionalConditions for releasing the stage. The first stage is released when the rollout starts and ignores its guard.
3 fields
minCompletedPercentnumberoptionalMinimal share of the devices in earlier stages that completed, in percent. Defaults to 100.
- Completed share must be between 0 and 100.
maxFailedPercentnumberoptionalMaximal share of the devices in earlier stages that failed, in percent. Defaults to 0.
- Failed share must be between 0 and 100.
soakSecsintegeroptionalMinimal time since the previous stage's spread finished, in seconds. Defaults to 0.
- Soak time must be at most 30 days.
completionExpressionstringoptionalExpression that decides whether an active device completed. Without it, devices complete as soon as they become active.
- Expressions must be at most 4096 characters.
failureExpressionstringoptionalExpression that decides whether an active device failed. Without it, devices never fail. Requires a completion expression.
- Expressions must be at most 4096 characters.
Response StartDeviceProfileRolloutOutput
numberintegerNumber of the started rollout.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"profileId": "<device-profile-id>",
"revision": 1,
"stages": [
{
"name": "<name>"
}
]
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/profiles_StartRollout{
"number": 1
}profiles_GetRollout
POST/api/v1/actions/invoke/profiles_GetRollout
- Unstable (feature
device_profiles)
Get the rollout of a profile.
Request GetDeviceProfileRolloutAction
projectIdstringProjectIdprofileIdstringDeviceProfileId
Response GetDeviceProfileRolloutOutput
One of the following, identified by result:
result: "NotFound"The profile does not exist in the project or has no rollout.
result: "Found"The profile's rollout.
numberintegerNumber of the rollout. Each rollout of a profile has a higher number than the one it replaced.
revisionintegerRevision that the rollout applies.
stagesarray<object>DeviceProfileRolloutStageStateStages in the order of their release.
4 fields
definitionobjectRolloutStage5 fields
namestring- Stage name must be between 1 and 128 characters.
groupsobjectDeviceGroupSelectoroptionalGroup conditions that the stage's devices satisfy. Without conditions, every device satisfies them.
3 fields
allarray<string>DeviceGroupIdoptionalEvery listed group must be present. Empty or absent imposes no condition.
anyarray<string>DeviceGroupIdoptionalAt least one listed group must be present. Empty matches no devices; absence imposes no condition.
nonearray<string>DeviceGroupIdoptionalEvery listed group must be absent. Empty or absent imposes no condition.
percentagenumberoptionalShare of the devices that satisfy the conditions, by their position in the rollout, in percent. May have a fraction, such as 0.5. Defaults to 100.
A device belongs to the first stage whose conditions it satisfies and whose percentage is above its position.
- Stage percentage must be greater than 0 and at most 100.
spreadSecsintegeroptionalTime over which the stage's devices become active, in seconds. Defaults to 0.
- Spread must be at most 30 days.
guardobjectRolloutGuardoptionalConditions for releasing the stage. The first stage is released when the rollout starts and ignores its guard.
3 fields
minCompletedPercentnumberoptionalMinimal share of the devices in earlier stages that completed, in percent. Defaults to 100.
- Completed share must be between 0 and 100.
maxFailedPercentnumberoptionalMaximal share of the devices in earlier stages that failed, in percent. Defaults to 0.
- Failed share must be between 0 and 100.
soakSecsintegeroptionalMinimal time since the previous stage's spread finished, in seconds. Defaults to 0.
- Soak time must be at most 30 days.
releasedAtstring (date-time)TimestampoptionalTime when the stage was released. Absent until then.
devicesobjectDeviceProfileRolloutDeviceCountsNumbers of the stage's devices by status.
4 fields
pendingintegeractiveintegercompletedintegerfailedinteger
guardobjectRolloutGuardStatusoptionalProgress of the stage's guard. Present for the next stage to release.
4 fields
completedPercentnumberShare of the devices in earlier stages that completed, in percent, rounded down to two decimal places.
failedPercentnumberShare of the devices in earlier stages that failed, in percent, rounded up to two decimal places.
remainingSecsintegerSeconds until the previous stage's spread and the soak time have passed, on the rollout's clock. Zero once they have.
passedbooleanWhether all conditions of the guard pass.
completionExpressionstringoptionalfailureExpressionstringoptionalstartedAtstring (date-time)TimestamphaltedAtstring (date-time)TimestampoptionalTime when the rollout was halted. Absent while it runs.
convergedbooleanWhether the last stage is released, its spread has finished, and every device of the rollout has completed or failed.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"profileId": "<device-profile-id>"
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/profiles_GetRollout{
"result": "Found",
"number": 1,
"revision": 1,
"stages": [
{
"definition": {
"name": "<name>"
},
"devices": {
"pending": 1,
"active": 1,
"completed": 1,
"failed": 1
}
}
],
"startedAt": "2026-01-01T12:00:00Z",
"converged": true
}profiles_QueryRolloutDevices
POST/api/v1/actions/invoke/profiles_QueryRolloutDevices
- Unstable (feature
device_profiles)
List the devices of a profile's rollout, by stage.
Request QueryDeviceProfileRolloutDevicesAction
projectIdstringProjectIdprofileIdstringDeviceProfileIdpageobjectPageRequestoptionalPage to return. Without this field, the first page is returned.
2 fields
limitintegeroptionalMaximum number of items. The default depends on the endpoint and the ceiling is configured by the Hub operator (1000 by default).
- Page limit must be positive.
cursorstringPageCursoroptionalContinue the same endpoint, scope, filters, and ordering.
Response QueryDeviceProfileRolloutDevicesOutput
devicesarray<object>DeviceProfileRolloutDeviceDevices on this page, by stage.
5 fields
deviceIdstringDeviceIdnamestringoptionalName of the device.
stageIndexintegerIndex of the device's stage.
statusstringDeviceProfileRolloutDeviceStatus"Pending"The rollout has not reached the device yet.
"Active"The rollout applied its revision, and the device's outcome is open.
"Completed"The device has taken the revision successfully.
"Failed"The device has failed to take the revision.
updatedAtstring (date-time)TimestampTime when the status last changed.
pageobjectPageInfoContinuation of the traversal.
1 field
nextCursorstringPageCursoroptionalCursor for the next page; absent when no more matching rows were visible.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"profileId": "<device-profile-id>"
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/profiles_QueryRolloutDevices{
"devices": [
{
"deviceId": "<device-id>",
"stageIndex": 1,
"status": "Pending",
"updatedAt": "2026-01-01T12:00:00Z"
}
],
"page": {}
}profiles_HaltRollout
POST/api/v1/actions/invoke/profiles_HaltRollout
- Unstable (feature
device_profiles)
Halt the rollout of a profile.
The rollout applies its revision to no further devices and releases no stages until it is resumed. Halting a halted rollout has no effect.
Request HaltDeviceProfileRolloutAction
projectIdstringProjectIdprofileIdstringDeviceProfileId
Response Empty
No fields. The response is an empty JSON object.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"profileId": "<device-profile-id>"
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/profiles_HaltRollout{}profiles_ResumeRollout
POST/api/v1/actions/invoke/profiles_ResumeRollout
- Unstable (feature
device_profiles)
Resume the halted rollout of a profile where it stopped.
Resuming a running rollout has no effect.
Request ResumeDeviceProfileRolloutAction
projectIdstringProjectIdprofileIdstringDeviceProfileId
Response Empty
No fields. The response is an empty JSON object.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"profileId": "<device-profile-id>"
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/profiles_ResumeRollout{}profiles_ReleaseRolloutStage
POST/api/v1/actions/invoke/profiles_ReleaseRolloutStage
- Unstable (feature
device_profiles)
Release the next stage of a running rollout, skipping its guard and the wait for the previous stage's spread.
Request ReleaseDeviceProfileRolloutStageAction
projectIdstringProjectIdprofileIdstringDeviceProfileIdstageIndexintegerIndex of the stage to release, which must be the next unreleased one.
Response Empty
No fields. The response is an empty JSON object.
Example
curl --fail-with-body \
-H "Authorization: Bearer $NEXIGON_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "<project-id>",
"profileId": "<device-profile-id>",
"stageIndex": 1
}' \
$NEXIGON_HUB_URL/api/v1/actions/invoke/profiles_ReleaseRolloutStage{}