Start Connector

Starts a connector.

Connectors allow you to retrieve information from external systems and update it through Haven OnDemand APIs. You can use it to create an index of the data in the external repository, automate workflows, for notifications, or to facilitate migration to other locations.

The Start Connector API starts a run of a cloud flavor connector according to the configuration that you created with the Create Connector API.

By default, the connector runs with its normal configuration, and sends content to the configured destination. You can override the connector destination when you start the run. For example, if the connector is configured to index into one Haven OnDemand text index, you can trigger a run to output the data to a different index.

Quick Start

The Start Connector API has a single required parameter, connector, to specify the name of the connector to start.

The connector status then switches to QUEUED. When the connector starts processing the request, the status switches to PROCESSING until the job is complete. You can check the status and further information upon job completion by using the Connector Status API.

The token property in the response is a unique identifier for the connector run that starts when you send the Start Connector request. You can use it to filter the Connector History API to a specific connector run.

URL

Authentication

This API requires an authentication token to be supplied in the following parameter:

Parameter

Description

apikey

The API key to use to authenticate the API request.

Parameters

This API accepts the following parameters:

Required

Name

Type

Description

connector

resource

The name of the connector to start. Maximum length of 100 characters.

Optional

Name

Type

Description

destination

json

A JSON object defining the destination to which the connector must send retrieved data. Currently it can send data only to a text index. This value overrides the currently configured destination. For details of the available properties, see the individual connector flavor documentation. See Connectors.

ignore_previous_state

boolean

Set to true to ignore the state of previous connector runs.
Default value: false.

token

string

The decryption token to use for decrypting connector credentials and credentials_policy (you receive the token by email). This parameter applies only to connectors with credentials. It is required only if you modify the destination parameter when you start the connector. If the token that you provide is not valid, Haven OnDemand sends a new token to the configured email address for the connector credentials policy.

This API returns a JSON response that is described by the model below. This single model is presented both as an easy to read abstract definition and as the formal JSON schema.

Haven OnDemand uses cookies to enhance and improve the experience it provides. By continuing to use this site or pressing Continue,
we will assume that you accept receiving all cookies. If you would like to change which cookies are set, you can change your settings.