GET /service/api/console/gsm/{gsmKey}

Gets information about a given GSM console.

Request Information

URI Parameters

Name	Description	Type	Additional Information
gsmKey	The GSM console keycode.	string	Required

URI Sample(s)


GET	https://unityapi.webrootcloudav.com/service/api/console/gsm/9639-69AE-CE10-4831-96B7

Body Parameters

None.

Response Information

Resource Description

Information about a given GSM console.

GetGSMDetailsResponseModel

Name	Description	Type	Additional Information
GSMConsoleName	The name of the GSM console.	string	None.
CreatedDate	The date when the GSM key has been created.	date	None.
EndDate	The date when the GSM key expires.	date	None.
RemainingDays	The number of days until the GSM key expires.	integer	None.
LicenseType	The license type of the GSM key: Full or Trial.	string	None.
TotalSeatsAllowed	The total number of Parent Keycode Site Seats/devices purchased.	integer	None.
TotalSites	The total number of sites.	integer	None.
DeactivatedSites	The number of deactivated sites.	integer	None.
CompanyEmail	The company's email address.	string	None.
CompanyPhone	The company's phone number.	string	None.
CompanyAddress	The company's address.	string	None.
Modules	The list of modules associated with the GSM key.	Collection of GetGSMDetailsResponseModel_Module	None.

Sample Response

{
  "GSMConsoleName": "GSM Test Console",
  "CreatedDate": "2025-05-28T08:26:47.0053171Z",
  "EndDate": "2026-10-28T08:26:47.0053171Z",
  "RemainingDays": 153,
  "LicenseType": "Full",
  "TotalSeatsAllowed": 800,
  "TotalSites": 500,
  "DeactivatedSites": 14,
  "CompanyEmail": "test1@webroot.com",
  "CompanyPhone": "07486415",
  "CompanyAddress": "",
  "Modules": [
    {
      "Type": "DNSP",
      "Seats": 800,
      "LicenseType": "Full",
      "EndDate": "2026-10-28T08:26:47.0053171Z"
    },
    {
      "Type": "WSAT",
      "Seats": 800,
      "LicenseType": "Full",
      "EndDate": "2026-10-28T08:26:47.0053171Z"
    },
    {
      "Type": "OTEDR",
      "Seats": 800,
      "LicenseType": "Full",
      "EndDate": "2026-10-28T08:26:47.0053171Z"
    },
    {
      "Type": "SAEP",
      "Seats": 800,
      "LicenseType": "Full",
      "EndDate": "2026-10-28T08:26:47.0053171Z"
    },
    {
      "Type": "PLRCS",
      "Seats": 800,
      "LicenseType": "Full",
      "EndDate": "2026-10-28T08:26:47.0053171Z"
    },
    {
      "Type": "PLRCB",
      "Seats": 800,
      "LicenseType": "Full",
      "EndDate": "2026-10-28T08:26:47.0053171Z"
    },
    {
      "Type": "PLRM",
      "Seats": 800,
      "LicenseType": "Full",
      "EndDate": "2026-10-28T08:26:47.0053171Z"
    }
  ]
}

<GetGSMDetailsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <CompanyAddress></CompanyAddress>
  <CompanyEmail>test1@webroot.com</CompanyEmail>
  <CompanyPhone>07486415</CompanyPhone>
  <CreatedDate>2025-05-28T08:26:47.0053171Z</CreatedDate>
  <DeactivatedSites>14</DeactivatedSites>
  <EndDate>2026-10-28T08:26:47.0053171Z</EndDate>
  <GSMConsoleName>GSM Test Console</GSMConsoleName>
  <LicenseType>Full</LicenseType>
  <Modules>
    <GetGSMDetailsResponseModel_Module>
      <EndDate>2026-10-28T08:26:47.0053171Z</EndDate>
      <LicenseType>Full</LicenseType>
      <Seats>800</Seats>
      <Type>DNSP</Type>
    </GetGSMDetailsResponseModel_Module>
    <GetGSMDetailsResponseModel_Module>
      <EndDate>2026-10-28T08:26:47.0053171Z</EndDate>
      <LicenseType>Full</LicenseType>
      <Seats>800</Seats>
      <Type>WSAT</Type>
    </GetGSMDetailsResponseModel_Module>
    <GetGSMDetailsResponseModel_Module>
      <EndDate>2026-10-28T08:26:47.0053171Z</EndDate>
      <LicenseType>Full</LicenseType>
      <Seats>800</Seats>
      <Type>OTEDR</Type>
    </GetGSMDetailsResponseModel_Module>
    <GetGSMDetailsResponseModel_Module>
      <EndDate>2026-10-28T08:26:47.0053171Z</EndDate>
      <LicenseType>Full</LicenseType>
      <Seats>800</Seats>
      <Type>SAEP</Type>
    </GetGSMDetailsResponseModel_Module>
    <GetGSMDetailsResponseModel_Module>
      <EndDate>2026-10-28T08:26:47.0053171Z</EndDate>
      <LicenseType>Full</LicenseType>
      <Seats>800</Seats>
      <Type>PLRCS</Type>
    </GetGSMDetailsResponseModel_Module>
    <GetGSMDetailsResponseModel_Module>
      <EndDate>2026-10-28T08:26:47.0053171Z</EndDate>
      <LicenseType>Full</LicenseType>
      <Seats>800</Seats>
      <Type>PLRCB</Type>
    </GetGSMDetailsResponseModel_Module>
    <GetGSMDetailsResponseModel_Module>
      <EndDate>2026-10-28T08:26:47.0053171Z</EndDate>
      <LicenseType>Full</LicenseType>
      <Seats>800</Seats>
      <Type>PLRM</Type>
    </GetGSMDetailsResponseModel_Module>
  </Modules>
  <RemainingDays>153</RemainingDays>
  <TotalSeatsAllowed>800</TotalSeatsAllowed>
  <TotalSites>500</TotalSites>
</GetGSMDetailsResponseModel>