API Reference

Run a search query within a collection

post
https://api.platform.censys.io/v3/collections//search/query

Run a search query across a collection's assets. Reference the documentation on Censys Query Language for information about query syntax. Host services that match your search criteria will be returned in a matched_services object.

Path Params
string
required

The UID for the collection

Body Params
fields
array of strings | null

Specify fields to only return in the response. If you provide fields and omit host.services.port, host.services.transport_protocol, and host.services.protocol, then matched_services will not be returned in the response.

fields
int64 | null
≥ 0

Number of results to return to per page. The default and maximum is 100.

string

page token for the requested page of search results

string
required

CenQL query string to search upon

Query Params
uuid
required

The ID of a Censys organization to associate the request with. See the Getting Started docs for more information.

Headers
uuid

The ID of a Censys organization to associate the request with. See the Getting Started docs for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field via the query parameter.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json
Updated 7 months ago