Available APIs

Here we provide an overview of the different LeanIX APIs and SDKs.

Overview

LeanIX is built with a Microservices architecture, with different services and API endpoints. Below you find a list of all public APIs. For each entry, you see their main resources, the endpoint URL, links to Swagger API References and links to SDKs if available. We also provide examples for the Usage of SDKs.

The endpoint URL depends on the instance you are using. We use the variable base_url, which has one of the following values:

  • https://app.leanix.net - If you are using the default instance of LeanIX
  • https://us.leanix.net - If you are using the US instance of LeanIX
  • https://<customer>.leanix.net - If you have a dedicated instance of LeanIX

Pathfinder API: IT Inventory

Information about used applications, technologies, projects and more objects can be stored in the IT Inventory of LeanIX. LeanIX provides a Data Model with so called "Fact Sheets" out of the box. Via the Pathfinder API you an interact with this data model.

Main resources:

  • All Fact Sheets Types: Applications, IT Components, Projects, ...
  • Comments
  • Subscriptions
  • Tags

Endpoint : <base_url>/services/pathfinder/v1, e.g. https://app.leanix.net/services/pathfinder/v1
Swagger API Reference
Swagger JSON
Java SDK

MTM API: User Management

MTM stands for Multi-Tenancy Manager. It is a central service of LeanIX to manage workspaces and user accounts. It also provides OAuth2 endpoints for authentication of users.

Main resources:

  • Accounts
  • Contracts
  • Workspaces
  • Users
  • Permissions

Endpoint : <base_url>/services/mtm/v1, e.g. https://app.leanix.net/services/mtm/v1
Swagger API Reference
Swagger JSON

Webhooks API: Event Subscriptions

Webhooks allow you to receive information about events as they happen in near real-time in LeanIX. You can then extend, customize, and integrate LeanIX with your own extensions or even with other applications.

Main resources:

  • Subscriptions

Endpoint : <base_url>/services/webhooks/v1, e.g. https://app.leanix.net/services/webhooks/v1
Getting started - Webhooks
Swagger API Reference
Swagger JSON

Metrics API: Real-time Data

The Metrics add-on allows you to store time-series data in LeanIX. This data can come from various sources, which are relevant to Business, Development or Operations.

Main resources:

  • Measurements
  • Points
  • Series

Endpoint : <base_url>/services/metrics/v1, e.g. https://app.leanix.net/services/metrics/v1
Swagger API Reference
Swagger JSON
Java SDK

Poll API: Custom Surveys

With the Survey add-on, admins can design own questionnaires in LeanIX which they send out to get the answers of users. The results of the surveys are displayed in context of LeanIX and can be accessed via the API.

Main resources:

  • Polls
  • PollRuns
  • PollResults

Endpoint : <base_url>/services/poll/v2, e.g. https://app.leanix.net/services/poll/v2
Swagger API Reference
Swagger JSON

Available APIs


Here we provide an overview of the different LeanIX APIs and SDKs.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.