Add - Neuron Agent API

Overview

Allows the client to add open intelligence about an endpoint.

HTTP request

POST /Agent/Intelligence/Add

Authentication

Requires a valid JWT bearer token.

Request (JSON)

{
	"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))
		}[])
	}
}

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	Named 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 adds recipients decide wether to trust the information or not.

Response (JSON)

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

Response parameters

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

Notes

This endpoint uses the request schema notation described in Pattern matching.

​Overview

​HTTP request

​Authentication

​Request (JSON)

​Input parameters

​Response (JSON)

​Response parameters

​Notes