Skip to content

delete_api_key

Operation

delete_api_key

delete_api_key(request: DeleteApiKeyInput | DeleteApiKeyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteApiKeyInputDict]) -> DeleteApiKeyOutput

Deletes the ApiKey resource.

Parameters:

Name Type Description Default
request DeleteApiKeyInput | DeleteApiKeyInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DeleteApiKeyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteApiKeyOutput

An instance of DeleteApiKeyOutput.

delete_api_key async

delete_api_key(request: DeleteApiKeyInput | DeleteApiKeyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteApiKeyInputDict]) -> DeleteApiKeyOutput

Deletes the ApiKey resource.

Parameters:

Name Type Description Default
request DeleteApiKeyInput | DeleteApiKeyInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DeleteApiKeyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteApiKeyOutput

An instance of DeleteApiKeyOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DeleteApiKeyInputDict

Bases: TypedDict

Dictionary form of DeleteApiKeyInput.

Attributes

api_key instance-attribute
api_key: Required[str]

The identifier of the ApiKey resource to be deleted.

DeleteApiKeyInput dataclass

Bases: _SerdeShape

A request to delete the ApiKey resource.

Attributes

api_key class-attribute instance-attribute
api_key: str | None = ...

The identifier of the ApiKey resource to be deleted.

Output

DeleteApiKeyOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteApiKeyOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.