Retrieves a paginated list of all endpoints with optional filtering criteria using the Rapida API.
Parameters
Configuration for the client connection.
request
GetAllEndpointRequest
required
Pagination configuration for the request.
The page number to retrieve (0-based indexing).
Number of endpoints to return per page.
Optional array of filtering criteria to apply to the endpoint search.
The field name to filter by.
The value to match against the specified key.
The logic operator for the criteria. Accepted values: “should” | “must”
Usage
from rapida import (
ConnectionConfig,
GetAllEndpointRequest,
get_all_endpoint
)
from pprint import pprint
connection_config = ConnectionConfig.default_connection_config(
ConnectionConfig.with_sdk("{your-rapida-api-key}")
)
response = get_all_endpoint(
client_cfg=connection_config,
request=GetAllEndpointRequest(
paginate=Paginate(page=0, pageSize=20),
criterias=[Criteria(key="KEY", value="VALUE", logic="should")],
),
)
pprint(response)
Response
Numeric status code for the operation.
Indicates whether the operation was successful.
Array of endpoint objects returned by the request.
Unique identifier for the endpoint.
Operational status of the endpoint.
Visibility status of the endpoint.
Identifier mapping to the endpoint’s source.
Associated project identifier.
Associated organization identifier.
Model identifier tied to the endpoint provider.
Selected language configuration for the endpoint.
Name assigned to the endpoint.
Description of the endpoint’s purpose.
Timestamp of endpoint creation.
Timestamp of last endpoint update.
Identifier of the creator.
Identifier of the last updater.
Error information, if applicable.
Machine-readable error code.
Pagination information for the response.
Total number of endpoints available.
Total number of pages available.
Current page number (0-based).
Number of items per page.
Indicates if there are more pages available.
Indicates if there are previous pages available.
