burpa._api_base.ApiBase

class documentation

class ApiBase: (source)

Known subclasses: burpa.BurpCommander, burpa.BurpRestApiClient

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: Optional[Dict[str, Any]] = None, **kwargs: Union[str, List[Any], Tuple[Any, ...], Dict[str, Any]]) -> requests.Response: (source) ¶

Parameters
request:`str`	Name keyword corresponding to the request name in `PARAMS` mapping.
requestargs:`Optional[Dict[str, Any]]`	Arguments to pass to `requests.request`.
**kwargs:`Union[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.Response`	Undocumented

PARAMS: Dict[str, Tuple[str, Union[str, Template], Union[str, Template, None]]] = (source) ¶

overridden in burpa.BurpCommander, burpa.BurpRestApiClient

Undocumented

Value

{}

@property
proxy_uri: str = (source) ¶

overridden in burpa.BurpCommander, burpa.BurpRestApiClient

Undocumented

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

Undocumented

def _serialize_request_kwargs(self, kwargs: Dict[str, Union[str, List[Any], Tuple[Any, ...], Dict[str, Any]]]) -> Dict[str, str]: (source) ¶

Undocumented

_logger: logging.Logger = (source) ¶

overridden in burpa.BurpCommander, burpa.BurpRestApiClient

Undocumented