Delete Connector

Deletes 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 Delete Connector API allows you to delete an existing connector configuration. You provide the name of a connector that you created with the Create Connector API. After you send the API request, the API asks for confirmation that you want to delete the connector.

After you delete the connector, you cannot use that configuration again.

Quick Start

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

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

{
  "deleted": true,
  "connector": "myconnector"
}

Note: For onsite flavor connectors, there might be a delay before the onsite connector stops transmitting information to Haven OnDemand.

Synchronous
https://api.havenondemand.com/1/api/sync/deleteconnector/v1
Asynchronous
https://api.havenondemand.com/1/api/async/deleteconnector/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 delete. 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.
Delete Connector Response {
connector ( string ) The name of the connector.
deleted ( boolean ) Indicates that the connector was deleted successfully.
}
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"
        },
        "deleted": {
            "type": "boolean"
        }
    },
    "required": [
        "connector",
        "deleted"
    ],
    "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.