Connect Card
Generates the Connect Card URI for the connector
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
example:
application/json;version=2
default:
application/json;version=2
Request
connect_card_config
object
redirect_uri
stringrequired
The URI on your site we redirect the end user to after successful setup. The URI must start with the https or http prefix.
example:
hide_setup_guide
boolean
An optional parameter that lets you hide the embedded setup guide in the Connect Card.
example:
Http + 1.1
POST
https://api.fivetran.com/v1/connectors/null/connect-card
POST /v1/connectors/null/connect-card HTTP/1.1
Accept: application/json;version=2
Authorization: Basic REPLACE_BASIC_AUTH
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 4
null
Responses
200
Successful response
Successful response schema
code
stringrequired
Response status code
example:
message
string
Response status text
example:
data
objectrequired
connect_card
object
token
string
The connect-card auth token
example:
uri
string
The Connect Card URI for the user interface
example:
connector_id
stringrequired
The connector identifier
example:
connect_card_config
object
redirect_uri
stringrequired
The URI on your site we redirect the end user to after successful setup. The URI must start with the https or http prefix.
example:
hide_setup_guide
boolean
An optional parameter that lets you hide the embedded setup guide in the Connect Card.
example:
null