get_rest_apis¶

Operation¶

get_rest_apis(input: GetRestApisInput, plugins: list[Plugin] | None = None) -> GetRestApisOutput

Lists the RestApis resources for your collection.

Parameters:

Name	Type	Description	Default
`input`	`GetRestApisInput`	An instance of `GetRestApisInput`.	required
`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`

Returns:

Type	Description
`GetRestApisOutput`	An instance of `GetRestApisOutput`.

The GET request to list existing RestApis defined for your collection.

limit: int | None = None

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

position: str | None = None

The current pagination position in the paged result set.

Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.

items: list[RestApi] | None = None

The current page of elements from this collection.

position: str | None = None

The current pagination position in the paged result set.