NSX-T Data Center REST API

Get IDS Custom Signature

Get IDS Custom Signature.
This API is only available when using VMware NSX.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures/{sig-id}
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/security/intrusion-services/custom-signature-versions/{version-id}/custom-signatures/{sig-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IdsCustomSignature+

IdsCustomSignature (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
action	Represents the signature's action Signature action.	string
attack_target	Signature attack target Target of the signature.	string
categories	IDS Signature Internal category Represents the internal categories a signature belongs to.	array of IdsSignatureInternalCategory
children	Subtree for this type within policy tree Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.	array of ChildPolicyConfigResource Children are not allowed for this type
class_type	Signature class type Class type of Signature.	string
confidence	Confidence Signature's confidence score.	string
cves	Represents the cve score. CVE score	array of string
cvss	CVSS of signature Represents the cvss value of a Signature. The value is derived from cvssv3 or cvssv2 score. NONE means cvssv3/cvssv2 score as 0.0 LOW means cvssv3/cvssv2 score as 0.1-3.9 MEDIUM means cvssv3/cvssv2 score as 4.0-6.9 HIGH means cvssv3/cvssv2 score as 7.0-8.9 CRITICAL means cvssv3/cvssv2 score as 9.0-10.0	string	Enum: NONE, LOW, MEDIUM, HIGH, CRITICAL
cvss_score	Signature CVSS score Represents the cvss value of a Signature. The value is derived from cvssv3 or cvssv2 score. If cvssv3 exists, then this is the cvssv3 score, else it is the cvssv2 score.	string
cvssv2	Signature cvssv2 score Signature cvssv2 score.	string
cvssv3	Signature cvssv3 score Signature cvssv3 score.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
direction	Direction Source-destination direction.	string
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enable	Activate/Deactivate flag Flag which tells whether the signature is enabled or not.	boolean
flow	Flow established. Flow established from server, from client etc.	string
id	Unique identifier of this resource	string	Sortable
impact	Impact Impact of Signature.	string
malware_family	Malware Family Family of the malware tracked in the signature.	string
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
mitre_attack	MitreAttack Mitre Attack details of Signature.	array of MitreAttack
name	Represents the signature name Signature name.	string
origin_site_id	A unique identifier assigned by the system for knowing which site owns an object This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+.	string	Readonly
original_signature	Original Signature Represents the original signature provided by the user.	string	Readonly
original_signature_id	Original Signature Id Represents the original signature Id provided by the user.	string	Readonly
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
owner_id	A unique identifier assigned by the system for the ownership of an object This is a UUID generated by the system for knowing who owns this object. This is used in NSX+.	string	Readonly
parent_path	Path of its parent Path of its parent	string	Readonly
path	Absolute path of this object Absolute path of this object	string	Readonly
performance_impact	Performance impact Performance impact of the signature.	string
policy	Policy Signature policy.	array of string
product_affected	Signature product affected Product affected by this signature.	string
protocol	Protocol Protocol used in the packet analysis.	string
realization_id	A unique identifier assigned by the system for realizing intent This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent.	string	Readonly
relative_path	Relative path of this object Path relative from its parent	string	Readonly
remote_path	Path of the object on the remote end. This path is populated only in case of multi-site scenario. Currently it is supported only for LM objects. When LM is onboarded to multi-site platform like NAPP or GM, remote_path will be set to the globally unique path across multi-site topology . It is generated based on local site-name and uses /org tree namespace. Note: It is populated only for LM objects. Not supported on the GM.	string	Readonly
resource_type	Must be set to the value IdsCustomSignature	string
risk_score	Risk Score Risk score of signature.	string
severity	Signature severity Represents the severity of the Signature.	string
signature	Signature Decoded Signature.	string
signature_id	Signature ID Represents the Signature's id.	string
signature_revision	Signature revision Represents revision of the Signature.	string
signature_severity	Signature severity Signature vendor set severity of the signature rule.	string
tag	Signature tag Vendor assigned classification tag.	array of string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
threshold	IDS signature threshold values Default threshold values for IDS signature.	IdsSignatureThreshold
type	Type Signature type.	array of string
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly
urls	List of mitre attack URLs pertaining to signature. List of mitre attack URLs pertaining to signature	array of string
validation_errors	IdsValidationError Validation errors of Signature.	array of IdsValidationError	Readonly
validation_message	Warning/Error message Represents the warning/error message for the custom signature if any.	string	Readonly
validation_notes	ValidationNote Validation notes for Signature.	array of ValidationNote	Readonly
validation_status	Validation status Validation status of the custom signature.	string	Readonly Enum: VALID, INVALID, PENDING, WARNING

Example Response:

{ "original_signature_id": "1060921", "validation_status": "VALID", "resource_type": "IdsCustomSignature", "id": "1001060921", "path": "/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test/signatures/1001060921", "relative_path": "1001060921", "parent_path": "/infra/settings/firewall/security/intrusion-services/custom-signature-versions/Test", "marked_for_delete": false, "overridden": false, "name": "NSX - Detect Zeus activity", "class_type": "trojan-activity", "severity": "CRITICAL", "signature_revision": "3007", "signature_id": "1001060921", "categories": [ "APPLICATION" ], "cvssv3": "0.0", "cvssv2": "0.0", "attack_target": "Client_Endpoint", "product_affected": "NONE", "flow": "established,to_client", "action": "reject", "enable": true, "impact": "80", "risk_score": "100", "confidence": "80", "signature": "reject http $EXTERNAL_NET any -> $HOME_NET any (msg:\"NSX - Detect Zeus activity\"; flow:established,to_client; target:dest_ip; content:\"|00 00 00 00 8D|L|C8 15 F6|dps|C7|VQ5|03|C|DD|&\"; pcre:\"/^\\x00\\x00\\x00\\x00\\x8DL\\xC8\\x15\\xF6dps\\xC7VQ5\\x03C\\xDD&/Q\"; threshold: type limit, track by_dst, seconds 180, count 1; metadata:ll_verifier_outcome successful, flip_endpoints True, server_side False, threat_class_name command&control, threat_name Zeus Variant, ids_mode REAL, blacklist_mode REAL, exploited None, confidence 80, severity 100, detector_id 60921, signature_severity Critical; reference:url,www.lastline.com; classtype:trojan-activity; sid:1060921; rev:3007; priority:1;)", "_system_owned": false, "_protection": "NOT_PROTECTED", "_create_time": 1717743290322, "_create_user": "admin", "_last_modified_time": 1717743290322, "_last_modified_user": "admin", "_revision": 0 }

Required Permissions:

read

Feature:

policy_common_ids

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable