ThreatSync+ NDR Assets API

Version: 1.0.2

ThreatSync+ NDR Assets API Version History

Download the API specification

Introduction

The ThreatSync+ NDR Assets API is a RESTful API that you can use to create, retrieve, update, delete, and search assets in ThreatSync+ NDR. This documentation explains how to get access to the ThreatSync+ NDR Assets API and includes examples to help you get started.

Get Started

This section describes how to submit requests to the ThreatSync+ NDR Assets API.

API URL

The ThreatSync+ NDR Assets API base path is:

https://{base API URL}/rest/threatsyncplus/assets/v1/

The base URL for WatchGuard public APIs varies by environment and region. The base API URL for your account appears on the Managed Access page in WatchGuard Cloud.

Endpoint Path Parameters

Each WatchGuard public API has a version, expressed as <major>.<minor>.<patch>. You specify the major API version, such as v1, as part of the endpoint URI path.

Authentication

WatchGuard public APIs use the Open Authorization (OAuth) 2.0 authorization framework for token-based authentication. To use the ThreatSync+ NDR Assets API, you must first enable API access in your WatchGuard Cloud account and make an API request to generate an access token.

You must include the access token and your API Key in the header of each request you make to the ThreatSync+ NDR Assets API.

For more information, see Authentication.

Request Headers

You must include this information in the header of each request you make to the ThreatSync+ NDR Assets API:

Content-Type

application/json

Accept

application/json

Authorization

The access token that you generate with the WatchGuard Authentication API. For more information, see Authentication.

WatchGuard-API-Key

The API Key associated with your WatchGuard Cloud account (shown on the Managed Access page in WatchGuard Cloud).

Create an Asset

/{v1}/accounts/{accountId}/asset

Make a request to this endpoint to create an asset.

Path Parameters

When you send a request to this endpoint, you must include these path parameters:

accountId
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: ACC-1234567

Query Parameters

tenant_name
string
REQUIRED

Specifies the WatchGuard Cloud account ID for the managed account you want to create an asset for.

Example: WGC-1-123abc456

Request Body

name
string
REQUIRED

Specifies the name of the asset.

Example: Asset1

description
string

Description of the asset.

addresses
array
REQUIRED

Specifies the address details of the asset.

type
string
REQUIRED

Specifies the address type of the asset. The allowed value is IP_V4.

Example: IP_V4

value
string
REQUIRED

Specifies the IP address of the asset.

Example: 10.0.0.15

roles
array

Specifies the role the asset performs on the network. The allowed values are:

  • Active Directory Server
  • Backup Server
  • DHCP Server
  • DNS Server
  • Domain Controller
  • Exchange Server
  • File Server
  • Firewall
  • FTP Server
  • IMAP Mail Server
  • IMAP/SSL Mail Server
  • LDAP Server
  • LDAP/SSL Server
  • NFS Server
  • Oracle Database Server
  • POP3 Mail Server
  • POP3/SSL Mail Server
  • Proxy Server/Edge
  • Remote Desktop Services
  • SCVMM
  • Secure Web Server
  • Security Server
  • SMTP Mail Server
  • SMTP/SSL Mail Server
  • SQL Database Server
  • SSH Server
  • Telnet server
  • Web Server
  • WSUS Server

Example: DHCP Server

device_type
array
REQUIRED

Specifies the device type of the asset. The allowed values are:

  • Access Point
  • Application Server
  • Cluster
  • Cluster SAN Fabric
  • Computer
  • Database Server
  • Domain Controller
  • Email Gateway
  • End User Computing
  • Firewall
  • Gateway
  • Network
  • Network Attached Storage
  • Network Switch
  • Printer
  • Proxy Server
  • Router
  • Server
  • Storage Device
  • Switch
  • VPN Server
  • Wireless Access Point

Example: Server

tags
array

Specifies the tags associated with the asset.

Example: ["server1", "server2"]

importance
integer
REQUIRED

Specifies the asset importance. The allowed values are:

  • 1 - Very Low
  • 2 - Low
  • 3 - Medium
  • 4 - High
  • 5 - Very High

Example: 1

Example Request

This request creates an asset for account ID WGC-1-123abc456:

curl -X POST 
	https://api.usa.cloud.watchguard.com/rest/threatsyncplus/assets/v1/accounts/ACC-123456/asset?tenant_name=WGC-1-123abc456
	-H 'Authorization: Bearer eyJraWQiOiJWamJQVlpnOU45SFRhdWJQZGVPU0d0WEdmbENTZnpRZ0E4NGdjTlRvN2ZjPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0OGU1MjczOS1hNDlkLTQ1YTctODE5OS1iOGQzNTljMjhlYTIiLCJjdXN0b206YXBpX2tleXMiOiJiOVJoUGl4aTlUbE5qZDNQNDE0dXdrelUyVldGdzFjbGhTNktOenVMIiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tXC91cy13ZXN0LTJfeTBSamtRdkdqIiwiY29nbml0bzp1c2VybmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJhdWQiOiIxY3Y0aWRuYjhzb2M1ZWZtdHFxMHVqMDRkIiwiZXZlbnRfaWQiOiJhNDk4Y2ZkZS1jYTY0LTQyNDUtYjhhMC1jYjU0Njc2YmE4YjYiLCJ0b2tlbl91c2UiOiJpZCIsImN1c3RvbTpiZXRhX3ByZWZlcmVuY2VzIjoie1wiQUNDLTEyNzc5NDVcIjogW3tcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtcGxhdGZvcm0tY29yZVwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcIm1mYS1vbi1hY2NvdW50c1wiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2djLWF1dGhwb2ludFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImF1dGhwb2ludC11c2VyLWluaGVyaXRhbmNlXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJEYXJrLVdlYi1Nb25pdG9yaW5nXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2Vzcy1tb2R1bGVzXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZG5zd2F0Y2gtYXBwbGljYXRpb25cIiwgXCJmZWF0dXJlX2lkZW50aWZpZXJcIjogXCJcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCJcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtYXV0aHBvaW50XCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiYXV0aHBvaW50LWdlb2ZlbmNlLXBvbGljeVwiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZmJ4LWNsb3VkLW1nbXQtMFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImNvbmYtZGlmZi1yZXBvcnRcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCIxLjAuMFwifSwge1wiYXBwbGljYXRpb25faWRlbnRpZmllclwiOiBcImZieC1tZ210LXN5c3RlbS1hY3Rpb25zXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiZmJ4LWZ3LWJldGEtYnVpbGRzXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn1dfSIsImF1dGhfdGltZSI6MTYyNDk3NTc2OCwibmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJjdXN0b206YWNjb3VudF9pZCI6IkFDQy0xMjc3OTQ1IiwiZXhwIjoxNjI0OTc5MzY4LCJjdXN0b206cm9sZSI6IjEiLCJpYXQiOjE2MjQ5NzU3Njh9.ofkgu5a2c-ViLJO1EkAT8-EcIkNWsLYqBOY9mIONEd5Lo3C27Mv3BpSxS1C35vrLN89Fo6YDb36DpZQVdZIZ5biOPAlDsY-wGx_kiDbNDOHvg4Sl9dZr_tZFs3yP3AikYH6oneNjnAaHL3OQCcEhQLUejhOsNf1NOPH2QQXovtfRxomygkZtngPZq4ATy_oDlXnzFA9ThXc7HjZ54aAJ9Z4p5-lJbHuwtpwpvLh6036_8Ba5yaD3r1ZuTghMRHprTVJNm2QrRDKd3jTfr7Sh87gAzRu80PHeZGsoiDQNssinxQxjVLI1Gq9vSPh03ZV01q9Pa5Xgg4WGkYHc2UKUuw' \
	-H 'Accept: application/json'
	-H 'Content-Type: application/json' 
	-H 'WatchGuard-API-Key: s9t7El6RZFg8UcmRhYKdwXqBhyuioiWER83Nqd0tL'
	-d '{
		"name": "70",
		"addresses": [
		{
			"type": "IP_V4",
			"value": "10.1.7.5"
		}
		],
		"roles": [
			"DHCP Server",
			"DNS Server",
			"Web Server"
			],
		"device_type": "Server",
		"importance": 3
	}'

