The Censys Search API provides functionality for interacting with Censys resources such as Hosts.
There are three main API endpoints that this library provides access to:
- :attr:`search <censys.search.v2.api.CensysSearchAPIv2.search>` - Allows searches against the Hosts index using the same search syntax as the web app.
- :attr:`view <censys.search.v2.api.CensysSearchAPIv2.view>` - Returns the structured data we have about a specific Host, given the resource's natural ID.
- :attr:`aggregate <censys.search.v2.api.CensysSearchAPIv2.aggregate>` - Allows you to view resources as a spectrum based on attributes of the resource, similar to the Report Builder page on the web app.
More details about each option can be found in the Censys API documentation. A list of index fields can be found in the Censys API definitions page.
Python class objects must be initialized for each resource index (Hosts).
- :attr:`CensysHosts <censys.search.v2.CensysHosts>`
- :attr:`CensysCerts <censys.search.v2.CensysCerts>`
Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHosts>` index.
Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHosts>` index.
Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHosts>` index.
Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHosts>` index.
Please note this method is only available only for the CensysHosts index.
Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHosts>` index.
Please note this method is only available only for the CensysHosts index.
Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHosts>` index.
Please note this method is only available only for the CensysHosts index.
Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHosts>` index.
Please note this method is only available only for the CensysHosts index.
Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHosts>` index.
Please note this method is only available only for the CensysCerts index
Below we show an example using the :attr:`CensysCerts <censys.search.v2.CensysCerts>` index.
from censys.search import CensysCerts
c = CensysCerts()
# Fetch a list of events for the specified IP address.
hosts, links = c.get_hosts_by_cert(
"fb444eb8e68437bae06232b9f5091bccff62a768ca09e92eb5c9c2cf9d17c426"
)
print(hosts)Below we show an example using the :attr:`CensysCerts <censys.search.v2.CensysCerts>` index.
from censys.search import CensysCerts
c = CensysCerts()
# Fetch a list of comments for the specified certificate.
comments = c.get_comments(
"fb444eb8e68437bae06232b9f5091bccff62a768ca09e92eb5c9c2cf9d17c426"
)
print(comments)Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHosts>` index.
from censys.search import CensysHosts
h = CensysHosts()
# Add a comment to a host.
comment = h.add_comment("1.1.1.1", "This is a test comment")
print(comment)Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHosts>` index.
from censys.search import CensysHosts
h = CensysHosts()
# Update a comment to a host.
comment = h.update_comment("1.1.1.1", 101, "This is an updated test comment")Below we show an example using the :attr:`CensysCerts <censys.search.v2.CensysCerts>` index.
from censys.search import CensysCerts
c = CensysCerts()
# Delete a comment for a certificate.
c.delete_comment(
"fb444eb8e68437bae06232b9f5091bccff62a768ca09e92eb5c9c2cf9d17c426", 102
)Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHosts>` index.
from censys.search import CensysHosts
h = CensysHosts()
# Fetch a list of all tags.
tags = h.list_all_tags()
print(tags)Below we show an example using the :attr:`CensysCerts <censys.search.v2.CensysCerts>` index.
from censys.search import CensysCerts
c = CensysCerts()
# Create a new tag.
tag = c.create_tag("test-tag")
print(tag)
# Optionally you can specify a color for the tag.
tag = c.create_tag("test-tag", color="#00FF00")
print(tag)Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHosts>` index.
from censys.search import CensysHosts
h = CensysHosts()
# Fetch a tag.
tag = h.get_tag("123")
print(tag)Below we show an example using the :attr:`CensysCerts <censys.search.v2.CensysCerts>` index.
from censys.search import CensysCerts
c = CensysCerts()
# Update a tag.
tag = c.update_tag("123", "test-tag")
print(tag)
# Optionally you can specify a color for the tag.
tag = c.update_tag("123", "test-tag", color="#00FF00")
print(tag)Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHosts>` index.
from censys.search import CensysHosts
h = CensysHosts()
# Delete a tag.
h.delete_tag("123")Below we show an example using the :attr:`CensysCerts <censys.search.v2.CensysCerts>` index.
from censys.search import CensysCerts
c = CensysCerts()
# Fetch a list of tags for a document.
tags = c.list_tags_on_document(
"fb444eb8e68437bae06232b9f5091bccff62a768ca09e92eb5c9c2cf9d17c426"
)
print(tags)Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHosts>` index.
from censys.search import CensysHosts
h = CensysHosts()
# Add a tag to a document.
h.add_tag_to_document("123")Below we show an example using the :attr:`CensysCerts <censys.search.v2.CensysCerts>` index.
from censys.search import CensysCerts
c = CensysCerts()
# Remove a tag from a document.
c.remove_tag_from_document(
"fb444eb8e68437bae06232b9f5091bccff62a768ca09e92eb5c9c2cf9d17c426"
)Please note this method is only available only for the CensysCerts index
Below we show an example using the :attr:`CensysCerts <censys.search.v2.CensysCerts>` index.
from censys.search import CensysCerts
c = CensysCerts()
# Fetch a list of certs with the specified tag.
certs = c.list_certs_with_tag("123")
print(certs)Please note this method is only available only for the CensysHosts index.
Below we show an example using the :attr:`CensysHosts <censys.search.v2.CensysHosts>` index.
from censys.search import CensysHosts
h = CensysHosts()
# Fetch a list of hosts with the specified tag.
hosts = h.list_hosts_with_tag("123")
print(hosts)