Censys
Censys is an internet intelligence and attack surface management platform that continuously scans the public IPv4 space, IPv6 announced ranges, and the global certificate transparency ecosystem to produce a comprehensive public dataset of internet-connected hosts, services, certificates, and web properties. The Censys Platform exposes this data through a unified REST API supporting host/web/certificate search, collections, threat hunting, adversary investigation, asset graph traversal, and supply-chain intelligence — making it a primary alternative to Shodan for security researchers, SOC teams, threat hunters, and attack-surface management programs.
2 APIs
11 Features
SecurityInternet IntelligenceAttack Surface ManagementThreat HuntingCyber Threat IntelligenceOSINTInternet ScanningCertificatesAsset Discovery
Global Internet Asset Index
Continuously refreshed host, service, certificate, and web-property dataset spanning the public IPv4 space, announced IPv6 ranges, and the global Certificate Transparency log ecosystem.
Censys Query Language (CenQL)
Unified, expressive query language used across hosts, certificates, and web properties — replaces the legacy Censys Search Language (CSL).
Collections
Saved asset groupings that can be queried, aggregated, and monitored with events, webhooks, and email notifications.
Threat Hunting (CensEye)
Automated pivot engine that hunts adversary infrastructure across host endpoints, fingerprints, certificates, and threats with on-demand discovery scans.
Adversary Investigation
Certificate-to-host and host-to-endpoint pivots, value-count enrichment, and live re-scan endpoints purpose-built for investigating malicious infrastructure.
Asset Graph
Graph-based attack surface composition — define seeds, build graphs, page through assets/edges, manage exclusions, and read per-asset risks.
Supply Chain Intelligence
Track third-party supplier exposure and supply-chain risk against the Censys asset dataset.
Account Management
Organization, membership, invitation, audit-log, credit, and per-user credit-usage APIs for tenant administration.
Tags and Comments
First-class annotation surface for tagging and commenting on assets across the platform.
Integrations (Splunk, SOAR, Google SecOps, Maltego, recon-ng, nmap)
Official connectors and community tooling for the major SOC / threat-intel ecosystems.
Legacy Search and ASM Compatibility
Censys Search v1/v2 and Censys ASM APIs remain available during the migration window; ASM endpoints are not deprecated.
External Attack Surface Management
Discover unknown assets, monitor exposure, and prioritize risk across an organization's internet-facing footprint.
Threat Hunting
Pivot across certificates, services, and endpoints to track adversary infrastructure with CensEye-driven discovery scans.
Adversary Investigation
Investigate IPs, certificates, and hosts associated with known malicious activity; rescan suspect infrastructure on demand.
SOC Triage and Enrichment
Enrich alerts in Splunk / SOAR / Google SecOps with Censys host, service, and certificate context.
Vulnerability Discovery
Identify exposed services, deprecated TLS versions, and known-vulnerable software footprints at internet scale.
Certificate Inventory
Search the certificate-transparency-backed corpus for organizational PKI inventory and rogue/expired cert detection.
Subdomain and Asset Discovery
Enumerate subdomains and related assets via certificate, DNS, and IP-graph pivots.
Supply Chain Risk
Track supplier exposure and weak links across third-party internet-facing assets.
Academic and Internet Measurement Research
Long-running Censys research mission supporting peer-reviewed internet-scale measurement studies.
Splunk
Censys Splunk Add-on and Apps for SIEM enrichment and dashboards.
Splunk SOAR
Censys SOAR connector for automated response playbooks.
Google SecOps (Chronicle)
Censys Google SecOps dashboard for SOC operations on Chronicle.
Microsoft Sentinel
Documented integration path for ingesting Censys data into Sentinel.
Maltego
Censys Maltego transforms for graph-based investigations.
recon-ng
Censys modules for the recon-ng reconnaissance framework.
nmap
NSE script that leverages Censys data for passive recon.
AWS / Azure / GCP
Censys Unified Cloud Connector pulls cloud-native asset inventory into Censys ASM.
Jira and ServiceNow
ASM ticketing/workflow integrations for asset and risk remediation tracking.
Postman
Censys-published Postman collections for Search and ASM APIs.
Censys Platform
Unified next-gen Censys interface for search, collections, threat hunting, and asset graph traversal.
Censys Attack Surface Management (ASM)
Continuous external attack-surface monitoring with risk scoring, integrations, and remediation workflows.
Censys Threat Hunting
Advanced pivoting, CensEye automation, Censys Threat Dataset, and on-demand scanning for proactive infrastructure hunting.
Censys Search (Legacy)
Original search.censys.io interface — Search v1/v2 APIs being migrated to the Platform API.
opencollection: 1.0.0
info:
name: Censys Platform API
version: 1.0.103
items:
- info:
name: Supply Chain Intelligence
type: folder
items:
- info:
name: Censys List Supply Chains
type: http
http:
method: GET
url: https://api.platform.censys.io/v1/supplychains
headers:
- name: X-Organization-ID
value: 11111111-2222-3333-4444-555555555555
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: query
description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: page_size
value: ''
type: query
description: Maximum number of supply chains to return per page.
- name: page_token
value: ''
type: query
description: Pagination token from a previous response to retrieve the next page of results.
auth:
type: bearer
token: '{{bearerToken}}'
docs: Returns a paginated list of supply chain IDs for the organization.<br><br>This endpoint does not cost credits to
execute.
- info:
name: Censys Search Suppliers
type: http
http:
method: GET
url: https://api.platform.censys.io/v1/supplychains/suppliers
headers:
- name: X-Organization-ID
value: 11111111-2222-3333-4444-555555555555
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: query
description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: keywords
value: Anthropic
type: query
description: Search keywords matched against supplier display names.
auth:
type: bearer
token: '{{bearerToken}}'
docs: Search for suppliers by display name keywords. Results are capped and not paginated.<br><br>This endpoint does not
cost credits to execute.
- info:
name: Censys Adds Supplier to Supply Chain
type: http
http:
method: POST
url: https://api.platform.censys.io/v1/supplychains/suppliers
headers:
- name: X-Organization-ID
value: 11111111-2222-3333-4444-555555555555
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: query
description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Add a list of suppliers to the specific supply chain.
- info:
name: Censys Remove a Supplier from a Supply Chain
type: http
http:
method: DELETE
url: https://api.platform.censys.io/v1/supplychains/suppliers/:supplier_id
headers:
- name: X-Organization-ID
value: 11111111-2222-3333-4444-555555555555
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: query
description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: supplier_id
value: 11111111-2222-3333-4444-555555555555
type: path
description: The ID of a Censys supplier to remove from the given supply chain.
- name: supply_chain_id
value: 11111111-2222-3333-4444-555555555555
type: query
description: The ID of a Censys supply chain.
auth:
type: bearer
token: '{{bearerToken}}'
docs: Remove a supplier from the specified supply chain.
- info:
name: Account Management
type: folder
items:
- info:
name: Censys Get Organization Details
type: http
http:
method: GET
url: https://api.platform.censys.io/v3/accounts/organizations/:organization_id
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: path
description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: include_member_counts
value: ''
type: query
description: Whether to include how many members are in this organization, split by role.
auth:
type: bearer
token: '{{bearerToken}}'
docs: Retrieve an organization's details, including the count of organization members broken down by role and organization
settings such as AI training and MFA requirements.<br><br>This endpoint does not cost any credits to execute.
- info:
name: Censys List Audit Log Events
type: http
http:
method: GET
url: https://api.platform.censys.io/v3/accounts/organizations/:organization_id/audit-log-events
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: path
description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: page_size
value: '1'
type: query
description: Amount of events to return per page.
- name: page_token
value: ''
type: query
description: Page token for the requested page of audit log events.
- name: start_time
value: '2026-01-01T00:00:00Z'
type: query
description: Only return events that occurred after this time. This value must be on or after 2026-01-01T00:00:00Z.
If not provided, will default to the earliest possible date.
- name: end_time
value: '2026-02-01T00:00:00Z'
type: query
description: Only return events that occurred before this time. This value must not be in the future. If not provided,
it defaults to the current time.
- name: event_type
value: ''
type: query
description: Only return events of this type. This field is deprecated and will be removed in a future version. Use
event_types instead.
- name: event_types
value: user_login,pat_created
type: query
description: Only return events of these types.
- name: exclude_event_types
value: user_login,pat_created
type: query
description: Exclude events of these types.
- name: user_email
value: user@example.com
type: query
description: Only return events performed by this user.
- name: order_by
value: ''
type: query
description: Order events by this field.
auth:
type: bearer
token: '{{bearerToken}}'
docs: Retrieve audit log events for an organization. Use query parameters to filter events by time range, user, and event
type.<br><br>This endpoint does not cost any credits to execute.
- info:
name: Censys Get Organization Credit Balance
type: http
http:
method: GET
url: https://api.platform.censys.io/v3/accounts/organizations/:organization_id/credits
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: path
description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
auth:
type: bearer
token: '{{bearerToken}}'
docs: Retrieve credit balance and expiration information for an organization. <br><br>Credits expire 12 months after they
are acquired.<br><br>This endpoint does not cost any credits to execute.
- info:
name: Censys Get Organization Credit Usage
type: http
http:
method: GET
url: https://api.platform.censys.io/v3/accounts/organizations/:organization_id/credits/usage
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: path
description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: date
value: '2025-11-01'
type: query
description: The date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-06). This field is deprecated
and will be removed in a future version. Use start_date and end_date instead. The date must be on or after 2025-01-01
(the earliest date available for credit usage reports).
- name: start_date
value: '2025-11-01'
type: query
description: The start date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-01). Must be on or after
2025-01-01 (the earliest date available for credit usage reports).
- name: end_date
value: '2025-12-01'
type: query
description: The end date for the credit usage report in YYYY-MM-DD format (e.g., 2025-12-01). If omitted, will default
to today's date. The date range (end_date - start_date) cannot exceed 365 days (1 year).
- name: granularity
value: daily
type: query
description: Whether to break down credit usage on a daily or monthly basis.
- name: include_consumer_breakdown
value: ''
type: query
description: Whether to include a breakdown of individual users' consumption in the credit usage report.
auth:
type: bearer
token: '{{bearerToken}}'
docs: Retrieve credit information for an organization over a specific date range. You must include a start date in your
request.<br><br>Admins can obtain credit usage information for all users in their organization. Members may only retrieve
usage information for their own account.<br><br>This endpoint does not cost any credits to execute.
- info:
name: Censys Invite User to Organization
type: http
http:
method: POST
url: https://api.platform.censys.io/v3/accounts/organizations/:organization_id/invitations
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: path
description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Invite a user to an organization. The user will receive an email to join the organization. This is equivalent to
[adding a new member via the UI](https://docs.censys.com/docs/platform-org-management#invite-members).<br><br>Only users
with the Admin role in the provided organization can perform this operation.<br><br>This endpoint does not cost any
credits to execute.
- info:
name: Censys List Organization Members
type: http
http:
method: GET
url: https://api.platform.censys.io/v3/accounts/organizations/:organization_id/members
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: path
description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: page_size
value: ''
type: query
description: Number of members to return per page
- name: page_token
value: ''
type: query
description: Pagination token for retrieving the next page of results
auth:
type: bearer
token: '{{bearerToken}}'
docs: Retrieve a paginated list of an organization's members and their user details, including their user ID, email, name,
creation time, and roles.<br><br>This endpoint does not cost any credits to execute.
- info:
name: Censys Update a Member's Roles in an Organization
type: http
http:
method: PATCH
url: https://api.platform.censys.io/v3/accounts/organizations/:organization_id/members/:user_id
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: path
description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: user_id
value: 11111111-2222-3333-4444-555555555555
type: path
description: The ID of a Censys user. You can obtain a user's ID by listing members of an organization.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Update the roles assigned to an organization member. This operation replaces a member's roles with the list provided
in the request body. To remove all roles from a member, provide an empty list. To completely remove a member from an
organization, use the [remove member endpoint](https://docs.censys.com/reference/v3-accountmanagement-remove-org-member).<br><br>Only
users with the Admin role in the provided organization can perform this operation.<br><br>This endpoint does not cost
any credits to
- info:
name: Censys Remove Member from Organization
type: http
http:
method: DELETE
url: https://api.platform.censys.io/v3/accounts/organizations/:organization_id/members/:user_id
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: path
description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: user_id
value: 11111111-2222-3333-4444-555555555555
type: path
description: The ID of a Censys user. You can obtain a user's ID by listing members of an organization.
auth:
type: bearer
token: '{{bearerToken}}'
docs: Remove a user from an organization. This is equivalent to [removing a member via the UI](https://docs.censys.com/docs/platform-org-management#remove-members).<br><br>Only
users with the Admin role in the provided organization can perform this operation.<br><br>This endpoint does not cost
any credits to execute.
- info:
name: Censys Get Organization Member Credit Usage
type: http
http:
method: GET
url: https://api.platform.censys.io/v3/accounts/organizations/:organization_id/members/:user_id/credits/usage
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: path
description: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: user_id
value: 11111111-2222-3333-4444-555555555555
type: path
description: The ID of a Censys user. You can obtain a user's ID by listing members of an organization.
- name: date
value: '2025-11-01'
type: query
description: The date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-06). This field is deprecated
and will be removed in a future version. Use start_date and end_date instead. The date must be on or after 2025-01-01
(the earliest date available for credit usage reports).
- name: start_date
value: '2025-11-01'
type: query
description: The start date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-01). Must be on or after
2025-01-01 (the earliest date available for credit usage reports).
- name: end_date
value: '2025-12-01'
type: query
description: The end date for the credit usage report in YYYY-MM-DD format (e.g., 2025-12-01). If omitted, will default
to today's date. The date range (end_date - start_date) cannot exceed 365 days (1 year).
- name: granularity
value: daily
type: query
description: Whether to break down credit usage on a daily or monthly basis.
auth:
type: bearer
token: '{{bearerToken}}'
docs: Retrieve credit consumption information for an organization member over a specific date range. You must include
a start date in your request.<br><br>This endpoint does not cost any credits to execute.
- info:
name: Censys Get Free User Credit Balance
type: http
http:
method: GET
url: https://api.platform.censys.io/v3/accounts/users/credits
auth:
type: bearer
token: '{{bearerToken}}'
docs: Retrieve your Free user account credit balance and refresh information. To retrieve the credit balance for a Starter
or Enterprise account, use the [get organization credit balance endpoint](https://docs.censys.com/reference/v3-accountmanagement-org-credits).<br><br>This
endpoint does not cost any credits to execute.
- info:
name: Censys Get Free User Credit Usage
type: http
http:
method: GET
url: https://api.platform.censys.io/v3/accounts/users/credits/usage
params:
- name: date
value: '2025-11-01'
type: query
description: The date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-06). This field is deprecated
and will be removed in a future version. Use start_date and end_date instead. The date must be on or after 2025-01-01
(the earliest date available for credit usage reports).
- name: start_date
value: '2025-11-01'
type: query
description: The start date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-01). Must be on or after
2025-01-01 (the earliest date available for credit usage reports).
- name: end_date
value: '2025-12-01'
type: query
description: The end date for the credit usage report in YYYY-MM-DD format (e.g., 2025-12-01). If omitted, will default
to today's date. The date range (end_date - start_date) cannot exceed 365 days (1 year).
- name: granularity
value: daily
type: query
description: Whether to break down credit usage on a daily or monthly basis.
auth:
type: bearer
token: '{{bearerToken}}'
docs: Retrieve your Free user account credit consumption information over a specific date range. You must include a start
date in your request.<br><br>This endpoint does not cost any credits to execute.
- info:
name: Collections
type: folder
items:
- info:
name: Censys List Collections
type: http
http:
method: GET
url: https://api.platform.censys.io/v3/collections
headers:
- name: X-Organization-ID
value: 11111111-2222-3333-4444-555555555555
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: query
description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: page_token
value: ''
type: query
description: page token for the requested page of collection results
- name: page_size
value: '1'
type: query
description: amount of results to return per page
- name: collection_statuses
value: populating,active
type: query
description: statuses of collection for results to be filtered on.
auth:
type: bearer
token: '{{bearerToken}}'
docs: List all collections for an organization. Retrieved information includes collection ID, name, query, description,
status, and asset count.<br><br>This endpoint does not cost credits to execute.
- info:
name: Censys Create a Collection
type: http
http:
method: POST
url: https://api.platform.censys.io/v3/collections
headers:
- name: X-Organization-ID
value: 11111111-2222-3333-4444-555555555555
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: query
description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Create a new collection.<br><br>This endpoint does not cost credits to execute.
- info:
name: Censys Get a Collection
type: http
http:
method: GET
url: https://api.platform.censys.io/v3/collections/:collection_uid
headers:
- name: X-Organization-ID
value: 11111111-2222-3333-4444-555555555555
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: query
description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: collection_uid
value: 11111111-2222-3333-4444-555555555555
type: path
description: The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/)
or via the collection URL when using the web console.
auth:
type: bearer
token: '{{bearerToken}}'
docs: Retrieve information about a collection. Retrieved information includes its name, query, description, status, and
asset count.<br><br>This endpoint does not cost credits to execute.
- info:
name: Censys Update a Collection
type: http
http:
method: PUT
url: https://api.platform.censys.io/v3/collections/:collection_uid
headers:
- name: X-Organization-ID
value: 11111111-2222-3333-4444-555555555555
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: query
description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: collection_uid
value: 11111111-2222-3333-4444-555555555555
type: path
description: The UID for the collection
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Update a collection's name, description, and/or query.<br><br>This endpoint does not cost credits to execute.
- info:
name: Censys Delete a Collection
type: http
http:
method: DELETE
url: https://api.platform.censys.io/v3/collections/:collection_uid
headers:
- name: X-Organization-ID
value: 11111111-2222-3333-4444-555555555555
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: query
description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: collection_uid
value: 11111111-2222-3333-4444-555555555555
type: path
description: The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/)
or via the collection URL when using the web console.
auth:
type: bearer
token: '{{bearerToken}}'
docs: Delete a collection.<br><br>This endpoint does not cost credits to execute.
- info:
name: Censys Get a Collection's Events
type: http
http:
method: GET
url: https://api.platform.censys.io/v3/collections/:collection_uid/events
headers:
- name: X-Organization-ID
value: 11111111-2222-3333-4444-555555555555
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: query
description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: collection_uid
value: 11111111-2222-3333-4444-555555555555
type: path
description: The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/)
or via the collection URL when using the web console.
- name: page_size
value: '1'
type: query
description: Amount of results to return per page.
- name: page_token
value: ''
type: query
description: Page token for the requested page of collection results.
- name: change_types
value: ''
type: query
description: Change types
- name: asset_change_types
value: ''
type: query
description: Asset change types
- name: status_change_types
value: ''
type: query
description: Status change types
- name: start_time
value: '2025-01-01T00:00:00Z'
type: query
description: Start time of the host timeline
- name: end_time
value: '2025-01-02T00:00:00Z'
type: query
description: End time of the host timeline
auth:
type: bearer
token: '{{bearerToken}}'
docs: Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection
status changes.<br><br>This endpoint does not cost credits to execute.
- info:
name: Censys Aggregate Results for a Search Query Within a Collection
type: http
http:
method: POST
url: https://api.platform.censys.io/v3/collections/:collection_uid/search/aggregate
headers:
- name: X-Organization-ID
value: 11111111-2222-3333-4444-555555555555
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: query
description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: collection_uid
value: 11111111-2222-3333-4444-555555555555
type: path
description: The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/)
or via the collection URL when using the web console.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Aggregate results for a Platform search query that targets a collection's assets. This functionality is equivalent
to the [Report Builder](https://docs.censys.com/docs/platform-report-builder#/) in the Platform web UI.
- info:
name: Censys Run a Search Query Within a Collection
type: http
http:
method: POST
url: https://api.platform.censys.io/v3/collections/:collection_uid/search/query
headers:
- name: X-Organization-ID
value: 11111111-2222-3333-4444-555555555555
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: query
description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: collection_uid
value: ''
type: path
description: The UID for the collection
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Run a search query across a collection's assets. Reference the [documentation on Censys Query Language](https://docs.censys.com/docs/censys-query-language#/)
for information about query syntax. Host services that match your search criteria will be returned in a `matched_services`
object.
- info:
name: Tags and Comments
type: folder
items:
- info:
name: Censys List Comments
type: http
http:
method: GET
url: https://api.platform.censys.io/v3/comments
headers:
- name: X-Organization-ID
value: 11111111-2222-3333-4444-555555555555
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: query
description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
- name: page_size
value: ''
type: query
description: Number of comments to return per page.
- name: page_token
value: ''
type: query
description: Pagination token from a previous response to retrieve the next page of results.
- name: order_by
value: ''
type: query
description: 'Sort order. Supported values: create_time_asc, create_time_desc.'
- name: asset_id
value: ''
type: query
description: Filter comments by asset identifier (host IP, certificate fingerprint, or web property hostname:port).
- name: created_by
value: ''
type: query
description: Filter comments by the user ID of the user who created the comment.
- name: created_before
value: ''
type: query
description: Filter comments created before this RFC3339 timestamp.
- name: created_after
value: ''
type: query
description: Filter comments created after this RFC3339 timestamp.
auth:
type: bearer
token: '{{bearerToken}}'
docs: Retrieve a paginated list of comments in your organization. Use query parameters to filter by asset, creator, or
creation time.<br><br>This endpoint does not cost any credits to execute.
- info:
name: Censys Create a Comment
type: http
http:
method: POST
url: https://api.platform.censys.io/v3/comments
headers:
- name: X-Organization-ID
value: 11111111-2222-3333-4444-555555555555
params:
- name: organization_id
value: 11111111-2222-3333-4444-555555555555
type: query
description: The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional)
for more information.
body:
type: json
data: '{}'
auth:
type: bearer
token: '{{bearerToken}}'
docs: Add a comment on an asset in your organization.<br><br>This endpoint does not cost any credits to execute.
- info:
name: Censys Update a Comment
type: http
http:
method: PUT
url: https://api.platform.censys.io/v3/c
# --- truncated at 32 KB (102 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/censys/refs/heads/main/apis.yml
