Device groups

The azion/applications functions that create, list, read, update, and delete the device groups of an application.

Last updated

View as Markdown Agent setup

A device group matches devices by a regular expression that the platform compares with the User-Agent request header. These azion/applications functions create, list, read, update, and delete the device groups of an application.

createDeviceGroup

Creates a device group in an application. A device group matches devices by a regular expression that the platform compares with the User-Agent request header.

TypeScript
01function createDeviceGroup(params: {
02 applicationId: number;
03 data: ApiCreateDeviceGroupPayload;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<AzionDeviceGroup>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
data{ name: string; user_agent: string }Yesname names the group, and user_agent holds the regular expression, such as Mobile|Android|iPhone.
optionsAzionClientOptionsNoRequest options.

Returns data as the created AzionDeviceGroup. The API refuses a name that contains a space or a hyphen. The function then returns error with the message HTTP error! Status: 400 - BAD REQUEST.

TypeScript
01import { createDeviceGroup } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04
05// Create a new device group
06const deviceGroupData = {
07 name: 'MobileDevices',
08 user_agent: 'Mobile|Android|iPhone',
09};
10
11const { data: newDeviceGroup, error } = await createDeviceGroup({ applicationId, data: deviceGroupData });
12
13if (error) {
14 console.error('Error creating device group:', error);
15} else {
16 console.log('Device group created successfully:', newDeviceGroup);
17}

Output:

Text
01Device group created successfully: {
02 id: 1234,
03 name: 'MobileDevices',
04 user_agent: 'Mobile|Android|iPhone'
05}

getDeviceGroups

Lists the device groups of an application, one page at a time.

TypeScript
01function getDeviceGroups(params: {
02 applicationId: number;
03 params?: ApiListDeviceGroupsParams;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationCollectionResponse<AzionDeviceGroup>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
paramsApiListDeviceGroupsParamsNoPagination: page and page_size.
optionsAzionClientOptionsNoRequest options.

Returns an AzionApplicationCollectionResponse whose data.results holds AzionDeviceGroup objects.

TypeScript
01import { getDeviceGroups } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04
05const { data: deviceGroups, error } = await getDeviceGroups({ applicationId, params: { page: 1, page_size: 20 } });
06
07if (error) {
08 console.error('Error listing device groups:', error);
09} else {
10 console.log(`Found ${deviceGroups?.count} device groups:`, deviceGroups?.results);
11}

Output:

Text
01Found 1 device groups: [
02 {
03 id: 1234,
04 name: 'MobileDevices',
05 user_agent: 'Mobile|Android|iPhone'
06 }
07]

getDeviceGroup

Returns one device group of an application by its ID.

TypeScript
01function getDeviceGroup(params: {
02 applicationId: number;
03 deviceGroupId: number;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<AzionDeviceGroup>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
deviceGroupIdnumberYesThe ID of the device group.
optionsAzionClientOptionsNoRequest options.

Returns data as an AzionDeviceGroup.

TypeScript
01import { getDeviceGroup } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const deviceGroupId = 1234; // Replace with the actual device group ID
05
06const { data: deviceGroup, error } = await getDeviceGroup({ applicationId, deviceGroupId });
07
08if (error) {
09 console.error('Error retrieving device group:', error);
10} else {
11 console.log('Device group details:', deviceGroup);
12}

Output:

Text
01Device group details: {
02 id: 1234,
03 name: 'MobileDevices',
04 user_agent: 'Mobile|Android|iPhone'
05}

updateDeviceGroup

Sends the device group fields you pass in a PATCH request. The new name follows the same rule as on create: no spaces and no hyphens.

TypeScript
01function updateDeviceGroup(params: {
02 applicationId: number;
03 deviceGroupId: number;
04 data: ApiUpdateDeviceGroupPayload;
05 options?: AzionClientOptions;
06}): Promise<AzionApplicationResponse<AzionDeviceGroup>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
deviceGroupIdnumberYesThe ID of the device group to update.
data{ name?: string; user_agent?: string }YesThe fields to change.
optionsAzionClientOptionsNoRequest options.

Returns data as the updated AzionDeviceGroup.

TypeScript
01import { updateDeviceGroup } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const deviceGroupId = 1234; // Replace with the actual device group ID
05
06const { data: updatedDeviceGroup, error } = await updateDeviceGroup({
07 applicationId,
08 deviceGroupId,
09 data: { name: 'MobileAndTablets', user_agent: 'Mobile|Android|iPhone|iPad' },
10});
11
12if (error) {
13 console.error('Error updating device group:', error);
14} else {
15 console.log('Device group updated:', updatedDeviceGroup);
16}

Output:

Text
01Device group updated: {
02 id: 1234,
03 name: 'MobileAndTablets',
04 user_agent: 'Mobile|Android|iPhone|iPad'
05}

deleteDeviceGroup

Deletes a device group of an application by its ID.

TypeScript
01function deleteDeviceGroup(params: {
02 applicationId: number;
03 deviceGroupId: number;
04 options?: AzionClientOptions;
05}): Promise<AzionApplicationResponse<void>>;
ParameterTypeRequiredDescription
applicationIdnumberYesThe ID of the application.
deviceGroupIdnumberYesThe ID of the device group to delete.
optionsAzionClientOptionsNoRequest options.

A successful delete returns error with the message Expected JSON response, but got: , so the sample reads the device group back with getDeviceGroup. A 404 error confirms the delete.

TypeScript
01import { deleteDeviceGroup, getDeviceGroup } from 'azion/applications';
02
03const applicationId = 1234567890; // Replace with the actual application ID
04const deviceGroupId = 1234; // Replace with the actual device group ID
05
06const { error: deleteError } = await deleteDeviceGroup({ applicationId, deviceGroupId });
07
08// On success (HTTP 204) the envelope still carries an error, so confirm by reading it back
09const { error } = await getDeviceGroup({ applicationId, deviceGroupId });
10if (error) {
11 console.log(`Device group ${deviceGroupId} deleted (read back: ${error.message})`);
12} else {
13 console.error('Error deleting device group:', deleteError);
14}

Output:

Device group 1234 deleted (read back: HTTP error! Status: 404 - NOT FOUND)
Azion Lib

The Azion Lib modules and the npm package each one ships in.

Applications

The module’s authentication, its response envelope, and the errors its functions report.

Application types

The payload and response types these functions take and return.

Device groups

The device group an application matches by User-Agent.