Modify a Connector state
Modifies the connector state. To update the state, you should pause your connector first.
To modify the connector state, do the following:
- Pause connector using Modify a Connector endpoint (set 'paused' to 'true').
- Update the state by using the Update Connector State endpoint.
- Unpause the connector by setting the 'paused' parameter to 'false' in the Modify a Connector endpoint request.
This endpoint is only supported for Function and Connector SDK connectors.
Request schema
Path parameters
connectorId
stringrequired
The unique identifier for the connector within the Fivetran system
example:
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Accept
string
default:
example:
Request
state
object
Http + 1.1
PATCH
https://api.fivetran.com/v1/connectors/connector_id/state
PATCH /v1/connectors/connector_id/state HTTP/1.1
Accept: application/json;version=2
Authorization: Basic REPLACE_BASIC_AUTH
Host: api.fivetran.com
Responses
200
Successful response
400
The connector state doesn't exist.
404
Connector not found error.
405
Not a function connector error.
409
Connector cannot be updated because the sync is in progress.
Successful response schema
code
stringrequired
Response status code
example:
message
string
Response status text
example:
data
objectrequired
state
object
{
"code": "Success",
"message": "Operation performed.",
"data": {
"state": {}
}
}