Enrichment API Reference

This is a reference for the Enrichment API integration. The endpoint configuration follows the same pattern as the ExternalDb moobot module; there is a minimum set of required parameters and an optional set of parameters.

For information on the Enrichment API endpoint, see /enrichment.

Integration Name

Name of the Enrichment API integration instance.

Type

String

Required

Yes

Default

EnrichmentAPI1

Connection Information

Configuration required to access the datastore endpoint within your environment.

For a resilient Percona cluster you require a high availability configuration. See Single site HA for more information.Single site HA

Database Host

Database hostname. If you leave this blank, the integration uses the connection details for the system Percona cluster. You configure these in system.conf, in the "MySQL" section.

Type

String

Required

No

Default

N/A

Database Port

Port to connect to the database over.

Type

Integer

Required

Yes, unless Database Host is blank.

Default

3306

Database User

Username to connect to the database. You configure this when creating the moog_enrichment database.

Type

String

Required

Yes

Default

enrichment

Database Password

Password to connect to the database. You configure this when creating the moog_enrichment database.

Type

String

Required

Yes

Default

N/A

Additional Properties

Additional connection information. See "Database connection properties" in ExternalDb for more information.

Type

String

Required

No

Default

N/A

Caching

Options for in-memory caching of results the endpoint returns.

Record Lifetime

Length of time to cache records before the API refreshes, in seconds.

Type

Integer

Required

Yes

Default

Yes

Cache Negative Result

Specifies whether to cache negative results before the API refreshes.

Type

Boolean

Required

No

Default

Disabled

Lifetime

Length of time to cache negative results before the API refreshes, in seconds.

Type

Integer

Required

If Negative Caching is enabled.

Default

N/A