Sign in

v1

latestOpenAPI 3.1.02026-07-2481742657.4 KB
Collections

Update a collection

Update a collection's name, description, and/or query.<br><br>This endpoint does not cost credits to execute.

put/v3/collections/{collection_uid}

Path parameters

collection_uidstring required

The UID for the collection

Example:11111111-2222-3333-4444-555555555555

The UID for the collection

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

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

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

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.

Request body

descriptionstring

description of the collection

namestring required

name of the collection

querystring required

query string to search upon to build the collection

Example request

{
  "description": "Hosts with services with AsyncRAT indicator in cert subject DN",
  "name": "Hosts services with AsyncRAT indicator",
  "query": "host.services.cert.parsed.subject_dn: \"asyncrat\""
}

Response

OK