censys.asm package¶
An easy-to-use and lightweight API wrapper for Censys ASM (censys.io).
- class censys.asm.AsmClient(api_key: Optional[str] = None, **kwargs)[source]¶
Bases:
object
Client ASM API class.
- Parameters
api_key (str) – Optional; The API Key provided by Censys.
**kwargs – Arbitrary keyword arguments.
- class censys.asm.Assets(asset_type: str, *args, **kwargs)[source]¶
Bases:
censys.asm.api.CensysAsmAPI
Assets API class.
- Parameters
asset_type (str) – Type of asset to interact with.
*args – Variable length argument list.
**kwargs – Arbitrary keyword arguments.
- add_comment(asset_id: str, comment: str) → dict[source]¶
Adds a comment to a specified asset on the ASM platform.
- add_tag(asset_id: str, name: str, color: Optional[str] = None) → dict[source]¶
Adds a tag to a specified asset on the ASM platform.
- delete_tag(asset_id: str, name: str) → dict[source]¶
Deletes a tag from a specified asset on the ASM platform by tag name.
- get_assets(page_number: int = 1, page_size: Optional[int] = None) → Iterator[dict][source]¶
Requests assets data.
- get_comment_by_id(asset_id: str, comment_id: int) → dict[source]¶
Requests a comment on a specified asset by comment ID.
- class censys.asm.CertificatesAssets(*args, **kwargs)[source]¶
Bases:
censys.asm.assets.assets.Assets
Certificates Assets API class.
- Parameters
*args – Variable length argument list.
**kwargs – Arbitrary keyword arguments.
- class censys.asm.Clouds(api_key: Optional[str] = None, **kwargs)[source]¶
Bases:
censys.asm.api.CensysAsmAPI
Clouds API class.
- base_path = 'clouds'¶
- get_domain_counts(since: Union[str, datetime.date, datetime.datetime]) → dict[source]¶
Retrieve domain counts by cloud.
- Parameters
since (Since) – Date to include domains from.
- Returns
Domain count result.
- Return type
- get_host_counts(since: Union[str, datetime.date, datetime.datetime]) → dict[source]¶
Retrieve host counts by cloud.
Hosts found after the date provided in the since parameter will be included in the new asset counts.
- Parameters
since (Since) – Date to include hosts from.
- Returns
Host count result.
- Return type
- get_object_store_counts(since: Union[str, datetime.date, datetime.datetime]) → dict[source]¶
Retrieve object store counts by cloud.
- Parameters
since (Since) – Date to include object stores from.
- Returns
Object store count result.
- Return type
- get_subdomain_counts(since: Union[str, datetime.date, datetime.datetime]) → dict[source]¶
Retrieve subdomain counts by cloud.
- Parameters
since (Since) – Date to include subdomains from.
- Returns
Subdomain count result.
- Return type
- class censys.asm.DomainsAssets(*args, **kwargs)[source]¶
Bases:
censys.asm.assets.assets.Assets
Domains Assets API class.
- Parameters
*args – Variable length argument list.
**kwargs – Arbitrary keyword arguments.
- class censys.asm.Events(api_key: Optional[str] = None, **kwargs)[source]¶
Bases:
censys.asm.api.CensysAsmAPI
Events API class.
- base_path = 'logbook'¶
- get_cursor(start: Optional[Union[datetime.datetime, int]] = None, filters: Optional[List[str]] = None) → str[source]¶
Requests a logbook cursor.
- Parameters
start ([datetime.datetime, int]) – Optional; Timestamp or event ID to begin searching.
filters (list) – Optional; List of filters applied to logbook search results.
- Returns
Cursor result.
- Return type
- class censys.asm.HostsAssets(*args, **kwargs)[source]¶
Bases:
censys.asm.assets.assets.Assets
Hosts Assets API class.
- Parameters
*args – Variable length argument list.
**kwargs – Arbitrary keyword arguments.
- class censys.asm.Seeds(api_key: Optional[str] = None, **kwargs)[source]¶
Bases:
censys.asm.api.CensysAsmAPI
Seeds API class.
- base_path = 'seeds'¶
censys.asm.api module¶
Base for interacting with the Censys ASM API.
- class censys.asm.api.CensysAsmAPI(api_key: Optional[str] = None, **kwargs)[source]¶
Bases:
censys.common.base.CensysAPIBase
This is the base class for ASM’s Seeds, Assets, and Events classes.
- Parameters
api_key (str) – Optional; The API Key provided by Censys.
**kwargs – Arbitrary keyword arguments.
- Raises
CensysException – Base Exception Class for the Censys API.