Cancel Connector Schedule

Cancels a connector schedule.

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

The Cancel Connector Schedule API allows you to stop a configured connector schedule. This API stops the specified schedule and removes it from the connector configuration.

Quick Start

The Cancel Connector Schedule API has a single required parameter, connector, to specify the name of the connector with the schedule you want to cancel. For example:

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


{
  "connector": "mycloudconnector",
  "stopped_schedule": true
}

Note: For onsite flavor connectors, after you cancel the schedule, you must restart the connector for it to detect your configuration changes.

Synchronous
https://api.havenondemand.com/1/api/sync/cancelconnectorschedule/v1
Asynchronous
https://api.havenondemand.com/1/api/async/cancelconnectorschedule/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 with a schedule to cancel. 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.
Cancel Connector Schedule Response {
connector ( string ) The name of the connector.
stopped_schedule ( boolean ) True if successfully stopped connector schedule.
}
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"
        },
        "stopped_schedule": {
            "type": "boolean"
        }
    },
    "required": [
        "connector",
        "stopped_schedule"
    ],
    "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.