Example Response

{
    "data": [
        {
            "id": "WGC-1-123abc456",
            "name": "70",
            "description": null,
            "addresses": [
                {
                    "type": "IP_V4",
                    "value": "10.1.7.5"
                }
            ],
            "roles": [
                "DHCP Server",
                "DNS Server",
                "Web Server"
            ],
            "is_active": true,
            "device_type": "Server",
            "tags": [],
            "importance": 3,
            "first_seen": null,
            "last_seen": null,
            "smartalert_count": 0,
            "asset_information_sources": [
                "USER"
            ],
            "threat_score": 0,
            "operating_system": null,
            "state": null
        }
    ],
    "meta": {
        "dataTotalCount": 1
    },
    "requestId": "01182ddd-14a0-43e9-b91e-43372237cdfc",
    "status": 200
}

Get a Specific Asset

/{v1}/accounts/{accountId}/asset/{asset_id}

Make a request to this endpoint to retrieve the details of a specific asset.

Path Parameters

When you send a request to this endpoint, you must include these path parameters:

accountId
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: ACC-1234567

asset_id
string
REQUIRED

Unique identity of the asset you want to retrieve the details for.

Query Parameters

tenant_name
string
REQUIRED

Specifies the WatchGuard Cloud account ID for which you want to get the asset details.

Example: WGC-1-123abc456

Example Request

curl -X GET 
	https://api.usa.cloud.watchguard.com/rest/threatsyncplus/assets/v1/accounts/ACC-1234567/asset/3fce7dec-ec93-40cc-a8b2-ce06edf0336f?tenant_name=WGC-1-123abc456
	-H 'Authorization: Bearer eyJraWQiOiJWamJQVlpnOU45SFRhdWJQZGVPU0d0WEdmbENTZnpRZ0E4NGdjTlRvN2ZjPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0OGU1MjczOS1hNDlkLTQ1YTctODE5OS1iOGQzNTljMjhlYTIiLCJjdXN0b206YXBpX2tleXMiOiJiOVJoUGl4aTlUbE5qZDNQNDE0dXdrelUyVldGdzFjbGhTNktOenVMIiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tXC91cy13ZXN0LTJfeTBSamtRdkdqIiwiY29nbml0bzp1c2VybmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJhdWQiOiIxY3Y0aWRuYjhzb2M1ZWZtdHFxMHVqMDRkIiwiZXZlbnRfaWQiOiJhNDk4Y2ZkZS1jYTY0LTQyNDUtYjhhMC1jYjU0Njc2YmE4YjYiLCJ0b2tlbl91c2UiOiJpZCIsImN1c3RvbTpiZXRhX3ByZWZlcmVuY2VzIjoie1wiQUNDLTEyNzc5NDVcIjogW3tcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtcGxhdGZvcm0tY29yZVwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcIm1mYS1vbi1hY2NvdW50c1wiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2djLWF1dGhwb2ludFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImF1dGhwb2ludC11c2VyLWluaGVyaXRhbmNlXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJEYXJrLVdlYi1Nb25pdG9yaW5nXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2Vzcy1tb2R1bGVzXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZG5zd2F0Y2gtYXBwbGljYXRpb25cIiwgXCJmZWF0dXJlX2lkZW50aWZpZXJcIjogXCJcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCJcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtYXV0aHBvaW50XCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiYXV0aHBvaW50LWdlb2ZlbmNlLXBvbGljeVwiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZmJ4LWNsb3VkLW1nbXQtMFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImNvbmYtZGlmZi1yZXBvcnRcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCIxLjAuMFwifSwge1wiYXBwbGljYXRpb25faWRlbnRpZmllclwiOiBcImZieC1tZ210LXN5c3RlbS1hY3Rpb25zXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiZmJ4LWZ3LWJldGEtYnVpbGRzXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn1dfSIsImF1dGhfdGltZSI6MTYyNDk3NTc2OCwibmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJjdXN0b206YWNjb3VudF9pZCI6IkFDQy0xMjc3OTQ1IiwiZXhwIjoxNjI0OTc5MzY4LCJjdXN0b206cm9sZSI6IjEiLCJpYXQiOjE2MjQ5NzU3Njh9.ofkgu5a2c-ViLJO1EkAT8-EcIkNWsLYqBOY9mIONEd5Lo3C27Mv3BpSxS1C35vrLN89Fo6YDb36DpZQVdZIZ5biOPAlDsY-wGx_kiDbNDOHvg4Sl9dZr_tZFs3yP3AikYH6oneNjnAaHL3OQCcEhQLUejhOsNf1NOPH2QQXovtfRxomygkZtngPZq4ATy_oDlXnzFA9ThXc7HjZ54aAJ9Z4p5-lJbHuwtpwpvLh6036_8Ba5yaD3r1ZuTghMRHprTVJNm2QrRDKd3jTfr7Sh87gAzRu80PHeZGsoiDQNssinxQxjVLI1Gq9vSPh03ZV01q9Pa5Xgg4WGkYHc2UKUuw' \
	-H 'Accept: application/json'
	-H 'Content-Type: application/json' 
	-H 'WatchGuard-API-Key: s9t7El6RZFg8UcmRhYKdwXqBhyuioiWER83Nqd0tL'

