Integration Attributes
General Attributes
The following are general integration attributes.
name
string
Name of the integration. The name can be modified by admins and integration managers.
polarity-integration-uuid
string
Unique UUID identifier for the integration. The uuid is unique to the integration rather than unique to the installation. As an example, if you have two copies of the VirusTotal integration installed, both copies will have the same UUID even though they have different ids. The polarity-integration-uuid cannot be modified.
acronym
string
The integration's acronym. The acronym can be modified by admins and integration managers.
description
string
The integration's description. The description can be modified by admins and integration managers.
version
string
Integration version (e.g., 3.0.0)
status
string
running if the integration is running or stopped if the integration is not running
entity-types
array
Array of strings representing supported entity types for the integration. This lists the supported entity types and is not a list of entity types that are currently enabled. Valid entity types are IPv4, IPv4CIDR, IPv6, MD5, SHA1, SHA256, url, cve, domain, email, string.
custom-types
array
Array of custom types defined for the integration. If the value is an empty array then no custom types are defined
options
array
An array of option objects.
run-on-server-start
bool
true if the integration automatically starts when the server boots up
tls-allow-unauthorized
bool
true if integration allows untrusted SSL connections when making HTTPS requests
default-color-is-locked
bool
true if the default color of the integration is locked for all users
on-demand-only
bool
true if the integration has been set or is locked to be an on-demand only integration
default-color
string
The default color of the integration (this is not the color currently set by a user but the default set within the integration's config.json file)
autosubscribe
bool
true if "Team Subscription" is enabled for this integration.
User Specific Attributes
The following attributes are specific to the user making the request to the GET /api/integrations endpoint.
subscribed
bool
true if the requesting user is subscribed to the integration
color
string
The color of the integration for the selected user in hex format (e.g., #6237cf)
color-name
string
The color of the integration for the selected user as human readable text. (e.g., dark-purple)
Cache Attributes
The following attributes are related to the integration's cache settings.
cache-is-enabled
bool
true if the integration cache is enabled
cache-is-per-user
bool
true if each user has their own integration cache
cache-lookup-misses
bool
true if the integration is caching misses
cache-ttl
number
Number of seconds that a lookup result is cached
cache-miss-ttl
number
Number of seconds that a lookup miss is cached
Proxy Attributes
The following attributes are related to an integration's proxy settings
proxy.enabled
bool
true if an integration specific proxy is enabled.
proxy.host
string
host for the proxy
proxy.user
string
user for the proxy if the proxy requires authentication
proxy.password
password
password for the given proxy user
proxy.port
number
port the proxy is running on (e.g., 8080)
proxy.scheme
string
scheme for the proxy (i.e., http or https)
Auto Restart Attributes
The following attributes are related to the integration's auto restart settings.
auto-restart-enabled
bool
true if the integration is set to restart automatically in the event of a crash
auto-restart-reset-after-up-time
number
Number of milliseconds that must elapse before auto restart counts reset
auto-restart-max-wait-time
number
Maximum number of milliseconds to wait before auto-restarting an integration
auto-restart-min-wait-time
number
Minimum number of milliseconds to wait before auto-restarting an integration
auto-restart-starts
number
Number of automatic restarts since the last reset time and last server restart.
auto-restart-total-starts
number
Total number of automatic restarts since the last server restart.
Unused Attributes
These are deprecated attributes or attributes that are not yet being used in the platform
starts
number
Not currently used
path
string
Not currently used
custom-type-support
bool
Not currently used
metrics
object
Not currently used
cache-expiration-cron
bool
Not currently used
Integration Options
The options attribute on the integration model is an array of integration option objects. Each options object has the following attributes.
key
string
The key is an identifier for the option unique to the integration.
value
string/bool/number
The value of the option for the requesting user
description
string
A description of the option
default
string/bool/number
The default value for the option
admin_only
bool
The admin_only attribute is used in conjunction with the user_can_edit attribute to determine the permission level of the specific option.
admin_only: true - "Lock and hide option for all users"
admin_only: false, user_can_edit: true - "User provides options value"
admin_only: false, user_can_edit: false` - "Lock and show option for all users"
user_can_edit
bool
See admin_only
type
string
The type of the option which can be one of text, boolean, number, or select
integration_id
string
The id of the integration the option belongs to
Last updated