Update a tag

put

https://api.platform.censys.io/v3/tags/{tag_id}

Update an existing tag in your organization. Only the fields provided in the request body will be updated; omitted fields are left unchanged.

Only the tag's creator or an organization admin can update a private tag. Tags with the shared setting can be updated by any organization member. A shared tag cannot be made private.

This endpoint does not cost any credits to execute.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tag_id

uuid

required

The ID of the tag to update.

Body Params

description

string

length ≤ 1000

New description.

name

string

length between 1 and 255

New display name. Must be unique within the organization.

privacy

string

enum

Tag visibility and management settings. private tags are only visible to and editable by organization admins. shared tags are visible to and editable by all organization members.

Allowed:

Query Params

organization_id

uuid

required

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

Headers

X-Organization-ID

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

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Tag updated successfully

401Request does not contain a valid Authorization token

403User does not have permission to access this data

404Tag not found

409Tag name already exists in this organization, or a shared tag cannot be made private

422Invalid input

500Internal server error