/Intelligence/Add

Allows the client to add open intelligence about an endpoint.

JSON

Request

{
	"Information":
	{
		"endpoint": Required(Str(PEndpoint)),
		"expires": Required(DateTime(PExpires>Now)),
	    "vector": Optional(Str(PVector)),
		"protocol": Optional(Str(PProtocol)),
		"classification": Optional(Str(PClassification)),
		"code": Optional(Str(PCode)),
		"message": Optional(Str(PMessage)),
		"Tag":Optional(
		{
			"name": Required(Str(PTagName)),
		    "value": Required(Str(PTagValue)),
			"type": Optional(Str(PTagType))
		}[]),
		"AgentProperty":Optional(
		{
			"name": Required(Str(PAgentPropertyName))
		}[])
	}
}

Response (if successful)

{
	"objectId": Required(Str(PObjectId))
}

XML

Request

<AddIntelligence xmlns="https://waher.se/Schema/BrokerAgent.xsd">
	<Information endpoint=(Required(Str(PEndpoint)))
	             expires=(Required(DateTime(PExpires>Now)))
	             vector=(Optional(Str(PVector)))
	             protocol=(Optional(Str(PProtocol)))
	             classification=(Optional(Str(PClassification)))
	             code=(Optional(Str(PCode)))
	             message=(Optional(Str(PMessage)))>
		<[
		<Tag name=(Required(Str(PTagName)))
		     value=(Required(Str(PTagValue)))
			 type=(Optional(Str(PTagType)))/>[]
		]>
		<[
		<AgentProperty name=(Required(Str(PAgentPropertyName)))/>[]
		]>
	</Information>
</AddIntelligence>

Response (if successful)

<IntelligenceAdded xmlns="https://waher.se/Schema/BrokerAgent.xsd"
                   objectId=(Required(Str(PObjectId)))/>

Input Parameters

Parameter	Description
`PEndpoint`	The endpoint to which the information refers. It can be an IP endpoint, XMPP endpoint, etc. Format depends on the protocol used.
`PExpires`	When the information will be purged from the record.
`PVector`	A string representing the threat vector.
`PProtocol`	A string representing the protocol used.
`PClassification`	A string representing a classification of the information.
`PCode`	A machine-readable string-valued code representing the message or type of information added.
`PMessage`	A human readable message.
`PTagName`	Name of information meta-tag associated with the information.
`PTagValue`	Value of information meta-tag associated with the information.
`PTagType`	XML data type of information (with prefix `xs:`). If recognized by the system, the corresponding string-valued tag value will be parsed and stored in parsed format for improved interoperability.
`PAgentPropertyName`	Name of Agent property that will be stored with the information, together with the corresponding agent identity value (if one exists) of the agent user adding the intelligence. Adding agent information allows recipients to decide whether to trust the information or not.

Note: Most string-valued input parameters can be defined by the implementation or a standard.

Note 2: Use of standard prefix names may be expanded in the future to cover other types of information beyond the types specified for XML Schema simple types.

Response Parameters

Parameter	Description
`PObjectId`	A Globally Unique ID (GUID) representing the information.

Javascript Library

Use the following asynchronous method in the Javascript Library, to call this resource.

var Response = await AgentAPI.Intelligence.Add(Endpoint,Expires,Vector,Protocol,Classification,Code,Message,Tags,AgentProperties);

Test

Endpoint:

Expires:

Vector:

Protocol:

Classification:

Code:

Message: