Table of Contents
  1. JSON
  2. XML
  3. Input Parameters
  4. Response Parameters
  5. Javascript Library

/Intelligence/CheckEndpoint

Allows the client to check open intelligence of an endpoint.

JSON

Request
{
	"endpoint":Required(Str(PEndpoint))
}
Response (if successful)
{
	"endpoint": Required(Str(PEndpoint)),
	"EndpointInfo": Optional(
	{
		"created": Required(DateTime(PCreated)),
		"domain": Required(Str(PDomain)),
		"lastProtocol": Required(Str(PLastProtocol)),
		"lastFailed": Required(Bool(PLastFailed)),
		"permanentBlock": Optional(Bool(PPermanentBlock)),
		"temporaryBlock": Optional(DateTime(PTemporaryBlock)),
		"reason": Optional(Str(PReason)),
		"whois": Optional(Str(PWhois)),
		"city": Optional(Str(PCity)),
		"region": Optional(Str(PRegion)),
		"country": Optional(Str(PCountry)),
		"countryCode": Optional(Str(PCountryCode)),
		"flag": Optional(Str(PFlag))
	})
}

XML

Request
<CheckEndpoint xmlns="https://waher.se/Schema/BrokerAgent.xsd"
               endpoint=(Required(Str(PEndpoint))) />
Response (if successful)
<Endpoint xmlns="https://waher.se/Schema/BrokerAgent.xsd"
          endpoint=(Required(Str(PEndpoint)))>
	<[Optional(
	<EndpointInfo xmlns="https://waher.se/Schema/BrokerAgent.xsd"
	              created=(Required(DateTime(PCreated)))
	              domain=(Required(Str(PDomain)))
	              lastProtocol=(Required(Str(PLastProtocol)))
	              lastFailed=(Required(Bool(PLastFailed)))
	              permanentBlock=(Optional(Bool(PPermanentBlock)))
	              temporaryBlock=(Optional(DateTime(PTemporaryBlock)))
	              reason=(Optional(Str(PReason)))
	              whois=(Optional(Str(PWhois)))
	              city=(Optional(Str(PCity)))
	              region=(Optional(Str(PRegion)))
	              country=(Optional(Str(PCountry)))
	              countryCode=(Optional(Str(PCountryCode)))
	              flag=(Optional(Str(PFlag))) />
	)]>
</Endpoint>

Input Parameters

Parameter Description
PEndpoint The endpoint to check. It can be an IP endpoint, XMPP endpoint, etc. Format depends on the protocol used.

Response Parameters

Parameter Description
PEndpoint Endpoint recorded in the record. This may be the same in the input, or a scaled down version, depending on the protocol. For IP Endpoints, the port number is removed (for instance).
PCreated When the record was created.
PLastProtocol Last protocol used from endpoint.
PLastFailed If last authentication attempt failed.
PPermanentBlock If endpoint is permanently blocked.
PTemporaryBlock If endpoint is temporarily blocked, and when next login attempt is allowed.
PReason Reason for any block.
PWhois WHOIS information about the endpoint, if available.
PCity City associated with endpoint.
PRegion Region associated with endpoint.
PCountry Country associated with endpoint.
PCountryCode Country code associated with endpoint.
PFlag Country flag associated with endpoint.

Javascript Library

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

var Response = await AgentAPI.Intelligence.CheckEndpoint(Endpoint);
Test


Request Payload:

Response Payload: