LogMeIn Central Developer Center

Welcome to the Central Developer Center

The Central API lets you streamline your IT inventory interface and transactions to improve your internal customer service. The following pages provides the basic structure of the API calls and demonstrates how to authenticate and make successful Central API calls

For more information about the functionality that the API methods invoke, visit the Central support site.

Note: Due to security restrictions, APIs can only be called once every minute.

Note: Due to the nature of API integration and the fact that it is almost always custom in nature, LogMeIn Support cannot provide assistance in writing or debugging customer code. If you are new to API programming, there are tutorials available on the internet that help you understand and reproduce the examples given on this website. To find out more about API programming, visit https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Client-side_web_APIs/Introduction.

Prerequisites

A LogMeIn Central subscription (paid or trial)

Authentication

You must authenticate each API action you call with your CompanyID + PSK pair in a header.

Important: A LogMeIn Central Account holder must obtain their PSK and CompanyID from the Configuration > API tab.

Checking your Credentials

Check if your credentials are valid by using the following command with your Company ID and PSK:

GET https://secure.logmein.com/public-api/v1/authentication

Headers

The Headers use Basic Authorization with the following format:

Authorization: Basic base64(companyId + ":" + PSK)

Results

Status Code

Description

Notes

200

The API call is Successful

The result of the API call will show in the body of the API call as either True or False:

{ "success": true|false }

Example

{
    "success": true
}

Host Actions API

GET Hosts

Return a list of LogMeIn hosts that are registered under a supplied company ID.

GET https://secure.logmein.com/public-api/v2/hosts

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Results

Response Body

Element	Description	Type
hosts	Lists all hosts.	array
description	The Computer description given to the host.	string
hostName	The Computer name of the physical host as displayed on the Computer Properties page. On Windows computers, this is called "Device name"; on a Mac, this is called "Name".	string
id	A unique ID number for the host.	integer
isHostOnline	Indicates if the host computer is online. The system pings the device and returns TRUE if a response is returned within a reasonable time.	boolean

Example

200-Success

