ApiKeyRoute
@justaname.id/sdk • Docs
@justaname.id/sdk / 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
Properties
headers
headers:
ApiKeyHeaders
The required headers for API key operations, specified by the ApiKeyHeaders interface.
Overrides
Defined in
packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts:45
params
params:
Omit<MakeOptionalProps<IRequest,never>,never>
Inherited from
Defined in
packages/@justaname.id/sdk/src/lib/types/common/iroute.ts:23
request
request:
object
The type of the request data. It is intentionally broad to accommodate various operations related to API keys.
Overrides
Defined in
packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts:43
response
response:
ApiKeyResponse
The expected response structure for the API key operations, adhering to the ApiKeyResponse interface.
Overrides
Defined in
packages/@justaname.id/sdk/src/lib/types/api-key/health-check.ts:44
route
route:
string
Inherited from
Defined in
packages/@justaname.id/sdk/src/lib/types/common/iroute.ts:24
Last updated