> For the complete documentation index, see [llms.txt](https://docs.justaname.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.justaname.id/sdk-reference/justaname-core-sdk/interfaces/iroute.md).

# IRoute

[**@justaname.id/sdk**](/sdk-reference/justaname-core-sdk.md) • **Docs**

***

[@justaname.id/sdk](/sdk-reference/justaname-core-sdk/globals.md) / IRoute

## Interface: IRoute\<Request, Response, Headers, Params, OmitParams, ExtraParams>

### Extended by

* [`ApiKeyRoute`](/sdk-reference/justaname-core-sdk/interfaces/apikeyroute.md)
* [`OffchainResolversGetAllRoute`](/sdk-reference/justaname-core-sdk/interfaces/offchainresolversgetallroute.md)
* [`RequestChallengeRoute`](/sdk-reference/justaname-core-sdk/interfaces/requestchallengeroute.md)
* [`VerifyMessageRoute`](/sdk-reference/justaname-core-sdk/interfaces/verifymessageroute.md)
* [`RequestAddMAppPermissionChallengeRoute`](broken://pages/G6C2zEp88yVlFYOwzAZI)
* [`RequestAppendMAppFieldChallengeRoute`](broken://pages/ksf8lfTPSirNDJIG9IKq)
* [`RequestRevokeMAppPermissionChallengeRoute`](broken://pages/GJQJ7GzrTVP4GKQHY3A9)
* [`SubnameAcceptRoute`](/sdk-reference/justaname-core-sdk/interfaces/subnameacceptroute.md)
* [`SubnameAddRoute`](/sdk-reference/justaname-core-sdk/interfaces/subnameaddroute.md)
* [`IsSubnameAvailableRoute`](/sdk-reference/justaname-core-sdk/interfaces/issubnameavailableroute.md)
* [`SubnameGetAllByEnsDomainWithCountRoute`](/sdk-reference/justaname-core-sdk/interfaces/subnamegetallbyensdomainwithcountroute.md)
* [`SubnameGetAllByAddressRoute`](/sdk-reference/justaname-core-sdk/interfaces/subnamegetallbyaddressroute.md)
* [`SubnameGetAllByDomainChainIdRoute`](/sdk-reference/justaname-core-sdk/interfaces/subnamegetallbydomainchainidroute.md)
* [`SubnameGetBySubnameRoute`](/sdk-reference/justaname-core-sdk/interfaces/subnamegetbysubnameroute.md)
* [`SubnameRecordsRoute`](/sdk-reference/justaname-core-sdk/interfaces/subnamerecordsroute.md)
* [`SubnameRejectRoute`](/sdk-reference/justaname-core-sdk/interfaces/subnamerejectroute.md)
* [`SubnameReserveRoute`](/sdk-reference/justaname-core-sdk/interfaces/subnamereserveroute.md)
* [`SubnameRevokeRoute`](/sdk-reference/justaname-core-sdk/interfaces/subnamerevokeroute.md)
* [`SubnameSearchRoute`](/sdk-reference/justaname-core-sdk/interfaces/subnamesearchroute.md)
* [`SubnameUpdateRoute`](/sdk-reference/justaname-core-sdk/interfaces/subnameupdateroute.md)
* [`SubnameGetInvitationsByAddressRoute`](/sdk-reference/justaname-core-sdk/interfaces/subnamegetinvitationsbyaddressroute.md)
* [`AddMAppPermissionRoute`](broken://pages/CQMz2OMwS6NBLeitlnBD)
* [`AppendMAppFieldRoute`](broken://pages/VT2emNChJqlOTQ8nwrQX)
* [`RevokeMAppPermissionRoute`](broken://pages/bHEsEMKSSG63ed22vIlt)

### Type Parameters

• **Request** *extends* [`IRequest`](/sdk-reference/justaname-core-sdk/interfaces/irequest.md) = [`IRequest`](/sdk-reference/justaname-core-sdk/interfaces/irequest.md)

• **Response** *extends* [`IResponse`](/sdk-reference/justaname-core-sdk/interfaces/iresponse.md) = [`IResponse`](/sdk-reference/justaname-core-sdk/interfaces/iresponse.md)

• **Headers** *extends* [`IHeaders`](/sdk-reference/justaname-core-sdk/interfaces/iheaders.md) = [`IHeaders`](/sdk-reference/justaname-core-sdk/interfaces/iheaders.md)

• **Params** *extends* keyof `Request` = `never`

• **OmitParams** *extends* keyof `Request` = `never`

• **ExtraParams** *extends* `Record`<`string`, `any`> = `object`

### Properties

#### headers

> **headers**: `Headers`

**Defined in**

[packages/@justaname.id/sdk/src/lib/types/common/iroute.ts:22](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/sdk/src/lib/types/common/iroute.ts#L22)

***

#### params

> **params**: `Omit`<[`MakeOptionalProps`](/sdk-reference/justaname-core-sdk/type-aliases/makeoptionalprops.md)<`Request`, `Params`>, `OmitParams`> & `ExtraParams`

**Defined in**

[packages/@justaname.id/sdk/src/lib/types/common/iroute.ts:23](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/sdk/src/lib/types/common/iroute.ts#L23)

***

#### request

> **request**: `Request`

**Defined in**

[packages/@justaname.id/sdk/src/lib/types/common/iroute.ts:20](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/sdk/src/lib/types/common/iroute.ts#L20)

***

#### response

> **response**: `Response`

**Defined in**

[packages/@justaname.id/sdk/src/lib/types/common/iroute.ts:21](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/sdk/src/lib/types/common/iroute.ts#L21)

***

#### route

> **route**: `string`

**Defined in**

[packages/@justaname.id/sdk/src/lib/types/common/iroute.ts:24](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/sdk/src/lib/types/common/iroute.ts#L24)