> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.itential.com/itential-cloud/api-reference/guidesintegration-api-routes/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server.

# Integration API routes

> How Itential Platform automatically creates integration API routes from OpenAPI document paths.

This feature was removed in the 2023.2 release. Refer to the [Breaking Change](/itential-platform/2023-2/release-notes/breaking-changes/integration-api-routes-removed) notification for details.

Itential Platform automatically creates integration API routes for all paths listed in an integration model. This allows you to use Itential Platform as a gateway for the routes defined in the OpenAPI (OAPI) document.

## Route example

When Itential Platform creates a route for an integration, it uses the name of the integration service and the `operationId` from the OAPI document. Using a GitHub OAPI document as an example, consider the following path object (response definitions removed for brevity):

```json
"/emojis": {
  "get": {
    "summary": "Emojis_GET",
    "description": "Lists all the emojis available to use on GitHub.",
    "operationId": "Emojis_GET",
    "parameters": [
      {
        "name": "Accept",
        "in": "header",
        "description": "Is used to set specified media type.",
        "style": "simple",
        "schema": {
          "type": "string"
        }
      }
    ],
    "deprecated": false
  }
}
```

Itential Platform creates a route based on the integration name and the `operationId`. If you name the integration `MyGitHub`,Itential Platform creates the following route for `/emojis`:

```
http://<IAP base path>/MyGitHub/Emojis_GET
```

## Reference

You can view the routes created by Itential Platform on the **Help Desk** page under **Adapter/Integration API**. Navigate to the menu icon on the left, select **Help**, then click the **View Documentation** button under **Adapter/Integration API**.

```
http://<IAP base path>/help
```

![](/_fern-img/e05b2dea1ed827c66d7da1e95a0f957071c5e1f1b60a69659272e8ce3aea5968.webp)

You can view detailed information about the OAPI document under the **Integration Models** section of **Admin Essentials**.

![](/_fern-img/f30e0e3b4c757d4110c6b817a2b8bf8eb44d58aa7fe975f0c23d4972b180d851.webp)

Click the name of the integration model and Itential Platform will render all the information contained in the OAPI document in the right panel.

## Other uses

Exposed integration routes can also be used in JSON Forms validation in the same manner as application routes. Find your base URL and API route in the dropdowns.

![](/_fern-img/f088c96274ead7d701429bb1f1d721d454e2cd9a77a6be9f3cbd464baad63997.webp)

> How Itential Platform automatically creates integration API routes from OpenAPI document paths.