Retrieve Connector state
Returns the connector state. 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:
Http + 1.1
GET
https://api.fivetran.com/v1/connectors/connector_id/state
GET /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.
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": {}
}
}