CEcensys
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}

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 required

The UID for the collection

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

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

Changes

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