General Requirements for Migration to LogicMonitor REST API v3

To migrate to LogicMonitor REST API v3, you need the following:

• A valid LMv1 API token or bearer token for authentication.
• Access to Swagger documentation from LogicMonitor for API v3 reference.

LogicMonitor REST API v3 Migration Considerations

• Update authentication method—Replace basic authentication with token-based authentication such as, LMv1 or bearer token. For more information, see REST API Authentication.
• Update API request headers—Use the new version 3 header (X-version: 3) or query parameter (v=3) in the API calls.
• Modify API URLs—Update endpoints to match the new v3 structure. For more information, see the API URL mapping table.
• Adapt to new response formats—Modify the client code to handle the new response format.
• Update error handling—Update the error handling logic to accommodate the new error response format.
• Update API filters—Update API filters according to the changes specified in the Filter Syntax section. For more information, see LogicMonitor REST API v3 Basic filters and LogicMonitor REST API v3 Advanced filters.
• Update parsing logic—Remove any logic that parses the status, errmsg, and data fields.
• Access fields from root—Access fields directly from the root of the JSON response.
• Simplify fields—Ensure that the client can correctly interpret the errorMessage, errorCode, and errorDetail fields.
• Test your scripts or applications—Use sample code and API v3 Swagger to validate your updates. For more information, see REST API v3 Swagger Documentation.