deleteApiKey method

Future<DeleteApiKeyResponse> deleteApiKey({
  1. required String key,
  2. RequestOptions? requestOptions,
})

Deletes the API key.

Required API Key ACLs:

  • admin

Parameters:

  • key API key.
  • requestOptions additional request configuration.

Implementation

Future<DeleteApiKeyResponse> deleteApiKey({
  required String key,
  RequestOptions? requestOptions,
}) async {
  assert(
    key.isNotEmpty,
    'Parameter `key` is required when calling `deleteApiKey`.',
  );
  final request = ApiRequest(
    method: RequestMethod.delete,
    path: r'/1/keys/{key}'
        .replaceAll('{' r'key' '}', Uri.encodeComponent(key.toString())),
  );
  final response = await _retryStrategy.execute(
    request: request,
    options: requestOptions,
  );
  return deserialize<DeleteApiKeyResponse, DeleteApiKeyResponse>(
    response,
    'DeleteApiKeyResponse',
    growable: true,
  );
}