Skip to content

delete_rest_api

Operation

delete_rest_api

delete_rest_api(request: DeleteRestApiInput | DeleteRestApiInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteRestApiInputDict]) -> DeleteRestApiOutput

Deletes the specified API.

Parameters:

Name Type Description Default
request DeleteRestApiInput | DeleteRestApiInputDict | 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[DeleteRestApiInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteRestApiOutput

An instance of DeleteRestApiOutput.

delete_rest_api async

delete_rest_api(request: DeleteRestApiInput | DeleteRestApiInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteRestApiInputDict]) -> DeleteRestApiOutput

Deletes the specified API.

Parameters:

Name Type Description Default
request DeleteRestApiInput | DeleteRestApiInputDict | 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[DeleteRestApiInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteRestApiOutput

An instance of DeleteRestApiOutput.

Input

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

DeleteRestApiInputDict

Bases: TypedDict

Dictionary form of DeleteRestApiInput.

Attributes

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

DeleteRestApiInput dataclass

Bases: _SerdeShape

Request to delete the specified API from your collection.

Attributes

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

The string identifier of the associated RestApi.

Output

DeleteRestApiOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteRestApiOutput 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.