Read deployment group

Fetches a deployment group by its unique name.

get/v1/default/deployment-groups/{group-id}

Request

Base URL
https://api.bymason.com
Auth
API key in header Authorization

Path parameters

group-idstring uuid required

Group id

Response

Read group response

idstring uuid required

unique ID for the group

namestring required

Group name

createdAtstring date-time required

Date group was created

updatedAtstring date-time required

Date group was last updated

descriptionstring

Description of the group

deviceFamily'D03' | 'F07' | 'D450' | 'D450A' | 'D450A1' | 'D450B' | 'C210' | 'F210' | 'F450' | 'G430' | 'G450' | 'I3399A' | 'A4100' | 'D215'

apiLevel23 | 25 | 27 | 30

deviceCountinteger required

Number of devices currently in the group

devicesUpToDateCountinteger

Of the devices in the group, indicates how many are running all the desired deployment versions

Example response

{
  "deviceCount": 100,
  "devicesUpToDateCount": 86,
  "apps": [
    {
      "createdAt": "2023-12-07T20:34:55.339Z",
      "name": "com.company.app",
      "version": "15"
    }
  ],
  "config": {
    "createdAt": "2023-12-07T20:34:55.339Z",
    "name": "customer123",
    "version": "2"
  },
  "os": {
    "createdAt": "2023-12-07T20:34:55.339Z",
    "name": "mason-os",
    "version": "6.2.2"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.