Example Response

{
    "data": [
        {
            "id": "3fce7dec-ec93-40cc-a8b2-ce06edf0336f",
            "name": "10.9.0.30",
            "description": "",
            "addresses": [
                {
                    "type": "IP_V4",
                    "value": "10.9.0.30"
                }
            ],
            "roles": [],
            "is_active": true,
            "device_type": "Computer",
            "tags": [],
            "importance": 3,
            "first_seen": 1745398800000,
            "last_seen": 1745816400000,
            "smartalert_count": 0,
            "asset_information_sources": null,
            "threat_score": 0,
            "operating_system": null,
            "state": "confirmed"
        }
    ],
    "meta": {
        "dataTotalCount": 1
    },
    "requestId": "8e68ef9d-8a06-4ad0-af3f-fdbc1f04d17e",
    "status": 200
}

Data returned in the response might include:

data
array

Details of the asset.

id
string

Unique identifier of the asset.

name
string

Name or identifier of the asset.

Example: Asset1.

description
string

Description of the asset.

addresses
array

Addresses associated with the asset.

type
string

Address type of the asset.

value
string

Value of the asset.

roles
array

Roles associated with the asset.

threat_score
integer

Threat score for the asset.

is_active
boolean

Indicates whether the asset is active.

device_type
deviceType

Device type of the asset.

tags
array

Tags associated with the asset.

importance
integer

Importance of the asset.

asset_information_sources
array

Source that initiated the creation of the asset. The possible values are:

  • DHCP_LOG - Indicates that a DHCP log initiated the creation of the asset.
  • USER - Indicates that a user initiated the creation of the asset.
  • VPN_LOG - Indicates that a VPN log initiated the creation of the asset.
  • SYSTEM - Indicated that a system initiated the creation of the asset.

first_seen
integer

Time since Unix epoch time when the asset was first seen, in milliseconds.

last_seen
integer

Time since Unix epoch time when the asset was last seen, in milliseconds.

smartalert_count
integer

Number of Smart Alerts received for the asset.

operating_system
string

Operating system information for the asset.

state
string

Indicates whether the device is validated through the observation of bidirectional traffic.

Example: Confirmed

requestId
string

The unique identifier of the request.

Example: xyz

status
integer

Specifies the response status.

Example: 200

meta
object

Specifies metadata for the request.

Example: { "dataTotalCount": 581 }

Update an Asset

/{v1}/accounts/{accountId}/asset/{asset_id}

Make a request to this endpoint to update a specific asset. In the request body, include only the parameters that you want to change.

Path Parameters

When you send a request to this endpoint, you must include these path parameters:

accountId
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: ACC-1234567

asset_id
string
REQUIRED

Unique ID of the asset you want to update the details for.

Query Parameters

tenant_name
string
REQUIRED

Specifies the WatchGuard Cloud account ID for the managed account you want to update the asset details for.

Example: WGC-1-123abc456

Request Body

name
string
REQUIRED

Specifies the name of the asset.

Example: Asset1

description
string

Description of the asset.

addresses
array
REQUIRED

Specifies the address details of the asset.

type
string
REQUIRED

Specifies the address type of the asset. The allowed value is IP_V4.

Example: IP_V4

value
string
REQUIRED

Specifies the IP address of the asset.

Example: 10.0.0.15

roles
array

Specifies the role the asset performs on the network. The allowed values are:

  • Active Directory Server
  • Backup Server
  • DHCP Server
  • DNS Server
  • Domain Controller
  • Exchange Server
  • File Server
  • Firewall
  • FTP Server
  • IMAP Mail Server
  • IMAP/SSL Mail Server
  • LDAP Server
  • LDAP/SSL Server
  • NFS Server
  • Oracle Database Server
  • POP3 Mail Server
  • POP3/SSL Mail Server
  • Proxy Server/Edge
  • Remote Desktop Services
  • SCVMM
  • Secure Web Server
  • Security Server
  • SMTP Mail Server
  • SMTP/SSL Mail Server
  • SQL Database Server
  • SSH Server
  • Telnet server
  • Web Server
  • WSUS Server

device_type
array
REQUIRED

Specifies the device type of the asset. The allowed values are:

  • Access Point
  • Application Server
  • Cluster
  • Cluster SAN Fabric
  • Computer
  • Database Server
  • Domain Controller
  • Email Gateway
  • End User Computing
  • Firewall
  • Gateway
  • Network
  • Network Attached Storage
  • Network Switch
  • Printer
  • Proxy Server
  • Router
  • Server
  • Storage Device
  • Switch
  • VPN Server
  • Wireless Access Point

tags
array

Specifies the tags associated with the asset.

Example: ["server1", "server2"]

importance
integer
REQUIRED

Specifies the asset importance. The allowed values are:

  • 1 - Very Low
  • 2 - Low
  • 3 - Medium
  • 4 - High
  • 5 - Very High

Example: 1

Example Request

This request updates an asset for the asset ID 3bb8abdc-a50f-4969-9a03-58cfbf7e1138:

