Skip to main content
Documentation

Groups

Actions in the groups namespace of the Nexigon Hub API.

Badges mark actions of the Device API and the Admin API, whose compatibility differs from other actions.

groups_Query

POST/api/v1/actions/invoke/groups_Query

List a project's group catalog, including groups without assignments.

Request QueryDeviceGroupsAction

  • projectIdstringProjectId

Response QueryDeviceGroupsOutput

  • groupsarray<object>DeviceGroup
    5 fields
    • groupIdstringDeviceGroupId
    • projectIdstringProjectId
    • namestring

      Unique within the project, ignoring case and surrounding whitespace.

    • colorstringDeviceGroupColoroptional
      • Group color must be a six-digit hexadecimal color, such as #3b82f6.
    • descriptionstringoptional

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/groups_Query
{
  "groups": [
    {
      "groupId": "<device-group-id>",
      "projectId": "<project-id>",
      "name": "<name>"
    }
  ]
}

groups_Create

POST/api/v1/actions/invoke/groups_Create

Create a group. Case-insensitive name collisions are rejected.

Request CreateDeviceGroupAction

  • projectIdstringProjectId
  • namestring
    • Group name must be between 1 and 128 characters.
  • colorstringDeviceGroupColoroptional
    • Group color must be a six-digit hexadecimal color, such as #3b82f6.
  • descriptionstringoptional
    • Group description must be at most 4096 characters.

Response DeviceGroup

  • groupIdstringDeviceGroupId
  • projectIdstringProjectId
  • namestring

    Unique within the project, ignoring case and surrounding whitespace.

  • colorstringDeviceGroupColoroptional
    • Group color must be a six-digit hexadecimal color, such as #3b82f6.
  • descriptionstringoptional

Example

curl --fail-with-body \
  -H "Authorization: Bearer $NEXIGON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"projectId":"<project-id>","name":"<name>"}' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/groups_Create
{
  "groupId": "<device-group-id>",
  "projectId": "<project-id>",
  "name": "<name>"
}

groups_Update

POST/api/v1/actions/invoke/groups_Update

Replace group metadata while retaining its identity and assignments.

Request UpdateDeviceGroupAction

  • projectIdstringProjectId
  • groupIdstringDeviceGroupId
  • namestring
    • Group name must be between 1 and 128 characters.
  • colorstringDeviceGroupColoroptional
    • Group color must be a six-digit hexadecimal color, such as #3b82f6.
  • descriptionstringoptional
    • Group 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>",
    "groupId": "<device-group-id>",
    "name": "<name>"
  }' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/groups_Update
{}

groups_Delete

POST/api/v1/actions/invoke/groups_Delete

Delete a group and its assignments.

Existing operation selectors retain the group identity and continue evaluating membership. A deleted group is absent from every device.

Request DeleteDeviceGroupAction

  • projectIdstringProjectId
  • groupIdstringDeviceGroupId

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>","groupId":"<device-group-id>"}' \
  $NEXIGON_HUB_URL/api/v1/actions/invoke/groups_Delete
{}