---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / [project-index](../index.md) / IndexedEndpoint

# Interface: IndexedEndpoint

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:71](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L71)

A storefront endpoint (`Controller-Action`).

## Properties

### action

> **action**: `string`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:75](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L75)

***

### cartridge

> **cartridge**: `string`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:78](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L78)

Cartridge that serves the endpoint (leftmost on the cartridge path).

***

### chain?

> `optional` **chain**: [`IndexedMiddleware`](IndexedMiddleware.md)[]

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:90](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L90)

SFRA: the composed middleware chain.

***

### controller

> **controller**: `string`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:74](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L74)

***

### csrf

> **csrf**: `"none"` \| `"middleware"` \| `"in-handler"` \| `"not-applicable"`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:88](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L88)

How CSRF tokens are checked. `none` for endpoints that accept POST without a check.

***

### events?

> `optional` **events**: [`RouteEventListener`](RouteEventListener.md)[]

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:92](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L92)

SFRA: route event listeners registered by the chain, in the order they run.

***

### filters?

> `optional` **filters**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:96](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L96)

SiteGenesis: guard filters.

***

### https

> **https**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:84](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L84)

Whether the endpoint requires HTTPS (SFRA `server.middleware.https`, SiteGenesis `https`, pipeline `secure`).

***

### id

> **id**: `string`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:73](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L73)

`Cart-AddProduct`.

***

### kind

> **kind**: [`EndpointKind`](../type-aliases/EndpointKind.md)

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:76](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L76)

***

### line

> **line**: `number`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:81](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L81)

***

### loginRequired

> **loginRequired**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:86](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L86)

Whether the endpoint requires a logged-in customer.

***

### methods

> **methods**: [`EndpointMethod`](../type-aliases/EndpointMethod.md)[]

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:82](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L82)

***

### public?

> `optional` **public**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:98](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L98)

Pipelines: whether the start node is public (not `call-mode="private"`).

***

### relPath

> **relPath**: `string`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:80](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L80)

File that defines the effective endpoint, relative to its cartridge.

***

### steps?

> `optional` **steps**: [`RouteStep`](RouteStep.md)[]

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:94](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L94)

SFRA: the statements that produced the chain, across cartridges.
