CEcensys
Collections

Get a collection

Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count. Use it to confirm it still reflects the scope you intend to monitor.<br><br>This endpoint does not cost credits to execute.

get/v3/collections/{collection_uid}

Request

  • Base URL
    https://api.platform.censys.io
  • URL
    https://api.platform.censys.io/v3/collections/{collection_uid}
  • Auth
    HTTP bearer

Path parameters

collection_uidstring uuid required

The UID for the collection. Obtain the collection ID using the list collections endpoint or via the collection URL when using the web console.

Example:11111111-2222-3333-4444-555555555555

Query parameters

organization_idstring uuid required

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

Example:11111111-2222-3333-4444-555555555555

Headers

X-Organization-IDstring 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.

Example:11111111-2222-3333-4444-555555555555

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.