curl -X PUT 
	https://api.usa.cloud.watchguard.com/rest/threatsyncplus/assets/v1/accounts/ACC-123456/asset/3bb8abdc-a50f-4969-9a03-58cfbf7e1138?tenant_name=WGC-1-123abc456
	-H 'Authorization: Bearer eyJraWQiOiJWamJQVlpnOU45SFRhdWJQZGVPU0d0WEdmbENTZnpRZ0E4NGdjTlRvN2ZjPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0OGU1MjczOS1hNDlkLTQ1YTctODE5OS1iOGQzNTljMjhlYTIiLCJjdXN0b206YXBpX2tleXMiOiJiOVJoUGl4aTlUbE5qZDNQNDE0dXdrelUyVldGdzFjbGhTNktOenVMIiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tXC91cy13ZXN0LTJfeTBSamtRdkdqIiwiY29nbml0bzp1c2VybmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJhdWQiOiIxY3Y0aWRuYjhzb2M1ZWZtdHFxMHVqMDRkIiwiZXZlbnRfaWQiOiJhNDk4Y2ZkZS1jYTY0LTQyNDUtYjhhMC1jYjU0Njc2YmE4YjYiLCJ0b2tlbl91c2UiOiJpZCIsImN1c3RvbTpiZXRhX3ByZWZlcmVuY2VzIjoie1wiQUNDLTEyNzc5NDVcIjogW3tcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtcGxhdGZvcm0tY29yZVwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcIm1mYS1vbi1hY2NvdW50c1wiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2djLWF1dGhwb2ludFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImF1dGhwb2ludC11c2VyLWluaGVyaXRhbmNlXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJEYXJrLVdlYi1Nb25pdG9yaW5nXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2Vzcy1tb2R1bGVzXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZG5zd2F0Y2gtYXBwbGljYXRpb25cIiwgXCJmZWF0dXJlX2lkZW50aWZpZXJcIjogXCJcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCJcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtYXV0aHBvaW50XCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiYXV0aHBvaW50LWdlb2ZlbmNlLXBvbGljeVwiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZmJ4LWNsb3VkLW1nbXQtMFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImNvbmYtZGlmZi1yZXBvcnRcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCIxLjAuMFwifSwge1wiYXBwbGljYXRpb25faWRlbnRpZmllclwiOiBcImZieC1tZ210LXN5c3RlbS1hY3Rpb25zXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiZmJ4LWZ3LWJldGEtYnVpbGRzXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn1dfSIsImF1dGhfdGltZSI6MTYyNDk3NTc2OCwibmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJjdXN0b206YWNjb3VudF9pZCI6IkFDQy0xMjc3OTQ1IiwiZXhwIjoxNjI0OTc5MzY4LCJjdXN0b206cm9sZSI6IjEiLCJpYXQiOjE2MjQ5NzU3Njh9.ofkgu5a2c-ViLJO1EkAT8-EcIkNWsLYqBOY9mIONEd5Lo3C27Mv3BpSxS1C35vrLN89Fo6YDb36DpZQVdZIZ5biOPAlDsY-wGx_kiDbNDOHvg4Sl9dZr_tZFs3yP3AikYH6oneNjnAaHL3OQCcEhQLUejhOsNf1NOPH2QQXovtfRxomygkZtngPZq4ATy_oDlXnzFA9ThXc7HjZ54aAJ9Z4p5-lJbHuwtpwpvLh6036_8Ba5yaD3r1ZuTghMRHprTVJNm2QrRDKd3jTfr7Sh87gAzRu80PHeZGsoiDQNssinxQxjVLI1Gq9vSPh03ZV01q9Pa5Xgg4WGkYHc2UKUuw' \
	-H 'Accept: application/json'
	-H 'Content-Type: application/json' 
	-H 'WatchGuard-API-Key: s9t7El6RZFg8UcmRhYKdwXqBhyuioiWER83Nqd0tL'
	-d '{
		"name": "10.5.33",
		"addresses": [
		{
			"type": "IP_V4",
			"value": "1.20.0.9"
		}
		],
		"roles": [
			"DHCP Server",
			"DNS Server",
			"Web Server"
			],
		"device_type": "Server",
		"importance": 3
	}'

Example Response

{
    "data": [
        {
            "id": "3bb8abdc-a50f-4969-9a03-58cfbf7e1138",
            "name": "10.5.33",
            "description": null,
            "addresses": [
                {
                    "type": "IP_V4",
                    "value": "1.20.0.9"
                }
            ],
            "roles": [
                "DHCP Server",
                "DNS Server",
                "Web Server"
            ],
            "is_active": true,
            "device_type": "Server",
            "tags": [],
            "importance": 3,
            "first_seen": 1774342309826,
            "last_seen": 1774342309826,
            "smartalert_count": 0,
            "asset_information_sources": [
                "USER"
            ],
            "threat_score": 0,
            "operating_system": null,
            "state": "confirmed"
        }
    ],
    "meta": {
        "dataTotalCount": 1
    },
    "requestId": "3c5fa6eb-ba27-4917-b548-8af791d860aa",
    "status": 200
}

Delete an Asset

/{v1}/accounts/{accountId}/asset/{asset_id}

Make a request to this endpoint to delete a specific asset.

Path Parameters

When you send a request to this endpoint, you must include these path parameters:

accountId
string
REQUIRED

Your WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: ACC-1234567 

asset_id
string
REQUIRED

Unique ID of the asset you want to delete.

Query Parameters

tenant_name
string
REQUIRED

Specifies the WatchGuard Cloud account ID for which you want to delete the asset.

Example: WGC-1-123abc456

Example Request

