Create, Delete, or Archive a Collection

Follow the instructions below to create a Collection. You can start the process from two different entry points.

From the Platform Console

1. Go to the Censys Platform and click on Collections in the left-side nav menu.
2. Click Create Collection.
3. Enter a Collection Name.
4. Enter a valid Censys Query that defines the collection membership. A collection may only target one query. Multiple queries or search criteria can be combined using the or operator.

📘

Note

A collection cannot exceed 10,000 assets. A collection cannot be created if its query produces more than 10,000 results.

5. Use the Size Estimator to view the number of assets it currently returns.
6. (Optional) Add a description to explain the purpose of the collection or what it tracks.
7. (Optional) Select a Collection Category. The category field can be used to filter collections and can be displayed in alerts, enhancing triage efficiency.
8. Click Create.

📘

Note

Collections may take a few minutes to populate.

From the Platform Search page

The Create Collection chip is a shortcut next to the search bar that enables you to build a collection from a query you have entered in the search bar. Clicking on the Create Collection chip takes you to the Collection Settings Details Card for a new Collection and pre-populates the query.

1. Go to the Censys Platform and enter a query in the search bar.

2. Click the Create Collection chip. The Create Collection chip appears if the query is valid and returns fewer than 10,000 results.

   

3. Enter a Collection Name.

4. The Collection Query is auto-populated. Use the Size Estimator to view the number of assets it currently returns.

5. Click Create.

6. (Optional) Add a description to explain the purpose of the collection or what it is tracking.

7. (Optional) Select a Collection Category. The category field can be used to filter collections and can be displayed in alerts, enhancing triage efficiency.

8. Click Create.

Edit a collection

You can update a collection's name, query, description, category, and share settings at any time from its Settings page. Follow the steps below to edit a collection.

1. Go to Collections > All Collections.

2. On the Collection Overview Card of the collection you want to update, click the three-dot icon and then select Settings.

   

3. Modify your desired settings and click Update.

Delete a collection

Follow the steps below to delete a collection.

1. Go to Collections > All Collections > select a collection to delete.

2. Click the three-dot menu to the right.

   

3. Review the warning prompt and select Yes, Delete it.

4. Select Delete Collection.

Webhooks

• Webhooks that support events from multiple collections remain. Events from the deleted collection are no longer sent to the destination

Archive a collection

Archive old or unused collections to reduce costs and keep your workspace focused on current projects.

When you archive a collection, all assets, history, webhooks, and alerts are removed, and no new assets can be added. Collection settings (query, collection description, collection category, and collaborators) are preserved, allowing you to reactivate the collection later. After reactivation, the collection will recollect assets and generate events. Archived collections no longer consume credits.

Prerequisites

Only admins and collection creators can archive collections.

Webhooks

• Webhooks supporting events from multiple collections remain. Events from the archived collection are no longer sent to the destination.

Archive a Collection

1. Go to Collections.

2. Click the three-dot icon on the right side of the collection card.

3. Select Archive.

   

4. Review the warning prompt and select Yes, Archive it.

5. After you archive your collection, the Archived tab appears next to All Collections. Your archived collection is listed under the Archived tab.

Reactivate an archived collection

1. Go to Collections.
2. Go to the Archived tab.
3. Select the collection you want to reactivate and click the three-dot icon.
4. Select Reactivate.