Class ApiKeysClient

API keys for a single listener.

Index

Constructors

Methods

Constructors

constructor

new ApiKeysClient(options: ApiKeysClientOptions): ApiKeysClient
Parameters
- options: ApiKeysClientOptions
  The underlying admin client and API-keys path.
Returns ApiKeysClient
- Defined in listeners/api-keys.ts:34

Methods

create

create(options?: RequestOptions): Promise<IssuedAPIKey>
Issues a new API key.

The response carries the one-time secret; it cannot be retrieved again and the operation is not idempotent.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<IssuedAPIKey>
The issued key, including its secret.
- Defined in listeners/api-keys.ts:66

list

list(options?: ListOptions): Promise<Paged<APIKey>>
Lists API keys.
Parameters
- options: ListOptions = {}
  Optional pagination and cancellation signal.
Returns Promise<Paged<APIKey>>
A lazily paginating collection of keys.

Throws
ApiException When the control plane returns a non-success status.
- Defined in listeners/api-keys.ts:48