curl -X DELETE 
	https://api.usa.cloud.watchguard.com/rest/threatsyncplus/assets/v1/accounts/ACC-123456/asset/3bb8abdc-a50f-4969-9a03-58cfbf7e1138?tenant_name=WGC-1-123abc456
	-H 'Authorization: Bearer eyJraWQiOiJWamJQVlpnOU45SFRhdWJQZGVPU0d0WEdmbENTZnpRZ0E4NGdjTlRvN2ZjPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0OGU1MjczOS1hNDlkLTQ1YTctODE5OS1iOGQzNTljMjhlYTIiLCJjdXN0b206YXBpX2tleXMiOiJiOVJoUGl4aTlUbE5qZDNQNDE0dXdrelUyVldGdzFjbGhTNktOenVMIiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tXC91cy13ZXN0LTJfeTBSamtRdkdqIiwiY29nbml0bzp1c2VybmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJhdWQiOiIxY3Y0aWRuYjhzb2M1ZWZtdHFxMHVqMDRkIiwiZXZlbnRfaWQiOiJhNDk4Y2ZkZS1jYTY0LTQyNDUtYjhhMC1jYjU0Njc2YmE4YjYiLCJ0b2tlbl91c2UiOiJpZCIsImN1c3RvbTpiZXRhX3ByZWZlcmVuY2VzIjoie1wiQUNDLTEyNzc5NDVcIjogW3tcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtcGxhdGZvcm0tY29yZVwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcIm1mYS1vbi1hY2NvdW50c1wiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2djLWF1dGhwb2ludFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImF1dGhwb2ludC11c2VyLWluaGVyaXRhbmNlXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJEYXJrLVdlYi1Nb25pdG9yaW5nXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2Vzcy1tb2R1bGVzXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZG5zd2F0Y2gtYXBwbGljYXRpb25cIiwgXCJmZWF0dXJlX2lkZW50aWZpZXJcIjogXCJcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCJcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtYXV0aHBvaW50XCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiYXV0aHBvaW50LWdlb2ZlbmNlLXBvbGljeVwiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZmJ4LWNsb3VkLW1nbXQtMFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImNvbmYtZGlmZi1yZXBvcnRcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCIxLjAuMFwifSwge1wiYXBwbGljYXRpb25faWRlbnRpZmllclwiOiBcImZieC1tZ210LXN5c3RlbS1hY3Rpb25zXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiZmJ4LWZ3LWJldGEtYnVpbGRzXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn1dfSIsImF1dGhfdGltZSI6MTYyNDk3NTc2OCwibmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJjdXN0b206YWNjb3VudF9pZCI6IkFDQy0xMjc3OTQ1IiwiZXhwIjoxNjI0OTc5MzY4LCJjdXN0b206cm9sZSI6IjEiLCJpYXQiOjE2MjQ5NzU3Njh9.ofkgu5a2c-ViLJO1EkAT8-EcIkNWsLYqBOY9mIONEd5Lo3C27Mv3BpSxS1C35vrLN89Fo6YDb36DpZQVdZIZ5biOPAlDsY-wGx_kiDbNDOHvg4Sl9dZr_tZFs3yP3AikYH6oneNjnAaHL3OQCcEhQLUejhOsNf1NOPH2QQXovtfRxomygkZtngPZq4ATy_oDlXnzFA9ThXc7HjZ54aAJ9Z4p5-lJbHuwtpwpvLh6036_8Ba5yaD3r1ZuTghMRHprTVJNm2QrRDKd3jTfr7Sh87gAzRu80PHeZGsoiDQNssinxQxjVLI1Gq9vSPh03ZV01q9Pa5Xgg4WGkYHc2UKUuw' \
	-H 'Accept: application/json'
	-H 'Content-Type: application/json' 
	-H 'WatchGuard-API-Key: s9t7El6RZFg8UcmRhYKdwXqBhyuioiWER83Nqd0tL'

Example Response

{
    "data": [],
    "meta": {
        "dataTotalCount": 0
    },
    "requestId": "8ca74597-2cf5-49d4-a66b-2878a64c8cc2",
    "status": 200
}

Get Assets by Field

/{v1}/accounts/{accountId}/asset/field/{field}

Make a request to this endpoint to get a list of assets that match the specified field value.

Path Parameters

When you send a request to this endpoint, you must include these path parameters:

accountId
string
REQUIRED

Specifies the WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.

Example: ACC-1234567

field
string
REQUIRED

Specifies the asset field to query. Specify one of these values:

  • name
  • addresses
  • asset_information_sources
  • roles
  • device_type

Query Parameters

tenant_name
string
REQUIRED

Specifies the WatchGuard Cloud account ID for which you want to get the asset details.

Example: WGC-1-123abc456

value
string
REQUIRED

Specifies the value to filter the results by.

Example: server

offset
integer

Specifies the index from which the result set starts (used for pagination).

Example: 0

size
integer

Specifies the number of assets to return in response. The default value is 10.

Valid range: 10 - 5000

Example: 20

order
integer

Specifies the sort order. The allowed values are:

  • 0 - ascending
  • 1 - descending

The default value is 0.

Example: 1

sort
string

Specifies the field to sort by. You can specify one of these values:

  • name
  • description
  • threat_score
  • device_type
  • importance
  • first_seen
  • last_seen
  • smartalert_count

The default value is name.

Example Request

