> 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/apikeyroute.md).

# ApiKeyRoute

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

***

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

## Interface: ApiKeyRoute

Represents a route configuration for operations involving API keys. This interface extends `IRoute`, providing a structure for requests and responses related to API keys, as well as specifying the headers required for these operations.

ApiKeyRoute

### Extends

* [`IRoute`](/sdk-reference/justaname-core-sdk/interfaces/iroute.md)

### Properties

#### headers

> **headers**: [`ApiKeyHeaders`](/sdk-reference/justaname-core-sdk/interfaces/apikeyheaders.md)

The required headers for API key operations, specified by the `ApiKeyHeaders` interface.

**Overrides**

[`IRoute`](/sdk-reference/justaname-core-sdk/interfaces/iroute.md).[`headers`](/sdk-reference/justaname-core-sdk/interfaces/iroute.md#headers)

**Defined in**

[packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts:45](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L45)

***

#### params

> **params**: `Omit`<[`MakeOptionalProps`](/sdk-reference/justaname-core-sdk/type-aliases/makeoptionalprops.md)<[`IRequest`](/sdk-reference/justaname-core-sdk/interfaces/irequest.md), `never`>, `never`>

**Inherited from**

[`IRoute`](/sdk-reference/justaname-core-sdk/interfaces/iroute.md).[`params`](/sdk-reference/justaname-core-sdk/interfaces/iroute.md#params)

**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**: `object`

The type of the request data. It is intentionally broad to accommodate various operations related to API keys.

**Overrides**

[`IRoute`](/sdk-reference/justaname-core-sdk/interfaces/iroute.md).[`request`](/sdk-reference/justaname-core-sdk/interfaces/iroute.md#request)

**Defined in**

[packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts:43](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L43)

***

#### response

> **response**: [`ApiKeyResponse`](/sdk-reference/justaname-core-sdk/interfaces/apikeyresponse.md)

The expected response structure for the API key operations, adhering to the `ApiKeyResponse` interface.

**Overrides**

[`IRoute`](/sdk-reference/justaname-core-sdk/interfaces/iroute.md).[`response`](/sdk-reference/justaname-core-sdk/interfaces/iroute.md#response)

**Defined in**

[packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts:44](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts#L44)

***

#### route

> **route**: `string`

**Inherited from**

[`IRoute`](/sdk-reference/justaname-core-sdk/interfaces/iroute.md).[`route`](/sdk-reference/justaname-core-sdk/interfaces/iroute.md#route)

**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)