Stop Connector

Stops a running 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 Stop Connector API allows you to manually stop a connector from running that was started using the Start Connector API.

Note: This API is available only for cloud flavor connectors, such as the Web Cloud Connector.

Quick Start

The Stop Connector API has a single required parameter, connector, to specify the name of the connector to stop. For example:

/1/api/[async|sync]/stopconnector/v1?connector=myconnector

This call returns a response of the following kind:

{
  "connector": "myconnector",
  "message": "Stopping connector... This process can take up 5 minutes to propagate."
}

You can stop a connector only if it is running. If the connector is not running, the API returns an error message.

After you send the Stop Connector request, it can take up to five minutes for the connector to stop. The connector might continue adding documents to your index until it is stopped. You cannot restart or delete the connector until it is fully stopped.

You can check whether the connector has stopped by using the Connector Status API. This API returns a status of STOPPING after you send the stop request, and STOPPED when the connector has successfully shut down.

Synchronous
https://api.havenondemand.com/1/api/sync/stopconnector/v1
Asynchronous
https://api.havenondemand.com/1/api/async/stopconnector/v1
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 stop. Maximum length of 100 characters.

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.

Asynchronous Use

Additional requests are required to get the result if this API is invoked asynchronously.

You can use /1/job/status/<job-id> to get the status of the job, including results if the job is finished.

You can also use /1/job/result/<job-id>, which waits until the job has finished and then returns the result.

Model
This is an abstract definition of the response that describes each of the properties that might be returned.
Stop Connector Response {
connector ( string ) The name of the connector.
message ( string ) Indicates that the connector is stopping.
}
Model Schema
This is a JSON schema that describes the syntax of the response. See json-schema.org for a complete reference.
{
    "properties": {
        "connector": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    },
    "required": [
        "connector",
        "message"
    ],
    "type": "object"
}


If you would like to provide us with more information then please use the box below:

We will use your submission to help improve our product.