burpa._api_base.ApiBase

class documentation

class ApiBase: (source)

Known subclasses: burpa.BurpCommander, burpa.BurpRestApiClient

View In Hierarchy

Base class for API wrapper classes that works by storing the API calls in templates.

Method request No summary
Constant PARAMS Undocumented
Property proxy_uri Undocumented
Method _api_request Undocumented
Method _serialize_request_kwargs Undocumented
Class Variable _logger Undocumented
def request(self, request: str, requestargs: dict[str, Any] | None = None, **kwargs: str | list[Any] | tuple[Any, ...] | dict[str, Any]) -> requests.Response: (source)
Parameters
request:strName keyword corresponding to the request name in PARAMS mapping.
requestargs:dict[str, Any] | NoneArguments to pass to requests.request.
**kwargs:str | list[Any] | tuple[Any, ...] | dict[str, Any]Template substitutions. This can be a string, a dict or a list. If it's a dict or a list or tuple, it will be automatically serialized as JSON before getting interpolated with template place holders.
Returns
requests.ResponseUndocumented
PARAMS: dict[str, tuple[str, str | Template, str | Template | None]] = (source)
overridden in burpa.BurpCommander, burpa.BurpRestApiClient

Undocumented

Value
{}
proxy_uri: str = (source)
overridden in burpa.BurpCommander, burpa.BurpRestApiClient

Undocumented

def _api_request(self, http_method: str, url: str, data: dict[str, Any] | None = None, requestargs: dict[str, Any] | None = None) -> requests.Response: (source)

Undocumented

def _serialize_request_kwargs(self, kwargs: dict[str, str | list[Any] | tuple[Any, ...] | dict[str, Any]]) -> dict[str, str]: (source)

Undocumented

_logger: logging.Logger = (source)
overridden in burpa.BurpCommander, burpa.BurpRestApiClient

Undocumented