curl -X GET 
	https://api.usa.cloud.watchguard.com/rest/threatsyncplus/assets/v1/accounts/ACC-123456/asset/field/addresses?tenant_name=WGC-1-123abc456&value=10.22.0.42
	-H 'Authorization: Bearer eyJraWQiOiJWamJQVlpnOU45SFRhdWJQZGVPU0d0WEdmbENTZnpRZ0E4NGdjTlRvN2ZjPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0OGU1MjczOS1hNDlkLTQ1YTctODE5OS1iOGQzNTljMjhlYTIiLCJjdXN0b206YXBpX2tleXMiOiJiOVJoUGl4aTlUbE5qZDNQNDE0dXdrelUyVldGdzFjbGhTNktOenVMIiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tXC91cy13ZXN0LTJfeTBSamtRdkdqIiwiY29nbml0bzp1c2VybmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJhdWQiOiIxY3Y0aWRuYjhzb2M1ZWZtdHFxMHVqMDRkIiwiZXZlbnRfaWQiOiJhNDk4Y2ZkZS1jYTY0LTQyNDUtYjhhMC1jYjU0Njc2YmE4YjYiLCJ0b2tlbl91c2UiOiJpZCIsImN1c3RvbTpiZXRhX3ByZWZlcmVuY2VzIjoie1wiQUNDLTEyNzc5NDVcIjogW3tcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtcGxhdGZvcm0tY29yZVwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcIm1mYS1vbi1hY2NvdW50c1wiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2djLWF1dGhwb2ludFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImF1dGhwb2ludC11c2VyLWluaGVyaXRhbmNlXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJEYXJrLVdlYi1Nb25pdG9yaW5nXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2Vzcy1tb2R1bGVzXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZG5zd2F0Y2gtYXBwbGljYXRpb25cIiwgXCJmZWF0dXJlX2lkZW50aWZpZXJcIjogXCJcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCJcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtYXV0aHBvaW50XCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiYXV0aHBvaW50LWdlb2ZlbmNlLXBvbGljeVwiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZmJ4LWNsb3VkLW1nbXQtMFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImNvbmYtZGlmZi1yZXBvcnRcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCIxLjAuMFwifSwge1wiYXBwbGljYXRpb25faWRlbnRpZmllclwiOiBcImZieC1tZ210LXN5c3RlbS1hY3Rpb25zXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiZmJ4LWZ3LWJldGEtYnVpbGRzXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn1dfSIsImF1dGhfdGltZSI6MTYyNDk3NTc2OCwibmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJjdXN0b206YWNjb3VudF9pZCI6IkFDQy0xMjc3OTQ1IiwiZXhwIjoxNjI0OTc5MzY4LCJjdXN0b206cm9sZSI6IjEiLCJpYXQiOjE2MjQ5NzU3Njh9.ofkgu5a2c-ViLJO1EkAT8-EcIkNWsLYqBOY9mIONEd5Lo3C27Mv3BpSxS1C35vrLN89Fo6YDb36DpZQVdZIZ5biOPAlDsY-wGx_kiDbNDOHvg4Sl9dZr_tZFs3yP3AikYH6oneNjnAaHL3OQCcEhQLUejhOsNf1NOPH2QQXovtfRxomygkZtngPZq4ATy_oDlXnzFA9ThXc7HjZ54aAJ9Z4p5-lJbHuwtpwpvLh6036_8Ba5yaD3r1ZuTghMRHprTVJNm2QrRDKd3jTfr7Sh87gAzRu80PHeZGsoiDQNssinxQxjVLI1Gq9vSPh03ZV01q9Pa5Xgg4WGkYHc2UKUuw' \
	-H 'Accept: application/json'
	-H 'Content-Type: application/json' 
	-H 'WatchGuard-API-Key: s9t7El6RZFg8UcmRhYKdwXqBhyuioiWER83Nqd0tL'

Example Response

{
    "data": [
        {
            "id": "28c0ae38-7eea-429b-a7bc-368109109543",
            "name": "10.22.0.42",
            "description": "",
            "addresses": [
                {
                    "type": "IP_V4",
                    "value": "10.22.0.42"
                }
            ],
            "roles": [],
            "is_active": true,
            "device_type": "Computer",
            "tags": [],
            "importance": 3,
            "first_seen": 1745398800000,
            "last_seen": 1745816400000,
            "smartalert_count": 0,
            "asset_information_sources": null,
            "threat_score": 0,
            "operating_system": null,
            "state": "confirmed"
        }
    ],
    "meta": {
        "dataTotalCount": 1
    },
    "requestId": "9c8ff731-d7bf-4cf8-9c9f-139161262f73",
    "status": 200
}

For parameters that require exact matches (for example, addresses, asset_information_sources, roles), the API returns a 404 status if no results are found. For parameters that support partial matches (for example, name, device_type), the API returns a 200 status with meta.dataTotalCount set to zero.

Data returned in the response might include:

data
array

Details of the asset.

id
string

Unique identifier of the asset.

name
string

Name or identifier of the asset.

Example: Asset1

description
string

Description of the asset.

addresses
array

Addresses associated with the asset.

type
stringa

Address type of the asset.

value
string

Value of the asset.

roles
array

Roles associated with the asset.

threat_score
integer

Threat score for the asset.

is_active
boolean

Indicates whether the asset is active.

device_type
deviceType

Device type of the asset.

tags
array

Tags associated with the asset.

importance
integer

Importance of the asset.

asset_information_sources
array

  • DHCP_LOG - Indicates that a DHCP log initiated the creation of the asset.
  • USER - Indicates that a user initiated the creation of the asset.
  • VPN_LOG - Indicates that a VPN log initiated the creation of the asset.
  • SYSTEM - Indicated that a system initiated the creation of the asset.

first_seen
integer

Time since Unix epoch time when the asset was first seen, in milliseconds.

last_seen
integer

Time since Unix epoch time when the asset was last seen, in milliseconds .

smartalert_count
integer

Number of Smart Alerts received for the asset.

operating_system
string

Operating system information for the asset.

state
string

Indicates whether the device is validated through the observation of bidirectional traffic.

Example: Confirmed

requestId
string

The unique identifier of the request.

Example: xyz

status
integer

Specifies the response status.

Example: 200

meta
object

Specifies metadata for the request.

Example: { "dataTotalCount": 581 }

nextPageUri
string

Provides the URI to retrieve the next page of results, if available.

previousPageUri
string

Provides the URI to retrieve the previous page of results, if available.

Get Assets By Name

/{v1}/accounts/{accountId}/asset/names

Make a request to this endpoint to get a list of asset names filtered by an optional asset name value.

If no value is specified, returns all assets.

Path Parameters

When you send a request to this endpoint, you must include these path parameters:

accountId
string
REQUIRED

Specifies the WatchGuard Cloud account ID. You can see your accountId on the My Account page in WatchGuard Cloud.
Example: ACC-1234567

Query Parameters

tenant_name
string
REQUIRED

Specifies the WatchGuard Cloud account ID for which you want to get the asset details.

Example: WGC-1-123abc456

value
string

Specifies an exact or partial asset name to search for.

If no value is specified, returns all assets.

size
integer

Specifies the number of assets to return. The default value is 10.

Range: 10 – 5000

offset
integer

Specifies the index from which the result set starts (used for pagination).

order
integer

Specifies the sort order.

The default value is 0.

Allowed values: 0 (ascending), 1 (descending).

Example Request