{
  "hosts": [
    {
       "description": "<host-name1>",
       "hostName": "johnnyPC1",
       "hostStateChangeDate": "2023-10-06T20:36:00Z",
       "id": <host-id1>,
       "isHostOnline" : true
    },
    {
       "description": "<host-name2>",
       "hostName": "johnnyPC2",
       "hostStateChangeDate": "2023-10-06T20:36:00Z",
       "id": <host-id2>,
       "isHostOnline" : false
    },
  ... ]
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

GET Hosts and Computer Groups

Return a list of LogMeIn hosts and the Computer Groups that are registered under a supplied company ID.

GET https://secure.logmein.com/public-api/v2/hostswithgroups

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Response Body

Element	Description	Type
groups	List of Computer Groups.	array
id	A unique id number for the Computer Group.	integer
name	The group name given to the Computer Group.	string
hosts	Lists all hosts.	array
description	The Computer description given to the host.	string
groupid	The id of the Computer group of which the host is a member. The groupid is the same as the id under groups.	string
id	A unique ID number for the host.	integer
isHostOnline	Indicates if the host computer is online. The system pings the device and returns TRUE if a response is returned within a reasonable time.	boolean

Example

200-Success

{
    "groups": [
    {
      "id": 49932,
      "name": "Work Computers"
    },
    {
      "id": 49933,
      "name": "Home Computers"
    },
    {
      "id": -1,
      "name": null
    }
  ],
  "hosts": [
    {
       "description": "Workhorse",
       "groupid" : 49932,
       "hostStateChangeDate": "2023-10-06T20:36:00Z",
       "id": <host-id1>,
       "isHostOnline" : true
    },
    {
       "description": "Kitty's machine",
       "groupid" : 49933,
       "hostStateChangeDate": "2023-10-06T20:36:00Z",
       "id": <host-id2>,
       "isHostOnline" : false
    },
  ... ]
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

PUT a new Description for the Host

Allows you to update the host description

PUT https://secure.logmein.com/public-api/v1/hosts/{host-id}/description

Note: {host-id} is the id of the host you want to update. To get a list of hosts and their IDs, run the GET Hosts API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Request body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Element	Description	Type
newDescription	The new Computer Description you want to give the host computer.	string

Example

{ 
"newDescription" : “Office Computer”
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

PUT hosts into different groups

Allows you to select host machines to move into different Computer Groups.

PUT https://secure.logmein.com/public-api/v1/host-groups/{groupid}/hosts

Note: The {groupid} is the target groupId. To get a list of hosts and their IDs, run the GET Hosts and Computer Groups API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Element	Description	Type
hostIds	The hosts you want to move into the computer group. You can define multiple hosts.	integer

Example

{ 
"hostIds" : [1026776926, 1238899440]
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

POST a Connection to a Host

Creates a URL link to connect to a host computer.

POST https://secure.logmein.com/public-api/v1/hosts/{host-id}/connection

Note: {host-id} is the id of the host you want to update. To get a list of hosts and their IDs, run the GET Hosts API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Element	Description	Type
directLink	Creates a direct link to the host	boolean
failWhenRaSessionInProgress	Sets whether a connection is still made if the host computer already has a live session connected to it	boolean

Example

{
    "directLink": false,
    "failWhenRaSessionInProgress": true,
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

DELETE Hosts

Allows you to delete a list of hosts.

DELETE https://secure.logmein.com/public-api/v1/hosts

Tip: To get a list of hosts and their IDs, run the GET Hosts API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Element	Description	Type
hostIds	The hosts you want to move into the computer group. You can define multiple hosts.	Integer

Example

{ 
"hostIds" : [1026776926, 1238899440]
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

System Inventory API

GET a list of System Inventory fields

Return a list of available System inventory fields.

Return a list of available System inventory fields. For more information on System inventory, see report types.

GET https://secure.logmein.com/public-api/v1/inventory/system/fields

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Results

Example

200-Success

[
    "ExternalIp",
    "JournalEntries",
    "LastBootDate",
    "LastLogonUserName",
    "LocalUserCreated",
    "LocalUserGroup",
    "LocalUserLastLogin",
    "LocalUserName",
    "LocalUserStatus",
    "OsInstallDate",
    "OsType",
    "SettingsTimezone",
    "WindowsProfileModified",
    "WindowsProfileName",
    "WindowsProfileSize"
]

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

POST a new System Inventory report

Create a report token with a custom System inventory report

For more information on System inventory, see report types.

Note: You must have Inventory reporting enabled. For more information, see Activate Inventory reporting.

POST https://secure.logmein.com/public-api/v1/inventory/system/reports

Note: If more than 50 entries are generated, a continuation token is created. You must use the continuation token to see the next set of entries.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Element	Description	Type
hostIds	The hosts you want information about. You can define multiple hosts	integer
fields	The System Inventory fields you want information about. You can define multiple fields. For a full list of fields, run the GET a list of System Inventory fields API.	string

Example

{	
"hostIds": [1026433963],
"fields": ["ExternalIp", "LastBootDate"]
}

Results

Response Body

Element	Description	Type
expires	the date when the token expires.	date
token	The report token generated for the System Inventory report.	string

Example

200-Success

{
    "expires": "2023-11-05 11:35:43Z",
    "token": "xP7DRsG8LfGKJhOwmklZVd8vLLeKkIhQEcfx6DwV"
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

GET an Active System Inventory Report Token

Returns the currently active System Inventory report token and when it expires.

GET https://secure.logmein.com/public-api/v1/inventory/system/reports

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Results

Response Body

Element	Description	Type
expires	the date when the token expires.	date
token	The report token generated for the System Inventory report.	string

Example

200-Success

{
    "expires": "2023-11-05 11:35:43Z",
    "token": "xP7DRsG8LfGKJhOwmklZVd8vLLeKkIhQEcfx6DwV"
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

GET a Generated System Inventory Report

Generate the currently active System Inventory report.

GET https://secure.logmein.com/public-api/v1/inventory/system/reports/{systemInvReportToken}

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Results

Response Body

Element	Description	Type
report	the details of the report generated by the API call.	array
expires	the date when the token expires.	date
token	The report token generated for the System Inventory report.	string
hosts	The hosts that you requested to see with the requested fields made in your previous POST a new System Inventory report API request.	array

Example

200-Success

{
  "report": {
    "token": null,
    "expires": "2023-11-21 10:16:55Z"
  },
  "hosts": {
    "1026433963": {
      "hostId": 1026433963,
      "localUsers": [],
      "lastLogonUserName": ".\\John"
    }
  }
}

Note: If more than 50 entries are generated, a continuation token is created. You must use the continuation token to see the next set of entries.

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

Hardware Inventory API

GET a list of Hardware Inventory fields

Return a list of available Hardware inventory fields.

Return a list of available System inventory fields. For more information on System inventory, see report types.

GET https://secure.logmein.com/public-api/v1/inventory/hardware/fields

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Results

Example

200-Success

[
    "BatteryName",
    "CpuNumberOfCores"
    "CpuNumberOfProcessors",
    "CpuSpeed",
    "CpuType",
    "DisplayDate",
    "DisplayProvider",
    "DisplayType",
    "DisplayVersion",
    "DriveCapacity",
    "DriveDiskType",
    "DriveMediaType",
    "DriveName",
    "DriveSerialNumber",
    "HardwareAssetTag",
    "HardwareManufacturer",
    "HardwareModel",
    "MemoryModules",
    "MemorySize",
    "MotherboardChipset",
    "MotherboardMemorySlots",
    "NetworkConnectionDefaultGateway",
    "NetworkConnectionDHCPServer",
    "NetworkConnectionIPAddress",
    "NetworkConnectionMacAddress",
    "NetworkConnectionName",
    "NetworkConnectionPrimaryDNS",
    "NetworkConnectionPrimaryWINS",
    "NetworkConnectionSecondaryDNS",
    "NetworkConnectionSecondaryWINS",
    "NetworkConnectionSubnetMask",
    "PartitionDrive",
    "PartitionFileSystem",
    "PartitionFreeSpace",
    "PartitionName",
    "PartitionRaid",
    "PartitionRaidFailingDiskNumber",
    "PartitionRaidStatus",
    "PartitionTotalSize",
    "PrimaryScreenResolution",
    "ServiceTag"
]

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

POST a new Hardware Inventory report

Create a report token with a custom Hardware inventory report

For more information on System inventory, see report types.

Note: You must have Inventory reporting enabled. For more information, see Activate Inventory reporting.

POST https://secure.logmein.com/public-api/v1/inventory/hardware/reports

Note: If more than 50 entries are generated, a continuation token is created. You must use the continuation token to see the next set of entries.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Element	Description	Type
hostIds	The hosts you want information about. You can define multiple hosts.	integer
fields	The System Inventory fields you want information about. You can define multiple fields. For a full list of fields, run the GET a list of Hardware Inventory fields API.	string

Example

{	
"hostIds": [1029767560, 1234567560],	
"fields": ["BatteryName", "CpuType"]
}

Results

Response Body

Element	Description	Type
expires	the date when the token expires.	date
token	The report token generated for the System Inventory report.	string

Example

200-Success

{
    "expires": "2023-11-05 11:35:43Z",
    "token": "xP7DRsG8LfGKJhOwmklZVd8vLLeKkIhQEcfx6DwV"
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

GET an Active Hardware Inventory Report Token

Returns the currently active Hardware Inventory report token and when it expires.

GET https://secure.logmein.com/public-api/v1/inventory/hardware/reports

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Results

Response Body

Element	Description	Type
expires	the date when the token expires.	date
token	The report token generated for the System Inventory report.	string

Example

200-Success

{
    "expires": "2023-11-05 11:35:43Z",
    "token": "xP7DRsG8LfGKJhOwmklZVd8vLLeKkIhQEcfx6DwV"
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

GET a Generated Hardware Inventory Report

Generate the currently active Hardware Inventory report.

GET https://secure.logmein.com/public-api/v1/inventory/hardware/reports/{hardwareInvReportToken}

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Results

Response Body

Element	Description	Type
report	the details of the report generated by the API call.	array
expires	the date when the token expires.	date
token	The report token generated for the System Inventory report.	string
hosts	The hosts that you requested to see with the requested fields made in your previous POST a new Hardware Inventory report API request.	array

Example

200-Success

{
    "report": {
        "token": null,
        "expires": "2023-11-20 14:58:41Z"
    },
    "hosts": {
        "1026433963": {
            "hostId": 1026433963,
            "processors": [
                {
                    "id": "1783055577",
                    "type": "Intel(R) Core(TM) i5-6600K CPU @ 3.50GHz",
                    "speed": null,
                    "numberOfCores": null,
                    "numberOfProcessors": null
                }
            ],
            "batteries": []
        }
    }
}

Note: If more than 50 entries are generated, a continuation token is created. You must use the continuation token to see the next set of entries.

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

Anti-Virus API

Monitor anti-virus software running on LogMeIn host computers.

LogMeIn Central lets you monitor anti-virus software on your hosts. For more information, see powered by Bitdefender.

Supported anti-virus software

View a list of supported anti-virus software, sortable by support level, product name, version, and vendor.

Support level	Description
Full support	For anti-virus software that is fully supported: GoTo can read all relevant information from the anti-virus software installed on the host When virus definition was last updated Threat log Host's real-time protection setting LogMeIn Central Premier and Security subscribers can do the following: Run commands on the host to manage its anti-virus software Enable real-time protection Check for the latest virus definition Run a full scan on the host
Partial support	For anti-virus software that is partially supported: GoTo can read all relevant information from the anti-virus software installed on the host When virus definition was last updated Host's real-time protection setting Central Premier and Security subscribers may be able to do the following: Run commands on the host to manage its anti-virus software Enable real-time protection Threat log Check for the latest virus definition Run a full scan on the host
Minimal support	GoTo can only read whether or not the virus definition is up-to-date.

GET Anti-Virus Details Installed on Hosts

Return a list of anti-virus details installed on hosts.

GET https://secure.logmein.com/public-api/v1/hosts/anti-virus/details

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Results

Response Body

Element	Description	Type	Notes
hostsGroups	Lists of Computer Groups in your LogMeIn Central account.	array
groupId	A unique id number for the Computer Group.	integer
groupName	The group name given to the Computer Group.	string
isCollapsed	Indicates if the computer group is open or closed in the User Interface on your LogMeIn Central website account.	integer
hosts	Lists all hosts.	array
hostDescription	The Computer description given to the host.	string
groupId	A unique id number for the Computer Group.	integer
isOnline	Indicates if the host computer is online. The system pings the device and returns TRUE if a response is returned within a reasonable time.	boolean
buildNumber	The build number of the Operating System on the host.	integer
isMac	Indicates if the host is a mac.	boolean
hostId	A unique ID number for the host.	integer
antiVirusStatus	The status of the anti-virus software installed on the host.	integer	ActionRequired =0 Warning = 1 Unknown = 2 Ok = 3 FreeOk = 4 -has a free sub installed on the host and can only receive limited anti-virus information. PartialOk = 5 - can only receive limited anti-virus information.
antiVirusName	The name of the anti-virus installed on the host.	string
isRealTimeProtectionOn	Indicates whether the installed anti-virus' Real-time protection is on.	boolean
isVirusDefinitionUpToDate	Indicates whether the installed anti-virus' virus definition is on.	boolean
virusDefinitionVersion	the version number of the virus definition installed on the host.	string
lastFullScanTime	The date when a full scan was performed by the antri-virus installed on the host.	date
numberOfThreats		integer
isMultipleAntiVirusDetected	Indicates whether or not multiple anti-virus software are installed on the host.	boolean
canReportThreatLog	Indicates whether a Threat Log is available on the host.	boolean
canReportRealTimeProtectionStatus	Indicates whether Real-Time protection is available on the host.	boolean

Example

200-Success

"hostGroups": [
        {
            "groupId": 705185,
            "groupName": "Change",
            "isCollapsed": null
        },
        {
            "groupId": 729612,
            "groupName": "New Group",
            "isCollapsed": null
        }
    ],
    "hosts": [
        {
            "hostDescription": "ALPHA",
            "groupId": 705185,
            "isOnline": false,
            "buildNumber": 10622,
            "isMac": false,
            "hostId": 1022767460,
            "antiVirusStatus": 2,
            "antiVirusName": null,
            "isRealTimeProtectionOn": false,
            "isVirusDefinitionUpToDate": false,
            "virusDefinitionVersion": null,
            "lastFullScanTime": null,
            "numberOfThreats": 0,
            "isMultipleAntiVirusDetected": false,
            "capabilities": {
                "canReportThreatLog": false,
                "canReportRealTimeProtectionStatus": false
            },
        },
        {
            "hostDescription": "TV Workstation",
            "groupId": 729612,
            "isOnline": true,
            "buildNumber": 11660,
            "isMac": false,
            "hostId": 1026433963,
            "antiVirusStatus": 3,
            "antiVirusName": "Bitdefender Internet Security 27.0.25.115 by Bitdefender",
            "isRealTimeProtectionOn": true,
            "isVirusDefinitionUpToDate": true,
            "virusDefinitionVersion": "2023.10.15",
            "lastFullScanTime": "2023-10-08T17:17:22Z",
            "numberOfThreats": 0,
            "isMultipleAntiVirusDetected": false,
            "capabilities": {
                "canReportThreatLog": true,
                "canReportRealTimeProtectionStatus": true
            },
         },
    ]

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

POST an Enable Real-Time Protection Command to Installed Antivirus

Enable Real-time protection on antivirus installed on the host.

POST https://secure.logmein.com/public-api/v1/anti-virus/actions/enable-realtimeprotection

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Element	Description	Type
targetHostIds	the hosts to which you want to send the command. You can select multiple hosts.	number

Example

{
    "targetHostIds": [1009854378, 1009867843]
}

Results

Element	Description	Type
commandStatuses	the status of the commands sent to the hosts.	array
targetHostId	the host to which the command is sent.	number
sentSuccessfully	Tells you whether or not the command is sent.	boolean

Example

{
    "commandStatuses": [
        { "targetHostId": 1009854378, "sentSuccessfully": true },
        { "targetHostId": 1009867843, "sentSuccessfully": true }
    ]
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

POST a Full Scan command to Installed Antivirus

Start a full antivirus scan on antivirus software installed on the host.

POST https://secure.logmein.com/public-api/v1/anti-virus/actions/start-fullscan

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Element	Description	Type
targetHostIds	the hosts to which you want to send the command. You can select multiple hosts.	number

Example

{
    "targetHostIds": [1009854378, 1009867843]
}

Results

Element	Description	Type
commandStatuses	the status of the commands sent to the hosts.	array
targetHostId	the host to which the command is sent.	number
sentSuccessfully	Tells you whether or not the command is sent.	boolean

Example

{
    "commandStatuses": [
        { "targetHostId": 1009854378, "sentSuccessfully": true },
        { "targetHostId": 1009867843, "sentSuccessfully": true }
    ]
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

POST a Refresh Status command to Antivirus

Refreshes the status of antivirus software installed on the host.

POST https://secure.logmein.com/public-api/v1/anti-virus/actions/refresh-status

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Element	Description	Type
targetHostIds	the hosts to which you want to send the command. You can select multiple hosts.	number

Example

{
    "targetHostIds": [1009854378, 1009867843]
}

Results

Element	Description	Type
commandStatuses	the status of the commands sent to the hosts.	array
targetHostId	the host to which the command is sent.	number
sentSuccessfully	Tells you whether or not the command is sent.	boolean

Example

{
    "commandStatuses": [
        { "targetHostId": 1009854378, "sentSuccessfully": true },
        { "targetHostId": 1009867843, "sentSuccessfully": true }
    ]
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

POST an Update Virus Definition Command to an Antivirus

Update the virus definitions for supported antivirus software.

POST https://secure.logmein.com/public-api/v1/anti-virus/actions/update-definition

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Element	Description	Type
targetHostIds	the hosts to which you want to send the command. You can select multiple hosts.	number

Example

{
    "targetHostIds": [1009854378, 1009867843]
}

Results

Element	Description	Type
commandStatuses	the status of the commands sent to the hosts.	array
targetHostId	the host to which the command is sent.	number
sentSuccessfully	Tells you whether or not the command is sent.	boolean

Example

{
    "commandStatuses": [
        { "targetHostId": 1009854378, "sentSuccessfully": true },
        { "targetHostId": 1009867843, "sentSuccessfully": true }
    ]
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

Users API

Get a List of Users

List the Users in your LogMeIn Central account.

GET https://secure.logmein.com/public-api/v2/users

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Response Body

Element	Description	Type
mahData	Details for the Master Account Holder of the LogMeIn Central account.	array
usersData	List for the users in your LogMeIn Central Account.
isPending	Indicates whether the invitations sent to the user is waiting for a reply.	boolean
id	A unique id number for the user.	integer
email	The email address of the user.	string
firstName	The first name set by the user.	string
lastName	The last name set by the user.	string
isEnabled	Indicates whether the user has accepted the user invitation. Its value is `false` in the following cases: The user has not accepted the invitation yet. The user had accepted the invitation, but the Master Account Holder disabled the user's account.	boolean
lastLoginDate	The last time the user logged into their LogMeIn Central account.	date

Example:

200 - OK

{
    "mahData": {
        "id": 1701441668,
        "email": "example@company.com",
        "firstName": "James T.",
        "lastName": "Boss",
        "isEnabled": true,
        "lastLoginDate": "10/19/2023 1:15:56 PM"
    },
    "usersData": [
        {
            "isPending": false,
            "id": 1701472698,
            "email": "john.doe@gmail.com",
            "firstName": "John",
            "lastName": "Doe",
            "isEnabled": true,
            "lastLoginDate": "7/24/2023 1:58:36 PM"
        }
    ]
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

Get several users' details

List the specified users' details. You must specify at least one but no more than 50 email addresses in a single API call.

POST https://secure.logmein.com/public-api/v3/users/details

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Request body

Define a list of email addresses in a JSON array to get the details of.

["user1@emailaddress.com", "user2@emailaddress.com"]

Response Body

Element	Description	Type
id	A unique ID number for the user.	integer
email	The email address of the user.	string
firstName	The first name set by the user.	string
lastName	The last name set by the user.	string
groupId	The ID of the group the user belongs to. The value is `-1` when the user is a member of the default group.	integer
enabled	Indicates whether the user has accepted the user invitation. Possible values are `true` and `false`.	boolean
userPermissions	Sets user permissions as described in User Permissions.	array
inheritedGroupPermissions	Sets user group permissions as described in User Group Permissions.	array

Example:

200 - OK

{ 
[ 
   { 
       "id": 1701472698
       "email": "john.doe@gmail.com",
       "firstName": "John", 
       "lastName": "Doe", 
       "groupId": -1, 
       "enabled": true, 
       "userPermissions": {permissions}, 
       "inheritedGroupPermissions": {permissions} 
   } 
]

HTTP responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	The number of email addresses in the API call is either zero or more than 50.
404	Not found	One or more users provided in the list of email address do not exist.

Invite users

Invite users to a group in an account. You must specify at least one but no more than 100 email addresses in an API call. Use a comma-separated list of email addresses for inviting multiple users.

POST https://secure.logmein.com/public-api/v3/users/invitation

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Request body

{ 
   "emails": ["john.doe@company.com", jane.doe@company.com], 
   "groupId": -1, 
   "permissions": { 
       <Permissions object>, 
   }, 
}

Element	Description	Type
emails	The email addresses of the users.	array
groupId	The ID of the group the user belongs to. Use the value is `-1` to add users to the default group. Note: To get a list of groups and their IDs, run the GET Hosts and Computer Groups API.	integer
permissions	Sets user permissions as described in User Permissions.	array

Response body

Example:

200 - OK

{ 
   "notInvitedEmails": ["<email1>", ...] 
}

Where notInvitedEmails contains the email addresses of those users who have already been invited or are active in the LogMeIn Central account.

HTTP responses

Code	Description	Notes
200	OK	The invite was successfully created.
400	Bad Request	There was an error with the request body. For more information, see the message in the returned JSON. API rate limit error: if the user has exceeded the maximum number of invitations possible

Update user settings

Update a user's group membership and permissions.

PUT https://secure.logmein.com/public-api/v3/users/details/set

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Request body

{ 
"email":  "testemail@company.com", 
"groupId": 671701, 
"permissions": [] 
 }

Element	Description	Type
email	The email address of the user.	string
groupId	The ID of the group the user belongs to. Use the value is `-1` to add users to the default group.	integer
permissions	Sets user permissions as described in User Permissions. In the permissions object you only need to define the permission you would like to update.	array

Response body

Example

200 - OK

HTTP responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	One of the following occurred: A property value is invalid. A permission name is invalid. There is no user for the given email. The user does not have access to one of the updated permissions. For example, you may try to set the One2Many permission for a user who does not have the Automation module.
404	Not found	User was not found.

Enable users

Enable a maximum of 50 users.

POST https://secure.logmein.com/public-api/v3/users/enable

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Request body

List of emails in a JSON array.

["user1@emailaddress.com", "user2@emailaddress.com"]

Response body

Example

200 - OK

HTTP responses

Code	Description	Notes
200	OK	Users were successfully enabled.
400	Bad Request	One of the following occurred: If the number of email addresses are either zero or more than 50. If an unexpected error occurred due to one or more of the specified users.
404	Not found	User was not found.

Disable users

Disable a maximum of 50 users.

POST https://secure.logmein.com/public-api/v3/users/disable

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Request body

List of emails in a JSON array.

["user1@emailaddress.com", "user2@emailaddress.com"]

Response body

Example

200 - OK

HTTP responses

Code	Description	Notes
200	OK	Users were successfully disabled.
400	Bad Request	One of the following occurred: If the number of email addresses are either zero or more than 50. If an unexpected error occurred due to one or more of the specified users.
404	Not found	User was not found.

Delete users

Delete a list of users.

DELETE https://secure.logmein.com/public-api/v3/users/

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Request body

List of emails in a JSON array.

["user1@emailaddress.com", "user2@emailaddress.com"]

Response body

Example

204 - No content

HTTP responses

Code

Description

Notes

204

No content

Users were successfully deleted.

400

Bad Request

One of the following occurred:

No emails were given, or there was an empty email item
No user can be found with the following email address(es):

User Permissions

Certain API calls allow you to set user and group permissions.

You can set the following user permissions. For detailed description of these permissions, see the LogMeIn Central support site.

{ 
   "grantAll": true|false, 
   "central": { 
       "enableCentral": true|false, 
       "reports": true|false, 
       "alertManagement": true|false, 
       "configurationManagement": true|false, 
       "computerGroupManagement": true|false, 
       "viewInventoryData": true|false, 
       "inventoryManagement": true|false, 
       "one2manyManagement": true|false, 
       "one2manyRun": true|false, 
       "windowsUpdateManagement": true|false, 
       "applicationUpdateManagement": true|false, 
       "antivirusManagement": true|false, 
       "remoteExecution": true|false, 
       "remoteExecutionCreateAndRun": true|false 
   }, 
   "management": { 
       "userManagement": true|false,
       "loginPolicyManagement": true|false, 
       "saveLoginCredentials": true|false, 
       "createDesktopShortcut": true|false, 
       "deployment": true|false, 
       "adhocSupport": true|false,
       "accountSecurity": true|false 
   }, 
   "interface": "advanced"|"simple", 
   "groupAndComputerPermissions": { 
       "allowFullRemoteControl": true|false, 
       "computerPermission": "groupSettings"|"accessall"|"specified", 
       "permittedGroupIds": [<computerGroupId1>, ...], 
       "permittedHostIds": [<hostId1>, ...] 
   }, 
   "network": { 
       "accessNetworks": true|false, 
       "networkAndClientManagement": true|false, 
       "editClientDefaults": true|false, 
       "editNetworkDefaults": true|false, 
   }, 
   "enforceTfa": true|false 
}

User Group Permissions

Certain API calls allow you to set user and group permissions.

You can set the following user group permissions. For detailed description of these permissions, see the LogMeIn Central support site.

{ 
   "grantAll": true|false, 
   "central": { 
       "enableCentral": true|false, 
       "reports": true|false, 
       "alertManagement": true|false, 
       "configurationManagement": true|false, 
       "computerGroupManagement": true|false, 
       "viewInventoryData": true|false, 
       "inventoryManagement": true|false, 
       "one2manyManagement": true|false, 
       "one2manyRun": true|false, 
       "windowsUpdateManagement": true|false, 
       "applicationUpdateManagement": true|false, 
       "antivirusManagement": true|false, 
       "remoteExecution": true|false, 
       "remoteExecutionCreateAndRun": true|false 
   }, 
   "management": { 
       "userManagement": true|false, 
       "loginPolicyManagement": true|false, 
       "saveLoginCredentials": true|false, 
       "createDesktopShortcut": true|false, 
       "deployment": true|false, 
       "adhocSupport": true|false, 
       "accountSecurity": true|false 
   }, 
   "interface": "advanced"|"simple", 
   "groupAndComputerPermissions": { 
       "allowFullRemoteControl": true|false, 
       "computerPermission": "groupSettings"|"accessall"|"specified", 
       "permittedGroupIds": [<computerGroupId1>, ...], 
       "permittedHostIds": [<hostId1>, ...] 
   }, 
   "network": { 
       "accessNetworks": true|false, 
       "networkAndClientManagement": true|false, 
       "editClientDefaults": true|false, 
       "editNetworkDefaults": true|false, 
   }, 
   "enforceTfa": true|false 
}

User Groups API

Get a list of user groups

List user groups in your LogMeIn Central account.

GET https://secure.logmein.com/public-api/v3/user-groups

Note: Master Account Holders will not be listed.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Request body

None.

Response body

Element	Description	Type
groupId	A unique ID for the user group.	integer
isEnabled	Indicates whether the user group is enabled. Possible values are `true` and `false`.	boolean
groupName	Name of the group where you want to list members.	string
userList	The list of users in the selected user group.	array
id	A unique ID for the user.	integer
enabled	Indicates whether the user's account is enabled.	boolean
pending	Indicates whether the invitations sent to the user is waiting for a reply.	boolean
firstName	The first name set by the user.	string
lastName	The last name set by the user.	string
email	The email address of the user.	string

Example

200-OK

{
   [ 
       { 
        "groupId": 705185, 
        "isEnabled": true|false, 
        "groupName": "New Group", 
        "userList": [ 
            { 
                "id": <user’s id>, 
                "enabled": true|false, 
                "pending ": true|false, 
                "firstName": <user’s first name>, 
                "lastName": <user’s last name>, 
                "email": <user’s email> 
            } 
        ] 
       } 
       ... 
   ] 
}

HTTP responses

Code	Description	Notes
200	OK	Successful call made.

Get a specific user group

Show the details of a single user group in your LogMeIn Central account.

GET https://secure.logmein.com/public-api/v3/user-groups/{groupId}

Note:

Master Account Holders will not be listed.
The {groupid} is the target groupId. To get a list of hosts and their IDs, run the GET Hosts and Computer Groups API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Response body

Element	Description	Type
groupId	A unique ID for the user group.	integer
groupName	Name of the selected user group.	string
enabled	Indicates whether the user group is enabled. Possible values are `true` and `false`.	boolean
permissions	Sets group permissions as described in Group Permissions for User Groups. In the permissions object you only need to define the permission you would like to update.	array
users	The list of users in the selected user group.	array
id	A unique ID for the user.	integer
enabled	Indicates whether the user's account is enabled.	boolean
pending	Indicates whether the invitations sent to the user is waiting for a reply.	boolean
firstName	The first name set by the user.	string
lastName	The last name set by the user.	string
email	The email address of the user.	string

Example

200 - OK

{ 
    "groupId": 705185, 
    "groupName": New Group, 
    "enabled": true|false, 
     "permissions": {Group Permissions}
     "users": [ 
           { 
                "id": <user’s id>, 
                "enabled": true|false, 
                "pending ": true|false, 
                "firstName": <user’s first name>, 
                "lastName": <user’s last name>,
                "email": <user’s email> 
            }, ... 
     ] 
}

HTTP responses

Code	Description	Notes
200	OK	Successful call made.
404	Not Found	The defined groupId does not exist.

Update user group settings

Update the name and permissions of a user group.

PUT https://secure.logmein.com/public-api/v3/user-groups/{groupId}

Note: The {groupid} is the target groupId. To get a list of hosts and their IDs, run the GET Hosts and Computer Groups API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Request body

Element	Description	Type
name	Name of the created group.	string
permissions	Sets group permissions as described in Group Permissions for User Groups. In the permissions object you only need to define the permission you would like to update.	array

{ 
   "name": "new group" 
   "permissions": {Group Permissions} 
}

Response body

Example

204-No content

HTTP responses

Code	Description	Notes
204	No content	Successful call made.
400	Bad Request	The request is incorrectly formed for one of the following reasons: Group does not exist Specified group name already exists A property value is invalid. A permission names is invalid There is no user with the given email address The user does not have access to one of the updated permissions. For example, you try to set One2Many permission for a user who does not have the Automation module purchased.

Create user group

Creates a user group in your LogMeIn Central account.

POST https://secure.logmein.com/public-api/v3/user-groups

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Request body

Element	Description	Type
name	Name of the created group.	string
permissions	Sets group permissions as described in Group Permissions for User Groups. In the permissions object you only need to define the permission you would like to update.	array

{ 
   "name": "new group" 
   "permissions": {Group Permissions} 
}

Response body

Example

200 - OK

HTTP responses

Code	Description	Notes
200	OK	The group was successfully created.
400	Bad Request	The request is incorrectly formed for one of the following reasons: You need to specify the name and permissions (optional) for the group to create The group name shouldn’t be same as the default group name The specified group name already exists Group name should be within 1 and 128 characters long

Delete a user group

Delete the selected user group.

DELETE https://secure.logmein.com/public-api/v3/user-groups/{groupId}

Note: The {groupid} is the target groupId. To get a list of hosts and their IDs, run the GET Hosts and Computer Groups API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Request body

None.

Response body

Example

204 - No content

HTTP responses

Code	Description	Notes
204	No content	Successful call made.
400	Bad request	You do not have permission to delete the group.

Enable a user group

Enable the selected user group.

POST https://secure.logmein.com/public-api/v3/user-groups/enable/{groupId}

Note: The {groupid} is the target groupId. To get a list of hosts and their IDs, run the GET Hosts and Computer Groups API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Request body

Not required.

Response body

Example

200 - OK

HTTP responses

Code	Description	Notes
200	OK	Successful call made.
404	Not found	Specified group does not exist.

Disable a user group

Disable the selected user group.

POST https://secure.logmein.com/public-api/v3/user-groups/disable/{groupId}

Note: The {groupid} is the target groupId. To get a list of hosts and their IDs, run the GET Hosts and Computer Groups API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Request body

Not required.

Response body

Example

200 - OK

HTTP responses

Code	Description	Notes
200	OK	Successful call made.
404	Not found	Specified group does not exist.

Rename a user group

Rename the selected user group.

POST https://secure.logmein.com/public-api/v3/user-groups/rename/{groupId}

Note: The {groupid} is the target groupId. To get a list of hosts and their IDs, run the GET Hosts and Computer Groups API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Request body

Element	Description	Type
newgroupname	New name of the selected user group.	string

{ 
   "newgroupname": "New Group" 
}

Response body

Example

204 - No content

HTTP responses

Code	Description	Notes
204	No content	Successful call made.
400	Bad request	The request is incorrectly formed for one of the following reasons: The specified `groupId` is incorrect. The specified group does not exist. The defined `newgroupname` already exists. The value of `newgroupname` is null or empty.

Change group membership of multiple users

Move multiple users to a group.

POST https://secure.logmein.com/public-api/v3/user-groups/move-users/{groupId}

Note: The {groupid} is the target groupId. To get a list of hosts and their IDs, run the GET Hosts and Computer Groups API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Request body

{ 
   [ "user1@emailaddress.com", "user2@emailaddress.com"] 
}

Response body

Example

204-No content

HTTP responses

Code	Description	Notes
204	No content	Successful call made.
404	Not found	Specified group does not exist.

Group Permissions for User Groups

Certain API calls allow you to set group permissions.

You can set the following permissions when calling user group APIs. For detailed description of these permissions, see the LogMeIn Central support site.

{ 
   "grantAll": true|false, 
   "central": { 
       "enableCentral": true|false, 
       "reports": true|false, 
       "alertManagement": true|false, 
       "configurationManagement": true|false, 
       "computerGroupManagement": true|false, 
       "viewInventoryData": true|false, 
       "inventoryManagement": true|false, 
       "one2manyManagement": true|false, 
       "one2manyRun": true|false, 
       "windowsUpdateManagement": true|false, 
       "applicationUpdateManagement": true|false, 
       "antivirusManagement": true|false, 
       "remoteExecution": true|false, 
       "remoteExecutionCreateAndRun": true|false 
   }, 
   "management": { 
       "userManagement": true|false, 
       "loginPolicyManagement": true|false, 
       "saveLoginCredentials": true|false, 
       "createDesktopShortcut": true|false, 
       "deployment": true|false, 
       "adHocSupport": true|false, 
       "accountSecurity": true|false 
   }, 
   "interface": "advanced"|"simple", 
   "groupAndComputerPermissions": { 
       "allowFullRemoteControl": true|false, 
       "computerPermission": "accessall"|"specified", 
       "permittedGroupIds": [<computerGroupId1>, ...], 
       "permittedHostIds": [<hostId1>, ...] 
   }, 
   "network": { 
       "accessNetworks": true|false, 
       "networkAndClientManagement": true|false, 
       "editClientDefaults": true|false, 
       "editNetworkDefaults": true|false, 
   } 
}

Reporting API

POST a Remote Access Report

Retrieve a report of remote access activity for a specified time range.

POST https://secure.logmein.com/public-api/v1/reports/remote-access

Note: {host-id} is the id of the host you want to update. To get a list of hosts and their IDs, run the GET Hosts API.

Note: {category-id} is the id of the category you want to remove. To get a list of hosts and their IDs, run the GET a List of Custom Fields API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Element	Description	Type
StartDate	The starting time for the report.	datetime
EndDate	The ending time for the report.	datetime

Example

{ 
                    "startDate": "2023-03-01",
                    "endDate": "2023-03-31"
}

Results

Element	Description	Type
sessionId	The unique identifier of the remote access session.	number
hostId	The unique identifier of the host.	number
sessionStart	The starting time of the remote access session.	datetime
sessionEnd	The end time of the remote access session.	datetime
userIp	The host's IP address.	ip address

Example

[
                    { 
                    "sessionId": 1000001,
                    "hostId": 1700985719,
                    "sessionStart": "2023-02-25 11:33:40",
                    "sessionEnd": "2023-02-25 11:36:15",
                    "userIp": "10.228.224.54"
                    }
]

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

POST a remote access report with groups

Retrieve a report of remote access activity for a specified time range with groups.

POST https://secure.logmein.com/public-api/v1/reports/remote-access-with-groups

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Note: There must not be more than three months between the start date and end date.

Element	Description	Type
startDate	The starting time for the report.	datetime
endDate	The ending time for the report.	datetime

Example

{ 
"startDate": "2023-03-01", 
"endDate": "2023-03-31" 
}

Results

Element	Description	Type
sessionId	The unique identifier of the remote access session.	number
hostId	The unique identifier of the host.	number
groupId	The unique identifier of the group your recently accessed host is in.	number
sessionStart	The starting time of the remote access session.	datetime
sessionEnd	The end time of the remote access session.	datetime
userIp	The host's IP address	ip address

Example

[
    { 
    "sessionId": 1000001,
    "hostId": 1700985719,
    "groupId": 12345,
    "sessionStart": "2023-02-25 11:33:40",
    "sessionEnd": "2023-02-25 11:36:15",
    "userIp": "10.228.224.54"
    }
]

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

POST a Computer Status Report

Retrieve information on recent activities for hosts and groups.

POST https://secure.logmein.com/public-api/v1/reports/computer-status

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Element	Description	Type
groupIDList	The id of the groups you want.	number
hostIDList	The id of the hosts you want	number

Example

{ 
    "groupIdList": [1234, 1235], 
    "hostIdList": [23456, 23457]
}

Results

Element	Description	Type	Notes
hostId	The unique identifier of the host.	number
groupId	The unique identifier of the group your recently accessed host is in.	number
computerDescription	The Computer description given to the host.	string
productType	This is obsolete info.	string	This always returns a value of 'i'.
subscriptionType	The type of subscription associated with the host.	number	0 - Basic 2 - Monthly 4 - Yearly 6 - Yearly Direct
startDate	The the subscription started.	datetime
renewalDate	The time the subscription is set to renew.	datetime
status	The state of the subscription associated with the host.	number	0 - Marked for cancel 1 - Active 2 - Expired 3 - Banned 99 – Cancelled
lastOnline	The last time when the host was pingable and was online.	datetime
lastRemoteSession	The last time the host was accessed.	datetime
lastKnownIpAddress	The host's last known IP address.	ip address
installDate	The date LogMein was installed on the host.	datetime
softwareVersion	The version of the LogMein software installed on the host.	number

Example

[
    {
     "hostId": 1700494403,
     "groupId": null,
     "computerDescription": 
     "TestComputer1",
     "productType": "i",
     "subscriptionType": 4,
     "startDate": "2022-06-14T12:54:00Z",
     "renewalDate": "2023-06-14T00:00:00Z",
     "status": 1,
     "lastOnline": "2023-11-16T10:00:00Z",
     "lastRemoteSession": "2023-10-17T09:56:00Z",
     "lastKnownIpAddress": "192.168.13.111",
     "installDate": "2023-10-14T09:59:00Z",
     "softwareVersion": 15242
     }
]

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

POST a Deleted Host Report

Retrieve details of deleted hosts.

POST https://secure.logmein.com/public-api/v1/reports/deleted-hosts/

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Element	Description	Type
startDate	The date from which you want details of deleted hosts.	datetime

Example

{ 
"startDate": "2023-03-01"
}

Results

Element	Description	Type	Notes
hostId	The unique identifier of the host.	number
status	The state of the subscription associated with the host.	string	Always returns a status of 'Deleted'.
hostName	The Computer description given to the host.	string
deletedReason	This is obsolete info.	string	Returns one of the following Host deleted from website / API Host software uninstall Invalid Subscription Account Cancel
deletedAt	The date when the host was deleted.	datetime
installedAt	The date when the host software was installed.	datetime

Example

[
    {
    "hostId": 1700494420,
    "status": "Deleted",
    "hostName": "TestComputer2",
    "deleteReason": "Host deleted from website / API",
    "deletedAt": "2023-07-05T11:30:00Z",
    "installedAt": "2022-10-20T11:29:00Z"
    }
]

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

Custom Fields

LogMeIn Central lets you store custom (user defined) data to your hosts. For more information, see Use custom fields to organize computers in.

GET a List of Custom Fields

Allows you to get a list of all created Custom Fields (also known as 'Custom Field Categories').

GET https://secure.logmein.com/public-api/v1/hosts/custom-fields/categories

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Results

Response Body

Element	Description	Type
metadataCategories	Lists the Custom Field categories.	array
id	A unique id number for the Custom Field category.	string
name	The value set for the Custom Field	string
values	A list of the values set in Custom fields categories.	array
id	A unique id string for the Custom Field category value.	string
name	The input for the Custom Field category value	string

Example

200-Success

{
    "metadataCategories": [
        {
            "id": "10150898-0dd5-4d36-964e-78ef88b2708c",
            "name": "Asset Tag",
            "values": [
                {
                    "id": "0e16bce9-4090-48d5-9ba3-4bc6eddd0dd0",
                    "name": "12ab34"
                },
                {
                    "id": "d0e5c6a1-eb91-4bfc-ad14-297d05b2d392",
                    "name": "45cs67"
                },
            ]
        },
        {
            "id": "4a4e5dbd-7213-4f26-a43c-60848d9328fb",
            "name": "Location",
            "values": [
                {
                    "id": "90859768-277a-4542-976a-6ce41934ccf2",
                    "name": "Budapest"
                },
                {
                    "id": "d85f36ce-2ca7-431c-bbe8-7d2b41c43409",
                    "name": "Chicago"
                },
            ]
        }
    ]
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

GET a list of Custom Fields assigned to hosts

Lists all hosts and the unique category IDs that are assigned to the hosts.

GET https://secure.logmein.com/public-api/v1/hosts/custom-fields

Note: To get the list of unique IDs and the categories they represent, run the GET a List of Custom Fields API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Results

Response Body

Element	Description	Type
hosts	List of hosts.	array
id	A unique ID number for the host.	string
metadata	The group name given to the Computer Group.	string
categoryId	A unique id string for the Custom Field category value.	string
valueId	A unique id string for the input of a Custom Field category value.	string

Example

200-Success

{
    "hosts": [
        {
            "id": 1022767460,
            "metadata": [
                {
                    "categoryId": "10150898-0dd5-4d36-964e-78ef88b2708c",
                    "valueId": "0e16bce9-4090-48d5-9ba3-4bc6eddd0dd0"
                },
                {
                    "categoryId": "40c25332-3b89-4c4d-8d12-22007f5cb4e2",
                    "valueId": "ef221913-3550-42d4-aece-b001a04cbd9d"
                },
                {
                    "categoryId": "4a4e5dbd-7213-4f26-a43c-60848d9328fb",
                    "valueId": "d85f36ce-2ca7-431c-bbe8-7d2b41c43409"
                },
                {
                    "categoryId": "685c8a62-7682-4601-a003-9a1361c49ad6",
                    "valueId": "9ad43854-6d27-4940-b53e-fa084cdc3b5b"
                }
            ]
        },

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

POST a new Custom Field

Create a new custom field category

POST https://secure.logmein.com/public-api/v1/hosts/custom-fields/categories

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Element	Description	Type
name	The new name for the new custom field category	string

Example

{ 
"name" : “Asset Tag”
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

POST a value to a host

Assign a value under a category to a host.

POST https://secure.logmein.com/public-api/v1/hosts/{host-id}/custom-fields/value-by-category/{category-id}

Note: {host-id} is the id of the host you want to update. To get a list of hosts and their IDs, run the GET Hosts API.

Note: {category-id} is the id of the category you want to remove. To get a list of hosts and their IDs, run the GET a List of Custom Fields API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Element	Description	Type
value	The new value under the Custom field category you want assigned to the host	string

Example

{ 
"value" : “England”
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

PUT a new name on a Custom Field

Rename a custom field category

PUT https://secure.logmein.com/public-api/v1/hosts/custom-fields/categories/{category-id}

Note: {category-id} is the id of the category you want to remove. To get a list of hosts and their IDs, run the GET a List of Custom Fields API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

Body

Note: When using a third-party API Development Environment, the body output must be set to application/json.

Element	Description	Type
name	The new name for the custom field category.	string

Example

{ 
    "name" : “Asset-Tag”
}

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

DELETE a Custom Field Category

Remove a custom field from all hosts

DELETE https://secure.logmein.com/public-api/v1/hosts/custom-fields/categories/{category-id}

Note: {category-id} is the id of the category you want to remove. To get a list of hosts and their IDs, run the GET a List of Custom Fields API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.

DELETE a Value Assigned to a host under a Specific Custom Field

Remove a custom field value assigned to a host

DELETE https://secure.logmein.com/public-api/v1/hosts/{host-id}/custom-fields/value-by-category/{category-id}

Note: {host-id} is the id of the host you want to update. To get a list of hosts and their IDs, run the GET Hosts API.

Note: {category-id} is the id of the category you want to remove. To get a list of hosts and their IDs, run the GET a List of Custom Fields API.

Headers

Type	Description	Required	Notes
Authorization	Contains your authorization information to allow authentication to a LogMeIn account.	Required	You must authenticate each API action you call with your CompanyID + PSK pair. See Authentication

HTTP Responses

Code	Description	Notes
200	OK	Successful call made.
400	Bad Request	A required parameter may be missing.
409	Unauthorized	The Authorization header may be missing or invalid.
415	Unsupported Media Type	A request may have been made for any format other than JSON.
429	Too Many Requests	The request may have been made for the action too many times.
500	Internal Server Error	May return the following message: An error occurred. If this problem happens again, please contact customer support at https://logmein.com/support and quote the error code.