> Connector object

The following objects are directly related to the connector API.

Connector

The connector object has the following properties.

PropertyTypeDescription
connectoridstring(readonly) ID of the connector.
name
(required)
stringName of the connector.
url
(required)
integerEndpoint URL, i.e. URL of the receiver.

User macros are supported.
protocolintegerCommunication protocol.

Possible values:
0 - (default) Zabbix Streaming Protocol v1.0.
data_typeintegerData type.

Possible values:
0 - (default) Item values;
1 - Events.
max_recordsintegerMaximum number of events or items that can be sent within one message.

Possible values range: 0 - 2147483647 (max value of 32-bit signed integer).

Default: 0 - Unlimited.
max_sendersintegerNumber of sender processes to run for this connector.

Possible values range: 1-100.

Default: 1.
max_attemptsintegerNumber of attempts.

Possible values range: 1-5.

Default: 1.
timeoutstringTimeout.

Time suffixes are supported, e.g. 30s, 1m.
User macros are supported.

Possible values range: 1-60 seconds.

Default: 5s.
http_proxystringHTTP(S) proxy connection string given as [protocol]://[username[:password]@]proxy.example.com[:port].

User macros are supported.
authtypeintegerHTTP authentication method.

Possible values:
0 - (default) None;
1 - Basic;
2 - NTLM;
3 - Kerberos;
4 - Digest;
5 - Bearer.
usernamestringUser name.

Available if HTTP authentication method is Basic, NTLM, Kerberos or Digest.

User macros are supported.
passwordstringPassword.

Available if HTTP authentication method is Basic, NTLM, Kerberos or Digest.

User macros are supported.
tokenstringBearer token

Required if HTTP authentication method is Bearer.

User macros are supported.
verify_peerintegerValidate host name in URL is in Common Name field or a Subject Alternate Name field of host certificate.

0 - Do not validate.
1 - (default) Validate.
verify_hostintegerValidate is host certificate authentic.

0 - Do not validate.
1 - (default) Validate.
ssl_cert_fileintegerPublic SSL Key file path.

User macros are supported.
ssl_key_fileintegerPrivate SSL Key file path.

User macros are supported.
ssl_key_passwordintegerPassword for SSL Key file.

User macros are supported.
descriptionstringDescription of the connector.
statusintegerWhether the connector is enabled.

Possible values:
0 - Disabled;
1 - (default) Enabled.
tags_evaltypeintegerTag evaluation method.

Possible values:
0 - (default) And/Or;
2 - Or.

Note that for some methods (update, delete) the required/optional parameter combination is different.

Tag filter

Tag filter allows to export only matching item values or events. If not set then everything will be exported. The tag filter object has the following properties.

PropertyTypeDescription
tag
(required)
stringTag name.
operatorintegerCondition operator.

Possible values:
0 - (default) Equals;
1 - Does not equal;
2 - Contains;
3 - Does not contain;
12 - Exists;
1 - Does not exist.
valuestringTag value.