curl -X GET 
	https://api.usa.cloud.watchguard.com/rest/threatsyncplus/assets/v1/accounts/ACC-123456/asset/names?tenant_name=WGC-1-123abc456&value=
	-H 'Authorization: Bearer eyJraWQiOiJWamJQVlpnOU45SFRhdWJQZGVPU0d0WEdmbENTZnpRZ0E4NGdjTlRvN2ZjPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI0OGU1MjczOS1hNDlkLTQ1YTctODE5OS1iOGQzNTljMjhlYTIiLCJjdXN0b206YXBpX2tleXMiOiJiOVJoUGl4aTlUbE5qZDNQNDE0dXdrelUyVldGdzFjbGhTNktOenVMIiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLXdlc3QtMi5hbWF6b25hd3MuY29tXC91cy13ZXN0LTJfeTBSamtRdkdqIiwiY29nbml0bzp1c2VybmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJhdWQiOiIxY3Y0aWRuYjhzb2M1ZWZtdHFxMHVqMDRkIiwiZXZlbnRfaWQiOiJhNDk4Y2ZkZS1jYTY0LTQyNDUtYjhhMC1jYjU0Njc2YmE4YjYiLCJ0b2tlbl91c2UiOiJpZCIsImN1c3RvbTpiZXRhX3ByZWZlcmVuY2VzIjoie1wiQUNDLTEyNzc5NDVcIjogW3tcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtcGxhdGZvcm0tY29yZVwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcIm1mYS1vbi1hY2NvdW50c1wiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2djLWF1dGhwb2ludFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImF1dGhwb2ludC11c2VyLWluaGVyaXRhbmNlXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJEYXJrLVdlYi1Nb25pdG9yaW5nXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwid2Vzcy1tb2R1bGVzXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZG5zd2F0Y2gtYXBwbGljYXRpb25cIiwgXCJmZWF0dXJlX2lkZW50aWZpZXJcIjogXCJcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCJcIn0sIHtcImFwcGxpY2F0aW9uX2lkZW50aWZpZXJcIjogXCJ3Z2MtYXV0aHBvaW50XCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiYXV0aHBvaW50LWdlb2ZlbmNlLXBvbGljeVwiLCBcImZlYXR1cmVfdmVyc2lvblwiOiBcIjEuMC4wXCJ9LCB7XCJhcHBsaWNhdGlvbl9pZGVudGlmaWVyXCI6IFwiZmJ4LWNsb3VkLW1nbXQtMFwiLCBcImZlYXR1cmVfaWRlbnRpZmllclwiOiBcImNvbmYtZGlmZi1yZXBvcnRcIiwgXCJmZWF0dXJlX3ZlcnNpb25cIjogXCIxLjAuMFwifSwge1wiYXBwbGljYXRpb25faWRlbnRpZmllclwiOiBcImZieC1tZ210LXN5c3RlbS1hY3Rpb25zXCIsIFwiZmVhdHVyZV9pZGVudGlmaWVyXCI6IFwiZmJ4LWZ3LWJldGEtYnVpbGRzXCIsIFwiZmVhdHVyZV92ZXJzaW9uXCI6IFwiMS4wLjBcIn1dfSIsImF1dGhfdGltZSI6MTYyNDk3NTc2OCwibmFtZSI6IjkwYTMzYzdiMWJiNGJhYmFfcndfaWQiLCJjdXN0b206YWNjb3VudF9pZCI6IkFDQy0xMjc3OTQ1IiwiZXhwIjoxNjI0OTc5MzY4LCJjdXN0b206cm9sZSI6IjEiLCJpYXQiOjE2MjQ5NzU3Njh9.ofkgu5a2c-ViLJO1EkAT8-EcIkNWsLYqBOY9mIONEd5Lo3C27Mv3BpSxS1C35vrLN89Fo6YDb36DpZQVdZIZ5biOPAlDsY-wGx_kiDbNDOHvg4Sl9dZr_tZFs3yP3AikYH6oneNjnAaHL3OQCcEhQLUejhOsNf1NOPH2QQXovtfRxomygkZtngPZq4ATy_oDlXnzFA9ThXc7HjZ54aAJ9Z4p5-lJbHuwtpwpvLh6036_8Ba5yaD3r1ZuTghMRHprTVJNm2QrRDKd3jTfr7Sh87gAzRu80PHeZGsoiDQNssinxQxjVLI1Gq9vSPh03ZV01q9Pa5Xgg4WGkYHc2UKUuw' \
	-H 'Accept: application/json'
	-H 'Content-Type: application/json' 
	-H 'WatchGuard-API-Key: s9t7El6RZFg8UcmRhYKdwXqBhyuioiWER83Nqd0tL'

Example Response

