TOC & Recently Viewed

Recently Viewed Topics

Tag Objects

Tenable.io API responses can include detailed or brief tag objects.

Detailed Tag Object

Tenable.io returns this object in response messages from the /tags endpoints.

Detailed Tag Object Syntax

{ "uuid": {string}, "created_at": {string}, "created_by": {string}, "updated_at": {string}, "updated_by": {string}, "category_uuid": {string}, "value": {string}, "description": {string}, "type": {string}, "category_name": {string}, "category_description": {string} }

Detailed Tag Object Attributes

Attribute Type Description
uuid string The UUID of the tag. Use this UUID when you want to query on the category:tag pair.
created_at string An ISO timestamp indicating the date and time on which the tag value was created, for example, 2018-08-09T13:51:17.243Z.
created_by string The name of the user who created the tag value.
updated_at string An ISO timestamp indicating the date and time on which the tag value was last updated, for example, 2018-08-09T13:51:17.243Z.
updated_by string The name of the user who last updated the tag value.
category_uuid string The UUID of the tag category associated with the tag value.
description string The description of the tag value.
value string The tag value. Must be unique within the category.
type string

The tag type:

  • static—A user must manually apply the tag to an asset. You can use the Tenable.io API to create and assign static tags to assets.
  • dynamicTenable.io automatically applies the tag based on asset attribute rules. You can use the Tenable.io user interface to create dynamic asset tags. For more information, see the Tenable.io Vulnerability Management User Guide.
category_name string The name of the category associated with the tag value.
category_description string The description of the category associated with the tag value.

Detailed Tag Object Example

{ "uuid": "0a6c1176-4c03-4776-a60a-048021a48799", "created_at": "2018-10-30T15:39:16.687Z", "created_by": "user3@example.com", "updated_at": "2018-10-30T15:39:16.687Z", "updated_by": "user3@example.com", "category_uuid": "8981f2d8-a043-4a74-ad78-e6a73b13ccaf", "value": "Seattle", "description": "", "type": "static", "category_name": "location", "category_description": "Asset location", }

Brief Tag Object

Tenable.io returns this object in asset chunk downloads when you retrieve asset data.

Brief Tag Object Syntax

{ "uuid": {string}, "key": {string}, "value": {string}, "added_by": {string}, "added_at": {string} }

Brief Tag Object Attributes

The table below defines the attributes of a brief asset tag object.

Attribute Type Description
uuid string The UUID of the tag.
key string The tag category (the first half of the category:value pair).
value string

The tag value (the second half of the category:value pair).

added_by string The UUID of the user who assigned the tag to the asset.
added_at string The ISO timestamp when the tag was assigned to the asset.

Brief Tag Object Example

{ "uuid": "6ee5761f-5c99-434b-aecb-e09b755921b7", "key": "Geographic Area", "value": "APAC", "added_by": "e7ecb50b-1330-4a8c-b8e5-ee00ec8c46f8", "added_at": "2018-02-13T14:53:13.817Z" }

Copyright © 2019 Tenable, Inc. All rights reserved. Tenable, Tenable.io, Tenable Network Security, Nessus, SecurityCenter, SecurityCenter Continuous View and Log Correlation Engine are registered trademarks of Tenable, Inc.. Tenable.sc, Lumin, Assure, and the Cyber Exposure Company are trademarks of Tenable, Inc. All other products or services are trademarks of their respective owners.