PATCH /v1/connections/{connectionId}/state
Updates the connection state. To update the state, you should pause your connection first.
To update the connection state, do the following:
- Pause connection using Update a Connection endpoint (set 'paused' to 'true').
- Update the state by using the Update Connection State endpoint.
- Unpause the connection by setting the 'paused' parameter to 'false' in the Update a Connection endpoint request.
This endpoint is only supported for Function and Connection SDK connectors.
Servers
- https://api.fivetran.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
connectionId |
String | Yes |
The unique identifier for the connection within the Fivetran system |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept |
String | No |
Default value: "application/json;version=2" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.