--- title: "Custom Asset Metadata" slug: "custom-asset-metadata" tags: ["automation", "assets", "asset matching"] updated: 2024-12-18T18:05:50Z published: 2024-12-18T18:05:50Z canonical: "help.nucleussec.com/custom-asset-metadata" --- > ## Documentation Index > Fetch the complete documentation index at: https://help.nucleussec.com/llms.txt > Use this file to discover all available pages before exploring further. # Custom Asset Metadata ## Overview Custom asset fields allow you to pull in as much asset metadata as you want from any of the various tools you connect to Nucleus, e.g., ServiceNow, Qualys, Nexpose, Checkmarx,etc. This metadata is then centralized on the Additional Metadata panel on the asset details page. ## How custom asset fields work There are several ways to get custom asset metadata into Nucleus. 1. Use a Nucleus [Connector](/v1/docs/connectors) to pull in scan results from external scanners and the custom metadata will populate automatically. 2. Manually upload [FlexConnect](/docs/nucleus-custom-file-schema) files that contain the assets and their metadata. 3. Use the Nucleus [API](/v1/docs/api-documentation) to populate asset metadata. Custom metadata will show up in the **Additional Metadata** section on the Asset Details page. ![image.png](https://cdn.document360.io/3888970a-6501-459e-acc9-c47b71c6d64c/Images/Documentation/image%2875%29.png) Example: Microsoft Defender for Endpoint If you use the Nucleus [Microsoft Defender](/v1/docs/microsoft-defender-for-endpoint) connector, when you sync vulnerability data from the ATP console it will automatically populate the asset information in Nucleus with fields such as: owner, domain, group, and more. ## Automation rules and custom asset fields Nucleus allows you to use any custom field from your external systems as criteria for automation rules within Nucleus. Combined with Nucleus' default correlation capabilities, this gives you the flexibility to automate and orchestrate workflows **across** tools. ### Dot notation Nucleus uses a dot notation to make it simple to know which fields you would like to filter on, and where that field is coming from. A field called 'branch' coming from Checkmarx will be labeled as "cxsast.branch" whereas a field from ServiceNow called 'Active' will be labeled as 'servicenow.active' ![image.png](https://cdn.document360.io/3888970a-6501-459e-acc9-c47b71c6d64c/Images/Documentation/image%2884%29.png) ### Let's look at an example As an example, let's use Tenable.io, ServiceNow CMDB, and Jira to build a workflow across these tools. 1. You're ingesting asset data from [ServiceNow](/v1/docs/servicenow) and one of the custom fields is named "Active", with either a 1 or a 0. This field is set in the ServiceNow console. 2. In step 2 you set up a [tenable.io connector](/v1/docs/nessus-tenableio) to start importing your network scan data. Nucleus will automatically correlate asset data from ServiceNow CMDB to Tenable.io to deduplicate your list of assets. Your metadata will automatically populate from the connectors. 3. Finally, in step 3 you want to set up a ticketing rule to create a ticket in Jira. You go to "Automation > Ticketing Rules > Add Rule", and you choose to create a ticket in Jira whenever a new critical vulnerability is found by tenable. Using Nucleus' asset metadata, you can create ticketing rules. In the ticketing rule you can choose to filter on the assets using the field "servicenow.active" or any other field coming from the external system. Based on the rule, tickets will be created for those specific assets automatically. ![image.png](https://cdn.document360.io/3888970a-6501-459e-acc9-c47b71c6d64c/Images/Documentation/image%2885%29.png) With automation rules in Nucleus, you can trigger workflows with custom asset fields. For example, with [Asset Processing Rules](https://help.nucleussec.com/v1/docs/asset-processing-rules) and custom asset fields, you can group assets based on on any asset metadata you want. ## How to remove asset metadata keys/values If you want to remove asset metadata keys/values from an asset or multiple assets, use a [FlexConnect file upload](/v1/docs/nucleus-custom-file-schema). In your file, specify the metadata key for the [asset_info](https://help.nucleussec.com/docs/nucleus-custom-file-schema#asset-metadata-fields) field and set the value to an empty string. This will remove the metadata from the asset entirely. ## Asset URLs Note The following functionality is available on an opt-in basis. Please contact your Nucleus account representative or support to activate Nucleus can display a URL for an asset in the asset properties section of the asset overview page. Users with edit asset permissions and API access may set or update this value using the assets API. By default, no URL field or value will display on an asset if none has been set. ### Setting or Updating the Asset URL The URL field may be set in two ways: (1) When creating new assets using the POST /projects/{project_id}/assets/{asset_id} endpoint, and (2) when updating existing assets using the PUT /projects/{project_id}/assets/{asset_id} endpoint. The URL field may be updated using the PUT endpoint. To set the URL field, pass the following fields into the asset.info field in the body of the API: ``` { "asset_info": { "nucleus.url": "string", "nucleus.url-display": "string" } } ``` `nucleus.url` is a required field to set the URL. `nucleus.url-display` is optional. If `nucleus.url-display` is not set but `nucleus.url` is, the UI will display the full URL string provided in `nucleus.url`. If `nucleus.url-display` is provided without `nucleus.url`, the API will return an error code. #### Example: URL with Display Text ![image.png](https://cdn.document360.io/3888970a-6501-459e-acc9-c47b71c6d64c/Images/Documentation/image%28389%29.png) #### Example: URL without Display Text ![image.png](https://cdn.document360.io/3888970a-6501-459e-acc9-c47b71c6d64c/Images/Documentation/image%28388%29.png) ### Removing the Asset URL To remove URL display text or the URL itself, pass an empty string in one of the API fields specified above. ### ## Related - [Automation Workflows](/automation-workflows.md) - [Assets](/assets.md) - [File Schema](/flexconnect-framework.md)