{
    "data": [
        {
            "id": "3bb8abdc-a50f-4969-9a03-58cfbf7e1138",
            "name": "1.5.6.33",
            "description": null,
            "addresses": [
                {
                    "type": "IP_V4",
                    "value": "10.110.0.15"
                }
            ],
            "roles": [
                "DHCP Server",
                "DNS Server",
                "Web Server"
            ],
            "is_active": true,
            "device_type": "Server",
            "tags": [],
            "importance": 3,
            "first_seen": 1770801471187,
            "last_seen": 1770801471187,
            "smartalert_count": 0,
            "asset_information_sources": [
                "USER"
            ],
            "threat_score": 0,
            "operating_system": null,
            "state": "confirmed"
        },
        {
            "id": "2af8300c-751f-4ef8-853b-d39ed8937efe",
            "name": "10.0.2.15",
            "description": "",
            "addresses": [
                {
                    "type": "IP_V4",
                    "value": "10.0.2.15"
                }
            ],
            "roles": [],
            "is_active": true,
            "device_type": "Computer",
            "tags": [],
            "importance": 3,
            "first_seen": 1767870000000,
            "last_seen": 1767871800000,
            "smartalert_count": 0,
            "asset_information_sources": null,
            "threat_score": 0,
            "operating_system": null,
            "state": "confirmed"
        },
        {
            "id": "37dbff6e-a552-4882-8c53-c608768b0f3c",
            "name": "10.0.2.3",
            "description": "",
            "addresses": [
                {
                    "type": "IP_V4",
                    "value": "10.0.2.3"
                }
            ],
            "roles": [],
            "is_active": true,
            "device_type": "Computer",
            "tags": [],
            "importance": 3,
            "first_seen": 1767870000000,
            "last_seen": 1767871800000,
            "smartalert_count": 0,
            "asset_information_sources": null,
            "threat_score": 0,
            "operating_system": null,
            "state": "confirmed"
        },
        {
            "id": "284f1f9e-1e4d-484b-9554-bef991d7c15b",
            "name": "10.1.0.1",
            "description": "",
            "addresses": [
                {
                    "type": "IP_V4",
                    "value": "10.1.0.1"
                }
            ],
            "roles": [],
            "is_active": true,
            "device_type": "Computer",
            "tags": [],
            "importance": 3,
            "first_seen": 1745398800000,
            "last_seen": 1745816400000,
            "smartalert_count": 0,
            "asset_information_sources": null,
            "threat_score": 0,
            "operating_system": null,
            "state": "confirmed"
        },
        {
            "id": "2a6d9be6-8399-4b3b-b315-a8b9e648af51",
            "name": "10.1.0.10",
            "description": "",
            "addresses": [
                {
                    "type": "IP_V4",
                    "value": "10.1.0.10"
                }
            ],
            "roles": [],
            "is_active": true,
            "device_type": "Computer",
            "tags": [],
            "importance": 3,
            "first_seen": 1745398800000,
            "last_seen": 1745816400000,
            "smartalert_count": 0,
            "asset_information_sources": null,
            "threat_score": 0,
            "operating_system": null,
            "state": "confirmed"
        },
        {
            "id": "3ce4cad4-4221-4b39-90ba-8f9707c7552f",
            "name": "10.1.0.100",
            "description": "",
            "addresses": [
                {
                    "type": "IP_V4",
                    "value": "10.1.0.100"
                }
            ],
            "roles": [],
            "is_active": true,
            "device_type": "Computer",
            "tags": [],
            "importance": 3,
            "first_seen": 1745398800000,
            "last_seen": 1745816400000,
            "smartalert_count": 0,
            "asset_information_sources": null,
            "threat_score": 0,
            "operating_system": null,
            "state": "confirmed"
        },
        {
            "id": "957486a6-3c28-470e-a736-58bb850faded",
            "name": "10.1.0.11",
            "description": "",
            "addresses": [
                {
                    "type": "IP_V4",
                    "value": "10.1.0.11"
                }
            ],
            "roles": [],
            "is_active": true,
            "device_type": "Computer",
            "tags": [],
            "importance": 3,
            "first_seen": 1745398800000,
            "last_seen": 1745816400000,
            "smartalert_count": 0,
            "asset_information_sources": null,
            "threat_score": 0,
            "operating_system": null,
            "state": "confirmed"
        },
        {
            "id": "12eefebb-cdff-42e8-a29c-1f701262696d",
            "name": "10.1.0.12",
            "description": "",
            "addresses": [
                {
                    "type": "IP_V4",
                    "value": "10.1.0.12"
                }
            ],
            "roles": [],
            "is_active": true,
            "device_type": "Computer",
            "tags": [],
            "importance": 3,
            "first_seen": 1745398800000,
            "last_seen": 1745816400000,
            "smartalert_count": 0,
            "asset_information_sources": null,
            "threat_score": 0,
            "operating_system": null,
            "state": "confirmed"
        },
        {
            "id": "8fbc355c-27aa-4175-826d-04196e6dd78b",
            "name": "10.1.0.13",
            "description": "",
            "addresses": [
                {
                    "type": "IP_V4",
                    "value": "10.1.0.13"
                }
            ],
            "roles": [],
            "is_active": true,
            "device_type": "Computer",
            "tags": [],
            "importance": 3,
            "first_seen": 1745398800000,
            "last_seen": 1745816400000,
            "smartalert_count": 0,
            "asset_information_sources": null,
            "threat_score": 0,
            "operating_system": null,
            "state": "confirmed"
        },
        {
            "id": "65f9c166-b131-40d4-82a0-80e0ec19a00c",
            "name": "10.1.0.14",
            "description": "",
            "addresses": [
                {
                    "type": "IP_V4",
                    "value": "10.1.0.14"
                }
            ],
            "roles": [],
            "is_active": true,
            "device_type": "Computer",
            "tags": [],
            "importance": 3,
            "first_seen": 1745398800000,
            "last_seen": 1745816400000,
            "smartalert_count": 0,
            "asset_information_sources": null,
            "threat_score": 0,
            "operating_system": null,
            "state": "confirmed"
        }
    ],
    "meta": {
        "dataTotalCount": 5137
    },
    "requestId": "6700b46c-ca1d-4911-9147-c5460c11edfc",
    "status": 200,
    "nextPageUri": "/ndr-public-api/v1/accounts/ACC-123456/asset/names?tenant_name=WGC-1-123abc456&value=&offset=10&size=10&sort=name&order=asc"
}

Data returned in the response might include:

data
array

Details of the asset.

id
string

Unique identifier of the asset.

name
string

Name or identifier of the asset.

Example: IP address.

description
string

Description of the asset.

addresses
array

Addresses associated with the asset.

type
string

Address type of the asset.

value
string

Value of the asset.

roles
array

Roles associated with the asset.

threat_score
integer

Threat score for the asset.

is_active
boolean

Indicates whether the asset is active.

device_type
deviceType

Device type of the asset.

tags
array

Tags associated with the asset.

importance
integer

Specifies the asset importance.

asset_information_sources
array

  • DHCP_LOG - Indicates that a DHCP log initiated the creation of the asset.
  • USER - Indicates that a user initiated the creation of the asset.
  • VPN_LOG - Indicates that a VPN log initiated the creation of the asset.
  • SYSTEM - Indicated that a system initiated the creation of the asset.

first_seen
integer

Unix epoch time in milliseconds when the asset was first seen.

last_seen
integer

Unix epoch time in milliseconds when the asset was last seen.

smartalert_count
integer

Number of Smart Alerts received on the asset.

operating_system
string

Operating system information.

state
string

Whether device is validated by observing bidirectional traffic.

For example: Confirmed

requestId
string

Specifies unique identifier of the request.

Example: xyz

status
integer

Specifies the response status.

Example: 200

meta
object

Specifies metadata for the request.

Example: { "dataTotalCount": 581 }

nextPageUri
string

Provides the URI to retrieve the next page of results, if available.

previousPageUri
string

Provides the URI to retrieve the previous page of results, if available.