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

# Adapter API routes

> How to define and expose adapter functionality through web API routes in Itential Platform.

Adapter API routes can be defined in the same manner as application routes. This allows you to expose adapter functionality using a web API instead of a task or custom code.

## Route example

Adding the `route` property to a method in the `pronghorn.json` file informs Itential Platform that you would like the route exposed.

For example, if you have an adapter named `HelloWorld`, you can define a route for one of its methods with the following entry in the `pronghorn.json` file:

```json
{
    "name" : "hello",
    "summary" : "Say hello",
    "description" : "Example",
    "input" : [],
    "output" : {
        "type" : "object",
        "name" : "return_data",
        "description" : "A string saying hello back to the user."
    },
    "route" : {
        "verb" : "GET",
        "path" : "/hello"
    },
    "roles" : ["admin"]
}
```

This example tells Itential Platform to define the route `/hello` as the interface for the `hello` method in the `HelloWorld` adapter.

One important difference between applications and adapters when it comes to their API routes is that applications use the `title` property in the `pronghorn.json` file for their base path, whereas adapters use their **service name**. The service name is the name you gave the adapter when creating it. You can view this name in the Admin Essentials application under the **Adapters** dropdown.

![](/_fern-img/4b0eae6c0d07714e241d426a8f9b999dde1e5ba1883e4039f4063087f0542105.webp)

Using the `HelloWorld` adapter as an example: if you added it to Itential Platform with the name `HelloWorldAlpha`, the `hello` method would be accessible at:

```
http://<IAP base path>/HelloWorldAlpha/hello
```

If you added a second `HelloWorld` adapter named `HelloWorldBeta`, the `hello` method would be at:

```
http://<IAP base path>/HelloWorldBeta/hello
```

## Reference

You can view the routes that Itential Platform creates on the **Help Desk** page under **Adapter/Integration API**. Navigate to the icon on the left pane, select **Help** (right side), then click the **View Documentation** button under **Adapter/Integration API**.

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

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

## Other uses

Exposed adapter 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)