> Connector object

The following objects are directly related to the connector API.

Connector

The connector object has the following properties.

PropertyTypeDescription
connectoridstringID of the connector.

Property behavior:
- read-only
- required for update operations
namestringName of the connector.

Property behavior:
- required for create operations
urlintegerEndpoint URL, that is, URL of the receiver.
User macros are supported.

Property behavior:
- required for create operations
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: 0-2147483647 (max value of 32-bit signed integer).

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

Possible values: 1-100.

Default: 1.
max_attemptsintegerNumber of attempts.

Possible values: 1-5.

Default: 1.
timeoutstringTimeout.
Time suffixes are supported (e.g., 30s, 1m).
User macros are supported.

Possible values: 1s-60s.

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.
User macros are supported.

Property behavior:
- supported if authtype is set to “Basic”, “NTLM”, “Kerberos”, or “Digest”
passwordstringPassword.
User macros are supported.

Property behavior:
- supported if authtype is set to “Basic”, “NTLM”, “Kerberos”, or “Digest”
tokenstringBearer token.
User macros are supported.

Property behavior:
- required if authtype is set to “Bearer”
verify_peerintegerWhether to validate the host name matches with the URLs provided in the Common Name or Subject Alternate Name fields of the host certificate.

Possible values:
0 - Do not validate;
1 - (default) Validate.
verify_hostintegerWhether to validate the authenticity of the host certificate.

Possible values:
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.

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
tagstringTag name.

Property behavior:
- required
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.