{ "openapi": "3.0.1", "info": { "title": "OpenAPI Definition", "description": "The OpenAPI Specification is a standard format to define the structure and syntax of REST APIs. OpenAPI documents are both machine and human-readable, which enables anyone to easily determine how each API works. [More details](https://www.openapis.org/faq)", "version": "v1" }, "servers": [ { "url": "https://api.fivetran.com" } ], "security": [ { "basicAuth": [] } ], "tags": [ { "name": "updated", "description": "2026-10-13T20:08:43.611Z" }, { "name": "hash", "description": "cd24bf70fd2e997549dd734ea8b57a0b2857668bf7a958a055e2728f17ab2323" } ], "paths": { "/public/connector-types": { "get": { "tags": [ "Public Endpoints" ], "summary": "Retrieve Source Metadata Public Endpoint", "description": "Returns all available source types. This endpoint provides metadata including the proper source name (‘Facebook Ads’ instead of facebook_ads), the source icon, feature tables, information about the Hybrid deployment support, information about the Authorization via API support, and links to Fivetran resources. As we update source names and icons, that metadata will automatically update within this endpoint.", "operationId": "metadata_public_connectors", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connector metadata retrieved successfully" }, "data": { "$ref": "#/components/schemas/MetadataResponse" } } } } } } }, "security": [] } }, "/v1/account/info": { "get": { "tags": [ "Account Management" ], "summary": "Get Account Info from the API Key", "description": "Returns information about current account from API key.", "operationId": "get_account_info", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Account information retrieved successfully" }, "data": { "$ref": "#/components/schemas/AccountInfoResponse" } } } } } }, "401": { "description": "Invalid authorization credentials" } } } }, "/v1/certificates": { "post": { "tags": [ "Certificate Management" ], "summary": "(Deprecated) Approve a Certificate", "description": "Approves a certificate for a connection/destination, so Fivetran trusts this certificate for a source/destination database. The connection/destination setup tests will fail if a non-approved certificate is provided.", "operationId": "approve_certificate", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrustCertificateRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "The certificate has been approved." } } } } } } }, "deprecated": true } }, "/v1/connections": { "get": { "tags": [ "Connection Management" ], "summary": "List All Connections", "description": "Returns a list of all accessible connections within your Fivetran account.", "operationId": "list_connections", "parameters": [ { "name": "group_id", "in": "query", "description": "Filter the list to connections belonging to this group. Retrieve group IDs from the [List All Groups](https://fivetran.com/docs/rest-api/api-reference/groups/list-all-groups) endpoint.", "required": false, "schema": { "type": "string", "example": "group_id" }, "example": "group_id" }, { "name": "schema", "in": "query", "description": "Filter the list to connections whose schema name matches this value. Partial matches are not supported.", "required": false, "schema": { "type": "string", "example": "schema" }, "example": "schema" }, { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connections list retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/ConnectorResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } }, "401": { "description": "Unauthorized error" }, "405": { "description": "Method not allowed error" }, "406": { "description": "Not acceptable error" } } }, "post": { "tags": [ "Connection Management" ], "summary": "Create a Connection", "description": "Creates a new connection within a specified group in your Fivetran account. Runs setup tests and returns testing results.
\n> IMPORTANT: The `destination_schema_names` field will soon become a required field. Make sure to include it in your API requests when creating new connections to prevent future disruptions.\n> IMPORTANT: If you want to get the fingerprint details, do not set `trust_fingerprints` to `true` when you create a connection with our REST API. We can only provide the fingerprint details through the failed SSH Tunnel Connection setup test. For a full walkthrough, see [Get Connection Fingerprint Details](https://fivetran.com/docs/rest-api/tutorials/get-connection-fingerprint-details).", "operationId": "create_connection", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewConnectorRequestV1" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection has been created" }, "data": { "$ref": "#/components/schemas/ConnectorResponseV1" } } } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found error" }, "406": { "description": "Not acceptable" }, "409": { "description": "Conflict" }, "415": { "description": "Unsupported media type" } } } }, "/v1/connections/{connectionId}": { "get": { "tags": [ "Connection Management" ], "summary": "Retrieve Connection Details", "description": "Returns a connection configuration and status details if a valid identifier was provided.", "operationId": "connection_details", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection details retrieved successfully" }, "data": { "$ref": "#/components/schemas/ConnectorResponseV1" } } } } } }, "401": { "description": "Unauthorized error" }, "404": { "description": "Not found error" }, "405": { "description": "Method not allowed error" }, "406": { "description": "Not acceptable error" } } }, "delete": { "tags": [ "Connection Management" ], "summary": "Delete a Connection", "description": "Deletes a connection from your Fivetran account.", "operationId": "delete_connection", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection with id 'string' has been deleted" } } } } } }, "404": { "description": "Not found error" } } }, "patch": { "tags": [ "Connection Management" ], "summary": "Update a Connection", "description": "Updates connection parameters for an existing connection within your Fivetran account.\n\nThis endpoint requires at least one persistent configuration parameter to be specified (e.g., `sync_frequency`, `paused`, `config`, `auth`, `daily_sync_time`, `schema_status`).\n\n> IMPORTANT: Parameters like `trust_certificates`, `trust_fingerprints`, and `run_setup_tests` are test-control parameters that affect only the behavior of setup tests during the update and do not persist in the connection configuration; they cannot be used on their own. If you want to run setup tests without making configuration changes, use the POST `/v1/connections/{connectionId}/test` endpoint instead.\n", "operationId": "modify_connection", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConnectorRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection has been updated" }, "data": { "$ref": "#/components/schemas/ConnectorResponseV1" } } } } } }, "404": { "description": "Not found error" } } } }, "/v1/connections/{connectionId}/certificates": { "get": { "tags": [ "Certificate Management" ], "summary": "List Certificates Approved for the Connection", "description": "Returns the list of approved certificates for the specified connection.", "operationId": "get_connection_certificates_list", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection certificates retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/CertificateDetailsResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } }, "404": { "description": "Connection not found." } } }, "post": { "tags": [ "Certificate Management" ], "summary": "Approve a Certificate for the Connection", "description": "Approves a certificate, so Fivetran trusts this certificate for a source database connection. \nThe connection setup tests will fail if a non-approved certificate is provided.\n\n> NOTE: This is only required for source connections based on the following databases: \n> - [MySQL](https://fivetran.com/docs/connectors/databases/mysql#supportedservices)\n> - [PostgreSQL](https://fivetran.com/docs/connectors/databases/postgresql#supportedservices)\n> - [SQLServer](https://fivetran.com/docs/connectors/databases/sql-server#supportedservices)\n", "operationId": "approve_connection_certificate", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveCertificateRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "The certificate has been approved." }, "data": { "$ref": "#/components/schemas/CertificateDetailsResponse" } } } } } }, "400": { "description": "Missing `hash` or `encoded_cert` fields in request payload" }, "404": { "description": "Connection not found" } } } }, "/v1/connections/{connectionId}/certificates/{hash}": { "get": { "tags": [ "Certificate Management" ], "summary": "Retrieve Connection Certificate Details", "description": "Returns details of the certificate approved for the specified connection with specified certificate hash.", "operationId": "get_connection_certificate_details", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "hash", "in": "path", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate).", "required": true, "schema": { "type": "string", "example": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g" }, "example": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection certificate details retrieved successfully" }, "data": { "$ref": "#/components/schemas/CertificateDetailsResponse" } } } } } }, "404": { "description": "Certificate with specified hash not found" } } }, "delete": { "tags": [ "Certificate Management" ], "summary": "Revoke Connection Certificate", "description": "Revokes a certificate, so Fivetran no longer trusts it while connecting to the source database.", "operationId": "revoke_connection_certificate", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "hash", "in": "path", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate).", "required": true, "schema": { "type": "string", "example": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g" }, "example": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Certificate 'string' has been revoked for connection 'string'" } } } } } }, "404": { "description": "Certificate with specified hash not found" } } } }, "/v1/connections/{connectionId}/connect-card": { "post": { "tags": [ "Connection Management" ], "summary": "Create a Connect Card", "description": "Generates the Connect Card URI for the connection", "operationId": "connect_card", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectCardConfigRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection Connect Card has been created" }, "data": { "$ref": "#/components/schemas/ConnectorConnectCardResponse" } } } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found error" }, "406": { "description": "Not acceptable" }, "415": { "description": "Unsupported media type" } } } }, "/v1/connections/{connectionId}/fingerprints": { "get": { "tags": [ "Certificate Management" ], "summary": "List Fingerprints Approved for the Connection", "description": "Returns the list of approved SSH fingerprints for specified connection", "operationId": "get_connection_fingerprints_list", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection fingerprints retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/FingerprintDetailsResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } }, "404": { "description": "Connection not found" } } }, "post": { "tags": [ "Certificate Management" ], "summary": "Approve a Fingerprint for the Connection", "description": "Approves a fingerprint, enabling Fivetran to trust it for a source database and establish connections via an SSH tunnel.", "operationId": "approve_connection_fingerprint", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveFingerprintRequest" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FingerprintDetailsResponse" } } } }, "400": { "description": "Missing `hash` or `public_key` fields in request payload" }, "404": { "description": "Connection not found" } } } }, "/v1/connections/{connectionId}/fingerprints/{hash}": { "get": { "tags": [ "Certificate Management" ], "summary": "Retrieve Connection Fingerprint Details", "description": "Returns SSH fingerprint details approved for specified connection with specified hash", "operationId": "get_connection_fingerprint_details", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "hash", "in": "path", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint).", "required": true, "schema": { "type": "string", "example": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g" }, "example": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection fingerprint details retrieved successfully" }, "data": { "$ref": "#/components/schemas/FingerprintDetailsResponse" } } } } } }, "404": { "description": "Fingerprint with specified hash not found" } } }, "delete": { "tags": [ "Certificate Management" ], "summary": "Revoke Connection Fingerprint", "description": "Revokes a fingerprint, so Fivetran no longer trusts it while connecting to the source database through an SSH tunnel.", "operationId": "revoke_connection_fingerprint", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "hash", "in": "path", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint).", "required": true, "schema": { "type": "string", "example": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g" }, "example": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Fingerprint with hash 'string' has been revoked for connection with id 'string'" } } } } } }, "404": { "description": "Fingerprint with specified hash not found" } } } }, "/v1/connections/{connectionId}/move": { "post": { "tags": [ "Connection Management" ], "summary": "Move a Connection", "description": "Moves a connection from its current destination group to a different destination group. The connection must be paused before calling this endpoint. Use `sync_behavior` to control how data syncs after the move: `CONTINUE` preserves the existing sync cursor so the connection resumes incremental sync from where it left off; `BACKFILL` resets the cursor and triggers a historical sync; `CONTINUE_WITH_DATA` preserves the cursor and additionally migrates existing data to the new destination by starting an asynchronous job. Use the `job_id` returned in the response to monitor progress via the move-connection-job-status endpoint. `CONTINUE_WITH_DATA` is supported only when moving a connection from Snowflake Native tables to a MDLS-linked Snowflake Lakehouse destination.", "operationId": "connection_moved", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveConnectionsRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection moved successfully" }, "data": { "$ref": "#/components/schemas/MoveConnectionsResponse" } } } } } }, "400": { "description": "Bad request error" }, "401": { "description": "Unauthorized error" }, "404": { "description": "Not found error" }, "406": { "description": "Not acceptable error" }, "415": { "description": "Unsupported media type error" } } } }, "/v1/connections/{connectionId}/move/{jobId}": { "get": { "tags": [ "Connection Management" ], "summary": "Retrieve Move Connection Job Status", "description": "Retrieves the status of an asynchronous connection move job. Use this endpoint to monitor the progress of a connection move operation that was initiated with the `CONTINUE_WITH_DATA` sync behavior.", "operationId": "connection_moved_job_status", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "jobId", "in": "path", "description": "The unique identifier of the move job. This is returned in the response when you initiate a connection move.", "required": true, "schema": { "type": "string", "example": "01234567-89ab-cdef-0123-456789abcdef" }, "example": "01234567-89ab-cdef-0123-456789abcdef" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Move connection job status retrieved successfully" }, "data": { "$ref": "#/components/schemas/MoveConnectionJobResponse" } } } } } }, "400": { "description": "Bad request error" }, "401": { "description": "Unauthorized error" }, "404": { "description": "Not found error" } } } }, "/v1/connections/{connectionId}/resync": { "post": { "tags": [ "Connection Management" ], "summary": "Re-sync Connection Data (Historical Sync)", "description": "Triggers a full historical sync of a connection or multiple schema tables within a connection. If the connection is paused, the table sync will be scheduled to be performed when the connection is re-enabled. If there is a data sync already in progress, we will try to complete it. If it fails, the request will be declined and the HTTP 409 Conflict error will be returned.", "operationId": "resync_connection", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResyncConnectorRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Sync has been successfully triggered for connection with id 'string'" } } } } } }, "400": { "description": "Bad request error. Returned when the scope object is empty, a schema key maps to an empty table array, or the connector does not support table-level re-sync." }, "401": { "description": "Unauthorized error" }, "404": { "description": "Not found error" }, "405": { "description": "Method not allowed error" }, "406": { "description": "Not acceptable error" }, "409": { "description": "Conflict error. Returned when a data sync is already in progress and cannot be completed before the re-sync can be scheduled." }, "415": { "description": "Unsupported media type error" } } } }, "/v1/connections/{connectionId}/schemas": { "get": { "tags": [ "Connection Schema Management" ], "summary": "Retrieve a Connection Schema Config", "description": "\nReturns the top-level schema configuration for an existing connection within your Fivetran account. The response includes global flags, every schema, each table, and only the columns that were explicitly overridden. \n\nUse this endpoint to read the current data-selection tree for a connection, to back up the schema before making edits, or to copy the configuration to another connection.\n\n> NOTE: To restore a backed-up schema or copy the configuration to another connection, use the [Update a Connection Schema Config](/docs/rest-api/api-reference/connection-schema/modify-connection-schema-config) endpoint.\n\nFor more information, see the [Connection Schema config](https://fivetran.com/docs/rest-api/tutorials/connection-schema-configuration-use-cases) tutorial.\n\n> NOTE: Unedited columns (those following table defaults) are omitted from the response. For a read-only cataloging workflow, walk this response from schemas to tables, inspect each table's `supports_columns_config` field, and call the [Retrieve Source Table Columns Config](/docs/rest-api/api-reference/connection-schema/connection-column-config) endpoint only for tables where that field is `true`.\n\nFor the NetSuite SuiteAnalytics, and Salesforce and Salesforce Sandbox connectors, the 'schemas' map field contains a single entry with the 'netsuite' or 'salesforce' key, respectively. For the 'schema.name_in_destination` name field, these connectors always return the destination schema name you set in the connection setup form.\n\nFor more information on using this API endpoint with the the Oracle Fusion Cloud Applications connectors, see the [Schema information documentation](https://fivetran.com/docs/connectors/applications/oracle-fusion-cloud-applications#schemainformation).\n\n> IMPORTANT: This endpoint does not apply to [Magic Folder](/docs/connectors/files#magicfolder) connectors.\n", "operationId": "connection_schema_config", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Schema configuration retrieved successfully" }, "data": { "$ref": "#/components/schemas/StandardConfigResponse" } } } } } } } }, "post": { "tags": [ "Connection Schema Management" ], "summary": "Set Up a New Connection Schema Config", "description": "Configures a Connection Schema for a new connection before the schema is captured from the source.\n\n> NOTE: The response returns the exact settings provided in the request.\n\nAfter the initial sync, when the connection captures the schema from the source, Fivetran attempts to apply the specified settings to the actual schema.\nIf certain tables or columns cannot be excluded, the settings for those entities are ignored.\n", "operationId": "pre_create_connection_schema_config", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardConfigCreateRequest" }, "examples": { "pre_create_schema_config_request": { "value": { "schemas": { "schema_name": { "enabled": true, "tables": { "table_name": { "enabled": true, "sync_mode": "SOFT_DELETE", "columns": { "column_name": { "enabled": true, "hashed": false } } } } } }, "schema_change_handling": "ALLOW_COLUMNS" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Schema configuration pre-created successfully" }, "data": { "$ref": "#/components/schemas/StandardConfigResponse" } } } } } } } }, "patch": { "tags": [ "Connection Schema Management" ], "summary": "Update a Connection Schema Config", "description": "Updates the schema config for an existing connection within your Fivetran account.\n\n> NOTE: For backward compatibility, the response may contain the 'enable_new_by_default' boolean field. It defines whether new schemas and tables discovered in the source are synced. The value is 'true' if you specify 'ALLOW_ALL' as a value of 'schema_change_handling'. In the future API versions, we may remove this field.\n>\n> The response contains all known schemas and tables. Also, it contains columns whose state has ever been set by the user. For more information, see also the [Connection Schema config](https://fivetran.com/docs/rest-api/tutorials/connection-schema-configuration-use-cases) tutorial.\n", "operationId": "modify_connection_schema_config", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardConfigUpdateRequest" }, "examples": { "modify_schema_config_request": { "value": { "schemas": { "schema_name": { "enabled": true, "tables": { "table_name": { "enabled": true, "sync_mode": "SOFT_DELETE", "columns": { "column_name": { "enabled": true, "hashed": false } } } } } }, "schema_change_handling": "BLOCK_ALL" } }, "modify_schema_config_row_filter_request": { "value": { "schemas": { "schema_name": { "enabled": true, "tables": { "orders": { "enabled": true, "row_filter": { "name": "active_orders", "description": "Sync only active orders", "column_clauses": [ { "column": "status", "column_type": "STRING", "operator": "EQUALS", "values": [ "ACTIVE" ] } ] } }, "customers": { "enabled": true, "row_filter": null }, "events": { "enabled": true } } } } } }, "modify_schema_config_row_filter_or_request": { "value": { "schemas": { "schema_name": { "enabled": true, "tables": { "orders": { "enabled": true, "row_filter": { "name": "high_value_or_us", "description": "Sync high-value orders or US orders", "operator": "OR", "column_clauses": [ { "column": "amount", "column_type": "LONG", "operator": "GREATER", "values": [ "1000" ] }, { "column": "country", "column_type": "STRING", "operator": "EQUALS", "values": [ "US" ] } ] } } } } } } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Schema configuration has been modified" }, "data": { "$ref": "#/components/schemas/StandardConfigResponse" } } } } } } } } }, "/v1/connections/{connectionId}/schemas/drop-columns": { "post": { "tags": [ "Connection Schema Management" ], "summary": "Drop Blocked Columns from the Destination.", "description": "Mark multiple blocked columns for deletion from your destination tables. The columns will be dropped during the next sync.", "operationId": "delete_multiple_columns_connection_config", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DropColumnsRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Column(s) successfully marked for deletion" } } } } } }, "400": { "description": "Bad request" }, "404": { "description": "Not found error" }, "409": { "description": "Column not in blocked state error" } } } }, "/v1/connections/{connectionId}/schemas/reload": { "post": { "tags": [ "Connection Schema Management" ], "summary": "Reload a Connection Schema Config", "description": "Reloads the connection schema config for an existing connection within your Fivetran account.\n\n> NOTE: This method reloads the full schema from the connection's data source. It may take a long time to complete the request. The method execution speed depends on the schema size and the number of databases, tables, and columns.\n>\n> The response contains all known schemas and tables. Also, it contains columns whose state has ever been set by the user. For more information, see also the [Connection Schema config](https://fivetran.com/docs/rest-api/tutorials/connection-schema-configuration-use-cases) tutorial.\n", "operationId": "reload_connection_schema_config", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReloadStandardConfigRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Schema configuration has been reloaded" }, "data": { "$ref": "#/components/schemas/StandardConfigResponse" } } } } } } } } }, "/v1/connections/{connectionId}/schemas/tables/resync": { "post": { "tags": [ "Connection Schema Management" ], "summary": "Re-sync Connection Table Data", "description": "Triggers a historical sync of all data for multiple schema tables within a connection. This action does not override the standard sync frequency you defined in the Fivetran dashboard.", "operationId": "resync_tables", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "schema": { "title": "Schema name", "uniqueItems": true, "type": "array", "description": "Schema name", "example": [ "table1", "table2" ], "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Re-sync has been triggered successfully" } } } } } } } } }, "/v1/connections/{connectionId}/schemas/{schemaName}": { "patch": { "tags": [ "Connection Schema Management" ], "summary": "Update a Connection Database Schema Config", "description": "Updates the database schema config for an existing connection within your Fivetran account (for a single schema within a connection with multiple schemas). \n\n> NOTE: The response contains all known schemas and tables. Also, it contains columns whose state has ever been set by the user. For more information, see also the [Connection Schema config](https://fivetran.com/docs/rest-api/tutorials/connection-schema-configuration-use-cases) tutorial. \n\nIn this API call, the NetSuite SuiteAnalytics, Salesforce and Salesforce Sandbox connectors always return the schema name as 'netsuite' and 'salesforce', respectively. \n\nFor more information about this API call for the Oracle Fusion Cloud Applications connectors, see our [Schema information](https://fivetran.com/docs/connectors/applications/oracle-fusion-cloud-applications#schemainformation) documentation.\n", "operationId": "modify_connection_database_schema_config", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "schemaName", "in": "path", "description": "The schema name as stored in the connection schema config. This value is case-sensitive; an incorrect case results in an HTTP 404 error.", "required": true, "schema": { "type": "string", "example": "schemaName" }, "example": "schemaName" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaUpdateRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Database schema configuration has been modified" }, "data": { "$ref": "#/components/schemas/StandardConfigResponse" } } } } } } } } }, "/v1/connections/{connectionId}/schemas/{schemaName}/tables/{tableName}": { "patch": { "tags": [ "Connection Schema Management" ], "summary": "Update a Connection Table Config", "description": "Updates the table config within your database schema for an existing connection within your Fivetran account.\n\nFor the NetSuite SuiteAnalytics and Salesforce and Salesforce Sandbox connectors, the 'schemas' map field will always have a single entry with the 'netsuite' or 'salesforce' key, respectively.\n", "operationId": "modify_connection_table_config", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "schemaName", "in": "path", "description": "The schema name as stored in the connection schema config. This value is case-sensitive; an incorrect case results in an HTTP 404 error.", "required": true, "schema": { "type": "string", "example": "schemaName" }, "example": "schemaName" }, { "name": "tableName", "in": "path", "description": "The table name as stored in the connection schema config. This value is case-sensitive; an incorrect case results in an HTTP 404 error.", "required": true, "schema": { "type": "string", "example": "tableName" }, "example": "tableName" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableUpdateRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Table configuration has been modified" }, "data": { "$ref": "#/components/schemas/StandardConfigResponse" } } } } } } } } }, "/v1/connections/{connectionId}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}": { "delete": { "tags": [ "Connection Schema Management" ], "summary": "Drop a Blocked Column From the Destination", "description": "Marks a blocked column for deletion from your destination table. The column will be dropped during the next sync.\n\nFor the NetSuite SuiteAnalytics and Salesforce and Salesforce Sandbox connectors, the 'schemas' map field will always have a single entry with the 'netsuite' or 'salesforce' key, respectively.\n", "operationId": "delete_column_connection_config", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "schemaName", "in": "path", "description": "The schema name as stored in the connection schema config. This value is case-sensitive; an incorrect case results in an HTTP 404 error.", "required": true, "schema": { "type": "string", "example": "schemaName" }, "example": "schemaName" }, { "name": "tableName", "in": "path", "description": "The table name as stored in the connection schema config. This value is case-sensitive; an incorrect case results in an HTTP 404 error.", "required": true, "schema": { "type": "string", "example": "tableName" }, "example": "tableName" }, { "name": "columnName", "in": "path", "description": "The column name as stored in the connection schema config. This value is case-sensitive; an incorrect case results in an HTTP 404 error.", "required": true, "schema": { "type": "string", "example": "columnName" }, "example": "columnName" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Column successfully marked for deletion" } } } } } }, "400": { "description": "Bad request" }, "404": { "description": "Not found error" }, "409": { "description": "Column not in blocked state error" } } }, "patch": { "tags": [ "Connection Schema Management" ], "summary": "Update a Connection Column Config", "description": "Updates the column config within your table for an existing connection within your Fivetran account.\n\nFor the NetSuite SuiteAnalytics and Salesforce and Salesforce Sandbox connectors, the 'schemas' map field will always have a single entry with the 'netsuite' or 'salesforce' key, respectively.\n> NOTE: The response contains all known schemas and tables. Also, it contains columns whose state has ever been set by the user. For more information, see also the [Connection Schema config](https://fivetran.com/docs/rest-api/tutorials/connection-schema-configuration-use-cases) tutorial.\n", "operationId": "modify_connection_column_config", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "schemaName", "in": "path", "description": "The schema name as stored in the connection schema config. This value is case-sensitive; an incorrect case results in an HTTP 404 error.", "required": true, "schema": { "type": "string", "example": "schemaName" }, "example": "schemaName" }, { "name": "tableName", "in": "path", "description": "The table name as stored in the connection schema config. This value is case-sensitive; an incorrect case results in an HTTP 404 error.", "required": true, "schema": { "type": "string", "example": "tableName" }, "example": "tableName" }, { "name": "columnName", "in": "path", "description": "The column name as stored in the connection schema config. This value is case-sensitive; an incorrect case results in an HTTP 404 error.", "required": true, "schema": { "type": "string", "example": "columnName" }, "example": "columnName" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ColumnUpdateRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Column configuration has been modified" }, "data": { "$ref": "#/components/schemas/StandardConfigResponse" } } } } } } } } }, "/v1/connections/{connectionId}/schemas/{schema}/tables/{table}/columns": { "get": { "tags": [ "Connection Schema Management" ], "summary": "Retrieve Source Table Columns Config", "description": "Returns the real-time column list for one source table by querying the source. The response includes the current enabled and hashed flags, and the patchable fields.\n\nTo determine whether this endpoint is available for a table, first [retrieve the connection schema config](/docs/rest-api/api-reference/connection-schema/connection-schema-config) and check the table's public [`supports_columns_config` response field](/docs/rest-api/api-reference/connection-schema/connection-schema-config#supports_columns_config). Column-level schema metadata support is reported per table rather than as a static connector-wide list. If `supports_columns_config` is `false`, column metadata is not available for that table.\n\n> NOTE: This endpoint works only for an existing connection that is in a `Connected` state.\n\n> NOTE: The connection schema config response includes every schema and table, but includes only columns that were explicitly overridden. Use this endpoint when you need the exhaustive real-time column list for a table that supports column-level configuration.\n", "operationId": "connection_column_config", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "schema", "in": "path", "description": "The database schema name within your destination", "required": true, "schema": { "type": "string", "example": "schema" }, "example": "schema" }, { "name": "table", "in": "path", "description": "The table name from the connection schema, using the original source system's naming conventions. This value is case-sensitive.", "required": true, "schema": { "type": "string", "example": "table" }, "example": "table" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Column configuration retrieved successfully" }, "data": { "$ref": "#/components/schemas/TableColumnsConfigResponse" } } } } } } } } }, "/v1/connections/{connectionId}/state": { "get": { "tags": [ "Connection Management" ], "summary": "Retrieve Connection State", "description": "This endpoint returns the connection state for [Function](/docs/connectors/functions) and [Connector SDK](/docs/connector-sdk) connections. Sending a request for any other connection type returns `400 Bad Request`. To update the connection state, use [Update Connection State](/docs/rest-api/api-reference/connections/modify-connection-state).\n\nTo read the sync status for any connection type, use [Retrieve connection details](/docs/rest-api/api-reference/connections/connection-details) and inspect the `status` object in the response.\n", "operationId": "connection_state", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection state retrieved successfully" }, "data": { "$ref": "#/components/schemas/ConnectorStateResponse" } } } } } }, "400": { "description": "The specified connection does not support state management. Only Function and Connector SDK connectors support this operation." }, "401": { "description": "Unauthorized error" }, "404": { "description": "Connection not found error." }, "405": { "description": "Method not allowed error." }, "406": { "description": "Not acceptable error" } } }, "patch": { "tags": [ "Connection Management" ], "summary": "Update a Connection State", "description": "Updates the connection state. This endpoint is only supported for [Function](/docs/connectors/functions) and [Connection SDK](/docs/connectors/connector-sdk) connectors. To update the state, you should pause your connection first.\n\nTo update the connection state, do the following:\n\n 1. Pause connection using [Update a Connection](/docs/rest-api/api-reference/connections/modify-connection) endpoint (set 'paused' to 'true').\n 2. Update the state by using the [Update Connection State](/docs/rest-api/api-reference/connections/modify-connection-state) endpoint.\n 3. Unpause the connection by setting the 'paused' parameter to 'false' in the [Update a Connection](/docs/rest-api/api-reference/connections/modify-connection) endpoint request.\n", "operationId": "modify_connection_state", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFunctionOrConnectorSdkState" }, "examples": { "update_connection_state_request": { "value": { "state": { "cursor": "2024-01-01T00:00:00Z" } } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection state has been updated" }, "data": { "$ref": "#/components/schemas/ConnectorStateResponse" } } } } } }, "400": { "description": "Invalid request. Possible causes: the request body is missing or malformed, the connection state does not exist, or the specified connection is not a Function or Connector SDK connector." }, "401": { "description": "Unauthorized error" }, "404": { "description": "Connection not found error." }, "405": { "description": "Method not allowed error." }, "406": { "description": "Not acceptable error" }, "409": { "description": "Connection cannot be updated because the sync is in progress." }, "415": { "description": "Unsupported media type error" } } } }, "/v1/connections/{connectionId}/sync": { "post": { "tags": [ "Connection Management" ], "summary": "Sync Connection Data", "description": "Triggers a data sync for an existing connection within your Fivetran account without waiting for the next scheduled sync. This action does not override the standard sync frequency you defined in the Fivetran dashboard.\n\nWhen `schedule_type` is set to `manual`, this endpoint is the only way syncs occur — including syncs in a `rescheduled` state. For a full walkthrough, see [Trigger Manual Syncs](https://fivetran.com/docs/rest-api/tutorials/trigger-syncs-manually).\n", "operationId": "sync_connection", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncConnectorRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Sync has been successfully triggered for connection with id 'string'" }, "data": { "$ref": "#/components/schemas/ConnectorSyncTriggerResponse" } } } } } }, "401": { "description": "Unauthorized error" }, "404": { "description": "Not found error" }, "406": { "description": "Not acceptable error" }, "415": { "description": "Unsupported media type error" } } } }, "/v1/connections/{connectionId}/sync-history": { "get": { "tags": [ "Connection Management" ], "summary": "Retrieve Connection Sync History", "description": "Returns a list of sync history records for the specified connection. The maximum time window is 7 days.", "operationId": "connection_sync_history", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "duration", "in": "query", "description": "Deprecated. Use `start_time` and `end_time` instead.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "start_time", "in": "query", "description": "The start of the time range for which to retrieve sync history, in ISO 8601 format (for example, 2026-01-01T00:00:00Z). If omitted, defaults to one hour before `end_time`. The maximum allowed range between `start_time` and `end_time` is 7 days.", "required": false, "schema": { "type": "string" } }, { "name": "end_time", "in": "query", "description": "The end of the time range for which to retrieve sync history, in ISO 8601 format (for example, 2026-01-01T01:00:00Z). If omitted, defaults to one hour after `start_time`. Must be after `start_time`.", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Operation performed successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/ConnectorSyncHistoryResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } }, "400": { "description": "Bad request error. Returned when the duration between `start_time` and `end_time` exceeds 7 days, `start_time` is after `end_time`, or `start_time` is more than 7 days in the past." }, "401": { "description": "Unauthorized error" }, "404": { "description": "Not found error" }, "405": { "description": "Method not allowed error" }, "406": { "description": "Not acceptable error" } } } }, "/v1/connections/{connectionId}/test": { "post": { "tags": [ "Connection Management" ], "summary": "Run Connection Setup Tests", "description": "Runs the setup tests for an existing connection within your Fivetran account. Use this parameter to test the connection without making any configuration changes. You can optionally include `trust_certificates` or `trust_fingerprints` parameters to automatically approve certificates or fingerprints during the test run.", "operationId": "run_setup_tests", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunSetupTestsRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Setup tests have been completed" }, "data": { "$ref": "#/components/schemas/ConnectorResponseV1" } } } } } }, "400": { "description": "Bad request error. Returned when the request body is omitted entirely (as opposed to an empty object, which is accepted)." }, "401": { "description": "Unauthorized error" }, "404": { "description": "Not found error" }, "405": { "description": "Method not allowed error" }, "406": { "description": "Not acceptable error" }, "415": { "description": "Unsupported media type error" } } } }, "/v1/connections/{connectionId}/warnings": { "get": { "tags": [ "Connection Management" ], "summary": "Retrieve Connection Warnings", "description": "Retrieve all active warnings for a connection, grouped by destination table. Each warning includes a code, message, error details, and creation timestamp.", "operationId": "connection_warnings", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection warnings retrieved successfully" }, "data": { "$ref": "#/components/schemas/ConnectionWarningsResponse" } } } } } }, "401": { "description": "Unauthorized error" }, "404": { "description": "Connection not found error" }, "405": { "description": "Method not allowed error" }, "406": { "description": "Not acceptable error" } } } }, "/v1/connections/{connectionId}/warnings/{warningType}": { "delete": { "tags": [ "Connection Management" ], "summary": "Dismiss Connection Warnings by Type", "description": "Dismiss all active warnings of a specific type for a connection. Requires the warning type to be registered in the warning type registry.", "operationId": "dismiss_connection_warning", "parameters": [ { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "warningType", "in": "path", "description": "The warning type to dismiss (e.g., 'resync_table_warning', 'type_coercion_to_null_warning')", "required": true, "schema": { "type": "string" } }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Warnings of type 'string' dismissed for connection 'string'" } } } } } }, "401": { "description": "Unauthorized error" }, "404": { "description": "Connection not found or warning type not registered" }, "405": { "description": "Method not allowed error" }, "406": { "description": "Not acceptable error" } } } }, "/v1/connector-sdk/packages": { "get": { "tags": [ "Connector SDK Package Resource" ], "summary": "List All Connector SDK Packages", "description": "Returns a list of all Connector SDK packages in your Fivetran account.", "operationId": "list_connector_sdk_packages", "parameters": [ { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connector SDK packages retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/ConnectorSdkPackageResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } }, "post": { "tags": [ "Connector SDK Package Resource" ], "summary": "Create Connector SDK Package", "description": "Uploads a new Connector SDK package to your Fivetran account. The package must be a ZIP file containing your custom connector code. You can create the package ZIP file using the [`fivetran package` command](/docs/connector-sdk/connector-development-and-configuration/connector-sdk-commands#fivetranpackage).\n\nAfter creating a package, use the standard [Create a Connection endpoint](/docs/rest-api/api-reference/connections/create-connection) with the returned `id` as `package_id` in the config.\n\n> NOTE: Each package can only be associated with one connection at a time.\n", "operationId": "create_connector_sdk_package", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "object", "description": "The ZIP file containing the Connector SDK package." } } } } } }, "responses": { "201": { "description": "Package created successfully", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Package created successfully" }, "data": { "$ref": "#/components/schemas/ConnectorSdkPackageResponse" } } }, "examples": { "create_connector_sdk_package_response": { "value": { "code": "Success", "data": { "id": "package_id", "connection_id": null, "connection_ids": [], "created_by": "user_id", "last_updated_by": "user_id", "created_at": "2024-01-14T19:30:00.000Z", "updated_at": "2024-01-14T19:30:00.000Z", "file_sha256_hash": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" } } } } } } }, "400": { "description": "Invalid package file or missing file parameter" } } } }, "/v1/connector-sdk/packages/{package_id}": { "get": { "tags": [ "Connector SDK Package Resource" ], "summary": "Retrieve Connector SDK Package Details", "description": "Returns details for a specific Connector SDK package.", "operationId": "get_connector_sdk_package", "parameters": [ { "name": "package_id", "in": "path", "description": "The unique identifier for the Connector SDK package.", "required": true, "schema": { "type": "string", "example": "package_id" }, "example": "package_id" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connector SDK package details retrieved successfully" }, "data": { "$ref": "#/components/schemas/ConnectorSdkPackageResponse" } } } } } }, "404": { "description": "Package not found" } } }, "delete": { "tags": [ "Connector SDK Package Resource" ], "summary": "Delete Connector SDK Package", "description": "Permanently deletes a Connector SDK package from your Fivetran account.\n\n> **Warning:** Packages that are associated with a connection cannot be deleted. You must first delete the connection before deleting the package.\n", "operationId": "delete_connector_sdk_package", "parameters": [ { "name": "package_id", "in": "path", "description": "The unique identifier for the Connector SDK package.", "required": true, "schema": { "type": "string", "example": "package_id" }, "example": "package_id" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Package deleted successfully", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Package deleted successfully" } } } } } }, "403": { "description": "Package is associated with a connection and cannot be deleted" }, "404": { "description": "Package not found" } } }, "patch": { "tags": [ "Connector SDK Package Resource" ], "summary": "Update Connector SDK Package", "description": "Updates an existing Connector SDK package by uploading a new version of the connector code.\n\nConnection using this package will automatically use the updated code on their next sync.\n", "operationId": "update_connector_sdk_package", "parameters": [ { "name": "package_id", "in": "path", "description": "The unique identifier for the Connector SDK package.", "required": true, "schema": { "type": "string", "example": "package_id" }, "example": "package_id" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "object", "description": "The ZIP file containing the Connector SDK package." } } } } } }, "responses": { "200": { "description": "Package updated successfully", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Package updated successfully" }, "data": { "$ref": "#/components/schemas/ConnectorSdkPackageResponse" } } } } } }, "400": { "description": "Invalid package file or missing file parameter" }, "403": { "description": "User is not the package owner or an account administrator" }, "404": { "description": "Package not found" } } } }, "/v1/connector-sdk/packages/{package_id}/download": { "get": { "tags": [ "Connector SDK Package Resource" ], "summary": "Download Connector SDK Package", "description": "Downloads the connector code package file (code.zip) for a specific Connector SDK package.\n\nThis endpoint returns the raw ZIP file as an octet-stream.\n", "operationId": "download_connector_sdk_package", "parameters": [ { "name": "package_id", "in": "path", "description": "The unique identifier for the Connector SDK package.", "required": true, "schema": { "type": "string", "example": "package_id" }, "example": "package_id" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Package file downloaded successfully", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Package not found" } } } }, "/v1/destinations": { "get": { "tags": [ "Destination Management" ], "summary": "List All Destinations Within Account", "description": "Returns a list of all accessible destinations within your Fivetran account.", "operationId": "list_destinations", "parameters": [ { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Destinations list retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/DestinationResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } }, "examples": { "get_response": { "value": { "code": "Success", "data": { "id": "decent_dropsy", "group_id": "decent_dropsy", "service": "snowflake", "region": "GCP_US_EAST4", "time_zone_offset": "-5", "setup_status": "connected", "config": { "host": "your-account.snowflakecomputing.com", "port": 443, "database": "fivetran", "auth": "PASSWORD", "user": "fivetran_user", "password": "******" } } } } } } } } } }, "post": { "tags": [ "Destination Management" ], "summary": "Create a Destination", "description": "Creates a new destination within a specified group in your Fivetran account.\n\n> IMPORTANT: Groups and destinations are mapped 1:1 to each other. We do this mapping using the group's `id` value that we automatically generate when you create a group, and the destination's `group_id` value that you specify when you create a destination. This means that you must create a group in your Fivetran account before you can create a destination in it.\n\n> IMPORTANT: If you want to get the certificate details, do not set `trust_certificates` to `true` when you create a destination with our REST API. We can only provide the certificate details through the failed Validate Certificate setup test. For a full walkthrough, see [Get Destination Certificate Details](https://fivetran.com/docs/rest-api/tutorials/get-destination-certificate-details).\n", "operationId": "create_destination", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDestinationRequest" }, "examples": { "create_request": { "value": { "group_id": "target_group_id", "service": "snowflake", "region": "GCP_US_EAST4", "time_zone_offset": "-5", "config": { "host": "your-account.snowflakecomputing.com", "port": 443, "database": "fivetran", "auth": "PASSWORD", "user": "fivetran_user", "password": "123456" } } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Created" }, "message": { "type": "string", "description": "Response status text", "example": "Destination has been created" }, "data": { "$ref": "#/components/schemas/DestinationExtendedResponse" } } }, "examples": { "create_successful_response": { "value": { "code": "Success", "message": "Destination has been created", "data": { "id": "decent_dropsy", "group_id": "decent_dropsy", "service": "snowflake", "region": "GCP_US_EAST4", "time_zone_offset": "-5", "setup_status": "connected", "setup_tests": [ { "title": "Host Connection", "status": "PASSED", "message": "" }, { "title": "Database Connection", "status": "PASSED", "message": "" }, { "title": "Permission Test", "status": "PASSED", "message": "" } ], "config": { "host": "your-account.snowflakecomputing.com", "port": 443, "database": "fivetran", "auth": "PASSWORD", "user": "fivetran_user", "password": "******" } } } } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "examples": { "service_not_supported": { "value": { "code": "InvalidInput", "message": "Unsupported service 'service_id'" } }, "invalid_input_group_id": { "value": { "code": "InvalidInput", "message": "Field 'group_id' is required" } }, "invalid_input_service": { "value": { "code": "InvalidInput", "message": "Field 'service' is required" } } } } } }, "402": { "description": "Payment required", "content": { "application/json": { "examples": { "region_not_available_for_plan": { "value": { "code": "AccountTierLimit", "message": "Region 'AWS_US_WEST_2' is forbidden for your account type" } }, "private_link_not_available_for_plan": { "value": { "code": "AccountTierLimit", "message": "The `PrivateLink` connection type is forbidden for your account type" } } } } } }, "404": { "description": "Not found", "content": { "application/json": { "examples": { "group_not_found": { "value": { "code": "NotFound", "message": "Destination with id not found" } } } } } } } } }, "/v1/destinations/{destinationId}": { "get": { "tags": [ "Destination Management" ], "summary": "Retrieve Destination Details", "description": "Returns a destination object if a valid identifier was provided.\n\nTo find a destination's unique identifier, call the [List All Groups](https://fivetran.com/docs/rest-api/groups#listallgroups) endpoint and search the response `items` for your target destination by its `name` field. The group's `id` value is also the destination's `id`, since groups and destinations are mapped 1:1.\n", "operationId": "destination_details", "parameters": [ { "name": "destinationId", "in": "path", "description": "The unique identifier for the destination within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "destinationId" }, "example": "destinationId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Destination details retrieved successfully" }, "data": { "$ref": "#/components/schemas/DestinationExtendedResponse" } } }, "examples": { "get_response": { "value": { "code": "Success", "data": { "id": "decent_dropsy", "group_id": "decent_dropsy", "service": "snowflake", "region": "GCP_US_EAST4", "time_zone_offset": "-5", "setup_status": "connected", "config": { "host": "your-account.snowflakecomputing.com", "port": 443, "database": "fivetran", "auth": "PASSWORD", "user": "fivetran_user", "password": "******" } } } } } } } }, "404": { "description": "Not found error" } } }, "delete": { "tags": [ "Destination Management" ], "summary": "Delete a Destination", "description": "Deletes a destination from your Fivetran account.", "operationId": "delete_destination", "parameters": [ { "name": "destinationId", "in": "path", "description": "The unique identifier for the destination within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "destinationId" }, "example": "destinationId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Destination with id 'string' has been deleted" } } }, "examples": { "delete_response": { "value": { "code": "Success", "message": "Destination with id 'destination_id' has been deleted" } } } } } }, "404": { "description": "Not found error" }, "409": { "description": "Conflict error" } } }, "patch": { "tags": [ "Destination Management" ], "summary": "Update a Destination", "description": "Updates information for an existing destination within your Fivetran account.", "operationId": "modify_destination", "parameters": [ { "name": "destinationId", "in": "path", "description": "The unique identifier for the destination within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "destinationId" }, "example": "destinationId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDestinationRequest" }, "examples": { "update_request": { "value": { "region": "GCP_AUSTRALIA_SOUTHEAST1", "time_zone_offset": "+10", "config": { "host": "your-account.snowflakecomputing.com", "port": 1433, "database": "fivetran", "auth": "PASSWORD", "user": "fivetran_user", "password": "123456" } } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Destination has been updated" }, "data": { "$ref": "#/components/schemas/DestinationExtendedResponse" } } }, "examples": { "update_successful_response": { "value": { "code": "Success", "message": "Destination has been updated", "data": { "id": "decent_dropsy", "group_id": "decent_dropsy", "service": "snowflake", "region": "GCP_AUSTRALIA_SOUTHEAST1", "time_zone_offset": "+10", "setup_status": "connected", "setup_tests": [ { "title": "Host Connection", "status": "PASSED", "message": "" }, { "title": "Database Connection", "status": "PASSED", "message": "" }, { "title": "Permission Test", "status": "PASSED", "message": "" } ], "config": { "host": "your-account.snowflakecomputing.com", "port": 1433, "database": "fivetran", "auth": "PASSWORD", "user": "fivetran_user", "password": "******" } } } } } } } }, "404": { "description": "Not found error" } } } }, "/v1/destinations/{destinationId}/certificates": { "get": { "tags": [ "Certificate Management" ], "summary": "List Certificates Approved for the Destination", "description": "Returns the list of approved certificates for the specified destination.", "operationId": "get_destination_certificates_list", "parameters": [ { "name": "destinationId", "in": "path", "description": "The unique identifier for the destination within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "destinationId" }, "example": "destinationId" }, { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Destination certificates retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/CertificateDetailsResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } }, "404": { "description": "Destination not found" } } }, "post": { "tags": [ "Certificate Management" ], "summary": "Approve a Certificate for the Destination", "description": "Approves a certificate, so Fivetran trusts this certificate for a destination database connection. \nThe destination connection setup tests will fail if a non-approved certificate is provided.\n\n> NOTE: This is only required for destination connections based on the following databases: \n> - [MySQL](https://fivetran.com/docs/destinations/mysql#supportedimplementations)\n> - [PostgreSQL](https://fivetran.com/docs/destinations/postgresql#supportedimplementations)\n> - [SQLServer](https://fivetran.com/docs/destinations/sql-server#supportedimplementations)\n", "operationId": "approve_destination_certificate", "parameters": [ { "name": "destinationId", "in": "path", "description": "The unique identifier for the destination within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "destinationId" }, "example": "destinationId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveCertificateRequest_approve_destination_certificate" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "The certificate has been approved." }, "data": { "$ref": "#/components/schemas/CertificateDetailsResponse" } } } } } }, "400": { "description": "Missing `hash` or `encoded_cert` fields in request payload" }, "404": { "description": "Destination not found" } } } }, "/v1/destinations/{destinationId}/certificates/{hash}": { "get": { "tags": [ "Certificate Management" ], "summary": "Retrieve Destination Certificate Details", "description": "Returns details of the certificate approved for the specified destination with specified certificate hash.", "operationId": "get_destination_certificate_details", "parameters": [ { "name": "destinationId", "in": "path", "description": "The unique identifier for the destination within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "destinationId" }, "example": "destinationId" }, { "name": "hash", "in": "path", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate).", "required": true, "schema": { "type": "string", "example": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g" }, "example": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Destination certificate details retrieved successfully" }, "data": { "$ref": "#/components/schemas/CertificateDetailsResponse" } } } } } }, "404": { "description": "Certificate with specified hash not found" } } }, "delete": { "tags": [ "Certificate Management" ], "summary": "Revoke Destination Certificate", "description": "Revokes a certificate, so Fivetran no longer trusts it while connecting to the destination database.", "operationId": "revoke_destination_certificate", "parameters": [ { "name": "destinationId", "in": "path", "description": "The unique identifier for the destination within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "destinationId" }, "example": "destinationId" }, { "name": "hash", "in": "path", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate).", "required": true, "schema": { "type": "string", "example": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g" }, "example": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Certificate 'string' has been revoked for destination 'string'" } } } } } }, "404": { "description": "Certificate with specified hash not found" } } } }, "/v1/destinations/{destinationId}/fingerprints": { "get": { "tags": [ "Certificate Management" ], "summary": "List Fingerprints Approved for the Destination", "description": "Returns the list of approved SSH fingerprints for specified destination", "operationId": "get_destination_fingerprints_list", "parameters": [ { "name": "destinationId", "in": "path", "description": "The unique identifier for the destination within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "destinationId" }, "example": "destinationId" }, { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Destination fingerprints retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/FingerprintDetailsResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } }, "404": { "description": "Destination not found" } } }, "post": { "tags": [ "Certificate Management" ], "summary": "Approve a Fingerprint for the Destination", "description": "Approves a fingerprint, enabling Fivetran to trust it for a destination database and establish connections via an SSH tunnel.", "operationId": "approve_destination_fingerprint", "parameters": [ { "name": "destinationId", "in": "path", "description": "The unique identifier for the destination within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "destinationId" }, "example": "destinationId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveFingerprintRequest_approve_destination_fingerprint" } } } }, "responses": { "200": { "description": "Successful response" }, "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FingerprintDetailsResponse" } } } }, "400": { "description": "Missing `hash` or `public_key` fields in request payload" }, "404": { "description": "Destination not found" } } } }, "/v1/destinations/{destinationId}/fingerprints/{hash}": { "get": { "tags": [ "Certificate Management" ], "summary": "Retrieve Destination Fingerprint Details", "description": "Returns SSH fingerprint details approved for specified destination with specified hash", "operationId": "get_destination_fingerprint_details", "parameters": [ { "name": "destinationId", "in": "path", "description": "The unique identifier for the destination within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "destinationId" }, "example": "destinationId" }, { "name": "hash", "in": "path", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint).", "required": true, "schema": { "type": "string", "example": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g" }, "example": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Destination fingerprint details retrieved successfully" }, "data": { "$ref": "#/components/schemas/FingerprintDetailsResponse" } } } } } }, "404": { "description": "Fingerprint with specified hash not found" } } }, "delete": { "tags": [ "Certificate Management" ], "summary": "Revoke Destination Fingerprint", "description": "Revokes a fingerprint, so Fivetran no longer trusts it while connecting to the destination database through an SSH tunnel.", "operationId": "revoke_destination_fingerprint", "parameters": [ { "name": "destinationId", "in": "path", "description": "The unique identifier for the destination within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "destinationId" }, "example": "destinationId" }, { "name": "hash", "in": "path", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint).", "required": true, "schema": { "type": "string", "example": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g" }, "example": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Fingerprint with hash = 'string' has been revoked for destination id = 'string'" } } } } } }, "404": { "description": "Fingerprint with specified hash not found" } } } }, "/v1/destinations/{destinationId}/test": { "post": { "tags": [ "Destination Management" ], "summary": "Run Destination Setup Tests", "description": "Runs the setup tests for an existing destination within your Fivetran account.", "operationId": "run_destination_setup_tests", "parameters": [ { "name": "destinationId", "in": "path", "description": "The unique identifier for the destination within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "destinationId" }, "example": "destinationId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json;version=2", "default": "application/json;version=2" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunSetupTestsRequest_run_destination_setup_tests" }, "examples": { "run_setup_tests_request": { "value": { "trust_certificates": true, "trust_fingerprints": true } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Setup tests have been completed" }, "data": { "$ref": "#/components/schemas/DestinationExtendedResponse" } } }, "examples": { "run_setup_tests_response": { "value": { "code": "Success", "message": "Setup tests have been completed", "data": { "id": "destination_id", "group_id": "group_id", "service": "postgres_rds_warehouse", "region": "GCP_US_EAST4", "time_zone_offset": "-8", "setup_status": "incomplete", "setup_tests": [ { "title": "Connecting to SSH tunnel", "status": "FAILED", "message": "Auth fail" } ], "config": { "public_key": "ssh-rsa ... fivetran user key", "database": "database_name", "password": "******", "tunnel_port": "22", "port": "5432", "host": "test.host.com", "tunnel_host": "test.tunnel.host.com", "user": "user_name", "connection_method": "SshTunnel", "tunnel_user": "tunnel_user_name" } } } } } } } }, "404": { "description": "Not found error" } } } }, "/v1/external-logging": { "get": { "tags": [ "Log Service Management" ], "summary": "List All Log Services within Account", "description": "Returns a list of all accessible [logging services](/docs/logs/external-logs) within your Fivetran account.", "operationId": "list_log_services", "parameters": [ { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "External logging services retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/LogResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } }, "post": { "tags": [ "Log Service Management" ], "summary": "Create a Group Log Service", "description": "Creates a new group-level [logging service](/docs/logs/external-logs) within a specified group in your Fivetran account.", "operationId": "add_log_service", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddLogRequest" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "External logging service has been added" }, "data": { "$ref": "#/components/schemas/LogExtendedResponse" } } } } } } } } }, "/v1/external-logging/account": { "get": { "tags": [ "Log Service Management" ], "summary": "Retrieve Account Log Service", "description": "Returns the account-level [logging service](/docs/logs/external-logs) if it exists.", "operationId": "get_account_log_service_details", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Account external logging service details retrieved successfully" }, "data": { "$ref": "#/components/schemas/LogExtendedResponse" } } } } } } } }, "post": { "tags": [ "Log Service Management" ], "summary": "Create Account Log Service", "description": "Creates an account-level [logging service](/docs/logs/external-logs).", "operationId": "add_account_log_service", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddAccountLogRequest" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Account external logging service has been added" }, "data": { "$ref": "#/components/schemas/LogExtendedResponse" } } } } } } } }, "delete": { "tags": [ "Log Service Management" ], "summary": "Delete Account Log Service", "description": "Deletes the account-level [logging service](/docs/logs/external-logs).", "operationId": "delete_account_log_service", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Account external logging service has been deleted" } } } } } } } }, "patch": { "tags": [ "Log Service Management" ], "summary": "Update Account Log Service", "description": "Updates information for the account-level [logging service](/docs/logs/external-logs).", "operationId": "update_account_log_service", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLogRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Account external logging service has been updated" }, "data": { "$ref": "#/components/schemas/LogExtendedResponse" } } } } } } } } }, "/v1/external-logging/account/test": { "post": { "tags": [ "Log Service Management" ], "summary": "Run Account Log Service Setup Tests", "description": "Runs the setup tests for the account-level [logging service](/docs/logs/external-logs).", "operationId": "run_setup_tests_account_log_service", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Account external logging service setup tests have been completed" }, "data": { "$ref": "#/components/schemas/LoggingServiceSetupTestResponse" } } } } } } } } }, "/v1/external-logging/{logId}": { "get": { "tags": [ "Log Service Management" ], "summary": "Retrieve Group Log Service Details", "description": "Returns a group-level [logging service](/docs/logs/external-logs) object if a valid identifier was provided.", "operationId": "get_log_service_details", "parameters": [ { "name": "logId", "in": "path", "description": "The unique identifier for the log service within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "logId" }, "example": "logId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "External logging service details retrieved successfully" }, "data": { "$ref": "#/components/schemas/LogExtendedResponse" } } } } } } } }, "delete": { "tags": [ "Log Service Management" ], "summary": "Delete a Group Log Service", "description": "Deletes a group-level [logging service](/docs/logs/external-logs) from your Fivetran account.", "operationId": "delete_log_service", "parameters": [ { "name": "logId", "in": "path", "description": "The unique identifier for the log service within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "logId" }, "example": "logId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "External logging service with id 'string' has been deleted" } } } } } } } }, "patch": { "tags": [ "Log Service Management" ], "summary": "Update a Group Log Service", "description": "Updates information for an existing group-level [logging service](/docs/logs/external-logs) within your Fivetran account.", "operationId": "update_log_service", "parameters": [ { "name": "logId", "in": "path", "description": "The unique identifier for the log service within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "logId" }, "example": "logId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLogRequest_update_log_service" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "External logging service has been updated" }, "data": { "$ref": "#/components/schemas/LogExtendedResponse" } } } } } } } } }, "/v1/external-logging/{logId}/test": { "post": { "tags": [ "Log Service Management" ], "summary": "Run Group Log Service Setup Tests", "description": "Runs the setup tests for an existing group-level [logging service](/docs/logs/external-logs) within your Fivetran account.", "operationId": "run_setup_tests_log_service", "parameters": [ { "name": "logId", "in": "path", "description": "The unique identifier for the log service within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "logId" }, "example": "logId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Setup tests have been completed" }, "data": { "$ref": "#/components/schemas/LoggingServiceSetupTestResponse" } } } } } } } } }, "/v1/external-secrets-managers": { "get": { "tags": [ "Handling External Secrets Manager (ESM) resources" ], "summary": "List all External Secrets Managers", "description": "Returns a list of all External Secrets Manager instances within your Fivetran account.", "operationId": "list_esms", "parameters": [ { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Operation performed successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/SecretsManagerResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } }, "examples": { "list_response": { "value": { "code": "Success", "data": { "items": [ { "id": "lucky_tiger", "type": "AWS_SECRET_MANAGER", "name": "My AWS Secrets Manager", "is_hybrid_deployment": false, "created_at": "2024-01-01T00:00:00.000000Z", "updated_at": "2024-06-01T00:00:00.000000Z" } ], "next_cursor": "eyJza2lwIjoyfQ" } } } } } } } } }, "post": { "tags": [ "Handling External Secrets Manager (ESM) resources" ], "summary": "Create an External Secrets Manager", "description": "Creates a new External Secrets Manager instance within your Fivetran account.", "operationId": "create_esm", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretsManagerCreateRequest" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Created" }, "message": { "type": "string", "description": "Response status text", "example": "External Secrets Manager has been created" }, "data": { "$ref": "#/components/schemas/SecretsManagerResponse" } } }, "examples": { "esm_response": { "value": { "code": "Success", "data": { "id": "lucky_tiger", "type": "AWS_SECRET_MANAGER", "name": "My AWS Secrets Manager", "is_hybrid_deployment": false, "created_at": "2024-01-01T00:00:00.000000Z", "updated_at": "2024-06-01T00:00:00.000000Z", "config": { "role_arn": "arn:aws:iam::123456789012:role/FivetranRole", "external_id": "fivetran_external_id" } } } } } } } }, "400": { "description": "Validation error", "content": { "application/json": { "examples": { "bad_request": { "value": { "code": "BadRequest", "message": "ESM config is required." } } } } } } } } }, "/v1/external-secrets-managers-entities": { "get": { "tags": [ "Handling External Secrets Manager (ESM) resources" ], "summary": "List All Entities Using External Secrets Managers", "description": "Returns a list of all source connections and destinations that are using any External Secrets Manager within your Fivetran account.", "operationId": "list_esm_entities", "parameters": [ { "name": "esm_id", "in": "query", "description": "Filter by a specific External Secrets Manager ID.", "required": false, "schema": { "type": "string", "example": "lucky_tiger" }, "example": "lucky_tiger" }, { "name": "type", "in": "query", "description": "Filter by entity type. Accepted values are source, destination, or all.", "required": false, "schema": { "type": "string", "example": "source" }, "example": "source" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Operation performed successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/SecretsManagerEntityItem" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } }, "examples": { "entities_response": { "value": { "code": "Success", "data": { "items": [ { "id": "connection_id", "type": "SOURCE", "name": "my_schema", "enabled": true, "secret_manager_id": "lucky_tiger", "created_at": "2024-01-01T00:00:00.000000Z" } ], "next_cursor": "eyJza2lwIjoyfQ" } } } } } } } } } }, "/v1/external-secrets-managers/{esmId}": { "get": { "tags": [ "Handling External Secrets Manager (ESM) resources" ], "summary": "Retrieve External Secrets Manager Details", "description": "Returns the details of an existing External Secrets Manager instance.", "operationId": "get_esm_details", "parameters": [ { "name": "esmId", "in": "path", "description": "The unique identifier of the External Secrets Manager instance.", "required": true, "schema": { "type": "string", "example": "lucky_tiger" }, "example": "lucky_tiger" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Operation performed successfully" }, "data": { "$ref": "#/components/schemas/SecretsManagerResponse" } } }, "examples": { "esm_response": { "value": { "code": "Success", "data": { "id": "lucky_tiger", "type": "AWS_SECRET_MANAGER", "name": "My AWS Secrets Manager", "is_hybrid_deployment": false, "created_at": "2024-01-01T00:00:00.000000Z", "updated_at": "2024-06-01T00:00:00.000000Z", "config": { "role_arn": "arn:aws:iam::123456789012:role/FivetranRole", "external_id": "fivetran_external_id" } } } } } } } }, "404": { "description": "External Secrets Manager not found", "content": { "application/json": { "examples": { "not_found": { "value": { "code": "NotFound", "message": "External Secrets Manager with 'lucky_tiger' id is not found." } } } } } } } }, "delete": { "tags": [ "Handling External Secrets Manager (ESM) resources" ], "summary": "Delete an External Secrets Manager", "description": "Deletes an External Secrets Manager instance from your Fivetran account. The instance must not be in use by any source connections or destinations.", "operationId": "delete_esm", "parameters": [ { "name": "esmId", "in": "path", "description": "The unique identifier of the External Secrets Manager instance.", "required": true, "schema": { "type": "string", "example": "lucky_tiger" }, "example": "lucky_tiger" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Resource deleted successfully" } } }, "examples": { "delete_successful": { "value": { "code": "Success", "message": "External Secrets Manager 'lucky_tiger' has been deleted." } } } } } }, "400": { "description": "External Secrets Manager is still in use", "content": { "application/json": { "examples": { "esm_in_use": { "value": { "code": "BadRequest", "message": "Failed to delete External Secrets Manager with 'lucky_tiger' id, because it is used by 1 connection(s) and 0 destination(s)." } } } } } }, "404": { "description": "External Secrets Manager not found", "content": { "application/json": { "examples": { "not_found": { "value": { "code": "NotFound", "message": "External Secrets Manager with 'lucky_tiger' id is not found." } } } } } } } }, "patch": { "tags": [ "Handling External Secrets Manager (ESM) resources" ], "summary": "Update an External Secrets Manager", "description": "Updates the configuration of an existing External Secrets Manager instance.", "operationId": "modify_esm", "parameters": [ { "name": "esmId", "in": "path", "description": "The unique identifier of the External Secrets Manager instance.", "required": true, "schema": { "type": "string", "example": "lucky_tiger" }, "example": "lucky_tiger" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretsManagerUpdateRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Resource updated successfully" }, "data": { "$ref": "#/components/schemas/SecretsManagerResponse" } } }, "examples": { "esm_response": { "value": { "code": "Success", "data": { "id": "lucky_tiger", "type": "AWS_SECRET_MANAGER", "name": "My AWS Secrets Manager", "is_hybrid_deployment": false, "created_at": "2024-01-01T00:00:00.000000Z", "updated_at": "2024-06-01T00:00:00.000000Z", "config": { "role_arn": "arn:aws:iam::123456789012:role/FivetranRole", "external_id": "fivetran_external_id" } } } } } } } }, "400": { "description": "Validation error", "content": { "application/json": { "examples": { "bad_request": { "value": { "code": "BadRequest", "message": "ESM config is required." } } } } } }, "404": { "description": "External Secrets Manager not found", "content": { "application/json": { "examples": { "not_found": { "value": { "code": "NotFound", "message": "External Secrets Manager with 'lucky_tiger' id is not found." } } } } } } } } }, "/v1/external-secrets-managers/{esmId}/entities": { "get": { "tags": [ "Handling External Secrets Manager (ESM) resources" ], "summary": "List Entities Using an External Secrets Manager", "description": "Returns a list of source connections and destinations that are using a specific External Secrets Manager.", "operationId": "get_esm_entities", "parameters": [ { "name": "esmId", "in": "path", "description": "The unique identifier of the External Secrets Manager instance.", "required": true, "schema": { "type": "string", "example": "lucky_tiger" }, "example": "lucky_tiger" }, { "name": "type", "in": "query", "description": "Filter by entity type. Accepted values are source, destination, or all.", "required": false, "schema": { "type": "string", "example": "source" }, "example": "source" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Operation performed successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/SecretsManagerEntityItem" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } }, "examples": { "entities_response": { "value": { "code": "Success", "data": { "items": [ { "id": "connection_id", "type": "SOURCE", "name": "my_schema", "enabled": true, "secret_manager_id": "lucky_tiger", "created_at": "2024-01-01T00:00:00.000000Z" } ], "next_cursor": "eyJza2lwIjoyfQ" } } } } } } } } } }, "/v1/groups": { "get": { "tags": [ "Group Management" ], "summary": "List All Destinations within Account", "description": "Returns a list of all groups within your Fivetran account.", "operationId": "list_all_groups", "parameters": [ { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Groups retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/GroupResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } }, "post": { "tags": [ "Group Management" ], "summary": "Create a Group", "description": "Creates a new group in your Fivetran account. \n\n> IMPORTANT: Groups and destinations are mapped 1:1 to each other. We do this mapping using the group's `id` value that we automatically generate when you create a group, and the destination's `group_id` value that you specify when you create a destination. This means that you must create a group in your Fivetran account before you can create a destination in it.\n", "operationId": "create_group", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewGroupRequest" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Group has been created" }, "data": { "$ref": "#/components/schemas/GroupResponse" } } } } } } } } }, "/v1/groups/{groupId}": { "get": { "tags": [ "Group Management" ], "summary": "Retrieve Group Details", "description": "Returns a group object if a valid identifier was provided.", "operationId": "group_details", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier for the group within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "groupId" }, "example": "groupId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Group details retrieved successfully" }, "data": { "$ref": "#/components/schemas/GroupResponse" } } } } } } } }, "delete": { "tags": [ "Group Management" ], "summary": "Delete a Group", "description": "Deletes a group from your Fivetran account.", "operationId": "delete_group", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier for the group within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "groupId" }, "example": "groupId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Group with id 'string' has been deleted" } } } } } } } }, "patch": { "tags": [ "Group Management" ], "summary": "Update a Group", "description": "Updates information for an existing group within your Fivetran account.", "operationId": "modify_group", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier for the group within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "groupId" }, "example": "groupId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGroupRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Group has been updated" }, "data": { "$ref": "#/components/schemas/GroupResponse" } } } } } } } } }, "/v1/groups/{groupId}/connections": { "get": { "tags": [ "Group Management" ], "summary": "List All Connections within a Group", "description": "Returns a list of information about all connections within a group in your Fivetran account.", "operationId": "list_all_connections_in_group", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier for the group within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "groupId" }, "example": "groupId" }, { "name": "schema", "in": "query", "description": "The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.", "required": false, "schema": { "type": "string", "example": "schema_name" }, "example": "schema_name" }, { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Group connections retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/ConnectorResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } } }, "/v1/groups/{groupId}/public-key": { "get": { "tags": [ "Group Management" ], "summary": "Retrieve Group Public SSH Key", "description": "Returns public key from SSH key pair associated with the group.", "operationId": "group_ssh_public_key", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier for the group within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "groupId" }, "example": "groupId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Group SSH public key retrieved successfully" }, "data": { "$ref": "#/components/schemas/GroupSshKeyResponse" } } } } } } } } }, "/v1/groups/{groupId}/service-account": { "get": { "tags": [ "Group Management" ], "summary": "Retrieve Group Service Account", "description": "Returns Fivetran service account associated with the group.", "operationId": "group_service_account", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier for the group within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "groupId" }, "example": "groupId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Group service account retrieved successfully" }, "data": { "$ref": "#/components/schemas/GroupServiceAccountResponse" } } } } } } } } }, "/v1/groups/{groupId}/users": { "get": { "tags": [ "Group Management" ], "summary": "List All Users within a Group", "description": "Returns a list of information about all users within a group in your Fivetran account.", "operationId": "list_all_users_in_group", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier for the group within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "groupId" }, "example": "groupId" }, { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "active", "in": "query", "description": "Indicates whether to return only enabled users (true) or not (false). By default, both enabled (allowed to log in) and suspended users are returned.", "required": false, "schema": { "type": "boolean", "example": true }, "example": true }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Group users retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/UserResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } }, "post": { "tags": [ "Group Management" ], "summary": "Add a User to a Group", "description": "Adds an existing user to a group in your Fivetran account.", "operationId": "add_user_to_group", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier for the group within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "groupId" }, "example": "groupId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddUserToGroupRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "User has been added to the group" } } } } } } } } }, "/v1/groups/{groupId}/users/{userId}": { "delete": { "tags": [ "Group Management" ], "summary": "Remove a User from a Group", "description": "Removes an existing user from a group in your Fivetran account.", "operationId": "delete_user_from_group", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier for the group within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "groupId" }, "example": "groupId" }, { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "User with id 'string' has been removed from the group" } } } } } } } } }, "/v1/hvr/register-hub": { "post": { "tags": [ "HVR Registrations Management" ], "summary": "Register Hub", "description": "Register a new hub within your Fivetran account.", "operationId": "hvr_register_hub", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HvrHubRegistrationRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "HVR hub has been registered" }, "data": { "$ref": "#/components/schemas/HvrHubRegistrationResponse" } } } } } } } } }, "/v1/hybrid-deployment-agents": { "get": { "tags": [ "Hybrid Deployment Agent Management" ], "summary": "List Hybrid Deployment Agents", "description": "Returns list of all Hybrid Deployment Agents within your Fivetran account, along with usage. Optionally filtered to a single group.", "operationId": "get_hybrid_deployment_agent_list", "parameters": [ { "name": "groupId", "in": "query", "description": "The Fivetran Group Id.", "required": false, "schema": { "type": "string", "example": "group_id" }, "example": "group_id" }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Hybrid deployment agents retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/HybridDeploymentAgentWithUsageResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } }, "post": { "tags": [ "Hybrid Deployment Agent Management" ], "summary": "Create a Hybrid Deployment Agent", "description": "Creates a new Hybrid Deployment Agent in a group.", "operationId": "create_hybrid_deployment_agent", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HybridDeploymentAgentCreateRequest" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Hybrid deployment agent has been created" }, "data": { "$ref": "#/components/schemas/HybridDeploymentAgentCreateResponse" } } } } } }, "400": { "description": "Missing name or license not accepted in the payload." }, "404": { "description": "Group not found." } } } }, "/v1/hybrid-deployment-agents/{agentId}": { "get": { "tags": [ "Hybrid Deployment Agent Management" ], "summary": "Returns Hybrid Deployment Agent Details", "description": "Returns Hybrid Deployment Agent Details.", "operationId": "get_hybrid_deployment_agent", "parameters": [ { "name": "agentId", "in": "path", "description": "Hybrid Deployment Agent Id", "required": true, "schema": { "type": "string", "example": "agentId" }, "example": "agentId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Hybrid deployment agent details retrieved successfully" }, "data": { "$ref": "#/components/schemas/HybridDeploymentAgentWithUsageResponse" } } } } } } } }, "delete": { "tags": [ "Hybrid Deployment Agent Management" ], "summary": "Delete a Hybrid Deployment Agent", "description": "Delete a Hybrid Deployment Agent.", "operationId": "delete_hybrid_deployment_agent", "parameters": [ { "name": "agentId", "in": "path", "description": "Hybrid Deployment Agent Id", "required": true, "schema": { "type": "string", "example": "agentId" }, "example": "agentId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Hybrid deployment agent with id = string has been deleted." } } } } } }, "404": { "description": "Hybrid Deployment Agent not found." } } } }, "/v1/hybrid-deployment-agents/{agentId}/re-auth": { "patch": { "tags": [ "Hybrid Deployment Agent Management" ], "summary": "Regenerate Authentication Keys", "description": "Regenerate authentication for a Hybrid Deployment Agent.", "operationId": "re_auth_hybrid_deployment_agent", "parameters": [ { "name": "agentId", "in": "path", "description": "Hybrid Deployment Agent Id", "required": true, "schema": { "type": "string", "example": "agentId" }, "example": "agentId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HybridDeploymentAgentReAuthRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Hybrid deployment agent re-authentication successful" }, "data": { "$ref": "#/components/schemas/HybridDeploymentAgentCreateResponse" } } } } } }, "404": { "description": "Hybrid Deployment Agent not found in group." } } } }, "/v1/hybrid-deployment-agents/{agentId}/reset-credentials": { "post": { "tags": [ "Hybrid Deployment Agent Management" ], "summary": "Reset Agent Credentials", "description": "Reset credentials for a Hybrid Deployment Agent.", "operationId": "reset_hybrid_deployment_agent_credentials", "parameters": [ { "name": "agentId", "in": "path", "description": "Hybrid Deployment Agent Id", "required": true, "schema": { "type": "string", "example": "agentId" }, "example": "agentId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Successfully reset credentials the agent with id = string" } } } } } }, "404": { "description": "Hybrid Deployment Agent not found" } } } }, "/v1/metadata/connector-types": { "get": { "tags": [ "Connector Metadata" ], "summary": "Retrieve Source Metadata", "description": "Returns all available source types within your Fivetran account. This endpoint makes it easier to display Fivetran connectors within your application because it provides metadata including the proper source name ('Facebook Ads' instead of 'facebook_ads'), the source icon, information about the Hybrid deployment support, and links to Fivetran resources. As we update source names and icons, that metadata will automatically update within this endpoint", "operationId": "metadata_connectors", "parameters": [ { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connectors list retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/MetadataResponseShort" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } } }, "/v1/metadata/connector-types/{service}": { "get": { "tags": [ "Connector Metadata" ], "summary": "Retrieve Connector Configuration Metadata", "description": "Returns metadata of configuration parameters and authorization parameters for a specified connector type.", "operationId": "metadata_connector_config", "parameters": [ { "name": "service", "in": "path", "description": "[The connector type](https://fivetran.com/docs/rest-api/getting-started#commonterms) identifier within the Fivetran system", "required": true, "schema": { "type": "string", "example": "google_ads" }, "example": "google_ads" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connector configuration retrieved successfully" }, "data": { "$ref": "#/components/schemas/MetadataResponse" } } } } } } } } }, "/v1/private-links": { "get": { "tags": [ "Private Link Management" ], "summary": "List All Private Links", "description": "Returns a list of all private links.", "operationId": "get_private_links", "parameters": [ { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Private links retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/PrivateLinkResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } }, "post": { "tags": [ "Private Link Management" ], "summary": "Create a Private Link", "description": "Creates a new private link in your Fivetran account. \n\n> NOTE: See the [Set Up a Connection With Private Links tutorial](/docs/rest-api/tutorials/set-up-connection-with-private-links) to learn how to use this endpoint to set up a [database connection](/docs/connectors/databases) with [private networking](/docs/using-fivetran/features#privatenetworking).\n", "operationId": "create_private_link", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivateLinkCreateRequest" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Private link has been created" }, "data": { "$ref": "#/components/schemas/PrivateLinkResponse" } } } } } } } } }, "/v1/private-links/{privateLinkId}": { "get": { "tags": [ "Private Link Management" ], "summary": "Retrieve Private Link Details", "description": "Returns a private link object if a valid identifier was provided.", "operationId": "get_private_link_details", "parameters": [ { "name": "privateLinkId", "in": "path", "description": "The unique identifier for the private link within the Fivetran system", "required": true, "schema": { "type": "string", "example": "privateLinkId" }, "example": "privateLinkId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Private link details retrieved successfully" }, "data": { "$ref": "#/components/schemas/PrivateLinkResponse" } } } } } }, "404": { "description": "Private Link not found" } } }, "delete": { "tags": [ "Private Link Management" ], "summary": "Delete a Private Link", "description": "Deletes a private link from your Fivetran account.", "operationId": "delete_private_link", "parameters": [ { "name": "privateLinkId", "in": "path", "description": "The unique identifier for the private link within the Fivetran system", "required": true, "schema": { "type": "string", "example": "privateLinkId" }, "example": "privateLinkId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Private link with id 'string' is marked for deletion" } } } } } }, "404": { "description": "Private Link not found" } } }, "patch": { "tags": [ "Private Link Management" ], "summary": "Update a Private Link", "description": "Updates information for an existing private link within your Fivetran account.", "operationId": "modify_private_link", "parameters": [ { "name": "privateLinkId", "in": "path", "description": "The unique identifier for the private link within the Fivetran system", "required": true, "schema": { "type": "string", "example": "privateLinkId" }, "example": "privateLinkId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivateLinkUpdateRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Private link has been updated" }, "data": { "$ref": "#/components/schemas/PrivateLinkResponse" } } } } } }, "404": { "description": "Private Link not found" } } } }, "/v1/proxy": { "get": { "tags": [ "Proxy Agent Management" ], "summary": "List all Proxy Agents", "description": "Returns a list of all proxy agents within your Fivetran account.", "operationId": "get_proxy_agent", "parameters": [ { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Proxy agent retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/ProxyAgentWithCountsResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } }, "examples": { "get_response_with_counts": { "value": { "code": "Success", "data": { "items": [ { "id": "id", "account_id": "account_id", "registered_at": "2018-12-01T15:43:29.013729Z", "region": "GCP_US_EAST4", "created_by": "created_by", "display_name": "display_name", "version": "1.0.0", "status": "CONNECTED", "connector_count": 3, "destination_count": 1 } ], "next_cursor": "eyJza2lwIjoyfQ" } } } } } } } } }, "post": { "tags": [ "Proxy Agent Management" ], "summary": "Create a Proxy Agent", "description": "Creates a new proxy agent within your Fivetran account.", "operationId": "create_proxy_agent", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyParamRequest" }, "examples": { "create_payload": { "value": { "display_name": "display_name", "group_region": "GCP_US_EAST4" } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Created" }, "message": { "type": "string", "description": "Response status text", "example": "Proxy agent has been created" }, "data": { "$ref": "#/components/schemas/ProxyAgentCreatedResponse" } } } } } }, "400": { "description": "Group region not supported", "content": { "application/json": { "examples": { "group_region_not_found": { "value": { "code": "InvalidInput", "message": "Group region not supported." } } } } } }, "409": { "description": "Proxy agent with same name already exists.", "content": { "application/json": { "examples": { "proxy_name_conflict": { "value": { "code": "Conflict", "message": "Proxy agent with same name already exists." } } } } } } } } }, "/v1/proxy/{agentId}": { "get": { "tags": [ "Proxy Agent Management" ], "summary": "Retrieve Proxy Agent Details", "description": "Retrieves the details of the specified proxy agent.", "operationId": "get_proxy_agent_details", "parameters": [ { "name": "agentId", "in": "path", "description": "The unique identifier for the proxy agent within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "agentId" }, "example": "agentId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyAgentWithUsageResponse" }, "examples": { "get_details_with_usages": { "value": { "code": "Success", "data": { "id": "id", "account_id": "account_id", "registered_at": "2018-12-01T15:43:29.013729Z", "region": "GCP_US_EAST4", "created_by": "created_by", "display_name": "display_name", "version": "1.0.0", "status": "CONNECTED", "usage": [ { "id": "connection_id", "schema": "schema", "service": "postgres" } ] } } } } } } }, "404": { "description": "Proxy Agent not found", "content": { "application/json": { "examples": { "proxy_not_found": { "value": { "code": "NotFound", "message": "Proxy Agent not found." } } } } } } } }, "delete": { "tags": [ "Proxy Agent Management" ], "summary": "Delete a Proxy Agent", "description": "Deletes the specified proxy agent from your Fivetran account.", "operationId": "delete_proxy_agent", "parameters": [ { "name": "agentId", "in": "path", "description": "The unique identifier for the proxy agent within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "agentId" }, "example": "agentId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Agent string successfully deleted" } } }, "examples": { "delete_successful": { "value": { "code": "Success", "message": "Agent successfully deleted." } } } } } }, "404": { "description": "Proxy agent not found.", "content": { "application/json": { "examples": { "proxy_not_found": { "value": { "code": "NotFound", "message": "Proxy Agent not found." } } } } } }, "409": { "description": "Proxy agent have attached connections.", "content": { "application/json": { "examples": { "proxy_has_connections": { "value": { "code": "Conflict", "message": "Proxy agent have attached connections." } } } } } } } } }, "/v1/proxy/{agentId}/connections": { "get": { "tags": [ "Proxy Agent Management" ], "summary": "List All Connections Attached to the Proxy Agent", "description": "Returns all connections attached to the specified proxy agent within your Fivetran account.", "operationId": "get_proxy_agent_connections", "parameters": [ { "name": "agentId", "in": "path", "description": "The unique identifier for the proxy agent within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "agentId" }, "example": "agentId" }, { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Proxy agent connections retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/ProxyIntegrationResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } }, "examples": { "get_connections_response": { "value": { "code": "Success", "data": { "items": [ { "connection_id": "connection_id" } ], "next_cursor": "eyJza2lwIjoyfQ" } } } } } } }, "404": { "description": "Proxy Agent not found", "content": { "application/json": { "examples": { "proxy_not_found": { "value": { "code": "NotFound", "message": "Proxy Agent not found." } } } } } } } } }, "/v1/proxy/{agentId}/regenerate-secrets": { "post": { "tags": [ "Proxy Agent Management" ], "summary": "Regenerate Secrets for Proxy Agent", "description": "Regenerate secrets for proxy agent within your Fivetran account.", "operationId": "regenerate_secrets_proxy_agent", "parameters": [ { "name": "agentId", "in": "path", "description": "The unique identifier for the proxy agent within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "agentId" }, "example": "agentId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Created" }, "message": { "type": "string", "description": "Response status text", "example": "Proxy agent secrets have been regenerated" }, "data": { "$ref": "#/components/schemas/ProxyAgentCreatedResponse" } } } } } }, "404": { "description": "Proxy agent not found.", "content": { "application/json": { "examples": { "proxy_not_found": { "value": { "code": "NotFound", "message": "Proxy Agent not found." } } } } } } } } }, "/v1/roles": { "get": { "tags": [ "Role Management" ], "summary": "List all roles", "description": "Returns a list of all predefined and custom roles within your Fivetran account.", "operationId": "list_all_roles", "parameters": [ { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Roles list retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/RoleResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } } }, "/v1/system-keys": { "get": { "tags": [ "System Key Management" ], "summary": "List All System Keys", "description": "Returns a list of system keys within your Fivetran account.", "operationId": "get_system_keys", "parameters": [ { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "System keys retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/SystemKeyResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } }, "examples": { "get_list_response": { "value": { "code": "Success", "data": { "items": [ { "id": "_moonbeam_acc_dev", "name": "dev", "key": "", "created_at": "2023-11-10T22:11:52.326265Z", "expired_at": "2024-02-10T22:11:52.326265Z" }, { "id": "cyclical_prospered", "name": "prod_key", "key": "", "created_at": "2023-11-10T22:11:58.931Z", "updated_at": "2023-11-10T22:11:58.931Z", "expired_at": "2024-02-10T22:11:58.931Z" } ] } } } } } } } } }, "post": { "tags": [ "System Key Management" ], "summary": "Create a System Key", "description": "Creates a new system key with your Fivetran account.", "operationId": "create_system_key", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSystemKeyRequest" }, "examples": { "create_request": { "value": { "name": "prod_key", "expiration_period": "THREE_MONTHS", "permissions": [ { "resource_type": "USER", "access_level": "READ" }, { "resource_type": "WEBHOOK", "access_level": "MANAGE" }, { "resource_type": "CONNECTOR", "access_level": "MANAGE" }, { "resource_type": "DESTINATION", "access_level": "MANAGE" }, { "resource_type": "TRANSFORMATION", "access_level": "MANAGE", "resource_filter": { "group_ids": [ "group_id_1", "group_id_2" ] } }, { "resource_type": "CONNECTOR", "access_level": "NONE", "resource_filter": { "ids": [ "connection_id_1", "connection_id_2" ] } } ] } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "System key has been created" }, "data": { "$ref": "#/components/schemas/SystemKeyResponse" } } }, "examples": { "create_response": { "value": { "code": "Success", "message": "System key has been created", "data": { "id": "sod_determine", "name": "prod_key", "key": "", "secret": "", "created_at": "2023-11-10T19:32:58.646Z", "expired_at": "2024-02-10T19:32:58.646Z", "permissions": [ { "resource_type": "USER", "access_level": "READ" }, { "resource_type": "WEBHOOK", "access_level": "MANAGE" }, { "resource_type": "DESTINATION", "access_level": "MANAGE" }, { "resource_type": "TRANSFORMATION", "access_level": "MANAGE", "resource_filter": { "group_ids": [ "group_id_1", "group_id_2" ] } }, { "resource_type": "CONNECTOR", "access_level": "NONE", "resource_filter": { "ids": [ "connection_id_1", "connection_id_2" ] } }, { "resource_type": "CONNECTOR", "access_level": "MANAGE" } ] } } } } } } } } } }, "/v1/system-keys/{keyId}": { "get": { "tags": [ "System Key Management" ], "summary": "Retrieve System Key Details", "description": "Retrieves a system key object within your Fivetran account.", "operationId": "get_system_key_details", "parameters": [ { "name": "keyId", "in": "path", "description": "The unique identifier for the system key within your Fivetran account.", "required": true, "schema": { "type": "string", "example": "keyId" }, "example": "keyId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "System key details retrieved successfully" }, "data": { "$ref": "#/components/schemas/SystemKeyResponse" } } }, "examples": { "get_response": { "value": { "code": "Success", "data": { "id": "rushed_fainting", "name": "updated_key", "key_value": "", "created_at": "2023-10-17T14:01:16.318Z", "updated_at": "2023-10-17T14:02:20.919291Z", "expired_at": "2024-01-17T14:01:16.318Z", "permissions": [ { "resource_type": "CONNECTOR", "access_level": "MANAGE" }, { "resource_type": "DESTINATION", "access_level": "MANAGE" }, { "resource_type": "TRANSFORMATION", "access_level": "MANAGE", "resource_filter": { "group_ids": [ "group_id_1", "group_id_2" ] } }, { "resource_type": "CONNECTOR", "access_level": "NONE", "resource_filter": { "ids": [ "connection_id_3", "connection_id_4" ] } } ] } } } } } } } } }, "delete": { "tags": [ "System Key Management" ], "summary": "Delete a System Key", "description": "Deletes a system key from your Fivetran account.", "operationId": "delete_system_key", "parameters": [ { "name": "keyId", "in": "path", "description": "The unique identifier for the system key within your Fivetran account.", "required": true, "schema": { "type": "string", "example": "keyId" }, "example": "keyId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "System key with id 'string' has been deleted" } } }, "examples": { "delete_response": { "value": { "code": "Success", "message": "System key with id 'rushed_fainting' has been deleted" } } } } } } } }, "patch": { "tags": [ "System Key Management" ], "summary": "Update a System Key", "description": "Updates an existing system key within your Fivetran account.", "operationId": "update_system_key", "parameters": [ { "name": "keyId", "in": "path", "description": "The unique identifier for the system key within your Fivetran account.", "required": true, "schema": { "type": "string", "example": "keyId" }, "example": "keyId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSystemKeyRequest" }, "examples": { "update_request": { "value": { "name": "updated_key", "permissions": [ { "resource_type": "CONNECTOR", "access_level": "MANAGE" }, { "resource_type": "DESTINATION", "access_level": "MANAGE" }, { "resource_type": "TRANSFORMATION", "access_level": "MANAGE", "resource_filter": { "group_ids": [ "group_id_3", "group_id_4" ] } }, { "resource_type": "CONNECTOR", "access_level": "NONE", "resource_filter": { "ids": [ "connection_id_3", "connection_id_4" ] } } ] } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "System key has been updated" }, "data": { "$ref": "#/components/schemas/SystemKeyResponse" } } }, "examples": { "update_response": { "value": { "code": "Success", "message": "System key has been updated", "data": { "id": "rushed_fainting", "name": "updated_key", "key_value": "", "created_at": "2023-10-17T14:01:16.318Z", "updated_at": "2023-10-17T14:02:20.919291Z", "expired_at": "2024-01-17T14:01:16.318Z", "permissions": [ { "resource_type": "CONNECTOR", "access_level": "MANAGE" }, { "resource_type": "DESTINATION", "access_level": "MANAGE" }, { "resource_type": "TRANSFORMATION", "access_level": "MANAGE", "resource_filter": { "group_ids": [ "group_id_3", "group_id_4" ] } }, { "resource_type": "CONNECTOR", "access_level": "NONE", "resource_filter": { "ids": [ "connection_id_3", "connection_id_4" ] } } ] } } } } } } } } } }, "/v1/system-keys/{keyId}/rotate": { "post": { "tags": [ "System Key Management" ], "summary": "Rotate a System Key", "description": "Updates the secret value and expired_at date for an existing system key within your Fivetran account.", "operationId": "rotate_system_key", "parameters": [ { "name": "keyId", "in": "path", "description": "The unique identifier for the system key within your Fivetran account.", "required": true, "schema": { "type": "string", "example": "keyId" }, "example": "keyId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RotateSystemKeyRequest" }, "examples": { "rotate_request": { "value": { "name": "updated_key", "permissions": { "expiration_period": "THREE_MONTHS" } } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "System key with id 'string' has been rotated" }, "data": { "$ref": "#/components/schemas/SystemKeyResponse" } } }, "examples": { "rotate_response": { "value": { "code": "Success", "message": "System key with id 'rushed_fainting' has been rotated", "data": { "id": "rushed_fainting", "name": "prod_key", "key": "", "secret": "", "created_at": "2023-11-10T19:32:58.646Z", "expired_at": "2024-02-10T19:32:58.646Z", "permissions": [ { "resource_type": "USER", "access_level": "READ" }, { "resource_type": "WEBHOOK", "access_level": "MANAGE" }, { "resource_type": "DESTINATION", "access_level": "MANAGE" }, { "resource_type": "TRANSFORMATION", "access_level": "MANAGE", "resource_filter": { "group_ids": [ "group_id_1", "group_id_2" ] } }, { "resource_type": "CONNECTOR", "access_level": "NONE", "resource_filter": { "ids": [ "connection_id_3", "connection_id_4" ] } }, { "resource_type": "CONNECTOR", "access_level": "MANAGE" } ] } } } } } } } } } }, "/v1/teams": { "get": { "tags": [ "Team Management" ], "summary": "List All Teams", "description": "Returns a list of all teams within your Fivetran account", "operationId": "list_all_teams", "parameters": [ { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Teams retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/TeamResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } }, "post": { "tags": [ "Team Management" ], "summary": "Create a Team", "description": "Creates a new team in your Fivetran account", "operationId": "create_team", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamRequest" } } } }, "responses": { "201": { "description": "default response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Team has been created" }, "data": { "$ref": "#/components/schemas/TeamResponse" } } } } } } } } }, "/v1/teams/{teamId}": { "get": { "tags": [ "Team Management" ], "summary": "Retrieve Team Details", "description": "Returns information for a given team within your Fivetran account", "operationId": "team_details", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Team details retrieved successfully" }, "data": { "$ref": "#/components/schemas/TeamResponse" } } } } } } } }, "delete": { "tags": [ "Team Management" ], "summary": "Delete a Team", "description": "Deletes a team from your Fivetran account", "operationId": "delete_team", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Team has been deleted" } } } } } } } }, "patch": { "tags": [ "Team Management" ], "summary": "Update a Team", "description": "Updates information for an existing team within your Fivetran account", "operationId": "modify_team", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTeamRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Team has been updated" }, "data": { "$ref": "#/components/schemas/TeamResponse" } } } } } } } } }, "/v1/teams/{teamId}/connections": { "get": { "tags": [ "Team Management" ], "summary": "List All Connection Memberships", "description": "Returns all connections a team has membership in.", "operationId": "get_team_memberships_in_connections", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Team connection memberships retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/MembershipResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } }, "post": { "tags": [ "Team Management" ], "summary": "Add Connection Membership", "description": "Adds a team as a member of a connection.", "operationId": "add_team_membership_in_connection", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipRequest" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection membership has been created" }, "data": { "$ref": "#/components/schemas/MembershipResponse" } } } } } } } } }, "/v1/teams/{teamId}/connections/{connectionId}": { "get": { "tags": [ "Team Management" ], "summary": "Retrieve Connection Membership", "description": "Returns details of a team membership in a connection.", "operationId": "get_team_membership_in_connection", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Team connection membership retrieved successfully" }, "data": { "$ref": "#/components/schemas/MembershipResponse" } } } } } } } }, "delete": { "tags": [ "Team Management" ], "summary": "Delete Connection Membership", "description": "Removes team membership in a connection.", "operationId": "delete_team_membership_in_connection", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection membership has been deleted" } } } } } } } }, "patch": { "tags": [ "Team Management" ], "summary": "Update Connection Membership", "description": "Updates team membership in a connection", "operationId": "update_team_membership_in_connection", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMembershipRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection membership has been updated" }, "data": { "$ref": "#/components/schemas/MembershipResponse" } } } } } } } } }, "/v1/teams/{teamId}/groups": { "get": { "tags": [ "Team Management" ], "summary": "List All Group Memberships", "description": "Returns all groups in which a team has membership.", "operationId": "get_team_memberships_in_groups", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Team group memberships retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/MembershipResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } }, "post": { "tags": [ "Team Management" ], "summary": "Add Group Membership", "description": "Adds a team as a member of a group.", "operationId": "add_team_membership_in_group", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipRequest_add_team_membership_in_group" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Group membership has been created" }, "data": { "$ref": "#/components/schemas/MembershipResponse" } } } } } } } } }, "/v1/teams/{teamId}/groups/{groupId}": { "get": { "tags": [ "Team Management" ], "summary": "Retrieve Group Membership Details", "description": "Returns details of a team membership in a group.", "operationId": "get_team_membership_in_group", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "groupId", "in": "path", "description": "The unique identifier for the group within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "groupId" }, "example": "groupId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Team group membership retrieved successfully" }, "data": { "$ref": "#/components/schemas/MembershipResponse" } } } } } } } }, "delete": { "tags": [ "Team Management" ], "summary": "Delete Group Membership", "description": "Removes a team's membership in a group.", "operationId": "delete_team_membership_in_group", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "groupId", "in": "path", "description": "The unique identifier for the group within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "groupId" }, "example": "groupId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Group membership has been deleted" } } } } } } } }, "patch": { "tags": [ "Team Management" ], "summary": "Update Group Membership", "description": "Updates team membership in a group.", "operationId": "update_team_membership_in_group", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "groupId", "in": "path", "description": "The unique identifier for the group within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "groupId" }, "example": "groupId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMembershipRequest_update_team_membership_in_group" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Group membership has been updated" }, "data": { "$ref": "#/components/schemas/MembershipResponse" } } } } } } } } }, "/v1/teams/{teamId}/role": { "delete": { "tags": [ "Team Management" ], "summary": "Delete Team from Account", "description": "Removes a team from your Fivetran account", "operationId": "delete_team_membership_in_account", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Team role in account has been removed" } } } } } } } } }, "/v1/teams/{teamId}/users": { "get": { "tags": [ "Team Management" ], "summary": "List All User Memberships", "description": "Returns a list of users and their roles within a team in your Fivetran account", "operationId": "list_users_in_team", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "active", "in": "query", "description": "Indicates whether to return only enabled users (true) or not (false). By default, both enabled (allowed to log in) and suspended users are returned.", "required": false, "schema": { "type": "boolean", "example": true }, "example": true }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Team users retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/TeamMembershipResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } }, "post": { "tags": [ "Team Management" ], "summary": "Add a User to the Team", "description": "Assigns a role for a user in a team.", "operationId": "add_user_to_team", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMembershipRequest" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "User has been added to the team" }, "data": { "$ref": "#/components/schemas/TeamMembershipResponse" } } } } } } } } }, "/v1/teams/{teamId}/users/{userId}": { "get": { "tags": [ "Team Management" ], "summary": "Retrieve User Membership in a Team", "description": "Returns the membership details for a user in a team.", "operationId": "get_user_in_team", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Team user details retrieved successfully" }, "data": { "$ref": "#/components/schemas/TeamMembershipResponse" } } } } } } } }, "delete": { "tags": [ "Team Management" ], "summary": "Delete a User from a Team", "description": "Removes a user from a team.", "operationId": "delete_user_from_team", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "User has been removed from the team" } } } } } } } }, "patch": { "tags": [ "Team Management" ], "summary": "Update a User Membership", "description": "Updates a user membership in a team.", "operationId": "update_user_membership", "parameters": [ { "name": "teamId", "in": "path", "description": "The unique identifier for the team within the account.", "required": true, "schema": { "type": "string", "example": "teamId" }, "example": "teamId" }, { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMembershipRequest_update_user_membership" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "User role has been updated" }, "data": { "$ref": "#/components/schemas/TeamMembershipResponse" } } } } } } } } }, "/v1/transformation-projects": { "get": { "tags": [ "Transformation Projects Management" ], "summary": "List all Transformation Projects", "description": "Returns a list of all transformation projects available via API within your Fivetran account.", "operationId": "list_all_transformation_projects", "parameters": [ { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Transformation projects retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/TransformationProjectResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } }, "post": { "tags": [ "Transformation Projects Management" ], "summary": "Create Transformation Project", "description": "Creates a new transformation project.", "operationId": "create_transformation_project", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTransformationProjectRequest" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Transformation project created successfully" }, "data": { "$ref": "#/components/schemas/TransformationProjectDetailsResponse" } } } } } } } } }, "/v1/transformation-projects/{projectId}": { "get": { "tags": [ "Transformation Projects Management" ], "summary": "Retrieve Transformation Project Details", "description": "Returns transformation project details if a valid identifier was provided.", "operationId": "transformation_project_details", "parameters": [ { "name": "projectId", "in": "path", "description": "The unique identifier for the transformation project within the Fivetran system", "required": true, "schema": { "type": "string", "example": "projectId" }, "example": "projectId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Transformation project details retrieved successfully" }, "data": { "$ref": "#/components/schemas/TransformationProjectDetailsResponse" } } } } } } } }, "delete": { "tags": [ "Transformation Projects Management" ], "summary": "Delete Transformation Project", "description": "Deletes transformation project if a valid identifier was provided.", "operationId": "delete_transformation_project", "parameters": [ { "name": "projectId", "in": "path", "description": "The unique identifier for the transformation project within the Fivetran system", "required": true, "schema": { "type": "string", "example": "projectId" }, "example": "projectId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Transformation project with id 'string' has been deleted" } } } } } } } }, "patch": { "tags": [ "Transformation Projects Management" ], "summary": "Update Transformation Project", "description": "Updates transformation project if a valid identifier was provided.", "operationId": "modify_transformation_project", "parameters": [ { "name": "projectId", "in": "path", "description": "The unique identifier for the transformation project within the Fivetran system", "required": true, "schema": { "type": "string", "example": "projectId" }, "example": "projectId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTransformationProjectRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Transformation project updated successfully" }, "data": { "$ref": "#/components/schemas/TransformationProjectDetailsResponse" } } } } } } } } }, "/v1/transformation-projects/{projectId}/test": { "post": { "tags": [ "Transformation Projects Management" ], "summary": "Test Transformation Project", "description": "Triggers tests for an existing transformation project.", "operationId": "test_transformation_project", "parameters": [ { "name": "projectId", "in": "path", "description": "The unique identifier for the transformation project within the Fivetran system", "required": true, "schema": { "type": "string", "example": "projectId" }, "example": "projectId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Transformation project test completed successfully" }, "data": { "$ref": "#/components/schemas/TransformationProjectDetailsResponse" } } } } } } } } }, "/v1/transformations": { "get": { "tags": [ "Transformation Management" ], "summary": "List all Transformations", "description": "Returns a list of all transformations within your Fivetran account.", "operationId": "transformations_list", "parameters": [ { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "group_id", "in": "query", "description": "Specify the group identifier to filter transformations by group", "required": false, "schema": { "type": "string", "example": "group_id" }, "example": "group_id" }, { "name": "project_id", "in": "query", "description": "Specify dbt project identifier to filter transformations by project", "required": false, "schema": { "type": "string", "example": "project_id" }, "example": "project_id" }, { "name": "type", "in": "query", "description": "Transformation type filter", "required": false, "schema": { "type": "string", "example": "DBT_CORE", "enum": [ "DBT_CORE", "QUICKSTART" ] }, "example": "DBT_CORE" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Transformations list retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/TransformationResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } }, "post": { "tags": [ "Transformation Management" ], "summary": "Create a Transformation", "description": "Creates a new transformation.", "operationId": "create_transformation", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTransformationRequest" } } } }, "responses": { "201": { "description": "Created response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Transformation created successfully" }, "data": { "$ref": "#/components/schemas/TransformationResponse" } } } } } } } } }, "/v1/transformations/package-metadata": { "get": { "tags": [ "Transformation Management" ], "summary": "List All Quickstart Package Metadata", "description": "Returns a list of available Quickstart transformation package metadata details.", "operationId": "transformation_package_metadata_list", "parameters": [ { "name": "service", "in": "query", "description": "Specify the service identifier to filter Quickstart packages by connection service", "required": false, "schema": { "type": "string", "example": "service" }, "example": "service" }, { "name": "name", "in": "query", "description": "Specify the package name to filter Quickstart packages by name", "required": false, "schema": { "type": "string", "example": "service" }, "example": "service" }, { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Transformation package metadata list retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/TransformationPackageMetadataResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } }, "400": { "description": "Bad request" } } } }, "/v1/transformations/package-metadata/{package_definition_id}": { "get": { "tags": [ "Transformation Management" ], "summary": "Retrieve a Quickstart Package Metadata Details", "description": "Returns the metadata details of the Quickstart transformation package if a valid identifier is provided.", "operationId": "transformation_package_metadata_details", "parameters": [ { "name": "package_definition_id", "in": "path", "description": "The unique identifier for the Quickstart transformation package definition within the Fivetran system", "required": true, "schema": { "type": "string", "example": "package_definition_id" }, "example": "package_definition_id" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Transformation package metadata details retrieved successfully" }, "data": { "$ref": "#/components/schemas/TransformationPackageMetadataResponse" } } } } } }, "404": { "description": "Transformation Package not found" } } } }, "/v1/transformations/{transformationId}": { "get": { "tags": [ "Transformation Management" ], "summary": "Retrieve Transformation Details", "description": "Returns a transformation details if a valid identifier is provided.", "operationId": "transformation_details", "parameters": [ { "name": "transformationId", "in": "path", "description": "The unique identifier for the transformation within the Fivetran system", "required": true, "schema": { "type": "string", "example": "transformationId" }, "example": "transformationId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Transformation details retrieved successfully" }, "data": { "$ref": "#/components/schemas/TransformationResponse" } } } } } }, "404": { "description": "Transformation not found" } } }, "delete": { "tags": [ "Transformation Management" ], "summary": "Delete a Transformation", "description": "Deletes a transformation if a valid identifier is provided.", "operationId": "delete_transformation", "parameters": [ { "name": "transformationId", "in": "path", "description": "The unique identifier for the transformation within the Fivetran system", "required": true, "schema": { "type": "string", "example": "transformationId" }, "example": "transformationId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Transformation with id 'string' has been deleted" } } } } } }, "404": { "description": "Transformation not found" } } }, "patch": { "tags": [ "Transformation Management" ], "summary": "Update a Transformation", "description": "Updates the transformation if a valid identifier is provided.", "operationId": "update_transformation", "parameters": [ { "name": "transformationId", "in": "path", "description": "The unique identifier for the transformation within the Fivetran system", "required": true, "schema": { "type": "string", "example": "transformationId" }, "example": "transformationId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTransformationRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Transformation updated successfully" }, "data": { "$ref": "#/components/schemas/TransformationResponse" } } } } } }, "404": { "description": "Transformation not found" } } } }, "/v1/transformations/{transformationId}/cancel": { "post": { "tags": [ "Transformation Management" ], "summary": "Cancel Running Transformation", "description": "Cancels the execution of the transformation if a valid identifier is provided.", "operationId": "cancel_transformation", "parameters": [ { "name": "transformationId", "in": "path", "description": "The unique identifier for the transformation within the Fivetran system", "required": true, "schema": { "type": "string", "example": "transformationId" }, "example": "transformationId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Transformation with id 'string' has been canceled" } } } } } }, "404": { "description": "Transformation not found" } } } }, "/v1/transformations/{transformationId}/run": { "post": { "tags": [ "Transformation Management" ], "summary": "Run Transformation", "description": "Runs the transformation if a valid identifier is provided.", "operationId": "run_transformation", "parameters": [ { "name": "transformationId", "in": "path", "description": "The unique identifier for the transformation within the Fivetran system", "required": true, "schema": { "type": "string", "example": "transformationId" }, "example": "transformationId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunTransformationRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Transformation with id 'string' has been started" } } } } } }, "404": { "description": "Transformation not found" } } } }, "/v1/transformations/{transformationId}/upgrade": { "post": { "tags": [ "Transformation Management" ], "summary": "Upgrade Transformation Package", "description": "Upgrades the Quickstart transformation package to latest version if a valid identifier is provided.", "operationId": "upgrade_transformation_package", "parameters": [ { "name": "transformationId", "in": "path", "description": "The unique identifier for the transformation within the Fivetran system", "required": true, "schema": { "type": "string", "example": "transformationId" }, "example": "transformationId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Transformation package has been upgraded" } } } } } }, "404": { "description": "Transformation Package not found" } } } }, "/v1/users": { "get": { "tags": [ "User Management" ], "summary": "List All Users", "description": "Returns a list of all users within your Fivetran account.", "operationId": "list_all_users", "parameters": [ { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "active", "in": "query", "description": "Indicates whether to return only enabled users (true) or not (false). By default, both enabled (allowed to log in) and suspended users are returned.", "required": false, "schema": { "type": "boolean", "example": true }, "example": true }, { "name": "user_type", "in": "query", "description": "The type of user. Possible values: `REGULAR_USER`: A human user who can log in to the Fivetran dashboard and interact with the API, and `SERVICE_ACCOUNT`: A non-human identity for machine-to-machine API access that cannot log in to the dashboard.", "required": false, "schema": { "type": "string", "example": "SERVICE_ACCOUNT" }, "example": "SERVICE_ACCOUNT" }, { "name": "has_api_key", "in": "query", "description": "Indicates whether the user has an assigned API key, including expired keys. Accepted values: `true` or `false`.", "required": false, "schema": { "type": "string", "example": "true" }, "example": "true" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Users list retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/UserResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } }, "post": { "tags": [ "User Management" ], "summary": "Invite a User", "description": "Creates a new user in your Fivetran account.\n\nFor a regular user, an invitation email is sent, and the user must accept it before gaining access; their details are accessible through the API in the meantime.\n\nFor a service account, the user gets created immediately with no invitation or email validation required.\n\n> Note: A service account user can't create another service account user.\n", "operationId": "create_user", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUserRequest" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "User has been created" }, "data": { "$ref": "#/components/schemas/UserResponse" } } } } } }, "400": { "description": "Bad request" } } } }, "/v1/users/api-keys": { "get": { "tags": [ "User Management" ], "summary": "List All API Keys", "description": "Returns a paginated list of API keys for all users within your Fivetran account.", "operationId": "list_api_keys", "parameters": [ { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "user_type", "in": "query", "description": "The type of user. Possible values: `REGULAR_USER`: A human user who can log in to the Fivetran dashboard and interact with the API, and `SERVICE_ACCOUNT`: A non-human identity for machine-to-machine API access that cannot log in to the dashboard.", "required": false, "schema": { "type": "string", "example": "SERVICE_ACCOUNT" }, "example": "SERVICE_ACCOUNT" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "API keys have been listed" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/ApiKeyResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } } }, "/v1/users/{id}": { "delete": { "tags": [ "User Management" ], "summary": "Delete a User", "description": "Deletes a user from your Fivetran account. You will be unable to delete an account owner user if there is only one remaining.", "operationId": "delete_user", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "user_id" }, "example": "user_id" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "User with id 'string' has been deleted" } } } } } }, "404": { "description": "Not found error" } } } }, "/v1/users/{userId}": { "get": { "tags": [ "User Management" ], "summary": "Retrieve User Details", "description": "Returns a user object if a valid identifier was provided.", "operationId": "user_details", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "User details retrieved successfully" }, "data": { "$ref": "#/components/schemas/UserResponse" } } } } } }, "404": { "description": "User not found" } } }, "patch": { "tags": [ "User Management" ], "summary": "Update a User", "description": "Updates information for an existing user within your Fivetran account.", "operationId": "modify_user", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "User has been updated" }, "data": { "$ref": "#/components/schemas/UserResponse" } } } } } }, "404": { "description": "User not found" } } } }, "/v1/users/{userId}/api-keys": { "get": { "tags": [ "User Management" ], "summary": "Retrieve User API Key", "description": "Returns the API key details for the specified service account.", "operationId": "get_user_api_key", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "User API key has been retrieved" }, "data": { "$ref": "#/components/schemas/ApiKeyResponse" } } } } } }, "404": { "description": "User not found" } } }, "post": { "tags": [ "User Management" ], "summary": "Create Service Account API Key", "description": "Creates a new API key for the specified service account. The secret is\nreturned once at creation and cannot be retrieved again.\n\n> Note: Only a regular user can perform this operation.\n", "operationId": "create_user_api_key", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "API key has been created" }, "data": { "$ref": "#/components/schemas/CreateApiKeyResponse" } } } } } }, "400": { "description": "Bad request" }, "404": { "description": "User not found" } } }, "delete": { "tags": [ "User Management" ], "summary": "Delete API Keys", "description": "Deletes all API keys for the specified user.\n\n> Note: Only a regular user can perform this operation.\n", "operationId": "delete_user_api_keys", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "API key deleted for service account user with id='string'" } } } } } }, "404": { "description": "User not found" } } } }, "/v1/users/{userId}/api-keys/rotate": { "post": { "tags": [ "User Management" ], "summary": "Rotate Service Account API Key", "description": "Rotates the API key for the specified service account and generates a new secret.\n\nDuring the optional overlap period, both the old and new secrets remain valid, allowing zero-downtime credential rotation.\n\n> Note: Only a regular user can perform this operation.\n", "operationId": "rotate_user_api_key", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RotateApiKeyRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "API key rotated successfully" }, "data": { "$ref": "#/components/schemas/RotateApiKeyResponse" } } } } } }, "400": { "description": "Bad request" }, "404": { "description": "User not found" } } } }, "/v1/users/{userId}/connections": { "get": { "tags": [ "User Management" ], "summary": "List All Connection Memberships", "description": "Returns all connection membership for a user within your Fivetran account.", "operationId": "get_user_memberships_in_connections", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "User memberships in connections retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/MembershipResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } }, "post": { "tags": [ "User Management" ], "summary": "Add a Connection Membership", "description": "Adds a connection membership", "operationId": "add_user_membership_in_connection", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipRequest_add_user_membership_in_connection" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection membership has been created" }, "data": { "$ref": "#/components/schemas/MembershipResponse" } } } } } }, "404": { "description": "User not found" } } } }, "/v1/users/{userId}/connections/{connectionId}": { "get": { "tags": [ "User Management" ], "summary": "Retrieve Connection Membership", "description": "Returns the details of a user's membership in a connection.", "operationId": "get_user_membership_in_connections", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "User membership in connection retrieved successfully" }, "data": { "$ref": "#/components/schemas/MembershipResponse" } } } } } }, "404": { "description": "User not found" } } }, "delete": { "tags": [ "User Management" ], "summary": "Delete Connection Membership", "description": "Removes user membership in a connection.", "operationId": "delete_user_membership_in_connection", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection membership has been deleted" }, "data": { "$ref": "#/components/schemas/MembershipResponse" } } } } } }, "404": { "description": "User not found" } } }, "patch": { "tags": [ "User Management" ], "summary": "Update Connection Membership", "description": "Updates user membership in a connection.", "operationId": "update_user_membership_in_connection", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "connectionId", "in": "path", "description": "The unique identifier of the connection. Retrieve it from the `id` field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the `id` field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection).", "required": true, "schema": { "type": "string", "example": "4107c213907114059a5544ad8fa66c52" }, "example": "4107c213907114059a5544ad8fa66c52" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMembershipRequest_update_user_membership_in_connection" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Connection membership has been updated" }, "data": { "$ref": "#/components/schemas/MembershipResponse" } } } } } }, "404": { "description": "User not found" } } } }, "/v1/users/{userId}/groups": { "get": { "tags": [ "User Management" ], "summary": "List All Group Memberships", "description": "Returns the membership details for all groups a user belongs to.", "operationId": "get_user_memberships_in_groups", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "User memberships in groups retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/MembershipResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } }, "post": { "tags": [ "User Management" ], "summary": "Add Group Membership", "description": "Adds a user membership in a group.", "operationId": "add_user_membership_in_group", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupMembershipRequest" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Group membership has been created" }, "data": { "$ref": "#/components/schemas/MembershipResponse" } } } } } }, "400": { "description": "Bad request" }, "404": { "description": "User not found" } } } }, "/v1/users/{userId}/groups/{groupId}": { "get": { "tags": [ "User Management" ], "summary": "Retrieve Group Membership Details", "description": "Returns details of a user membership in group.", "operationId": "get_user_membership_in_group", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "groupId", "in": "path", "description": "The unique identifier for the group within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "groupId" }, "example": "groupId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "User membership in group retrieved successfully" }, "data": { "$ref": "#/components/schemas/MembershipResponse" } } } } } }, "404": { "description": "User not found" } } }, "delete": { "tags": [ "User Management" ], "summary": "Delete Group Membership", "description": "Removes user from a group.", "operationId": "delete_user_membership_in_group", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "groupId", "in": "path", "description": "The unique identifier for the group within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "groupId" }, "example": "groupId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Group membership has been deleted" } } } } } }, "404": { "description": "User not found" } } }, "patch": { "tags": [ "User Management" ], "summary": "Update Group Membership", "description": "Updates user group membership.", "operationId": "update_user_membership_in_group", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "groupId", "in": "path", "description": "The unique identifier for the group within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "groupId" }, "example": "groupId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMembershipRequest_update_user_membership_in_group" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Group membership has been updated" } } } } } }, "404": { "description": "User not found" } } } }, "/v1/users/{userId}/role": { "delete": { "tags": [ "User Management" ], "summary": "Delete Account Role", "description": "Removes a user's role from an account, but the user remains a member of the account.", "operationId": "delete_user_membership_in_account", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier for the user within the account.", "required": true, "schema": { "type": "string", "example": "userId" }, "example": "userId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "User role in account has been removed" } } } } } }, "404": { "description": "User not found" } } } }, "/v1/webhooks": { "get": { "tags": [ "Webhook Management" ], "summary": "List all Webhooks", "description": "The endpoint allows you to retrieve the list of existing webhooks available for the current account", "operationId": "list_all_webhooks", "parameters": [ { "name": "cursor", "in": "query", "description": "Paging cursor, [read more about pagination](https://fivetran.com/docs/rest-api/pagination)", "required": false, "schema": { "type": "string", "example": "cursor_value" }, "example": "cursor_value" }, { "name": "limit", "in": "query", "description": "Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 100 }, "example": 100 }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Webhooks retrieved successfully" }, "data": { "required": [ "items" ], "properties": { "items": { "type": "array", "description": "The collection of returned items", "items": { "$ref": "#/components/schemas/WebhookResponse" } }, "next_cursor": { "type": "string", "description": "The value of the cursor parameter for the next page", "example": "cursor_value" } } } } } } } } } } }, "/v1/webhooks/account": { "post": { "tags": [ "Webhook Management" ], "summary": "Create an Account Webhook", "description": "This endpoint allows you to create a new webhook for the current account.", "operationId": "create_account_webhook", "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Account webhook has been created" }, "data": { "$ref": "#/components/schemas/WebhookResponse" } } } } } } } } }, "/v1/webhooks/group/{groupId}": { "post": { "tags": [ "Webhook Management" ], "summary": "Create a Group Webhook", "description": "This endpoint allows you to create a new webhook for a given group", "operationId": "create_group_webhook", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier for the group within the Fivetran system.", "required": true, "schema": { "type": "string", "example": "groupId" }, "example": "groupId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequest_create_group_webhook" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Group webhook has been created" }, "data": { "$ref": "#/components/schemas/WebhookResponse" } } } } } }, "404": { "description": "Group not found" } } } }, "/v1/webhooks/{webhookId}": { "get": { "tags": [ "Webhook Management" ], "summary": "Retrieve Webhook Details", "description": "This endpoint allows you to retrieve details of the existing webhook for a given identifier", "operationId": "webhook_details", "parameters": [ { "name": "webhookId", "in": "path", "description": "The webhook ID", "required": true, "schema": { "type": "string", "example": "webhookId" }, "example": "webhookId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Webhook details retrieved successfully" }, "data": { "$ref": "#/components/schemas/WebhookResponse" } } } } } }, "404": { "description": "Webhook not found" } } }, "delete": { "tags": [ "Webhook Management" ], "summary": "Delete a Webhook", "description": "This endpoint allows you to delete an existing webhook with a given identifier", "operationId": "delete_webhook", "parameters": [ { "name": "webhookId", "in": "path", "description": "The webhook ID", "required": true, "schema": { "type": "string", "example": "webhookId" }, "example": "webhookId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Webhook with id 'string' has been deleted" } } } } } }, "404": { "description": "Webhook not found" } } }, "patch": { "tags": [ "Webhook Management" ], "summary": "Update a Webhook", "description": "The endpoint allows you to update the existing webhook with a given identifier", "operationId": "modify_webhook", "parameters": [ { "name": "webhookId", "in": "path", "description": "The webhook ID", "required": true, "schema": { "type": "string", "example": "webhookId" }, "example": "webhookId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequest_modify_webhook" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Webhook has been updated" }, "data": { "$ref": "#/components/schemas/WebhookResponse" } } } } } }, "404": { "description": "Webhook not found" } } } }, "/v1/webhooks/{webhookId}/test": { "post": { "tags": [ "Webhook Management" ], "summary": "Test a Webhook", "description": "The endpoint allows you to test an existing webhook. It sends a webhook with a given identifier for a dummy connection with identifier _connection_1", "operationId": "test_webhook", "parameters": [ { "name": "webhookId", "in": "path", "description": "The webhook ID", "required": true, "schema": { "type": "string", "example": "webhookId" }, "example": "webhookId" }, { "name": "Accept", "in": "header", "schema": { "type": "string", "example": "application/json", "default": "application/json" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookTestRequest" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "required": [ "code", "data" ], "properties": { "code": { "type": "string", "description": "Response status code", "example": "Success" }, "message": { "type": "string", "description": "Response status text", "example": "Webhook test completed successfully" }, "data": { "$ref": "#/components/schemas/WebhookTestResponse" } } } } } }, "404": { "description": "Webhook not found" } } } } }, "components": { "schemas": { "TrustCertificateRequest": { "required": [ "encoded_cert", "hash" ], "type": "object", "properties": { "hash": { "type": "string", "description": "Hash of the certificate.", "example": "jhg5UI7fgrI6yy..." }, "encoded_cert": { "type": "string", "description": "The certificate encoded in base64.", "example": "MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMAkGA1UEBhMCV..." }, "connection_id": { "type": "string", "description": "The unique identifier for the connection within the Fivetran system.", "example": "connection_id" }, "destination_id": { "type": "string", "description": "The unique identifier for the destination within the Fivetran system.", "example": "destination_id" } } }, "ApproveCertificateRequest": { "required": [ "encoded_cert", "hash" ], "type": "object", "properties": { "hash": { "type": "string", "description": "Hash of the certificate.", "example": "jhg5UI7fgrI6yy..." }, "encoded_cert": { "type": "string", "description": "The certificate encoded in base64.", "example": "MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMAkGA1UEBhMCV..." } } }, "CertificateDetailsResponse": { "required": [ "hash", "id", "name", "public_key", "sha1", "sha256", "type", "validated_by", "validated_date" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the certificate (Base64URL encoded hash of the certificate).", "example": "Y29ubmVjdG9yIGNlcnRpZmljYXRlIGhhc2g" }, "name": { "type": "string", "description": "The certificate name.", "example": "Certificate Name" }, "hash": { "type": "string", "description": "Hash of the certificate.", "example": "jhg5UI7fgrI6yy..." }, "type": { "type": "string", "description": "Type of the certificate.", "example": "TLS" }, "sha1": { "type": "string", "description": "SHA1 of certificate.", "example": "c8de1d13vtu435ilj435lj345796d8jh7hk8hgk" }, "sha256": { "type": "string", "description": "SHA256 of certificate.", "example": "5vt6rt6jtr654eef94ec3f91122a623b389f4d331ff330026e43af21013vb45f" }, "public_key": { "type": "string", "description": "The certificate decoded public key.", "example": "Sun RSA public key, 2048 bits params: null modulus: 7685655455... public exponent: 65537" }, "validated_date": { "type": "string", "description": "Date when certificate has been validated and approved.", "format": "date-time", "example": "2023-08-20T10:15:20.677566Z" }, "validated_by": { "type": "string", "description": "The unique identified for the user who has approved the certificate.", "example": "user_id" } } }, "ApproveCertificateRequest_approve_destination_certificate": { "required": [ "encoded_cert", "hash" ], "type": "object", "properties": { "hash": { "type": "string", "description": "Hash of the certificate.", "example": "jhg5UI7fgrI6yy..." }, "encoded_cert": { "type": "string", "description": "The certificate encoded in base64.", "example": "MIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQUFADCBijELMAkGA1UEBhMCV..." } } }, "ConnectCardConfig": { "required": [ "redirect_uri" ], "type": "object", "properties": { "redirect_uri": { "type": "string", "description": "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": "https://your.site/path" }, "hide_setup_guide": { "type": "boolean", "description": "An optional parameter that lets you hide the embedded setup guide in the Connect Card.", "example": true }, "all_fields": { "type": "boolean", "description": "An optional parameter that lets you show all fields on Connect Card including those that are hidden by default for certain connectors.", "example": true } } }, "DestinationConfiguration": { "type": "object", "properties": { "virtual_warehouse": { "type": "string", "description": "Snowflake's virtual warehouse used in the connection", "example": "virtual_warehouse" } } }, "JsonNode": { "type": "object" }, "NewConnectorRequestV1": { "required": [ "group_id", "service" ], "type": "object", "properties": { "group_id": { "type": "string", "description": "The unique identifier of the destination group to create the connection in. Retrieve group IDs from the [List All Groups](https://fivetran.com/docs/rest-api/api-reference/groups/list-all-groups) endpoint.", "example": "group_id" }, "service": { "type": "string", "description": "The connector name within the Fivetran system", "example": "google_ads" }, "trust_certificates": { "type": "boolean", "description": "Specifies whether we should trust the certificate automatically during setup tests. The default value is FALSE. This parameter only affects the behavior of setup tests and does not persist in the connection configuration. When using the PATCH endpoint to update a connection, this parameter must be combined with `run_setup_tests=true` and at least one persistent configuration parameter (e.g., `sync_frequency`, `paused`, `config`, `auth`). If you only want to run setup tests with automatic certificate trust, use the POST `/v1/connections/{connectionId}/test` endpoint instead. If a certificate is not trusted automatically during testing, it has to be approved with [Certificates Management API Approve a destination certificate](https://fivetran.com/docs/rest-api/certificates#approveadestinationcertificate).", "example": true }, "trust_fingerprints": { "type": "boolean", "description": "Specifies whether we should trust the SSH fingerprint automatically during setup tests. The default value is FALSE. This parameter only affects the behavior of setup tests and does not persist in the connection configuration. When using the PATCH endpoint to update a connection, this parameter must be combined with `run_setup_tests=true` and at least one persistent configuration parameter (e.g., `sync_frequency`, `paused`, `config`, `auth`). If you only want to run setup tests with automatic fingerprint trust, use the POST `/v1/connections/{connectionId}/test` endpoint instead. If a fingerprint is not trusted automatically during testing, it has to be approved with [Certificates Management API Approve a destination fingerprint](https://fivetran.com/docs/rest-api/certificates#approveadestinationfingerprint).", "example": true }, "run_setup_tests": { "type": "boolean", "description": "Specifies whether the setup tests should be run automatically after updating the connection. The default value is TRUE. When using this parameter in a PATCH request, you must also include at least one persistent configuration parameter (e.g., `sync_frequency`, `paused`, `config`, `auth`). This parameter can be combined with `trust_certificates` or `trust_fingerprints` to automatically approve `certificates/fingerprints` during the test run. To run setup tests without making configuration changes, use the POST `/v1/connections/{connectionId}/test` endpoint instead.", "example": true }, "paused": { "type": "boolean", "description": "Specifies whether the connection is paused", "example": false }, "pause_after_trial": { "type": "boolean", "description": "Specifies whether the connection should be paused after the free trial period has ended", "example": false }, "sync_frequency": { "type": "integer", "description": "The connection sync frequency in minutes. `null` when the connection's schedule has no single cadence to report, such as a custom cron or multiple-time-of-day schedule.", "format": "int32", "example": 1440, "enum": [ "1", "5", "15", "30", "60", "120", "180", "360", "480", "720", "1440" ] }, "data_delay_sensitivity": { "type": "string", "description": "The level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value is LOW. CUSTOM is only available for customers using the [Enterprise plan](https://fivetran.com/docs/getting-started/pricing#fivetranplans) or above.", "example": "LOW", "enum": [ "LOW", "NORMAL", "HIGH", "CUSTOM", "SYNC_FREQUENCY" ] }, "data_delay_threshold": { "type": "integer", "description": "Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when data_delay_sensitivity set to CUSTOM.", "format": "int32", "example": 0 }, "daily_sync_time": { "type": "string", "description": "The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use [the baseline sync start time](https://fivetran.com/docs/getting-started/syncoverview#syncfrequencyandscheduling). This parameter has no effect on the [0 to 60 minutes offset](https://fivetran.com/docs/getting-started/syncoverview#syncstarttimesandoffsets) used to determine the actual sync start time", "example": "14:00" }, "schedule_type": { "type": "string", "description": "Controls whether Fivetran automatically schedules syncs. `auto` - Fivetran schedules syncs based on the `schedule` object. `manual` - automatic scheduling is disabled; syncs run only when triggered via the [Sync Connection](https://fivetran.com/docs/rest-api/api-reference/connections/sync-connection) endpoint.", "example": "auto", "enum": [ "auto", "manual" ] }, "connect_card_config": { "$ref": "#/components/schemas/ConnectCardConfig" }, "proxy_agent_id": { "type": "string", "description": "The unique identifier for the proxy agent within the Fivetran system", "example": "proxy_agent_id" }, "private_link_id": { "type": "string", "description": "The unique identifier for the self-served private link that is used by the connection", "example": "private_link_id" }, "networking_method": { "type": "string", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "hybrid_deployment_agent_id": { "type": "string", "description": "The unique identifier for the hybrid deployment agent within the Fivetran system. If not specified, the agent ID from the destination will be used", "example": "hybrid_deployment_agent_id" }, "destination_configuration": { "$ref": "#/components/schemas/DestinationConfiguration" }, "destination_schema_names": { "type": "string", "description": "Defines how you want the schema names to appear in your destination.
The available values are:
- FIVETRAN_NAMING - Use Fivetran naming conventions to simplify and standardize the schema, table and column names in the destination.
- SOURCE_NAMING - Preserve source schema table and column names in the destination.
You can modify your selection only before the initial sync. Learn more in [our documentation](https://fivetran.com/docs/core-concepts#namingconventions)
\n> IMPORTANT: This field will soon become a required field. Make sure to include it in your API requests when creating new connections to prevent future disruptions.", "example": "FIVETRAN_NAMING", "enum": [ "FIVETRAN_NAMING", "SOURCE_NAMING" ] }, "external_secrets_manager_id": { "type": "string", "description": "The unique identifier of the [External Secrets Manager](/docs/rest-api/api-reference/external-secrets-managers) instance. Connector service must [support](/docs/core-concepts/features/external-secret-managers#connectors) External Secrets Manager feature to use this field.", "example": "esm_id" }, "data_checks": { "type": "boolean", "description": "Enables or disables automated data validation (compare) for this connection. When set to `true`, Fivetran compares source and destination data after each sync to detect discrepancies. When set to `false`, validation is skipped. Returned only for connector and destination types that support data validation; absent otherwise. Supported sources: MySQL, Oracle, PostgreSQL, SQL Server, SAP HANA, Snowflake DB. Supported destinations: Snowflake, BigQuery, Redshift, Databricks, PostgreSQL, Managed Data Lake.", "example": true } }, "discriminator": { "propertyName": "service", "mapping": { "15five": "#/components/schemas/15five_NewConnectorRequestV1", "360learning": "#/components/schemas/360learning_NewConnectorRequestV1", "7shifts": "#/components/schemas/7shifts_NewConnectorRequestV1", "absorb_lms": "#/components/schemas/absorb_lms_NewConnectorRequestV1", "acculynx": "#/components/schemas/acculynx_NewConnectorRequestV1", "activecampaign": "#/components/schemas/activecampaign_NewConnectorRequestV1", "acumatica": "#/components/schemas/acumatica_NewConnectorRequestV1", "ada": "#/components/schemas/ada_NewConnectorRequestV1", "adform": "#/components/schemas/adform_NewConnectorRequestV1", "adjust": "#/components/schemas/adjust_NewConnectorRequestV1", "adobe_analytics": "#/components/schemas/adobe_analytics_NewConnectorRequestV1", "adobe_analytics_data_feed": "#/components/schemas/adobe_analytics_data_feed_NewConnectorRequestV1", "adobe_commerce": "#/components/schemas/adobe_commerce_NewConnectorRequestV1", "adobe_workfront": "#/components/schemas/adobe_workfront_NewConnectorRequestV1", "adp_workforce_now": "#/components/schemas/adp_workforce_now_NewConnectorRequestV1", "adroll": "#/components/schemas/adroll_NewConnectorRequestV1", "adyen": "#/components/schemas/adyen_NewConnectorRequestV1", "affinity": "#/components/schemas/affinity_NewConnectorRequestV1", "afterpay": "#/components/schemas/afterpay_NewConnectorRequestV1", "aha": "#/components/schemas/aha_NewConnectorRequestV1", "ai_generated": "#/components/schemas/ai_generated_NewConnectorRequestV1", "aircall": "#/components/schemas/aircall_NewConnectorRequestV1", "airtable": "#/components/schemas/airtable_NewConnectorRequestV1", "akamai": "#/components/schemas/akamai_NewConnectorRequestV1", "akeneo": "#/components/schemas/akeneo_NewConnectorRequestV1", "alation": "#/components/schemas/alation_NewConnectorRequestV1", "alchemer": "#/components/schemas/alchemer_NewConnectorRequestV1", "algolia": "#/components/schemas/algolia_NewConnectorRequestV1", "alida": "#/components/schemas/alida_NewConnectorRequestV1", "amazon_ads": "#/components/schemas/amazon_ads_NewConnectorRequestV1", "amazon_attribution": "#/components/schemas/amazon_attribution_NewConnectorRequestV1", "amazon_dsp": "#/components/schemas/amazon_dsp_NewConnectorRequestV1", "amazon_selling_partner": "#/components/schemas/amazon_selling_partner_NewConnectorRequestV1", "amplitude": "#/components/schemas/amplitude_NewConnectorRequestV1", "amqp": "#/components/schemas/amqp_NewConnectorRequestV1", "anaplan": "#/components/schemas/anaplan_NewConnectorRequestV1", "anthropic_claude": "#/components/schemas/anthropic_claude_NewConnectorRequestV1", "anvyl": "#/components/schemas/anvyl_NewConnectorRequestV1", "apache_kafka": "#/components/schemas/apache_kafka_NewConnectorRequestV1", "apollo": "#/components/schemas/apollo_NewConnectorRequestV1", "appcues": "#/components/schemas/appcues_NewConnectorRequestV1", "appfigures": "#/components/schemas/appfigures_NewConnectorRequestV1", "apple_search_ads": "#/components/schemas/apple_search_ads_NewConnectorRequestV1", "applovin": "#/components/schemas/applovin_NewConnectorRequestV1", "appsflyer": "#/components/schemas/appsflyer_NewConnectorRequestV1", "asana": "#/components/schemas/asana_NewConnectorRequestV1", "ascend_by_partnerize": "#/components/schemas/ascend_by_partnerize_NewConnectorRequestV1", "ashby": "#/components/schemas/ashby_NewConnectorRequestV1", "assembled": "#/components/schemas/assembled_NewConnectorRequestV1", "asset_panda": "#/components/schemas/asset_panda_NewConnectorRequestV1", "atlassian_compass": "#/components/schemas/atlassian_compass_NewConnectorRequestV1", "atlassian_jira_align": "#/components/schemas/atlassian_jira_align_NewConnectorRequestV1", "atlassian_ops_genie": "#/components/schemas/atlassian_ops_genie_NewConnectorRequestV1", "attentive": "#/components/schemas/attentive_NewConnectorRequestV1", "attio": "#/components/schemas/attio_NewConnectorRequestV1", "aumni": "#/components/schemas/aumni_NewConnectorRequestV1", "aura_from_unity": "#/components/schemas/aura_from_unity_NewConnectorRequestV1", "aurora": "#/components/schemas/aurora_NewConnectorRequestV1", "aurora_postgres": "#/components/schemas/aurora_postgres_NewConnectorRequestV1", "auth0": "#/components/schemas/auth0_NewConnectorRequestV1", "autodesk_bim_360": "#/components/schemas/autodesk_bim_360_NewConnectorRequestV1", "avantlink": "#/components/schemas/avantlink_NewConnectorRequestV1", "aveva_pi": "#/components/schemas/aveva_pi_NewConnectorRequestV1", "awin": "#/components/schemas/awin_NewConnectorRequestV1", "aws_cloudtrail": "#/components/schemas/aws_cloudtrail_NewConnectorRequestV1", "aws_cost_report": "#/components/schemas/aws_cost_report_NewConnectorRequestV1", "aws_inventory": "#/components/schemas/aws_inventory_NewConnectorRequestV1", "aws_lambda": "#/components/schemas/aws_lambda_NewConnectorRequestV1", "aws_msk": "#/components/schemas/aws_msk_NewConnectorRequestV1", "azure_blob_storage": "#/components/schemas/azure_blob_storage_NewConnectorRequestV1", "azure_cosmos_for_mongo": "#/components/schemas/azure_cosmos_for_mongo_NewConnectorRequestV1", "azure_devops": "#/components/schemas/azure_devops_NewConnectorRequestV1", "azure_event_hub": "#/components/schemas/azure_event_hub_NewConnectorRequestV1", "azure_function": "#/components/schemas/azure_function_NewConnectorRequestV1", "azure_postgres": "#/components/schemas/azure_postgres_NewConnectorRequestV1", "azure_service_bus": "#/components/schemas/azure_service_bus_NewConnectorRequestV1", "azure_sql_db": "#/components/schemas/azure_sql_db_NewConnectorRequestV1", "azure_sql_managed_db": "#/components/schemas/azure_sql_managed_db_NewConnectorRequestV1", "backbone_plm": "#/components/schemas/backbone_plm_NewConnectorRequestV1", "ballotready": "#/components/schemas/ballotready_NewConnectorRequestV1", "bamboohr": "#/components/schemas/bamboohr_NewConnectorRequestV1", "bazaarvoice": "#/components/schemas/bazaarvoice_NewConnectorRequestV1", "betterworks": "#/components/schemas/betterworks_NewConnectorRequestV1", "big_commerce": "#/components/schemas/big_commerce_NewConnectorRequestV1", "bigin_by_zoho_crm": "#/components/schemas/bigin_by_zoho_crm_NewConnectorRequestV1", "bigmarker": "#/components/schemas/bigmarker_NewConnectorRequestV1", "bigquery_db": "#/components/schemas/bigquery_db_NewConnectorRequestV1", "billing_platform": "#/components/schemas/billing_platform_NewConnectorRequestV1", "bing_webmaster_tools": "#/components/schemas/bing_webmaster_tools_NewConnectorRequestV1", "bingads": "#/components/schemas/bingads_NewConnectorRequestV1", "birdeye": "#/components/schemas/birdeye_NewConnectorRequestV1", "bitly": "#/components/schemas/bitly_NewConnectorRequestV1", "bizzabo_app": "#/components/schemas/bizzabo_app_NewConnectorRequestV1", "boostr": "#/components/schemas/boostr_NewConnectorRequestV1", "box": "#/components/schemas/box_NewConnectorRequestV1", "braintree": "#/components/schemas/braintree_NewConnectorRequestV1", "braintree_sandbox": "#/components/schemas/braintree_sandbox_NewConnectorRequestV1", "branch": "#/components/schemas/branch_NewConnectorRequestV1", "brave_ads": "#/components/schemas/brave_ads_NewConnectorRequestV1", "braze": "#/components/schemas/braze_NewConnectorRequestV1", "breathe_hr": "#/components/schemas/breathe_hr_NewConnectorRequestV1", "brevo": "#/components/schemas/brevo_NewConnectorRequestV1", "brex": "#/components/schemas/brex_NewConnectorRequestV1", "brightcove": "#/components/schemas/brightcove_NewConnectorRequestV1", "brightflag": "#/components/schemas/brightflag_NewConnectorRequestV1", "brightpearl": "#/components/schemas/brightpearl_NewConnectorRequestV1", "brivo": "#/components/schemas/brivo_NewConnectorRequestV1", "buildium": "#/components/schemas/buildium_NewConnectorRequestV1", "buildkite": "#/components/schemas/buildkite_NewConnectorRequestV1", "business_central": "#/components/schemas/business_central_NewConnectorRequestV1", "buzzsprout": "#/components/schemas/buzzsprout_NewConnectorRequestV1", "bynder": "#/components/schemas/bynder_NewConnectorRequestV1", "cabcharge": "#/components/schemas/cabcharge_NewConnectorRequestV1", "calabrio": "#/components/schemas/calabrio_NewConnectorRequestV1", "calcom": "#/components/schemas/calcom_NewConnectorRequestV1", "calendly": "#/components/schemas/calendly_NewConnectorRequestV1", "callrail": "#/components/schemas/callrail_NewConnectorRequestV1", "campaignmonitor": "#/components/schemas/campaignmonitor_NewConnectorRequestV1", "campfire": "#/components/schemas/campfire_NewConnectorRequestV1", "canny": "#/components/schemas/canny_NewConnectorRequestV1", "canvas_by_instructure": "#/components/schemas/canvas_by_instructure_NewConnectorRequestV1", "canvas_data_2_by_instructure": "#/components/schemas/canvas_data_2_by_instructure_NewConnectorRequestV1", "captivateiq": "#/components/schemas/captivateiq_NewConnectorRequestV1", "care_quality_commission": "#/components/schemas/care_quality_commission_NewConnectorRequestV1", "castor_edc": "#/components/schemas/castor_edc_NewConnectorRequestV1", "centra": "#/components/schemas/centra_NewConnectorRequestV1", "ceridian_dayforce": "#/components/schemas/ceridian_dayforce_NewConnectorRequestV1", "chameleon": "#/components/schemas/chameleon_NewConnectorRequestV1", "chargebee_product_catalog_1": "#/components/schemas/chargebee_product_catalog_1_NewConnectorRequestV1", "chargebee_product_catalog_2": "#/components/schemas/chargebee_product_catalog_2_NewConnectorRequestV1", "chargedesk": "#/components/schemas/chargedesk_NewConnectorRequestV1", "charthop": "#/components/schemas/charthop_NewConnectorRequestV1", "chartmogul": "#/components/schemas/chartmogul_NewConnectorRequestV1", "checkout": "#/components/schemas/checkout_NewConnectorRequestV1", "checkr": "#/components/schemas/checkr_NewConnectorRequestV1", "chorusai": "#/components/schemas/chorusai_NewConnectorRequestV1", "churnkey": "#/components/schemas/churnkey_NewConnectorRequestV1", "churnzero": "#/components/schemas/churnzero_NewConnectorRequestV1", "cimis": "#/components/schemas/cimis_NewConnectorRequestV1", "cin7": "#/components/schemas/cin7_NewConnectorRequestV1", "cin7core": "#/components/schemas/cin7core_NewConnectorRequestV1", "circle_community_platform": "#/components/schemas/circle_community_platform_NewConnectorRequestV1", "circleci": "#/components/schemas/circleci_NewConnectorRequestV1", "cj_commission_detail": "#/components/schemas/cj_commission_detail_NewConnectorRequestV1", "clari": "#/components/schemas/clari_NewConnectorRequestV1", "claude_compliance": "#/components/schemas/claude_compliance_NewConnectorRequestV1", "clazar": "#/components/schemas/clazar_NewConnectorRequestV1", "clickup": "#/components/schemas/clickup_NewConnectorRequestV1", "clockify": "#/components/schemas/clockify_NewConnectorRequestV1", "clockodo": "#/components/schemas/clockodo_NewConnectorRequestV1", "close": "#/components/schemas/close_NewConnectorRequestV1", "cloudbeds": "#/components/schemas/cloudbeds_NewConnectorRequestV1", "cloudflare_analytics": "#/components/schemas/cloudflare_analytics_NewConnectorRequestV1", "cloudfront": "#/components/schemas/cloudfront_NewConnectorRequestV1", "cloudtalk": "#/components/schemas/cloudtalk_NewConnectorRequestV1", "clubspeed": "#/components/schemas/clubspeed_NewConnectorRequestV1", "coalesce": "#/components/schemas/coalesce_NewConnectorRequestV1", "coassemble": "#/components/schemas/coassemble_NewConnectorRequestV1", "cockroachdb": "#/components/schemas/cockroachdb_NewConnectorRequestV1", "coda": "#/components/schemas/coda_NewConnectorRequestV1", "codefresh": "#/components/schemas/codefresh_NewConnectorRequestV1", "collibra": "#/components/schemas/collibra_NewConnectorRequestV1", "column": "#/components/schemas/column_NewConnectorRequestV1", "commercetools": "#/components/schemas/commercetools_NewConnectorRequestV1", "compliance_checkpoint": "#/components/schemas/compliance_checkpoint_NewConnectorRequestV1", "concord": "#/components/schemas/concord_NewConnectorRequestV1", "concur": "#/components/schemas/concur_NewConnectorRequestV1", "confluence": "#/components/schemas/confluence_NewConnectorRequestV1", "confluent_cloud": "#/components/schemas/confluent_cloud_NewConnectorRequestV1", "connector_sdk": "#/components/schemas/connector_sdk_NewConnectorRequestV1", "consensus_demo_automation_platform": "#/components/schemas/consensus_demo_automation_platform_NewConnectorRequestV1", "constant_contact": "#/components/schemas/constant_contact_NewConnectorRequestV1", "contrast_security": "#/components/schemas/contrast_security_NewConnectorRequestV1", "convex": "#/components/schemas/convex_NewConnectorRequestV1", "copper": "#/components/schemas/copper_NewConnectorRequestV1", "cornerstone": "#/components/schemas/cornerstone_NewConnectorRequestV1", "cosmos": "#/components/schemas/cosmos_NewConnectorRequestV1", "coupa": "#/components/schemas/coupa_NewConnectorRequestV1", "credly": "#/components/schemas/credly_NewConnectorRequestV1", "criteo": "#/components/schemas/criteo_NewConnectorRequestV1", "criteo_retail_media": "#/components/schemas/criteo_retail_media_NewConnectorRequestV1", "crossbeam": "#/components/schemas/crossbeam_NewConnectorRequestV1", "crowddev": "#/components/schemas/crowddev_NewConnectorRequestV1", "crunchbase": "#/components/schemas/crunchbase_NewConnectorRequestV1", "cube_software": "#/components/schemas/cube_software_NewConnectorRequestV1", "culture_amp": "#/components/schemas/culture_amp_NewConnectorRequestV1", "cursor": "#/components/schemas/cursor_NewConnectorRequestV1", "customerio": "#/components/schemas/customerio_NewConnectorRequestV1", "cvent": "#/components/schemas/cvent_NewConnectorRequestV1", "d2l_brightspace": "#/components/schemas/d2l_brightspace_NewConnectorRequestV1", "databricks_db": "#/components/schemas/databricks_db_NewConnectorRequestV1", "datadog": "#/components/schemas/datadog_NewConnectorRequestV1", "datastreamer_source": "#/components/schemas/datastreamer_source_NewConnectorRequestV1", "db2i_hva": "#/components/schemas/db2i_hva_NewConnectorRequestV1", "db2i_sap_hva": "#/components/schemas/db2i_sap_hva_NewConnectorRequestV1", "db2luw": "#/components/schemas/db2luw_NewConnectorRequestV1", "db2z": "#/components/schemas/db2z_NewConnectorRequestV1", "dbt_cloud": "#/components/schemas/dbt_cloud_NewConnectorRequestV1", "dcl_logistics": "#/components/schemas/dcl_logistics_NewConnectorRequestV1", "deel": "#/components/schemas/deel_NewConnectorRequestV1", "deposco": "#/components/schemas/deposco_NewConnectorRequestV1", "deputy": "#/components/schemas/deputy_NewConnectorRequestV1", "destini": "#/components/schemas/destini_NewConnectorRequestV1", "device_magic": "#/components/schemas/device_magic_NewConnectorRequestV1", "dialpad": "#/components/schemas/dialpad_NewConnectorRequestV1", "discourse": "#/components/schemas/discourse_NewConnectorRequestV1", "dixa": "#/components/schemas/dixa_NewConnectorRequestV1", "docebo": "#/components/schemas/docebo_NewConnectorRequestV1", "documentdb": "#/components/schemas/documentdb_NewConnectorRequestV1", "donus": "#/components/schemas/donus_NewConnectorRequestV1", "doorloop": "#/components/schemas/doorloop_NewConnectorRequestV1", "double_click_campaign_manager": "#/components/schemas/double_click_campaign_manager_NewConnectorRequestV1", "double_click_publishers": "#/components/schemas/double_click_publishers_NewConnectorRequestV1", "drata": "#/components/schemas/drata_NewConnectorRequestV1", "drift": "#/components/schemas/drift_NewConnectorRequestV1", "drip": "#/components/schemas/drip_NewConnectorRequestV1", "dropbox": "#/components/schemas/dropbox_NewConnectorRequestV1", "dropbox_sign": "#/components/schemas/dropbox_sign_NewConnectorRequestV1", "dsv": "#/components/schemas/dsv_NewConnectorRequestV1", "duoplane": "#/components/schemas/duoplane_NewConnectorRequestV1", "dutchie": "#/components/schemas/dutchie_NewConnectorRequestV1", "dynamics_365": "#/components/schemas/dynamics_365_NewConnectorRequestV1", "dynamodb": "#/components/schemas/dynamodb_NewConnectorRequestV1", "easypost": "#/components/schemas/easypost_NewConnectorRequestV1", "ebay": "#/components/schemas/ebay_NewConnectorRequestV1", "economic": "#/components/schemas/economic_NewConnectorRequestV1", "elastic_cloud": "#/components/schemas/elastic_cloud_NewConnectorRequestV1", "elastic_cloud_serverless": "#/components/schemas/elastic_cloud_serverless_NewConnectorRequestV1", "electronic_tenant_solutions": "#/components/schemas/electronic_tenant_solutions_NewConnectorRequestV1", "eloqua": "#/components/schemas/eloqua_NewConnectorRequestV1", "email": "#/components/schemas/email_NewConnectorRequestV1", "employment_hero": "#/components/schemas/employment_hero_NewConnectorRequestV1", "epic_clarity": "#/components/schemas/epic_clarity_NewConnectorRequestV1", "es_self_hosted": "#/components/schemas/es_self_hosted_NewConnectorRequestV1", "eventbrite": "#/components/schemas/eventbrite_NewConnectorRequestV1", "eventsforce": "#/components/schemas/eventsforce_NewConnectorRequestV1", "everflow": "#/components/schemas/everflow_NewConnectorRequestV1", "everhour": "#/components/schemas/everhour_NewConnectorRequestV1", "exact_online": "#/components/schemas/exact_online_NewConnectorRequestV1", "expensein": "#/components/schemas/expensein_NewConnectorRequestV1", "expensify": "#/components/schemas/expensify_NewConnectorRequestV1", "ezofficeinventory": "#/components/schemas/ezofficeinventory_NewConnectorRequestV1", "facebook_ads": "#/components/schemas/facebook_ads_NewConnectorRequestV1", "facebook_pages": "#/components/schemas/facebook_pages_NewConnectorRequestV1", "factbird": "#/components/schemas/factbird_NewConnectorRequestV1", "factorial": "#/components/schemas/factorial_NewConnectorRequestV1", "fathom": "#/components/schemas/fathom_NewConnectorRequestV1", "fillout": "#/components/schemas/fillout_NewConnectorRequestV1", "firebase": "#/components/schemas/firebase_NewConnectorRequestV1", "fireflies": "#/components/schemas/fireflies_NewConnectorRequestV1", "firehydrant": "#/components/schemas/firehydrant_NewConnectorRequestV1", "fivetran_log": "#/components/schemas/fivetran_log_NewConnectorRequestV1", "flexport": "#/components/schemas/flexport_NewConnectorRequestV1", "float": "#/components/schemas/float_NewConnectorRequestV1", "flywheel_digital": "#/components/schemas/flywheel_digital_NewConnectorRequestV1", "fone_dynamics": "#/components/schemas/fone_dynamics_NewConnectorRequestV1", "forethought": "#/components/schemas/forethought_NewConnectorRequestV1", "forj_community": "#/components/schemas/forj_community_NewConnectorRequestV1", "formstack": "#/components/schemas/formstack_NewConnectorRequestV1", "fortnox": "#/components/schemas/fortnox_NewConnectorRequestV1", "fountain": "#/components/schemas/fountain_NewConnectorRequestV1", "fourkites": "#/components/schemas/fourkites_NewConnectorRequestV1", "freightview": "#/components/schemas/freightview_NewConnectorRequestV1", "freshbooks": "#/components/schemas/freshbooks_NewConnectorRequestV1", "freshchat": "#/components/schemas/freshchat_NewConnectorRequestV1", "freshdesk": "#/components/schemas/freshdesk_NewConnectorRequestV1", "freshdesk_contact_center": "#/components/schemas/freshdesk_contact_center_NewConnectorRequestV1", "freshsales": "#/components/schemas/freshsales_NewConnectorRequestV1", "freshservice": "#/components/schemas/freshservice_NewConnectorRequestV1", "freshsuccess": "#/components/schemas/freshsuccess_NewConnectorRequestV1", "freshteam": "#/components/schemas/freshteam_NewConnectorRequestV1", "friendbuy": "#/components/schemas/friendbuy_NewConnectorRequestV1", "front": "#/components/schemas/front_NewConnectorRequestV1", "ftp": "#/components/schemas/ftp_NewConnectorRequestV1", "fulfil": "#/components/schemas/fulfil_NewConnectorRequestV1", "fullstory": "#/components/schemas/fullstory_NewConnectorRequestV1", "g2": "#/components/schemas/g2_NewConnectorRequestV1", "gainsight_customer_success": "#/components/schemas/gainsight_customer_success_NewConnectorRequestV1", "gainsight_product_experience": "#/components/schemas/gainsight_product_experience_NewConnectorRequestV1", "gcs": "#/components/schemas/gcs_NewConnectorRequestV1", "gem": "#/components/schemas/gem_NewConnectorRequestV1", "genesys": "#/components/schemas/genesys_NewConnectorRequestV1", "getfeedback": "#/components/schemas/getfeedback_NewConnectorRequestV1", "github": "#/components/schemas/github_NewConnectorRequestV1", "gitlab": "#/components/schemas/gitlab_NewConnectorRequestV1", "gladly": "#/components/schemas/gladly_NewConnectorRequestV1", "globalmeet": "#/components/schemas/globalmeet_NewConnectorRequestV1", "gmail": "#/components/schemas/gmail_NewConnectorRequestV1", "gocardless": "#/components/schemas/gocardless_NewConnectorRequestV1", "gofundme_pro": "#/components/schemas/gofundme_pro_NewConnectorRequestV1", "goldcast": "#/components/schemas/goldcast_NewConnectorRequestV1", "gongio": "#/components/schemas/gongio_NewConnectorRequestV1", "google_ads": "#/components/schemas/google_ads_NewConnectorRequestV1", "google_analytics_4": "#/components/schemas/google_analytics_4_NewConnectorRequestV1", "google_analytics_4_export": "#/components/schemas/google_analytics_4_export_NewConnectorRequestV1", "google_business_profile": "#/components/schemas/google_business_profile_NewConnectorRequestV1", "google_calendar": "#/components/schemas/google_calendar_NewConnectorRequestV1", "google_classroom": "#/components/schemas/google_classroom_NewConnectorRequestV1", "google_cloud_function": "#/components/schemas/google_cloud_function_NewConnectorRequestV1", "google_cloud_mysql": "#/components/schemas/google_cloud_mysql_NewConnectorRequestV1", "google_cloud_postgresql": "#/components/schemas/google_cloud_postgresql_NewConnectorRequestV1", "google_cloud_sqlserver": "#/components/schemas/google_cloud_sqlserver_NewConnectorRequestV1", "google_display_and_video_360": "#/components/schemas/google_display_and_video_360_NewConnectorRequestV1", "google_drive": "#/components/schemas/google_drive_NewConnectorRequestV1", "google_play": "#/components/schemas/google_play_NewConnectorRequestV1", "google_search_ads_360": "#/components/schemas/google_search_ads_360_NewConnectorRequestV1", "google_search_console": "#/components/schemas/google_search_console_NewConnectorRequestV1", "google_sheets": "#/components/schemas/google_sheets_NewConnectorRequestV1", "google_tag_manager": "#/components/schemas/google_tag_manager_NewConnectorRequestV1", "google_tasks": "#/components/schemas/google_tasks_NewConnectorRequestV1", "gorgias": "#/components/schemas/gorgias_NewConnectorRequestV1", "green_power_monitor": "#/components/schemas/green_power_monitor_NewConnectorRequestV1", "greenhouse": "#/components/schemas/greenhouse_NewConnectorRequestV1", "grepsr": "#/components/schemas/grepsr_NewConnectorRequestV1", "grin": "#/components/schemas/grin_NewConnectorRequestV1", "guidewire_cloud_data_access": "#/components/schemas/guidewire_cloud_data_access_NewConnectorRequestV1", "guru": "#/components/schemas/guru_NewConnectorRequestV1", "h_level": "#/components/schemas/h_level_NewConnectorRequestV1", "happyfox": "#/components/schemas/happyfox_NewConnectorRequestV1", "harvest": "#/components/schemas/harvest_NewConnectorRequestV1", "healthie": "#/components/schemas/healthie_NewConnectorRequestV1", "heap": "#/components/schemas/heap_NewConnectorRequestV1", "heartland_retail_pos": "#/components/schemas/heartland_retail_pos_NewConnectorRequestV1", "helpdesk": "#/components/schemas/helpdesk_NewConnectorRequestV1", "helpjuice": "#/components/schemas/helpjuice_NewConnectorRequestV1", "helpscout": "#/components/schemas/helpscout_NewConnectorRequestV1", "helpshift": "#/components/schemas/helpshift_NewConnectorRequestV1", "heroku_kafka": "#/components/schemas/heroku_kafka_NewConnectorRequestV1", "heroku_postgres": "#/components/schemas/heroku_postgres_NewConnectorRequestV1", "hex": "#/components/schemas/hex_NewConnectorRequestV1", "hibob": "#/components/schemas/hibob_NewConnectorRequestV1", "higher_logic_vanilla": "#/components/schemas/higher_logic_vanilla_NewConnectorRequestV1", "hilti_ontrack": "#/components/schemas/hilti_ontrack_NewConnectorRequestV1", "hopin": "#/components/schemas/hopin_NewConnectorRequestV1", "hubspot": "#/components/schemas/hubspot_NewConnectorRequestV1", "ibacos": "#/components/schemas/ibacos_NewConnectorRequestV1", "ilevel": "#/components/schemas/ilevel_NewConnectorRequestV1", "impact": "#/components/schemas/impact_NewConnectorRequestV1", "impact_partner": "#/components/schemas/impact_partner_NewConnectorRequestV1", "incidentio": "#/components/schemas/incidentio_NewConnectorRequestV1", "infobip": "#/components/schemas/infobip_NewConnectorRequestV1", "insightly": "#/components/schemas/insightly_NewConnectorRequestV1", "instagram_business": "#/components/schemas/instagram_business_NewConnectorRequestV1", "integral_ad_science": "#/components/schemas/integral_ad_science_NewConnectorRequestV1", "integrate": "#/components/schemas/integrate_NewConnectorRequestV1", "intercom": "#/components/schemas/intercom_NewConnectorRequestV1", "invoiced": "#/components/schemas/invoiced_NewConnectorRequestV1", "ironclad": "#/components/schemas/ironclad_NewConnectorRequestV1", "ironclad_clickwrap": "#/components/schemas/ironclad_clickwrap_NewConnectorRequestV1", "ironsource": "#/components/schemas/ironsource_NewConnectorRequestV1", "iterable": "#/components/schemas/iterable_NewConnectorRequestV1", "itunes_connect": "#/components/schemas/itunes_connect_NewConnectorRequestV1", "ivanti": "#/components/schemas/ivanti_NewConnectorRequestV1", "jama_software": "#/components/schemas/jama_software_NewConnectorRequestV1", "jamf": "#/components/schemas/jamf_NewConnectorRequestV1", "jibble": "#/components/schemas/jibble_NewConnectorRequestV1", "jira": "#/components/schemas/jira_NewConnectorRequestV1", "jobnimbus": "#/components/schemas/jobnimbus_NewConnectorRequestV1", "jotform": "#/components/schemas/jotform_NewConnectorRequestV1", "justcall": "#/components/schemas/justcall_NewConnectorRequestV1", "kandji": "#/components/schemas/kandji_NewConnectorRequestV1", "katana": "#/components/schemas/katana_NewConnectorRequestV1", "kevel": "#/components/schemas/kevel_NewConnectorRequestV1", "keypay": "#/components/schemas/keypay_NewConnectorRequestV1", "khoros_care": "#/components/schemas/khoros_care_NewConnectorRequestV1", "khoros_communities": "#/components/schemas/khoros_communities_NewConnectorRequestV1", "khoros_marketing": "#/components/schemas/khoros_marketing_NewConnectorRequestV1", "kinesis": "#/components/schemas/kinesis_NewConnectorRequestV1", "kisi": "#/components/schemas/kisi_NewConnectorRequestV1", "kissmetrics": "#/components/schemas/kissmetrics_NewConnectorRequestV1", "klarna": "#/components/schemas/klarna_NewConnectorRequestV1", "klaviyo": "#/components/schemas/klaviyo_NewConnectorRequestV1", "konnect_insights": "#/components/schemas/konnect_insights_NewConnectorRequestV1", "kustomer": "#/components/schemas/kustomer_NewConnectorRequestV1", "kyriba": "#/components/schemas/kyriba_NewConnectorRequestV1", "lattice": "#/components/schemas/lattice_NewConnectorRequestV1", "launchdarkly": "#/components/schemas/launchdarkly_NewConnectorRequestV1", "leap_crm": "#/components/schemas/leap_crm_NewConnectorRequestV1", "leapsome": "#/components/schemas/leapsome_NewConnectorRequestV1", "learn_amp": "#/components/schemas/learn_amp_NewConnectorRequestV1", "learnupon": "#/components/schemas/learnupon_NewConnectorRequestV1", "leave_dates": "#/components/schemas/leave_dates_NewConnectorRequestV1", "lemlist": "#/components/schemas/lemlist_NewConnectorRequestV1", "lessonly": "#/components/schemas/lessonly_NewConnectorRequestV1", "lever": "#/components/schemas/lever_NewConnectorRequestV1", "liftoff": "#/components/schemas/liftoff_NewConnectorRequestV1", "light_speed_retail": "#/components/schemas/light_speed_retail_NewConnectorRequestV1", "lightspeed_retail_xseries": "#/components/schemas/lightspeed_retail_xseries_NewConnectorRequestV1", "line_ads": "#/components/schemas/line_ads_NewConnectorRequestV1", "linear": "#/components/schemas/linear_NewConnectorRequestV1", "linkedin_ads": "#/components/schemas/linkedin_ads_NewConnectorRequestV1", "linkedin_company_pages": "#/components/schemas/linkedin_company_pages_NewConnectorRequestV1", "linksquares": "#/components/schemas/linksquares_NewConnectorRequestV1", "listen360": "#/components/schemas/listen360_NewConnectorRequestV1", "livechat_partner": "#/components/schemas/livechat_partner_NewConnectorRequestV1", "livestorm": "#/components/schemas/livestorm_NewConnectorRequestV1", "lob": "#/components/schemas/lob_NewConnectorRequestV1", "local_file_system": "#/components/schemas/local_file_system_NewConnectorRequestV1", "looker_source": "#/components/schemas/looker_source_NewConnectorRequestV1", "loop": "#/components/schemas/loop_NewConnectorRequestV1", "loopio": "#/components/schemas/loopio_NewConnectorRequestV1", "lucca": "#/components/schemas/lucca_NewConnectorRequestV1", "luma": "#/components/schemas/luma_NewConnectorRequestV1", "magento_mysql": "#/components/schemas/magento_mysql_NewConnectorRequestV1", "magento_mysql_rds": "#/components/schemas/magento_mysql_rds_NewConnectorRequestV1", "mailchimp": "#/components/schemas/mailchimp_NewConnectorRequestV1", "maileon": "#/components/schemas/maileon_NewConnectorRequestV1", "mailgun": "#/components/schemas/mailgun_NewConnectorRequestV1", "mailjet": "#/components/schemas/mailjet_NewConnectorRequestV1", "maintainx": "#/components/schemas/maintainx_NewConnectorRequestV1", "malomo": "#/components/schemas/malomo_NewConnectorRequestV1", "mambu": "#/components/schemas/mambu_NewConnectorRequestV1", "mandrill": "#/components/schemas/mandrill_NewConnectorRequestV1", "maria": "#/components/schemas/maria_NewConnectorRequestV1", "maria_azure": "#/components/schemas/maria_azure_NewConnectorRequestV1", "maria_rds": "#/components/schemas/maria_rds_NewConnectorRequestV1", "marin": "#/components/schemas/marin_NewConnectorRequestV1", "marketo": "#/components/schemas/marketo_NewConnectorRequestV1", "matomo": "#/components/schemas/matomo_NewConnectorRequestV1", "mavenlink": "#/components/schemas/mavenlink_NewConnectorRequestV1", "maxio_chargify": "#/components/schemas/maxio_chargify_NewConnectorRequestV1", "maxio_saasoptics": "#/components/schemas/maxio_saasoptics_NewConnectorRequestV1", "medallia": "#/components/schemas/medallia_NewConnectorRequestV1", "medallia_agile_research": "#/components/schemas/medallia_agile_research_NewConnectorRequestV1", "megaphone": "#/components/schemas/megaphone_NewConnectorRequestV1", "mention": "#/components/schemas/mention_NewConnectorRequestV1", "microsoft_dynamics_365_fno": "#/components/schemas/microsoft_dynamics_365_fno_NewConnectorRequestV1", "microsoft_entra_id": "#/components/schemas/microsoft_entra_id_NewConnectorRequestV1", "microsoft_lists": "#/components/schemas/microsoft_lists_NewConnectorRequestV1", "microsoft_power_bi": "#/components/schemas/microsoft_power_bi_NewConnectorRequestV1", "microsoft_teams": "#/components/schemas/microsoft_teams_NewConnectorRequestV1", "missive": "#/components/schemas/missive_NewConnectorRequestV1", "mixmax": "#/components/schemas/mixmax_NewConnectorRequestV1", "mixpanel": "#/components/schemas/mixpanel_NewConnectorRequestV1", "mode": "#/components/schemas/mode_NewConnectorRequestV1", "mollie": "#/components/schemas/mollie_NewConnectorRequestV1", "moloco": "#/components/schemas/moloco_NewConnectorRequestV1", "monday": "#/components/schemas/monday_NewConnectorRequestV1", "mongo": "#/components/schemas/mongo_NewConnectorRequestV1", "mongo_sharded": "#/components/schemas/mongo_sharded_NewConnectorRequestV1", "mountain": "#/components/schemas/mountain_NewConnectorRequestV1", "mux": "#/components/schemas/mux_NewConnectorRequestV1", "myosh": "#/components/schemas/myosh_NewConnectorRequestV1", "mysql": "#/components/schemas/mysql_NewConnectorRequestV1", "mysql_azure": "#/components/schemas/mysql_azure_NewConnectorRequestV1", "mysql_rds": "#/components/schemas/mysql_rds_NewConnectorRequestV1", "namely": "#/components/schemas/namely_NewConnectorRequestV1", "national_heavy_vehicle_regulator": "#/components/schemas/national_heavy_vehicle_regulator_NewConnectorRequestV1", "navan": "#/components/schemas/navan_NewConnectorRequestV1", "netsuite_suiteanalytics": "#/components/schemas/netsuite_suiteanalytics_NewConnectorRequestV1", "nice": "#/components/schemas/nice_NewConnectorRequestV1", "notion": "#/components/schemas/notion_NewConnectorRequestV1", "nylas": "#/components/schemas/nylas_NewConnectorRequestV1", "odoo": "#/components/schemas/odoo_NewConnectorRequestV1", "odoo_synconics": "#/components/schemas/odoo_synconics_NewConnectorRequestV1", "okendo": "#/components/schemas/okendo_NewConnectorRequestV1", "okta": "#/components/schemas/okta_NewConnectorRequestV1", "ometria": "#/components/schemas/ometria_NewConnectorRequestV1", "on24": "#/components/schemas/on24_NewConnectorRequestV1", "oncehub": "#/components/schemas/oncehub_NewConnectorRequestV1", "one_drive": "#/components/schemas/one_drive_NewConnectorRequestV1", "onetrust": "#/components/schemas/onetrust_NewConnectorRequestV1", "open_data_dc": "#/components/schemas/open_data_dc_NewConnectorRequestV1", "open_exchange_rates": "#/components/schemas/open_exchange_rates_NewConnectorRequestV1", "openai": "#/components/schemas/openai_NewConnectorRequestV1", "openai_compliance_platform": "#/components/schemas/openai_compliance_platform_NewConnectorRequestV1", "opendistro": "#/components/schemas/opendistro_NewConnectorRequestV1", "opensearch": "#/components/schemas/opensearch_NewConnectorRequestV1", "optimizely": "#/components/schemas/optimizely_NewConnectorRequestV1", "oracle": "#/components/schemas/oracle_NewConnectorRequestV1", "oracle_business_intelligence_publisher": "#/components/schemas/oracle_business_intelligence_publisher_NewConnectorRequestV1", "oracle_ebs": "#/components/schemas/oracle_ebs_NewConnectorRequestV1", "oracle_fusion_cloud_apps_crm": "#/components/schemas/oracle_fusion_cloud_apps_crm_NewConnectorRequestV1", "oracle_fusion_cloud_apps_fscm": "#/components/schemas/oracle_fusion_cloud_apps_fscm_NewConnectorRequestV1", "oracle_fusion_cloud_apps_hcm": "#/components/schemas/oracle_fusion_cloud_apps_hcm_NewConnectorRequestV1", "oracle_fusion_field_service": "#/components/schemas/oracle_fusion_field_service_NewConnectorRequestV1", "oracle_hva": "#/components/schemas/oracle_hva_NewConnectorRequestV1", "oracle_moat_analytics": "#/components/schemas/oracle_moat_analytics_NewConnectorRequestV1", "oracle_netsuite_openair": "#/components/schemas/oracle_netsuite_openair_NewConnectorRequestV1", "oracle_rac": "#/components/schemas/oracle_rac_NewConnectorRequestV1", "oracle_rds": "#/components/schemas/oracle_rds_NewConnectorRequestV1", "oracle_sap_hva": "#/components/schemas/oracle_sap_hva_NewConnectorRequestV1", "oracle_sap_hva_netweaver": "#/components/schemas/oracle_sap_hva_netweaver_NewConnectorRequestV1", "orbit": "#/components/schemas/orbit_NewConnectorRequestV1", "ordergroove": "#/components/schemas/ordergroove_NewConnectorRequestV1", "ordway": "#/components/schemas/ordway_NewConnectorRequestV1", "ortto": "#/components/schemas/ortto_NewConnectorRequestV1", "outbrain": "#/components/schemas/outbrain_NewConnectorRequestV1", "outreach": "#/components/schemas/outreach_NewConnectorRequestV1", "packiyo": "#/components/schemas/packiyo_NewConnectorRequestV1", "paddle": "#/components/schemas/paddle_NewConnectorRequestV1", "pagerduty": "#/components/schemas/pagerduty_NewConnectorRequestV1", "pandadoc": "#/components/schemas/pandadoc_NewConnectorRequestV1", "papershift": "#/components/schemas/papershift_NewConnectorRequestV1", "parcellab": "#/components/schemas/parcellab_NewConnectorRequestV1", "pardot": "#/components/schemas/pardot_NewConnectorRequestV1", "pardot_sandbox": "#/components/schemas/pardot_sandbox_NewConnectorRequestV1", "partnerize": "#/components/schemas/partnerize_NewConnectorRequestV1", "partnerstack_vendor": "#/components/schemas/partnerstack_vendor_NewConnectorRequestV1", "paychex": "#/components/schemas/paychex_NewConnectorRequestV1", "paylocity": "#/components/schemas/paylocity_NewConnectorRequestV1", "paypal": "#/components/schemas/paypal_NewConnectorRequestV1", "paypal_sandbox": "#/components/schemas/paypal_sandbox_NewConnectorRequestV1", "pendo": "#/components/schemas/pendo_NewConnectorRequestV1", "pennylane": "#/components/schemas/pennylane_NewConnectorRequestV1", "peopleforce": "#/components/schemas/peopleforce_NewConnectorRequestV1", "persona": "#/components/schemas/persona_NewConnectorRequestV1", "personio": "#/components/schemas/personio_NewConnectorRequestV1", "phoenix_ads": "#/components/schemas/phoenix_ads_NewConnectorRequestV1", "picqer": "#/components/schemas/picqer_NewConnectorRequestV1", "pigment": "#/components/schemas/pigment_NewConnectorRequestV1", "pingdom": "#/components/schemas/pingdom_NewConnectorRequestV1", "pinpoint": "#/components/schemas/pinpoint_NewConnectorRequestV1", "pinterest_ads": "#/components/schemas/pinterest_ads_NewConnectorRequestV1", "pinterest_organic": "#/components/schemas/pinterest_organic_NewConnectorRequestV1", "pipe17": "#/components/schemas/pipe17_NewConnectorRequestV1", "pipedrive": "#/components/schemas/pipedrive_NewConnectorRequestV1", "pivotal_tracker": "#/components/schemas/pivotal_tracker_NewConnectorRequestV1", "piwik_pro": "#/components/schemas/piwik_pro_NewConnectorRequestV1", "placerai": "#/components/schemas/placerai_NewConnectorRequestV1", "planetscale": "#/components/schemas/planetscale_NewConnectorRequestV1", "planful": "#/components/schemas/planful_NewConnectorRequestV1", "planhat": "#/components/schemas/planhat_NewConnectorRequestV1", "playvox": "#/components/schemas/playvox_NewConnectorRequestV1", "playvox_workforce_management": "#/components/schemas/playvox_workforce_management_NewConnectorRequestV1", "podio": "#/components/schemas/podio_NewConnectorRequestV1", "poplar": "#/components/schemas/poplar_NewConnectorRequestV1", "postgres": "#/components/schemas/postgres_NewConnectorRequestV1", "postgres_rds": "#/components/schemas/postgres_rds_NewConnectorRequestV1", "posthog": "#/components/schemas/posthog_NewConnectorRequestV1", "postmark": "#/components/schemas/postmark_NewConnectorRequestV1", "power_reviews_enterprise": "#/components/schemas/power_reviews_enterprise_NewConnectorRequestV1", "prisma_cloud": "#/components/schemas/prisma_cloud_NewConnectorRequestV1", "prive": "#/components/schemas/prive_NewConnectorRequestV1", "procore": "#/components/schemas/procore_NewConnectorRequestV1", "productboard": "#/components/schemas/productboard_NewConnectorRequestV1", "productive": "#/components/schemas/productive_NewConnectorRequestV1", "profound": "#/components/schemas/profound_NewConnectorRequestV1", "proofpoint_security_awareness": "#/components/schemas/proofpoint_security_awareness_NewConnectorRequestV1", "prosperstack": "#/components/schemas/prosperstack_NewConnectorRequestV1", "purple_dot": "#/components/schemas/purple_dot_NewConnectorRequestV1", "pylon_support_platform": "#/components/schemas/pylon_support_platform_NewConnectorRequestV1", "qmatic_data_connect": "#/components/schemas/qmatic_data_connect_NewConnectorRequestV1", "qualaroo": "#/components/schemas/qualaroo_NewConnectorRequestV1", "qualtrics": "#/components/schemas/qualtrics_NewConnectorRequestV1", "quickbooks": "#/components/schemas/quickbooks_NewConnectorRequestV1", "quora_ads": "#/components/schemas/quora_ads_NewConnectorRequestV1", "quorum": "#/components/schemas/quorum_NewConnectorRequestV1", "rakutenadvertising": "#/components/schemas/rakutenadvertising_NewConnectorRequestV1", "ramp": "#/components/schemas/ramp_NewConnectorRequestV1", "rarible": "#/components/schemas/rarible_NewConnectorRequestV1", "rebound_returns": "#/components/schemas/rebound_returns_NewConnectorRequestV1", "recharge": "#/components/schemas/recharge_NewConnectorRequestV1", "recurly": "#/components/schemas/recurly_NewConnectorRequestV1", "reddit_ads": "#/components/schemas/reddit_ads_NewConnectorRequestV1", "referralhero": "#/components/schemas/referralhero_NewConnectorRequestV1", "refiner": "#/components/schemas/refiner_NewConnectorRequestV1", "reltio": "#/components/schemas/reltio_NewConnectorRequestV1", "replyio": "#/components/schemas/replyio_NewConnectorRequestV1", "resource_management_by_smartsheet": "#/components/schemas/resource_management_by_smartsheet_NewConnectorRequestV1", "retailnext": "#/components/schemas/retailnext_NewConnectorRequestV1", "retently": "#/components/schemas/retently_NewConnectorRequestV1", "revel": "#/components/schemas/revel_NewConnectorRequestV1", "revenuecat": "#/components/schemas/revenuecat_NewConnectorRequestV1", "reviewsai": "#/components/schemas/reviewsai_NewConnectorRequestV1", "reviewsio": "#/components/schemas/reviewsio_NewConnectorRequestV1", "revops": "#/components/schemas/revops_NewConnectorRequestV1", "revx": "#/components/schemas/revx_NewConnectorRequestV1", "ricochet360": "#/components/schemas/ricochet360_NewConnectorRequestV1", "ringcentral": "#/components/schemas/ringcentral_NewConnectorRequestV1", "ringover": "#/components/schemas/ringover_NewConnectorRequestV1", "rippling": "#/components/schemas/rippling_NewConnectorRequestV1", "rithum": "#/components/schemas/rithum_NewConnectorRequestV1", "rivo": "#/components/schemas/rivo_NewConnectorRequestV1", "rocketlane": "#/components/schemas/rocketlane_NewConnectorRequestV1", "rokt": "#/components/schemas/rokt_NewConnectorRequestV1", "rollbar": "#/components/schemas/rollbar_NewConnectorRequestV1", "rootly": "#/components/schemas/rootly_NewConnectorRequestV1", "rtb_house": "#/components/schemas/rtb_house_NewConnectorRequestV1", "ruddr": "#/components/schemas/ruddr_NewConnectorRequestV1", "rundeck": "#/components/schemas/rundeck_NewConnectorRequestV1", "s3": "#/components/schemas/s3_NewConnectorRequestV1", "s3_compatible_storage": "#/components/schemas/s3_compatible_storage_NewConnectorRequestV1", "safebase": "#/components/schemas/safebase_NewConnectorRequestV1", "safetyculture": "#/components/schemas/safetyculture_NewConnectorRequestV1", "sage_hr": "#/components/schemas/sage_hr_NewConnectorRequestV1", "sage_intacct": "#/components/schemas/sage_intacct_NewConnectorRequestV1", "sailthru": "#/components/schemas/sailthru_NewConnectorRequestV1", "salesforce": "#/components/schemas/salesforce_NewConnectorRequestV1", "salesforce_commerce_cloud": "#/components/schemas/salesforce_commerce_cloud_NewConnectorRequestV1", "salesforce_marketing_cloud": "#/components/schemas/salesforce_marketing_cloud_NewConnectorRequestV1", "salesforce_sandbox": "#/components/schemas/salesforce_sandbox_NewConnectorRequestV1", "salesloft": "#/components/schemas/salesloft_NewConnectorRequestV1", "salsify": "#/components/schemas/salsify_NewConnectorRequestV1", "samsara": "#/components/schemas/samsara_NewConnectorRequestV1", "sana": "#/components/schemas/sana_NewConnectorRequestV1", "sap_business_by_design": "#/components/schemas/sap_business_by_design_NewConnectorRequestV1", "sap_hana_db": "#/components/schemas/sap_hana_db_NewConnectorRequestV1", "sap_odata": "#/components/schemas/sap_odata_NewConnectorRequestV1", "sap_oracle": "#/components/schemas/sap_oracle_NewConnectorRequestV1", "sap_success_factors": "#/components/schemas/sap_success_factors_NewConnectorRequestV1", "scorm": "#/components/schemas/scorm_NewConnectorRequestV1", "security_journey": "#/components/schemas/security_journey_NewConnectorRequestV1", "segment": "#/components/schemas/segment_NewConnectorRequestV1", "sendgrid": "#/components/schemas/sendgrid_NewConnectorRequestV1", "sentry": "#/components/schemas/sentry_NewConnectorRequestV1", "servicenow": "#/components/schemas/servicenow_NewConnectorRequestV1", "servicetitan": "#/components/schemas/servicetitan_NewConnectorRequestV1", "servicetrade": "#/components/schemas/servicetrade_NewConnectorRequestV1", "sevdesk": "#/components/schemas/sevdesk_NewConnectorRequestV1", "sftp": "#/components/schemas/sftp_NewConnectorRequestV1", "share_point": "#/components/schemas/share_point_NewConnectorRequestV1", "shareasale": "#/components/schemas/shareasale_NewConnectorRequestV1", "sharetribe": "#/components/schemas/sharetribe_NewConnectorRequestV1", "shiphero": "#/components/schemas/shiphero_NewConnectorRequestV1", "shipmonk": "#/components/schemas/shipmonk_NewConnectorRequestV1", "shipnetwork": "#/components/schemas/shipnetwork_NewConnectorRequestV1", "shipstation": "#/components/schemas/shipstation_NewConnectorRequestV1", "shopify": "#/components/schemas/shopify_NewConnectorRequestV1", "shopware": "#/components/schemas/shopware_NewConnectorRequestV1", "shortcut": "#/components/schemas/shortcut_NewConnectorRequestV1", "shortio": "#/components/schemas/shortio_NewConnectorRequestV1", "showpad": "#/components/schemas/showpad_NewConnectorRequestV1", "siemens_building_x_openness": "#/components/schemas/siemens_building_x_openness_NewConnectorRequestV1", "sigma_computing_source": "#/components/schemas/sigma_computing_source_NewConnectorRequestV1", "simplecast": "#/components/schemas/simplecast_NewConnectorRequestV1", "simplesat": "#/components/schemas/simplesat_NewConnectorRequestV1", "singlestore_source": "#/components/schemas/singlestore_source_NewConnectorRequestV1", "sistrix": "#/components/schemas/sistrix_NewConnectorRequestV1", "skilljar": "#/components/schemas/skilljar_NewConnectorRequestV1", "skillstx": "#/components/schemas/skillstx_NewConnectorRequestV1", "skimlinks": "#/components/schemas/skimlinks_NewConnectorRequestV1", "skuvault": "#/components/schemas/skuvault_NewConnectorRequestV1", "slab": "#/components/schemas/slab_NewConnectorRequestV1", "slack": "#/components/schemas/slack_NewConnectorRequestV1", "slack_admin_data": "#/components/schemas/slack_admin_data_NewConnectorRequestV1", "slack_app": "#/components/schemas/slack_app_NewConnectorRequestV1", "smadex": "#/components/schemas/smadex_NewConnectorRequestV1", "smarthr": "#/components/schemas/smarthr_NewConnectorRequestV1", "smartrecruiters": "#/components/schemas/smartrecruiters_NewConnectorRequestV1", "smartsheet": "#/components/schemas/smartsheet_NewConnectorRequestV1", "smartwaiver": "#/components/schemas/smartwaiver_NewConnectorRequestV1", "snapchat_ads": "#/components/schemas/snapchat_ads_NewConnectorRequestV1", "snowflake_db": "#/components/schemas/snowflake_db_NewConnectorRequestV1", "snowplow": "#/components/schemas/snowplow_NewConnectorRequestV1", "snyk": "#/components/schemas/snyk_NewConnectorRequestV1", "solarwinds_service_desk": "#/components/schemas/solarwinds_service_desk_NewConnectorRequestV1", "sonarqube": "#/components/schemas/sonarqube_NewConnectorRequestV1", "sparkpost": "#/components/schemas/sparkpost_NewConnectorRequestV1", "splash": "#/components/schemas/splash_NewConnectorRequestV1", "splitio": "#/components/schemas/splitio_NewConnectorRequestV1", "splunk": "#/components/schemas/splunk_NewConnectorRequestV1", "spotify_ads": "#/components/schemas/spotify_ads_NewConnectorRequestV1", "sprout": "#/components/schemas/sprout_NewConnectorRequestV1", "sql_server": "#/components/schemas/sql_server_NewConnectorRequestV1", "sql_server_hva": "#/components/schemas/sql_server_hva_NewConnectorRequestV1", "sql_server_rds": "#/components/schemas/sql_server_rds_NewConnectorRequestV1", "sql_server_sap_ecc_hva": "#/components/schemas/sql_server_sap_ecc_hva_NewConnectorRequestV1", "square": "#/components/schemas/square_NewConnectorRequestV1", "squarespace": "#/components/schemas/squarespace_NewConnectorRequestV1", "stackadapt_graphql": "#/components/schemas/stackadapt_graphql_NewConnectorRequestV1", "standard_metrics": "#/components/schemas/standard_metrics_NewConnectorRequestV1", "starrez": "#/components/schemas/starrez_NewConnectorRequestV1", "statistics_netherlands_cbs": "#/components/schemas/statistics_netherlands_cbs_NewConnectorRequestV1", "statsig": "#/components/schemas/statsig_NewConnectorRequestV1", "statuspage": "#/components/schemas/statuspage_NewConnectorRequestV1", "stickyio": "#/components/schemas/stickyio_NewConnectorRequestV1", "stripe": "#/components/schemas/stripe_NewConnectorRequestV1", "stripe_test": "#/components/schemas/stripe_test_NewConnectorRequestV1", "stylight": "#/components/schemas/stylight_NewConnectorRequestV1", "subscript": "#/components/schemas/subscript_NewConnectorRequestV1", "sugarcrm": "#/components/schemas/sugarcrm_NewConnectorRequestV1", "survey_monkey": "#/components/schemas/survey_monkey_NewConnectorRequestV1", "survicate": "#/components/schemas/survicate_NewConnectorRequestV1", "swoogo": "#/components/schemas/swoogo_NewConnectorRequestV1", "tableau_source": "#/components/schemas/tableau_source_NewConnectorRequestV1", "taboola": "#/components/schemas/taboola_NewConnectorRequestV1", "talkdesk": "#/components/schemas/talkdesk_NewConnectorRequestV1", "talkwalker": "#/components/schemas/talkwalker_NewConnectorRequestV1", "teads": "#/components/schemas/teads_NewConnectorRequestV1", "teamtailor": "#/components/schemas/teamtailor_NewConnectorRequestV1", "teamwork": "#/components/schemas/teamwork_NewConnectorRequestV1", "tempo": "#/components/schemas/tempo_NewConnectorRequestV1", "testrail": "#/components/schemas/testrail_NewConnectorRequestV1", "textus": "#/components/schemas/textus_NewConnectorRequestV1", "the_movie_database": "#/components/schemas/the_movie_database_NewConnectorRequestV1", "the_trade_desk": "#/components/schemas/the_trade_desk_NewConnectorRequestV1", "thinkific": "#/components/schemas/thinkific_NewConnectorRequestV1", "ticket_tailor": "#/components/schemas/ticket_tailor_NewConnectorRequestV1", "tiktok_ads": "#/components/schemas/tiktok_ads_NewConnectorRequestV1", "tiktok_organic": "#/components/schemas/tiktok_organic_NewConnectorRequestV1", "tiktok_organic_app": "#/components/schemas/tiktok_organic_app_NewConnectorRequestV1", "tiktok_shop_partner_center": "#/components/schemas/tiktok_shop_partner_center_NewConnectorRequestV1", "tive": "#/components/schemas/tive_NewConnectorRequestV1", "toggl_track": "#/components/schemas/toggl_track_NewConnectorRequestV1", "totango": "#/components/schemas/totango_NewConnectorRequestV1", "tracksuit_source": "#/components/schemas/tracksuit_source_NewConnectorRequestV1", "transcend": "#/components/schemas/transcend_NewConnectorRequestV1", "trelica": "#/components/schemas/trelica_NewConnectorRequestV1", "trello": "#/components/schemas/trello_NewConnectorRequestV1", "tremendous": "#/components/schemas/tremendous_NewConnectorRequestV1", "triple_whale": "#/components/schemas/triple_whale_NewConnectorRequestV1", "trisolute": "#/components/schemas/trisolute_NewConnectorRequestV1", "trustpilot": "#/components/schemas/trustpilot_NewConnectorRequestV1", "twilio": "#/components/schemas/twilio_NewConnectorRequestV1", "twitter": "#/components/schemas/twitter_NewConnectorRequestV1", "twitter_ads": "#/components/schemas/twitter_ads_NewConnectorRequestV1", "tymeshift": "#/components/schemas/tymeshift_NewConnectorRequestV1", "typeform": "#/components/schemas/typeform_NewConnectorRequestV1", "udemy_business": "#/components/schemas/udemy_business_NewConnectorRequestV1", "ukg_pro": "#/components/schemas/ukg_pro_NewConnectorRequestV1", "ukg_pro_workforce_management": "#/components/schemas/ukg_pro_workforce_management_NewConnectorRequestV1", "unicommerce": "#/components/schemas/unicommerce_NewConnectorRequestV1", "upland": "#/components/schemas/upland_NewConnectorRequestV1", "uppromote": "#/components/schemas/uppromote_NewConnectorRequestV1", "uptempo": "#/components/schemas/uptempo_NewConnectorRequestV1", "uservoice": "#/components/schemas/uservoice_NewConnectorRequestV1", "validio": "#/components/schemas/validio_NewConnectorRequestV1", "veeqo": "#/components/schemas/veeqo_NewConnectorRequestV1", "veeva_vault": "#/components/schemas/veeva_vault_NewConnectorRequestV1", "venminder": "#/components/schemas/venminder_NewConnectorRequestV1", "vimeo": "#/components/schemas/vimeo_NewConnectorRequestV1", "visit_by_ges": "#/components/schemas/visit_by_ges_NewConnectorRequestV1", "visma": "#/components/schemas/visma_NewConnectorRequestV1", "vitally": "#/components/schemas/vitally_NewConnectorRequestV1", "vonage_contact_center": "#/components/schemas/vonage_contact_center_NewConnectorRequestV1", "vts": "#/components/schemas/vts_NewConnectorRequestV1", "vwo": "#/components/schemas/vwo_NewConnectorRequestV1", "walmart_dsp": "#/components/schemas/walmart_dsp_NewConnectorRequestV1", "walmart_marketplace": "#/components/schemas/walmart_marketplace_NewConnectorRequestV1", "web_scraper": "#/components/schemas/web_scraper_NewConnectorRequestV1", "webconnex": "#/components/schemas/webconnex_NewConnectorRequestV1", "webhooks": "#/components/schemas/webhooks_NewConnectorRequestV1", "when_i_work": "#/components/schemas/when_i_work_NewConnectorRequestV1", "wherefour": "#/components/schemas/wherefour_NewConnectorRequestV1", "wicked_reports": "#/components/schemas/wicked_reports_NewConnectorRequestV1", "woocommerce": "#/components/schemas/woocommerce_NewConnectorRequestV1", "wordpress": "#/components/schemas/wordpress_NewConnectorRequestV1", "workable": "#/components/schemas/workable_NewConnectorRequestV1", "workday": "#/components/schemas/workday_NewConnectorRequestV1", "workday_adaptive": "#/components/schemas/workday_adaptive_NewConnectorRequestV1", "workday_financial_management": "#/components/schemas/workday_financial_management_NewConnectorRequestV1", "workday_hcm": "#/components/schemas/workday_hcm_NewConnectorRequestV1", "workday_strategic_sourcing": "#/components/schemas/workday_strategic_sourcing_NewConnectorRequestV1", "workleap_officevibe": "#/components/schemas/workleap_officevibe_NewConnectorRequestV1", "workramp": "#/components/schemas/workramp_NewConnectorRequestV1", "wrike": "#/components/schemas/wrike_NewConnectorRequestV1", "writesonic": "#/components/schemas/writesonic_NewConnectorRequestV1", "xactly": "#/components/schemas/xactly_NewConnectorRequestV1", "xandr": "#/components/schemas/xandr_NewConnectorRequestV1", "xero": "#/components/schemas/xero_NewConnectorRequestV1", "xray": "#/components/schemas/xray_NewConnectorRequestV1", "xsolla": "#/components/schemas/xsolla_NewConnectorRequestV1", "yahoo_display_ads_on_yahoo_japan": "#/components/schemas/yahoo_display_ads_on_yahoo_japan_NewConnectorRequestV1", "yahoo_dsp": "#/components/schemas/yahoo_dsp_NewConnectorRequestV1", "yahoo_gemini": "#/components/schemas/yahoo_gemini_NewConnectorRequestV1", "yahoo_search_ads_yahoo_japan": "#/components/schemas/yahoo_search_ads_yahoo_japan_NewConnectorRequestV1", "yext": "#/components/schemas/yext_NewConnectorRequestV1", "yotpo": "#/components/schemas/yotpo_NewConnectorRequestV1", "yougov_brandindex": "#/components/schemas/yougov_brandindex_NewConnectorRequestV1", "yougov_sport": "#/components/schemas/yougov_sport_NewConnectorRequestV1", "younium": "#/components/schemas/younium_NewConnectorRequestV1", "youtube_analytics": "#/components/schemas/youtube_analytics_NewConnectorRequestV1", "zendesk": "#/components/schemas/zendesk_NewConnectorRequestV1", "zendesk_chat": "#/components/schemas/zendesk_chat_NewConnectorRequestV1", "zendesk_sell": "#/components/schemas/zendesk_sell_NewConnectorRequestV1", "zendesk_sunshine": "#/components/schemas/zendesk_sunshine_NewConnectorRequestV1", "zendesk_workforce_management": "#/components/schemas/zendesk_workforce_management_NewConnectorRequestV1", "zenefits": "#/components/schemas/zenefits_NewConnectorRequestV1", "zingtree": "#/components/schemas/zingtree_NewConnectorRequestV1", "zip": "#/components/schemas/zip_NewConnectorRequestV1", "zoho_books": "#/components/schemas/zoho_books_NewConnectorRequestV1", "zoho_campaigns": "#/components/schemas/zoho_campaigns_NewConnectorRequestV1", "zoho_crm": "#/components/schemas/zoho_crm_NewConnectorRequestV1", "zoho_desk": "#/components/schemas/zoho_desk_NewConnectorRequestV1", "zoho_inventory": "#/components/schemas/zoho_inventory_NewConnectorRequestV1", "zoho_people": "#/components/schemas/zoho_people_NewConnectorRequestV1", "zoho_recruit": "#/components/schemas/zoho_recruit_NewConnectorRequestV1", "zonka_feedback": "#/components/schemas/zonka_feedback_NewConnectorRequestV1", "zoom": "#/components/schemas/zoom_NewConnectorRequestV1", "zuora": "#/components/schemas/zuora_NewConnectorRequestV1", "zuora_sandbox": "#/components/schemas/zuora_sandbox_NewConnectorRequestV1" } } }, "ConnectCardConfigRequest": { "required": [ "connect_card_config" ], "type": "object", "properties": { "connect_card_config": { "description": "Configuration for the Connect Card flow. Connect Card is a Fivetran-hosted UI that allows your end users to authorize a connection without accessing the Fivetran dashboard. Use `redirect_uri` to control where users land after completing setup.", "allOf": [ { "$ref": "#/components/schemas/ConnectCardConfig" } ] } } }, "MoveConnectionsRequest": { "required": [ "destination_group_id" ], "type": "object", "properties": { "destination_group_id": { "type": "string", "description": "The unique identifier of the destination group to move the connection to. Retrieve group IDs from the [List All Groups](https://fivetran.com/docs/rest-api/api-reference/groups/list-all-groups) endpoint.", "example": "destination_group_id" }, "sync_behavior": { "type": "string", "description": "Controls how data syncs after the move. Use `CONTINUE` to preserve the existing sync cursor so the connection resumes incremental sync from where it left off. Use `BACKFILL` to reset the cursor and trigger a historical sync. Use `CONTINUE_WITH_DATA` to preserve the cursor and additionally migrate existing data to the new destination by starting an asynchronous job—use the `job_id` returned in the response to monitor progress. `CONTINUE_WITH_DATA` is supported only when moving a connection from Snowflake Native tables to a MDLS-linked Snowflake Lakehouse destination.", "example": "CONTINUE", "enum": [ "CONTINUE", "BACKFILL", "CONTINUE_WITH_DATA" ] }, "force_move": { "type": "boolean", "description": "Set to `true` to acknowledge move warnings and confirm that you want to proceed. Required if the connector's credentials depend on the current source group, or if the connection and its current destination support unstructured file replication but the target destination doesn't. If you don't provide the confirmation, the API returns an error describing the required action and the functionality you'd lose. Default: `false`", "example": true } } }, "ResyncConnectorRequest": { "type": "object", "properties": { "scope": { "type": "object", "properties": { "schema": { "title": "Schema name", "uniqueItems": true, "type": "array", "description": "Schema name", "example": [ "table1", "table2" ], "items": { "type": "string" } } }, "description": "A map where each key is a schema name and each value is a non-empty array of table names to re-sync within that schema.\nBoth the scope object and each schema's table array must be non-empty — an empty scope object or an empty table array returns 400.\nIf omitted or set to null, all schemas and tables of the connection are re-synced.\nThis parameter is only supported for connectors that support table-level re-sync (typically database connectors such as PostgreSQL, MySQL, and Oracle). Sending scope to an unsupported connector type (for example, Google Sheets) returns 400.\nRetrieve valid schema and table names from GET /v1/connections/{connectionId}/schemas.\n" } } }, "RunSetupTestsRequest": { "type": "object", "properties": { "trust_certificates": { "type": "boolean", "description": "Specifies whether we should trust the certificate automatically during setup tests. The default value is FALSE. This parameter only affects the behavior of setup tests and does not persist in the connection configuration. When using the PATCH endpoint to update a connection, this parameter must be combined with `run_setup_tests=true` and at least one persistent configuration parameter (e.g., `sync_frequency`, `paused`, `config`, `auth`). If you only want to run setup tests with automatic certificate trust, use the POST `/v1/connections/{connectionId}/test` endpoint instead. If a certificate is not trusted automatically during testing, it has to be approved with [Certificates Management API Approve a destination certificate](https://fivetran.com/docs/rest-api/certificates#approveadestinationcertificate).", "example": true }, "trust_fingerprints": { "type": "boolean", "description": "Specifies whether we should trust the SSH fingerprint automatically during setup tests. The default value is FALSE. This parameter only affects the behavior of setup tests and does not persist in the connection configuration. When using the PATCH endpoint to update a connection, this parameter must be combined with `run_setup_tests=true` and at least one persistent configuration parameter (e.g., `sync_frequency`, `paused`, `config`, `auth`). If you only want to run setup tests with automatic fingerprint trust, use the POST `/v1/connections/{connectionId}/test` endpoint instead. If a fingerprint is not trusted automatically during testing, it has to be approved with [Certificates Management API Approve a destination fingerprint](https://fivetran.com/docs/rest-api/certificates#approveadestinationfingerprint).", "example": true } } }, "SyncConnectorRequest": { "type": "object", "properties": { "force": { "type": "boolean", "description": "If force is true and the connection is currently syncing, it will stop the sync and re-run it. If force is false, the connection will sync only if it isn't currently syncing. The default value is false", "example": true } } }, "UpdateConnectorRequest": { "type": "object", "properties": { "config": { "description": "The setup configuration. Check possible config formats in [create method](/docs/rest-api/api-reference/connections/create-connection/)", "allOf": [ { "$ref": "#/components/schemas/JsonNode" } ] }, "auth": { "description": "The connector authorization settings. Check possible config formats in [create method](/docs/rest-api/api-reference/connections/create-connection/)" }, "paused": { "type": "boolean", "description": "Specifies whether the connection is paused", "example": false }, "trust_certificates": { "type": "boolean", "description": "Specifies whether we should trust the certificate automatically during setup tests. The default value is FALSE. This parameter only affects the behavior of setup tests and does not persist in the connection configuration. When using the PATCH endpoint to update a connection, this parameter must be combined with `run_setup_tests=true` and at least one persistent configuration parameter (e.g., `sync_frequency`, `paused`, `config`, `auth`). If you only want to run setup tests with automatic certificate trust, use the POST `/v1/connections/{connectionId}/test` endpoint instead. If a certificate is not trusted automatically during testing, it has to be approved with [Certificates Management API Approve a destination certificate](https://fivetran.com/docs/rest-api/certificates#approveadestinationcertificate).", "example": true }, "trust_fingerprints": { "type": "boolean", "description": "Specifies whether we should trust the SSH fingerprint automatically during setup tests. The default value is FALSE. This parameter only affects the behavior of setup tests and does not persist in the connection configuration. When using the PATCH endpoint to update a connection, this parameter must be combined with `run_setup_tests=true` and at least one persistent configuration parameter (e.g., `sync_frequency`, `paused`, `config`, `auth`). If you only want to run setup tests with automatic fingerprint trust, use the POST `/v1/connections/{connectionId}/test` endpoint instead. If a fingerprint is not trusted automatically during testing, it has to be approved with [Certificates Management API Approve a destination fingerprint](https://fivetran.com/docs/rest-api/certificates#approveadestinationfingerprint).", "example": true }, "sync_frequency": { "type": "integer", "description": "The connection sync frequency in minutes. `null` when the connection's schedule has no single cadence to report, such as a custom cron or multiple-time-of-day schedule.", "format": "int32", "example": 1440, "enum": [ "1", "5", "15", "30", "60", "120", "180", "360", "480", "720", "1440" ] }, "data_delay_threshold": { "type": "integer", "format": "int32" }, "data_delay_sensitivity": { "type": "string", "enum": [ "LOW", "NORMAL", "HIGH", "CUSTOM", "SYNC_FREQUENCY" ] }, "daily_sync_time": { "type": "string", "description": "The daily sync start time, in `HH:MM` format (UTC), at which the connection syncs. Returned only when `sync_frequency` is `1440` and `daily_sync_time` was explicitly set. `null` otherwise.", "example": "14:00" }, "pause_after_trial": { "type": "boolean", "description": "Specifies whether the connection should be paused after the free trial period has ended", "example": false }, "schema_status": { "type": "string", "description": "Schema status.", "example": "BLOCKED_ON_CAPTURE", "enum": [ "blocked_on_capture", "ready" ] }, "is_historical_sync": { "type": "boolean", "description": "The boolean specifying whether the connection should be triggered to re-sync all historical data. If you set this parameter to TRUE, a [historical sync](https://fivetran.com/docs/getting-started/glossary#historicalsync) starts immediately. If a sync is currently running, it's canceled and restarted as a historical sync. All subsequent syncs after the historical sync completes will be incremental. If the value is FALSE or not specified, the connection doesn't re-sync historical data. This parameter is automatically reset to FALSE once the historical sync is completed.", "example": true }, "schedule_type": { "type": "string", "description": "Controls whether Fivetran automatically schedules syncs. `auto` - Fivetran schedules syncs based on the `schedule` object. `manual` - automatic scheduling is disabled; syncs run only when triggered via the [Sync Connection](https://fivetran.com/docs/rest-api/api-reference/connections/sync-connection) endpoint.", "example": "auto", "enum": [ "auto", "manual" ] }, "run_setup_tests": { "type": "boolean", "description": "Specifies whether the setup tests should be run automatically after updating the connection. The default value is TRUE. When using this parameter in a PATCH request, you must also include at least one persistent configuration parameter (e.g., `sync_frequency`, `paused`, `config`, `auth`). This parameter can be combined with `trust_certificates` or `trust_fingerprints` to automatically approve `certificates/fingerprints` during the test run. To run setup tests without making configuration changes, use the POST `/v1/connections/{connectionId}/test` endpoint instead.", "example": true }, "networking_method": { "type": "string", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "hybrid_deployment_agent_id": { "type": "string", "description": "The unique identifier for the hybrid deployment agent within the Fivetran system. If not specified, the agent ID from the destination will be used", "example": "hybrid_deployment_agent_id" }, "proxy_agent_id": { "type": "string", "description": "The unique identifier for the proxy agent within the Fivetran system", "example": "proxy_agent_id" }, "private_link_id": { "type": "string", "description": "The unique identifier for the self-served private link that is used by the connection", "example": "private_link_id" }, "destination_configuration": { "$ref": "#/components/schemas/DestinationConfiguration" }, "external_secrets_manager_id": { "type": "string", "description": "The unique identifier of the [External Secrets Manager](/docs/rest-api/api-reference/external-secrets-managers) instance. Connector service must [support](/docs/core-concepts/features/external-secret-managers#connectors) External Secrets Manager feature to use this field." }, "external_secrets_keys_config": { "description": "The setup configuration keys to be stored in external secrets manager. Check possible config formats in [create method](/docs/rest-api/api-reference/connections/create-connection/)" }, "data_checks": { "type": "boolean", "description": "Enables or disables automated data validation (compare) for this connection. When set to `true`, Fivetran compares source and destination data after each sync to detect discrepancies. When set to `false`, validation is skipped. Returned only for connector and destination types that support data validation; absent otherwise. Supported sources: MySQL, Oracle, PostgreSQL, SQL Server, SAP HANA, Snowflake DB. Supported destinations: Snowflake, BigQuery, Redshift, Databricks, PostgreSQL, Managed Data Lake.", "example": true } } }, "UpdateFunctionOrConnectorSdkState": { "type": "object", "properties": { "state": { "description": "A freeform JSON object representing the connector's cursor or internal state to write. The structure is defined by the connector implementation and varies by connector type. If omitted or set to null, the existing state is preserved and the response returns 200 without modification.", "example": { "cursor": "2024-01-01T00:00:00Z" }, "allOf": [ { "$ref": "#/components/schemas/JsonNode" } ] } } }, "ConnectCardResponse": { "type": "object", "properties": { "token": { "type": "string", "description": "A short-lived JWT that authorizes the end user to configure this connection via the Connect Card interface. Use the `uri` field directly to redirect users — it already embeds this token. If you need to construct your own URL, pass this value as the `auth` query parameter to `https://fivetran.com/connect-card/setup`.", "example": "eyJ0e..." }, "uri": { "type": "string", "description": "The complete URL to redirect the end user to in order to authorize the connection. It embeds the auth token, redirect URI, and setup guide visibility as query parameters. Redirect the user directly to this address.", "example": "https://fivetran.com/connect-card/setup?redirect_uri=https://your.site/path&auth=eyJ0e...&hide_setup_guide=true" } } }, "ConnectionTask": { "type": "object", "properties": { "code": { "type": "string", "description": "A machine-readable identifier for the condition type. Use this value to programmatically detect and respond to specific connection conditions." }, "message": { "type": "string", "description": "A human-readable label describing the condition. For example: Reconnect, Resync Table Warning." }, "details": { "type": "string", "description": "Additional context about this condition beyond the message field." } } }, "ConnectionWarning": { "type": "object", "properties": { "code": { "type": "string", "description": "A machine-readable identifier for the condition type. Use this value to programmatically detect and respond to specific connection conditions." }, "message": { "type": "string", "description": "A human-readable label describing the condition. For example: Reconnect, Resync Table Warning." }, "details": { "type": "string", "description": "Additional context about this condition beyond the message field." } } }, "ConnectorResponseV1": { "required": [ "created_at", "data_delay_sensitivity", "group_id", "id", "pause_after_trial", "paused", "schedule_type", "schema", "service", "service_version", "status", "sync_frequency" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of this connection. Use this value as the `connectionId` path parameter when calling other Connections API endpoints, such as [Retrieve Connection Details](https://fivetran.com/docs/rest-api/api-reference/connections/connection-details) or [Sync Connection Data](https://fivetran.com/docs/rest-api/api-reference/connections/sync-connection).", "example": "connection_id" }, "service": { "type": "string", "description": "The connector name within the Fivetran system", "example": "google_ads" }, "schema": { "type": "string", "description": "The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination", "example": "schema.table" }, "paused": { "type": "boolean", "description": "Specifies whether the connection is paused", "example": false }, "status": { "description": "The current operational state of the connection, including setup state, sync state, update state, and any active tasks or warnings.", "allOf": [ { "$ref": "#/components/schemas/ConnectorStatusResponse" } ] }, "schedule": { "description": "The connection's sync schedule configuration", "allOf": [ { "$ref": "#/components/schemas/ConnectorSchedule" } ] }, "group_id": { "type": "string", "description": "The unique identifier of the destination group this connection belongs to. Use this value with the [List All Groups](https://fivetran.com/docs/rest-api/api-reference/groups/list-all-groups) or [Retrieve Group Details](https://fivetran.com/docs/rest-api/api-reference/groups/group-details) endpoints.", "example": "group_id" }, "service_version": { "type": "integer", "description": "The connector version within the Fivetran system", "format": "int32", "example": 0 }, "connected_by": { "type": "string", "description": "The unique identifier of the user who created this connection. `null` if the connection was created programmatically without a user context. Use this value with the [Retrieve User Details](https://fivetran.com/docs/rest-api/api-reference/users/user-details) endpoint.", "example": "priceless_odour" }, "created_at": { "type": "string", "description": "The timestamp of the time the connection was created in your account", "format": "date-time", "example": "2023-12-01T15:43:29.013729Z" }, "succeeded_at": { "type": "string", "description": "The UTC timestamp of the most recent successful sync. `null` if the connection has never completed a successful sync.", "format": "date-time", "example": "2024-03-17T12:31:40.870504Z" }, "failed_at": { "type": "string", "description": "The UTC timestamp of the most recent failed sync. `null` if the connection has never experienced a sync failure.", "format": "date-time", "example": "2024-04-01T18:13:25.043659Z" }, "pause_after_trial": { "type": "boolean", "description": "Specifies whether the connection should be paused after the free trial period has ended", "example": false }, "sync_frequency": { "type": "integer", "description": "The connection sync frequency in minutes. `null` when the connection's schedule has no single cadence to report, such as a custom cron or multiple-time-of-day schedule.", "format": "int32", "example": 1440, "enum": [ "1", "5", "15", "30", "60", "120", "180", "360", "480", "720", "1440" ] }, "data_delay_threshold": { "type": "integer", "description": "Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when data_delay_sensitivity set to CUSTOM.", "format": "int32", "example": 0 }, "data_delay_sensitivity": { "type": "string", "description": "The level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY. The default value is LOW. CUSTOM is only available for customers using the [Enterprise plan](https://fivetran.com/docs/getting-started/pricing#fivetranplans) or above.", "example": "LOW", "enum": [ "LOW", "NORMAL", "HIGH", "CUSTOM", "SYNC_FREQUENCY" ] }, "private_link_id": { "type": "string", "description": "The unique identifier for the self-served private link that is used by the connection", "example": "link_id" }, "networking_method": { "type": "string", "enum": [ "Directly", "SshTunnel", "PrivateLink", "ProxyAgent", "UnmanagedProxyAgent", "Unknown" ] }, "proxy_agent_id": { "type": "string", "description": "The unique identifier for the proxy agent within the Fivetran system", "example": "agent_id" }, "daily_sync_time": { "type": "string", "description": "The daily sync start time, in `HH:MM` format (UTC), at which the connection syncs. Returned only when `sync_frequency` is `1440` and `daily_sync_time` was explicitly set. `null` otherwise.", "example": "14:00" }, "schedule_type": { "type": "string", "description": "Controls whether Fivetran automatically schedules syncs. `auto` - Fivetran schedules syncs based on the `schedule` object. `manual` - automatic scheduling is disabled; syncs run only when triggered via the [Sync Connection](https://fivetran.com/docs/rest-api/api-reference/connections/sync-connection) endpoint.", "example": "auto" }, "setup_tests": { "type": "array", "description": "Setup tests results for this connection", "items": { "$ref": "#/components/schemas/SetupTestResultResponse" } }, "source_sync_details": { "type": "object", "description": "Read-only, connector-specific sync state. Depending on the connector type, this object may include source scope identifiers such as accounts, profiles, or projects; per-entity cursors or checkpoints; or last-synced timestamps. This field is optional, and its schema varies by connector type. To determine whether a connector exposes this information and inspect its returned fields, use [Retrieve Connection Details](https://fivetran.com/docs/rest-api/api-reference/connections/connection-details)." }, "connect_card": { "$ref": "#/components/schemas/ConnectCardResponse" }, "connect_card_config": { "$ref": "#/components/schemas/ConnectCardConfig" }, "hybrid_deployment_agent_id": { "type": "string", "description": "The unique identifier for the hybrid deployment agent within the Fivetran system. If not specified, the agent ID from the destination will be used", "example": "agent_id" }, "destination_configuration": { "$ref": "#/components/schemas/DestinationConfiguration" }, "destination_schema_names": { "type": "string", "description": "Defines how schema names appear in your destination.
The possible values are:
- FIVETRAN_NAMING - Uses Fivetran naming conventions to simplify and standardize the schema, table and column names in the destination.
- SOURCE_NAMING - Preserves source schema table and column names in the destination.
", "example": "FIVETRAN_NAMING", "enum": [ "FIVETRAN_NAMING", "SOURCE_NAMING" ] }, "external_secrets_manager_id": { "type": "string", "description": "The unique identifier of the [External Secrets Manager](/docs/rest-api/api-reference/external-secrets-managers) instance. Connector service must [support](/docs/core-concepts/features/external-secret-managers#connectors) External Secrets Manager feature to use this field.", "example": "esm_id" }, "data_checks": { "type": "boolean", "description": "Enables or disables automated data validation (compare) for this connection. When set to `true`, Fivetran compares source and destination data after each sync to detect discrepancies. When set to `false`, validation is skipped. Returned only for connector and destination types that support data validation; absent otherwise. Supported sources: MySQL, Oracle, PostgreSQL, SQL Server, SAP HANA, Snowflake DB. Supported destinations: Snowflake, BigQuery, Redshift, Databricks, PostgreSQL, Managed Data Lake.", "example": true } }, "discriminator": { "propertyName": "service", "mapping": { "15five": "#/components/schemas/15five_ConnectorResponseV1", "360learning": "#/components/schemas/360learning_ConnectorResponseV1", "7shifts": "#/components/schemas/7shifts_ConnectorResponseV1", "absorb_lms": "#/components/schemas/absorb_lms_ConnectorResponseV1", "acculynx": "#/components/schemas/acculynx_ConnectorResponseV1", "activecampaign": "#/components/schemas/activecampaign_ConnectorResponseV1", "acumatica": "#/components/schemas/acumatica_ConnectorResponseV1", "ada": "#/components/schemas/ada_ConnectorResponseV1", "adform": "#/components/schemas/adform_ConnectorResponseV1", "adjust": "#/components/schemas/adjust_ConnectorResponseV1", "adobe_analytics": "#/components/schemas/adobe_analytics_ConnectorResponseV1", "adobe_analytics_data_feed": "#/components/schemas/adobe_analytics_data_feed_ConnectorResponseV1", "adobe_commerce": "#/components/schemas/adobe_commerce_ConnectorResponseV1", "adobe_workfront": "#/components/schemas/adobe_workfront_ConnectorResponseV1", "adp_workforce_now": "#/components/schemas/adp_workforce_now_ConnectorResponseV1", "adroll": "#/components/schemas/adroll_ConnectorResponseV1", "adyen": "#/components/schemas/adyen_ConnectorResponseV1", "affinity": "#/components/schemas/affinity_ConnectorResponseV1", "afterpay": "#/components/schemas/afterpay_ConnectorResponseV1", "aha": "#/components/schemas/aha_ConnectorResponseV1", "ai_generated": "#/components/schemas/ai_generated_ConnectorResponseV1", "aircall": "#/components/schemas/aircall_ConnectorResponseV1", "airtable": "#/components/schemas/airtable_ConnectorResponseV1", "akamai": "#/components/schemas/akamai_ConnectorResponseV1", "akeneo": "#/components/schemas/akeneo_ConnectorResponseV1", "alation": "#/components/schemas/alation_ConnectorResponseV1", "alchemer": "#/components/schemas/alchemer_ConnectorResponseV1", "algolia": "#/components/schemas/algolia_ConnectorResponseV1", "alida": "#/components/schemas/alida_ConnectorResponseV1", "amazon_ads": "#/components/schemas/amazon_ads_ConnectorResponseV1", "amazon_attribution": "#/components/schemas/amazon_attribution_ConnectorResponseV1", "amazon_dsp": "#/components/schemas/amazon_dsp_ConnectorResponseV1", "amazon_selling_partner": "#/components/schemas/amazon_selling_partner_ConnectorResponseV1", "amplitude": "#/components/schemas/amplitude_ConnectorResponseV1", "amqp": "#/components/schemas/amqp_ConnectorResponseV1", "anaplan": "#/components/schemas/anaplan_ConnectorResponseV1", "anthropic_claude": "#/components/schemas/anthropic_claude_ConnectorResponseV1", "anvyl": "#/components/schemas/anvyl_ConnectorResponseV1", "apache_kafka": "#/components/schemas/apache_kafka_ConnectorResponseV1", "apollo": "#/components/schemas/apollo_ConnectorResponseV1", "appcues": "#/components/schemas/appcues_ConnectorResponseV1", "appfigures": "#/components/schemas/appfigures_ConnectorResponseV1", "apple_search_ads": "#/components/schemas/apple_search_ads_ConnectorResponseV1", "applovin": "#/components/schemas/applovin_ConnectorResponseV1", "appsflyer": "#/components/schemas/appsflyer_ConnectorResponseV1", "asana": "#/components/schemas/asana_ConnectorResponseV1", "ascend_by_partnerize": "#/components/schemas/ascend_by_partnerize_ConnectorResponseV1", "ashby": "#/components/schemas/ashby_ConnectorResponseV1", "assembled": "#/components/schemas/assembled_ConnectorResponseV1", "asset_panda": "#/components/schemas/asset_panda_ConnectorResponseV1", "atlassian_compass": "#/components/schemas/atlassian_compass_ConnectorResponseV1", "atlassian_jira_align": "#/components/schemas/atlassian_jira_align_ConnectorResponseV1", "atlassian_ops_genie": "#/components/schemas/atlassian_ops_genie_ConnectorResponseV1", "attentive": "#/components/schemas/attentive_ConnectorResponseV1", "attio": "#/components/schemas/attio_ConnectorResponseV1", "aumni": "#/components/schemas/aumni_ConnectorResponseV1", "aura_from_unity": "#/components/schemas/aura_from_unity_ConnectorResponseV1", "aurora": "#/components/schemas/aurora_ConnectorResponseV1", "aurora_postgres": "#/components/schemas/aurora_postgres_ConnectorResponseV1", "auth0": "#/components/schemas/auth0_ConnectorResponseV1", "autodesk_bim_360": "#/components/schemas/autodesk_bim_360_ConnectorResponseV1", "avantlink": "#/components/schemas/avantlink_ConnectorResponseV1", "aveva_pi": "#/components/schemas/aveva_pi_ConnectorResponseV1", "awin": "#/components/schemas/awin_ConnectorResponseV1", "aws_cloudtrail": "#/components/schemas/aws_cloudtrail_ConnectorResponseV1", "aws_cost_report": "#/components/schemas/aws_cost_report_ConnectorResponseV1", "aws_inventory": "#/components/schemas/aws_inventory_ConnectorResponseV1", "aws_lambda": "#/components/schemas/aws_lambda_ConnectorResponseV1", "aws_msk": "#/components/schemas/aws_msk_ConnectorResponseV1", "azure_blob_storage": "#/components/schemas/azure_blob_storage_ConnectorResponseV1", "azure_cosmos_for_mongo": "#/components/schemas/azure_cosmos_for_mongo_ConnectorResponseV1", "azure_devops": "#/components/schemas/azure_devops_ConnectorResponseV1", "azure_event_hub": "#/components/schemas/azure_event_hub_ConnectorResponseV1", "azure_function": "#/components/schemas/azure_function_ConnectorResponseV1", "azure_postgres": "#/components/schemas/azure_postgres_ConnectorResponseV1", "azure_service_bus": "#/components/schemas/azure_service_bus_ConnectorResponseV1", "azure_sql_db": "#/components/schemas/azure_sql_db_ConnectorResponseV1", "azure_sql_managed_db": "#/components/schemas/azure_sql_managed_db_ConnectorResponseV1", "backbone_plm": "#/components/schemas/backbone_plm_ConnectorResponseV1", "ballotready": "#/components/schemas/ballotready_ConnectorResponseV1", "bamboohr": "#/components/schemas/bamboohr_ConnectorResponseV1", "bazaarvoice": "#/components/schemas/bazaarvoice_ConnectorResponseV1", "betterworks": "#/components/schemas/betterworks_ConnectorResponseV1", "big_commerce": "#/components/schemas/big_commerce_ConnectorResponseV1", "bigin_by_zoho_crm": "#/components/schemas/bigin_by_zoho_crm_ConnectorResponseV1", "bigmarker": "#/components/schemas/bigmarker_ConnectorResponseV1", "bigquery_db": "#/components/schemas/bigquery_db_ConnectorResponseV1", "billing_platform": "#/components/schemas/billing_platform_ConnectorResponseV1", "bing_webmaster_tools": "#/components/schemas/bing_webmaster_tools_ConnectorResponseV1", "bingads": "#/components/schemas/bingads_ConnectorResponseV1", "birdeye": "#/components/schemas/birdeye_ConnectorResponseV1", "bitly": "#/components/schemas/bitly_ConnectorResponseV1", "bizzabo_app": "#/components/schemas/bizzabo_app_ConnectorResponseV1", "boostr": "#/components/schemas/boostr_ConnectorResponseV1", "box": "#/components/schemas/box_ConnectorResponseV1", "braintree": "#/components/schemas/braintree_ConnectorResponseV1", "braintree_sandbox": "#/components/schemas/braintree_sandbox_ConnectorResponseV1", "branch": "#/components/schemas/branch_ConnectorResponseV1", "brave_ads": "#/components/schemas/brave_ads_ConnectorResponseV1", "braze": "#/components/schemas/braze_ConnectorResponseV1", "breathe_hr": "#/components/schemas/breathe_hr_ConnectorResponseV1", "brevo": "#/components/schemas/brevo_ConnectorResponseV1", "brex": "#/components/schemas/brex_ConnectorResponseV1", "brightcove": "#/components/schemas/brightcove_ConnectorResponseV1", "brightflag": "#/components/schemas/brightflag_ConnectorResponseV1", "brightpearl": "#/components/schemas/brightpearl_ConnectorResponseV1", "brivo": "#/components/schemas/brivo_ConnectorResponseV1", "buildium": "#/components/schemas/buildium_ConnectorResponseV1", "buildkite": "#/components/schemas/buildkite_ConnectorResponseV1", "business_central": "#/components/schemas/business_central_ConnectorResponseV1", "buzzsprout": "#/components/schemas/buzzsprout_ConnectorResponseV1", "bynder": "#/components/schemas/bynder_ConnectorResponseV1", "cabcharge": "#/components/schemas/cabcharge_ConnectorResponseV1", "calabrio": "#/components/schemas/calabrio_ConnectorResponseV1", "calcom": "#/components/schemas/calcom_ConnectorResponseV1", "calendly": "#/components/schemas/calendly_ConnectorResponseV1", "callrail": "#/components/schemas/callrail_ConnectorResponseV1", "campaignmonitor": "#/components/schemas/campaignmonitor_ConnectorResponseV1", "campfire": "#/components/schemas/campfire_ConnectorResponseV1", "canny": "#/components/schemas/canny_ConnectorResponseV1", "canvas_by_instructure": "#/components/schemas/canvas_by_instructure_ConnectorResponseV1", "canvas_data_2_by_instructure": "#/components/schemas/canvas_data_2_by_instructure_ConnectorResponseV1", "captivateiq": "#/components/schemas/captivateiq_ConnectorResponseV1", "care_quality_commission": "#/components/schemas/care_quality_commission_ConnectorResponseV1", "castor_edc": "#/components/schemas/castor_edc_ConnectorResponseV1", "centra": "#/components/schemas/centra_ConnectorResponseV1", "ceridian_dayforce": "#/components/schemas/ceridian_dayforce_ConnectorResponseV1", "chameleon": "#/components/schemas/chameleon_ConnectorResponseV1", "chargebee_product_catalog_1": "#/components/schemas/chargebee_product_catalog_1_ConnectorResponseV1", "chargebee_product_catalog_2": "#/components/schemas/chargebee_product_catalog_2_ConnectorResponseV1", "chargedesk": "#/components/schemas/chargedesk_ConnectorResponseV1", "charthop": "#/components/schemas/charthop_ConnectorResponseV1", "chartmogul": "#/components/schemas/chartmogul_ConnectorResponseV1", "checkout": "#/components/schemas/checkout_ConnectorResponseV1", "checkr": "#/components/schemas/checkr_ConnectorResponseV1", "chorusai": "#/components/schemas/chorusai_ConnectorResponseV1", "churnkey": "#/components/schemas/churnkey_ConnectorResponseV1", "churnzero": "#/components/schemas/churnzero_ConnectorResponseV1", "cimis": "#/components/schemas/cimis_ConnectorResponseV1", "cin7": "#/components/schemas/cin7_ConnectorResponseV1", "cin7core": "#/components/schemas/cin7core_ConnectorResponseV1", "circle_community_platform": "#/components/schemas/circle_community_platform_ConnectorResponseV1", "circleci": "#/components/schemas/circleci_ConnectorResponseV1", "cj_commission_detail": "#/components/schemas/cj_commission_detail_ConnectorResponseV1", "clari": "#/components/schemas/clari_ConnectorResponseV1", "claude_compliance": "#/components/schemas/claude_compliance_ConnectorResponseV1", "clazar": "#/components/schemas/clazar_ConnectorResponseV1", "clickup": "#/components/schemas/clickup_ConnectorResponseV1", "clockify": "#/components/schemas/clockify_ConnectorResponseV1", "clockodo": "#/components/schemas/clockodo_ConnectorResponseV1", "close": "#/components/schemas/close_ConnectorResponseV1", "cloudbeds": "#/components/schemas/cloudbeds_ConnectorResponseV1", "cloudflare_analytics": "#/components/schemas/cloudflare_analytics_ConnectorResponseV1", "cloudfront": "#/components/schemas/cloudfront_ConnectorResponseV1", "cloudtalk": "#/components/schemas/cloudtalk_ConnectorResponseV1", "clubspeed": "#/components/schemas/clubspeed_ConnectorResponseV1", "coalesce": "#/components/schemas/coalesce_ConnectorResponseV1", "coassemble": "#/components/schemas/coassemble_ConnectorResponseV1", "cockroachdb": "#/components/schemas/cockroachdb_ConnectorResponseV1", "coda": "#/components/schemas/coda_ConnectorResponseV1", "codefresh": "#/components/schemas/codefresh_ConnectorResponseV1", "collibra": "#/components/schemas/collibra_ConnectorResponseV1", "column": "#/components/schemas/column_ConnectorResponseV1", "commercetools": "#/components/schemas/commercetools_ConnectorResponseV1", "compliance_checkpoint": "#/components/schemas/compliance_checkpoint_ConnectorResponseV1", "concord": "#/components/schemas/concord_ConnectorResponseV1", "concur": "#/components/schemas/concur_ConnectorResponseV1", "confluence": "#/components/schemas/confluence_ConnectorResponseV1", "confluent_cloud": "#/components/schemas/confluent_cloud_ConnectorResponseV1", "connector_sdk": "#/components/schemas/connector_sdk_ConnectorResponseV1", "consensus_demo_automation_platform": "#/components/schemas/consensus_demo_automation_platform_ConnectorResponseV1", "constant_contact": "#/components/schemas/constant_contact_ConnectorResponseV1", "contrast_security": "#/components/schemas/contrast_security_ConnectorResponseV1", "convex": "#/components/schemas/convex_ConnectorResponseV1", "copper": "#/components/schemas/copper_ConnectorResponseV1", "cornerstone": "#/components/schemas/cornerstone_ConnectorResponseV1", "cosmos": "#/components/schemas/cosmos_ConnectorResponseV1", "coupa": "#/components/schemas/coupa_ConnectorResponseV1", "credly": "#/components/schemas/credly_ConnectorResponseV1", "criteo": "#/components/schemas/criteo_ConnectorResponseV1", "criteo_retail_media": "#/components/schemas/criteo_retail_media_ConnectorResponseV1", "crossbeam": "#/components/schemas/crossbeam_ConnectorResponseV1", "crowddev": "#/components/schemas/crowddev_ConnectorResponseV1", "crunchbase": "#/components/schemas/crunchbase_ConnectorResponseV1", "cube_software": "#/components/schemas/cube_software_ConnectorResponseV1", "culture_amp": "#/components/schemas/culture_amp_ConnectorResponseV1", "cursor": "#/components/schemas/cursor_ConnectorResponseV1", "customerio": "#/components/schemas/customerio_ConnectorResponseV1", "cvent": "#/components/schemas/cvent_ConnectorResponseV1", "d2l_brightspace": "#/components/schemas/d2l_brightspace_ConnectorResponseV1", "databricks_db": "#/components/schemas/databricks_db_ConnectorResponseV1", "datadog": "#/components/schemas/datadog_ConnectorResponseV1", "datastreamer_source": "#/components/schemas/datastreamer_source_ConnectorResponseV1", "db2i_hva": "#/components/schemas/db2i_hva_ConnectorResponseV1", "db2i_sap_hva": "#/components/schemas/db2i_sap_hva_ConnectorResponseV1", "db2luw": "#/components/schemas/db2luw_ConnectorResponseV1", "db2z": "#/components/schemas/db2z_ConnectorResponseV1", "dbt_cloud": "#/components/schemas/dbt_cloud_ConnectorResponseV1", "dcl_logistics": "#/components/schemas/dcl_logistics_ConnectorResponseV1", "deel": "#/components/schemas/deel_ConnectorResponseV1", "deposco": "#/components/schemas/deposco_ConnectorResponseV1", "deputy": "#/components/schemas/deputy_ConnectorResponseV1", "destini": "#/components/schemas/destini_ConnectorResponseV1", "device_magic": "#/components/schemas/device_magic_ConnectorResponseV1", "dialpad": "#/components/schemas/dialpad_ConnectorResponseV1", "discourse": "#/components/schemas/discourse_ConnectorResponseV1", "dixa": "#/components/schemas/dixa_ConnectorResponseV1", "docebo": "#/components/schemas/docebo_ConnectorResponseV1", "documentdb": "#/components/schemas/documentdb_ConnectorResponseV1", "donus": "#/components/schemas/donus_ConnectorResponseV1", "doorloop": "#/components/schemas/doorloop_ConnectorResponseV1", "double_click_campaign_manager": "#/components/schemas/double_click_campaign_manager_ConnectorResponseV1", "double_click_publishers": "#/components/schemas/double_click_publishers_ConnectorResponseV1", "drata": "#/components/schemas/drata_ConnectorResponseV1", "drift": "#/components/schemas/drift_ConnectorResponseV1", "drip": "#/components/schemas/drip_ConnectorResponseV1", "dropbox": "#/components/schemas/dropbox_ConnectorResponseV1", "dropbox_sign": "#/components/schemas/dropbox_sign_ConnectorResponseV1", "dsv": "#/components/schemas/dsv_ConnectorResponseV1", "duoplane": "#/components/schemas/duoplane_ConnectorResponseV1", "dutchie": "#/components/schemas/dutchie_ConnectorResponseV1", "dynamics_365": "#/components/schemas/dynamics_365_ConnectorResponseV1", "dynamodb": "#/components/schemas/dynamodb_ConnectorResponseV1", "easypost": "#/components/schemas/easypost_ConnectorResponseV1", "ebay": "#/components/schemas/ebay_ConnectorResponseV1", "economic": "#/components/schemas/economic_ConnectorResponseV1", "elastic_cloud": "#/components/schemas/elastic_cloud_ConnectorResponseV1", "elastic_cloud_serverless": "#/components/schemas/elastic_cloud_serverless_ConnectorResponseV1", "electronic_tenant_solutions": "#/components/schemas/electronic_tenant_solutions_ConnectorResponseV1", "eloqua": "#/components/schemas/eloqua_ConnectorResponseV1", "email": "#/components/schemas/email_ConnectorResponseV1", "employment_hero": "#/components/schemas/employment_hero_ConnectorResponseV1", "epic_clarity": "#/components/schemas/epic_clarity_ConnectorResponseV1", "es_self_hosted": "#/components/schemas/es_self_hosted_ConnectorResponseV1", "eventbrite": "#/components/schemas/eventbrite_ConnectorResponseV1", "eventsforce": "#/components/schemas/eventsforce_ConnectorResponseV1", "everflow": "#/components/schemas/everflow_ConnectorResponseV1", "everhour": "#/components/schemas/everhour_ConnectorResponseV1", "exact_online": "#/components/schemas/exact_online_ConnectorResponseV1", "expensein": "#/components/schemas/expensein_ConnectorResponseV1", "expensify": "#/components/schemas/expensify_ConnectorResponseV1", "ezofficeinventory": "#/components/schemas/ezofficeinventory_ConnectorResponseV1", "facebook_ads": "#/components/schemas/facebook_ads_ConnectorResponseV1", "facebook_pages": "#/components/schemas/facebook_pages_ConnectorResponseV1", "factbird": "#/components/schemas/factbird_ConnectorResponseV1", "factorial": "#/components/schemas/factorial_ConnectorResponseV1", "fathom": "#/components/schemas/fathom_ConnectorResponseV1", "fillout": "#/components/schemas/fillout_ConnectorResponseV1", "firebase": "#/components/schemas/firebase_ConnectorResponseV1", "fireflies": "#/components/schemas/fireflies_ConnectorResponseV1", "firehydrant": "#/components/schemas/firehydrant_ConnectorResponseV1", "fivetran_log": "#/components/schemas/fivetran_log_ConnectorResponseV1", "flexport": "#/components/schemas/flexport_ConnectorResponseV1", "float": "#/components/schemas/float_ConnectorResponseV1", "flywheel_digital": "#/components/schemas/flywheel_digital_ConnectorResponseV1", "fone_dynamics": "#/components/schemas/fone_dynamics_ConnectorResponseV1", "forethought": "#/components/schemas/forethought_ConnectorResponseV1", "forj_community": "#/components/schemas/forj_community_ConnectorResponseV1", "formstack": "#/components/schemas/formstack_ConnectorResponseV1", "fortnox": "#/components/schemas/fortnox_ConnectorResponseV1", "fountain": "#/components/schemas/fountain_ConnectorResponseV1", "fourkites": "#/components/schemas/fourkites_ConnectorResponseV1", "freightview": "#/components/schemas/freightview_ConnectorResponseV1", "freshbooks": "#/components/schemas/freshbooks_ConnectorResponseV1", "freshchat": "#/components/schemas/freshchat_ConnectorResponseV1", "freshdesk": "#/components/schemas/freshdesk_ConnectorResponseV1", "freshdesk_contact_center": "#/components/schemas/freshdesk_contact_center_ConnectorResponseV1", "freshsales": "#/components/schemas/freshsales_ConnectorResponseV1", "freshservice": "#/components/schemas/freshservice_ConnectorResponseV1", "freshsuccess": "#/components/schemas/freshsuccess_ConnectorResponseV1", "freshteam": "#/components/schemas/freshteam_ConnectorResponseV1", "friendbuy": "#/components/schemas/friendbuy_ConnectorResponseV1", "front": "#/components/schemas/front_ConnectorResponseV1", "ftp": "#/components/schemas/ftp_ConnectorResponseV1", "fulfil": "#/components/schemas/fulfil_ConnectorResponseV1", "fullstory": "#/components/schemas/fullstory_ConnectorResponseV1", "g2": "#/components/schemas/g2_ConnectorResponseV1", "gainsight_customer_success": "#/components/schemas/gainsight_customer_success_ConnectorResponseV1", "gainsight_product_experience": "#/components/schemas/gainsight_product_experience_ConnectorResponseV1", "gcs": "#/components/schemas/gcs_ConnectorResponseV1", "gem": "#/components/schemas/gem_ConnectorResponseV1", "genesys": "#/components/schemas/genesys_ConnectorResponseV1", "getfeedback": "#/components/schemas/getfeedback_ConnectorResponseV1", "github": "#/components/schemas/github_ConnectorResponseV1", "gitlab": "#/components/schemas/gitlab_ConnectorResponseV1", "gladly": "#/components/schemas/gladly_ConnectorResponseV1", "globalmeet": "#/components/schemas/globalmeet_ConnectorResponseV1", "gmail": "#/components/schemas/gmail_ConnectorResponseV1", "gocardless": "#/components/schemas/gocardless_ConnectorResponseV1", "gofundme_pro": "#/components/schemas/gofundme_pro_ConnectorResponseV1", "goldcast": "#/components/schemas/goldcast_ConnectorResponseV1", "gongio": "#/components/schemas/gongio_ConnectorResponseV1", "google_ads": "#/components/schemas/google_ads_ConnectorResponseV1", "google_analytics_4": "#/components/schemas/google_analytics_4_ConnectorResponseV1", "google_analytics_4_export": "#/components/schemas/google_analytics_4_export_ConnectorResponseV1", "google_business_profile": "#/components/schemas/google_business_profile_ConnectorResponseV1", "google_calendar": "#/components/schemas/google_calendar_ConnectorResponseV1", "google_classroom": "#/components/schemas/google_classroom_ConnectorResponseV1", "google_cloud_function": "#/components/schemas/google_cloud_function_ConnectorResponseV1", "google_cloud_mysql": "#/components/schemas/google_cloud_mysql_ConnectorResponseV1", "google_cloud_postgresql": "#/components/schemas/google_cloud_postgresql_ConnectorResponseV1", "google_cloud_sqlserver": "#/components/schemas/google_cloud_sqlserver_ConnectorResponseV1", "google_display_and_video_360": "#/components/schemas/google_display_and_video_360_ConnectorResponseV1", "google_drive": "#/components/schemas/google_drive_ConnectorResponseV1", "google_play": "#/components/schemas/google_play_ConnectorResponseV1", "google_search_ads_360": "#/components/schemas/google_search_ads_360_ConnectorResponseV1", "google_search_console": "#/components/schemas/google_search_console_ConnectorResponseV1", "google_sheets": "#/components/schemas/google_sheets_ConnectorResponseV1", "google_tag_manager": "#/components/schemas/google_tag_manager_ConnectorResponseV1", "google_tasks": "#/components/schemas/google_tasks_ConnectorResponseV1", "gorgias": "#/components/schemas/gorgias_ConnectorResponseV1", "green_power_monitor": "#/components/schemas/green_power_monitor_ConnectorResponseV1", "greenhouse": "#/components/schemas/greenhouse_ConnectorResponseV1", "grepsr": "#/components/schemas/grepsr_ConnectorResponseV1", "grin": "#/components/schemas/grin_ConnectorResponseV1", "guidewire_cloud_data_access": "#/components/schemas/guidewire_cloud_data_access_ConnectorResponseV1", "guru": "#/components/schemas/guru_ConnectorResponseV1", "h_level": "#/components/schemas/h_level_ConnectorResponseV1", "happyfox": "#/components/schemas/happyfox_ConnectorResponseV1", "harvest": "#/components/schemas/harvest_ConnectorResponseV1", "healthie": "#/components/schemas/healthie_ConnectorResponseV1", "heap": "#/components/schemas/heap_ConnectorResponseV1", "heartland_retail_pos": "#/components/schemas/heartland_retail_pos_ConnectorResponseV1", "helpdesk": "#/components/schemas/helpdesk_ConnectorResponseV1", "helpjuice": "#/components/schemas/helpjuice_ConnectorResponseV1", "helpscout": "#/components/schemas/helpscout_ConnectorResponseV1", "helpshift": "#/components/schemas/helpshift_ConnectorResponseV1", "heroku_kafka": "#/components/schemas/heroku_kafka_ConnectorResponseV1", "heroku_postgres": "#/components/schemas/heroku_postgres_ConnectorResponseV1", "hex": "#/components/schemas/hex_ConnectorResponseV1", "hibob": "#/components/schemas/hibob_ConnectorResponseV1", "higher_logic_vanilla": "#/components/schemas/higher_logic_vanilla_ConnectorResponseV1", "hilti_ontrack": "#/components/schemas/hilti_ontrack_ConnectorResponseV1", "hopin": "#/components/schemas/hopin_ConnectorResponseV1", "hubspot": "#/components/schemas/hubspot_ConnectorResponseV1", "ibacos": "#/components/schemas/ibacos_ConnectorResponseV1", "ilevel": "#/components/schemas/ilevel_ConnectorResponseV1", "impact": "#/components/schemas/impact_ConnectorResponseV1", "impact_partner": "#/components/schemas/impact_partner_ConnectorResponseV1", "incidentio": "#/components/schemas/incidentio_ConnectorResponseV1", "infobip": "#/components/schemas/infobip_ConnectorResponseV1", "insightly": "#/components/schemas/insightly_ConnectorResponseV1", "instagram_business": "#/components/schemas/instagram_business_ConnectorResponseV1", "integral_ad_science": "#/components/schemas/integral_ad_science_ConnectorResponseV1", "integrate": "#/components/schemas/integrate_ConnectorResponseV1", "intercom": "#/components/schemas/intercom_ConnectorResponseV1", "invoiced": "#/components/schemas/invoiced_ConnectorResponseV1", "ironclad": "#/components/schemas/ironclad_ConnectorResponseV1", "ironclad_clickwrap": "#/components/schemas/ironclad_clickwrap_ConnectorResponseV1", "ironsource": "#/components/schemas/ironsource_ConnectorResponseV1", "iterable": "#/components/schemas/iterable_ConnectorResponseV1", "itunes_connect": "#/components/schemas/itunes_connect_ConnectorResponseV1", "ivanti": "#/components/schemas/ivanti_ConnectorResponseV1", "jama_software": "#/components/schemas/jama_software_ConnectorResponseV1", "jamf": "#/components/schemas/jamf_ConnectorResponseV1", "jibble": "#/components/schemas/jibble_ConnectorResponseV1", "jira": "#/components/schemas/jira_ConnectorResponseV1", "jobnimbus": "#/components/schemas/jobnimbus_ConnectorResponseV1", "jotform": "#/components/schemas/jotform_ConnectorResponseV1", "justcall": "#/components/schemas/justcall_ConnectorResponseV1", "kandji": "#/components/schemas/kandji_ConnectorResponseV1", "katana": "#/components/schemas/katana_ConnectorResponseV1", "kevel": "#/components/schemas/kevel_ConnectorResponseV1", "keypay": "#/components/schemas/keypay_ConnectorResponseV1", "khoros_care": "#/components/schemas/khoros_care_ConnectorResponseV1", "khoros_communities": "#/components/schemas/khoros_communities_ConnectorResponseV1", "khoros_marketing": "#/components/schemas/khoros_marketing_ConnectorResponseV1", "kinesis": "#/components/schemas/kinesis_ConnectorResponseV1", "kisi": "#/components/schemas/kisi_ConnectorResponseV1", "kissmetrics": "#/components/schemas/kissmetrics_ConnectorResponseV1", "klarna": "#/components/schemas/klarna_ConnectorResponseV1", "klaviyo": "#/components/schemas/klaviyo_ConnectorResponseV1", "konnect_insights": "#/components/schemas/konnect_insights_ConnectorResponseV1", "kustomer": "#/components/schemas/kustomer_ConnectorResponseV1", "kyriba": "#/components/schemas/kyriba_ConnectorResponseV1", "lattice": "#/components/schemas/lattice_ConnectorResponseV1", "launchdarkly": "#/components/schemas/launchdarkly_ConnectorResponseV1", "leap_crm": "#/components/schemas/leap_crm_ConnectorResponseV1", "leapsome": "#/components/schemas/leapsome_ConnectorResponseV1", "learn_amp": "#/components/schemas/learn_amp_ConnectorResponseV1", "learnupon": "#/components/schemas/learnupon_ConnectorResponseV1", "leave_dates": "#/components/schemas/leave_dates_ConnectorResponseV1", "lemlist": "#/components/schemas/lemlist_ConnectorResponseV1", "lessonly": "#/components/schemas/lessonly_ConnectorResponseV1", "lever": "#/components/schemas/lever_ConnectorResponseV1", "liftoff": "#/components/schemas/liftoff_ConnectorResponseV1", "light_speed_retail": "#/components/schemas/light_speed_retail_ConnectorResponseV1", "lightspeed_retail_xseries": "#/components/schemas/lightspeed_retail_xseries_ConnectorResponseV1", "line_ads": "#/components/schemas/line_ads_ConnectorResponseV1", "linear": "#/components/schemas/linear_ConnectorResponseV1", "linkedin_ads": "#/components/schemas/linkedin_ads_ConnectorResponseV1", "linkedin_company_pages": "#/components/schemas/linkedin_company_pages_ConnectorResponseV1", "linksquares": "#/components/schemas/linksquares_ConnectorResponseV1", "listen360": "#/components/schemas/listen360_ConnectorResponseV1", "livechat_partner": "#/components/schemas/livechat_partner_ConnectorResponseV1", "livestorm": "#/components/schemas/livestorm_ConnectorResponseV1", "lob": "#/components/schemas/lob_ConnectorResponseV1", "local_file_system": "#/components/schemas/local_file_system_ConnectorResponseV1", "looker_source": "#/components/schemas/looker_source_ConnectorResponseV1", "loop": "#/components/schemas/loop_ConnectorResponseV1", "loopio": "#/components/schemas/loopio_ConnectorResponseV1", "lucca": "#/components/schemas/lucca_ConnectorResponseV1", "luma": "#/components/schemas/luma_ConnectorResponseV1", "magento_mysql": "#/components/schemas/magento_mysql_ConnectorResponseV1", "magento_mysql_rds": "#/components/schemas/magento_mysql_rds_ConnectorResponseV1", "mailchimp": "#/components/schemas/mailchimp_ConnectorResponseV1", "maileon": "#/components/schemas/maileon_ConnectorResponseV1", "mailgun": "#/components/schemas/mailgun_ConnectorResponseV1", "mailjet": "#/components/schemas/mailjet_ConnectorResponseV1", "maintainx": "#/components/schemas/maintainx_ConnectorResponseV1", "malomo": "#/components/schemas/malomo_ConnectorResponseV1", "mambu": "#/components/schemas/mambu_ConnectorResponseV1", "mandrill": "#/components/schemas/mandrill_ConnectorResponseV1", "maria": "#/components/schemas/maria_ConnectorResponseV1", "maria_azure": "#/components/schemas/maria_azure_ConnectorResponseV1", "maria_rds": "#/components/schemas/maria_rds_ConnectorResponseV1", "marin": "#/components/schemas/marin_ConnectorResponseV1", "marketo": "#/components/schemas/marketo_ConnectorResponseV1", "matomo": "#/components/schemas/matomo_ConnectorResponseV1", "mavenlink": "#/components/schemas/mavenlink_ConnectorResponseV1", "maxio_chargify": "#/components/schemas/maxio_chargify_ConnectorResponseV1", "maxio_saasoptics": "#/components/schemas/maxio_saasoptics_ConnectorResponseV1", "medallia": "#/components/schemas/medallia_ConnectorResponseV1", "medallia_agile_research": "#/components/schemas/medallia_agile_research_ConnectorResponseV1", "megaphone": "#/components/schemas/megaphone_ConnectorResponseV1", "mention": "#/components/schemas/mention_ConnectorResponseV1", "microsoft_dynamics_365_fno": "#/components/schemas/microsoft_dynamics_365_fno_ConnectorResponseV1", "microsoft_entra_id": "#/components/schemas/microsoft_entra_id_ConnectorResponseV1", "microsoft_lists": "#/components/schemas/microsoft_lists_ConnectorResponseV1", "microsoft_power_bi": "#/components/schemas/microsoft_power_bi_ConnectorResponseV1", "microsoft_teams": "#/components/schemas/microsoft_teams_ConnectorResponseV1", "missive": "#/components/schemas/missive_ConnectorResponseV1", "mixmax": "#/components/schemas/mixmax_ConnectorResponseV1", "mixpanel": "#/components/schemas/mixpanel_ConnectorResponseV1", "mode": "#/components/schemas/mode_ConnectorResponseV1", "mollie": "#/components/schemas/mollie_ConnectorResponseV1", "moloco": "#/components/schemas/moloco_ConnectorResponseV1", "monday": "#/components/schemas/monday_ConnectorResponseV1", "mongo": "#/components/schemas/mongo_ConnectorResponseV1", "mongo_sharded": "#/components/schemas/mongo_sharded_ConnectorResponseV1", "mountain": "#/components/schemas/mountain_ConnectorResponseV1", "mux": "#/components/schemas/mux_ConnectorResponseV1", "myosh": "#/components/schemas/myosh_ConnectorResponseV1", "mysql": "#/components/schemas/mysql_ConnectorResponseV1", "mysql_azure": "#/components/schemas/mysql_azure_ConnectorResponseV1", "mysql_rds": "#/components/schemas/mysql_rds_ConnectorResponseV1", "namely": "#/components/schemas/namely_ConnectorResponseV1", "national_heavy_vehicle_regulator": "#/components/schemas/national_heavy_vehicle_regulator_ConnectorResponseV1", "navan": "#/components/schemas/navan_ConnectorResponseV1", "netsuite_suiteanalytics": "#/components/schemas/netsuite_suiteanalytics_ConnectorResponseV1", "nice": "#/components/schemas/nice_ConnectorResponseV1", "notion": "#/components/schemas/notion_ConnectorResponseV1", "nylas": "#/components/schemas/nylas_ConnectorResponseV1", "odoo": "#/components/schemas/odoo_ConnectorResponseV1", "odoo_synconics": "#/components/schemas/odoo_synconics_ConnectorResponseV1", "okendo": "#/components/schemas/okendo_ConnectorResponseV1", "okta": "#/components/schemas/okta_ConnectorResponseV1", "ometria": "#/components/schemas/ometria_ConnectorResponseV1", "on24": "#/components/schemas/on24_ConnectorResponseV1", "oncehub": "#/components/schemas/oncehub_ConnectorResponseV1", "one_drive": "#/components/schemas/one_drive_ConnectorResponseV1", "onetrust": "#/components/schemas/onetrust_ConnectorResponseV1", "open_data_dc": "#/components/schemas/open_data_dc_ConnectorResponseV1", "open_exchange_rates": "#/components/schemas/open_exchange_rates_ConnectorResponseV1", "openai": "#/components/schemas/openai_ConnectorResponseV1", "openai_compliance_platform": "#/components/schemas/openai_compliance_platform_ConnectorResponseV1", "opendistro": "#/components/schemas/opendistro_ConnectorResponseV1", "opensearch": "#/components/schemas/opensearch_ConnectorResponseV1", "optimizely": "#/components/schemas/optimizely_ConnectorResponseV1", "oracle": "#/components/schemas/oracle_ConnectorResponseV1", "oracle_business_intelligence_publisher": "#/components/schemas/oracle_business_intelligence_publisher_ConnectorResponseV1", "oracle_ebs": "#/components/schemas/oracle_ebs_ConnectorResponseV1", "oracle_fusion_cloud_apps_crm": "#/components/schemas/oracle_fusion_cloud_apps_crm_ConnectorResponseV1", "oracle_fusion_cloud_apps_fscm": "#/components/schemas/oracle_fusion_cloud_apps_fscm_ConnectorResponseV1", "oracle_fusion_cloud_apps_hcm": "#/components/schemas/oracle_fusion_cloud_apps_hcm_ConnectorResponseV1", "oracle_fusion_field_service": "#/components/schemas/oracle_fusion_field_service_ConnectorResponseV1", "oracle_hva": "#/components/schemas/oracle_hva_ConnectorResponseV1", "oracle_moat_analytics": "#/components/schemas/oracle_moat_analytics_ConnectorResponseV1", "oracle_netsuite_openair": "#/components/schemas/oracle_netsuite_openair_ConnectorResponseV1", "oracle_rac": "#/components/schemas/oracle_rac_ConnectorResponseV1", "oracle_rds": "#/components/schemas/oracle_rds_ConnectorResponseV1", "oracle_sap_hva": "#/components/schemas/oracle_sap_hva_ConnectorResponseV1", "oracle_sap_hva_netweaver": "#/components/schemas/oracle_sap_hva_netweaver_ConnectorResponseV1", "orbit": "#/components/schemas/orbit_ConnectorResponseV1", "ordergroove": "#/components/schemas/ordergroove_ConnectorResponseV1", "ordway": "#/components/schemas/ordway_ConnectorResponseV1", "ortto": "#/components/schemas/ortto_ConnectorResponseV1", "outbrain": "#/components/schemas/outbrain_ConnectorResponseV1", "outreach": "#/components/schemas/outreach_ConnectorResponseV1", "packiyo": "#/components/schemas/packiyo_ConnectorResponseV1", "paddle": "#/components/schemas/paddle_ConnectorResponseV1", "pagerduty": "#/components/schemas/pagerduty_ConnectorResponseV1", "pandadoc": "#/components/schemas/pandadoc_ConnectorResponseV1", "papershift": "#/components/schemas/papershift_ConnectorResponseV1", "parcellab": "#/components/schemas/parcellab_ConnectorResponseV1", "pardot": "#/components/schemas/pardot_ConnectorResponseV1", "pardot_sandbox": "#/components/schemas/pardot_sandbox_ConnectorResponseV1", "partnerize": "#/components/schemas/partnerize_ConnectorResponseV1", "partnerstack_vendor": "#/components/schemas/partnerstack_vendor_ConnectorResponseV1", "paychex": "#/components/schemas/paychex_ConnectorResponseV1", "paylocity": "#/components/schemas/paylocity_ConnectorResponseV1", "paypal": "#/components/schemas/paypal_ConnectorResponseV1", "paypal_sandbox": "#/components/schemas/paypal_sandbox_ConnectorResponseV1", "pendo": "#/components/schemas/pendo_ConnectorResponseV1", "pennylane": "#/components/schemas/pennylane_ConnectorResponseV1", "peopleforce": "#/components/schemas/peopleforce_ConnectorResponseV1", "persona": "#/components/schemas/persona_ConnectorResponseV1", "personio": "#/components/schemas/personio_ConnectorResponseV1", "phoenix_ads": "#/components/schemas/phoenix_ads_ConnectorResponseV1", "picqer": "#/components/schemas/picqer_ConnectorResponseV1", "pigment": "#/components/schemas/pigment_ConnectorResponseV1", "pingdom": "#/components/schemas/pingdom_ConnectorResponseV1", "pinpoint": "#/components/schemas/pinpoint_ConnectorResponseV1", "pinterest_ads": "#/components/schemas/pinterest_ads_ConnectorResponseV1", "pinterest_organic": "#/components/schemas/pinterest_organic_ConnectorResponseV1", "pipe17": "#/components/schemas/pipe17_ConnectorResponseV1", "pipedrive": "#/components/schemas/pipedrive_ConnectorResponseV1", "pivotal_tracker": "#/components/schemas/pivotal_tracker_ConnectorResponseV1", "piwik_pro": "#/components/schemas/piwik_pro_ConnectorResponseV1", "placerai": "#/components/schemas/placerai_ConnectorResponseV1", "planetscale": "#/components/schemas/planetscale_ConnectorResponseV1", "planful": "#/components/schemas/planful_ConnectorResponseV1", "planhat": "#/components/schemas/planhat_ConnectorResponseV1", "playvox": "#/components/schemas/playvox_ConnectorResponseV1", "playvox_workforce_management": "#/components/schemas/playvox_workforce_management_ConnectorResponseV1", "podio": "#/components/schemas/podio_ConnectorResponseV1", "poplar": "#/components/schemas/poplar_ConnectorResponseV1", "postgres": "#/components/schemas/postgres_ConnectorResponseV1", "postgres_rds": "#/components/schemas/postgres_rds_ConnectorResponseV1", "posthog": "#/components/schemas/posthog_ConnectorResponseV1", "postmark": "#/components/schemas/postmark_ConnectorResponseV1", "power_reviews_enterprise": "#/components/schemas/power_reviews_enterprise_ConnectorResponseV1", "prisma_cloud": "#/components/schemas/prisma_cloud_ConnectorResponseV1", "prive": "#/components/schemas/prive_ConnectorResponseV1", "procore": "#/components/schemas/procore_ConnectorResponseV1", "productboard": "#/components/schemas/productboard_ConnectorResponseV1", "productive": "#/components/schemas/productive_ConnectorResponseV1", "profound": "#/components/schemas/profound_ConnectorResponseV1", "proofpoint_security_awareness": "#/components/schemas/proofpoint_security_awareness_ConnectorResponseV1", "prosperstack": "#/components/schemas/prosperstack_ConnectorResponseV1", "purple_dot": "#/components/schemas/purple_dot_ConnectorResponseV1", "pylon_support_platform": "#/components/schemas/pylon_support_platform_ConnectorResponseV1", "qmatic_data_connect": "#/components/schemas/qmatic_data_connect_ConnectorResponseV1", "qualaroo": "#/components/schemas/qualaroo_ConnectorResponseV1", "qualtrics": "#/components/schemas/qualtrics_ConnectorResponseV1", "quickbooks": "#/components/schemas/quickbooks_ConnectorResponseV1", "quora_ads": "#/components/schemas/quora_ads_ConnectorResponseV1", "quorum": "#/components/schemas/quorum_ConnectorResponseV1", "rakutenadvertising": "#/components/schemas/rakutenadvertising_ConnectorResponseV1", "ramp": "#/components/schemas/ramp_ConnectorResponseV1", "rarible": "#/components/schemas/rarible_ConnectorResponseV1", "rebound_returns": "#/components/schemas/rebound_returns_ConnectorResponseV1", "recharge": "#/components/schemas/recharge_ConnectorResponseV1", "recurly": "#/components/schemas/recurly_ConnectorResponseV1", "reddit_ads": "#/components/schemas/reddit_ads_ConnectorResponseV1", "referralhero": "#/components/schemas/referralhero_ConnectorResponseV1", "refiner": "#/components/schemas/refiner_ConnectorResponseV1", "reltio": "#/components/schemas/reltio_ConnectorResponseV1", "replyio": "#/components/schemas/replyio_ConnectorResponseV1", "resource_management_by_smartsheet": "#/components/schemas/resource_management_by_smartsheet_ConnectorResponseV1", "retailnext": "#/components/schemas/retailnext_ConnectorResponseV1", "retently": "#/components/schemas/retently_ConnectorResponseV1", "revel": "#/components/schemas/revel_ConnectorResponseV1", "revenuecat": "#/components/schemas/revenuecat_ConnectorResponseV1", "reviewsai": "#/components/schemas/reviewsai_ConnectorResponseV1", "reviewsio": "#/components/schemas/reviewsio_ConnectorResponseV1", "revops": "#/components/schemas/revops_ConnectorResponseV1", "revx": "#/components/schemas/revx_ConnectorResponseV1", "ricochet360": "#/components/schemas/ricochet360_ConnectorResponseV1", "ringcentral": "#/components/schemas/ringcentral_ConnectorResponseV1", "ringover": "#/components/schemas/ringover_ConnectorResponseV1", "rippling": "#/components/schemas/rippling_ConnectorResponseV1", "rithum": "#/components/schemas/rithum_ConnectorResponseV1", "rivo": "#/components/schemas/rivo_ConnectorResponseV1", "rocketlane": "#/components/schemas/rocketlane_ConnectorResponseV1", "rokt": "#/components/schemas/rokt_ConnectorResponseV1", "rollbar": "#/components/schemas/rollbar_ConnectorResponseV1", "rootly": "#/components/schemas/rootly_ConnectorResponseV1", "rtb_house": "#/components/schemas/rtb_house_ConnectorResponseV1", "ruddr": "#/components/schemas/ruddr_ConnectorResponseV1", "rundeck": "#/components/schemas/rundeck_ConnectorResponseV1", "s3": "#/components/schemas/s3_ConnectorResponseV1", "s3_compatible_storage": "#/components/schemas/s3_compatible_storage_ConnectorResponseV1", "safebase": "#/components/schemas/safebase_ConnectorResponseV1", "safetyculture": "#/components/schemas/safetyculture_ConnectorResponseV1", "sage_hr": "#/components/schemas/sage_hr_ConnectorResponseV1", "sage_intacct": "#/components/schemas/sage_intacct_ConnectorResponseV1", "sailthru": "#/components/schemas/sailthru_ConnectorResponseV1", "salesforce": "#/components/schemas/salesforce_ConnectorResponseV1", "salesforce_commerce_cloud": "#/components/schemas/salesforce_commerce_cloud_ConnectorResponseV1", "salesforce_marketing_cloud": "#/components/schemas/salesforce_marketing_cloud_ConnectorResponseV1", "salesforce_sandbox": "#/components/schemas/salesforce_sandbox_ConnectorResponseV1", "salesloft": "#/components/schemas/salesloft_ConnectorResponseV1", "salsify": "#/components/schemas/salsify_ConnectorResponseV1", "samsara": "#/components/schemas/samsara_ConnectorResponseV1", "sana": "#/components/schemas/sana_ConnectorResponseV1", "sap_business_by_design": "#/components/schemas/sap_business_by_design_ConnectorResponseV1", "sap_hana_db": "#/components/schemas/sap_hana_db_ConnectorResponseV1", "sap_odata": "#/components/schemas/sap_odata_ConnectorResponseV1", "sap_oracle": "#/components/schemas/sap_oracle_ConnectorResponseV1", "sap_success_factors": "#/components/schemas/sap_success_factors_ConnectorResponseV1", "scorm": "#/components/schemas/scorm_ConnectorResponseV1", "security_journey": "#/components/schemas/security_journey_ConnectorResponseV1", "segment": "#/components/schemas/segment_ConnectorResponseV1", "sendgrid": "#/components/schemas/sendgrid_ConnectorResponseV1", "sentry": "#/components/schemas/sentry_ConnectorResponseV1", "servicenow": "#/components/schemas/servicenow_ConnectorResponseV1", "servicetitan": "#/components/schemas/servicetitan_ConnectorResponseV1", "servicetrade": "#/components/schemas/servicetrade_ConnectorResponseV1", "sevdesk": "#/components/schemas/sevdesk_ConnectorResponseV1", "sftp": "#/components/schemas/sftp_ConnectorResponseV1", "share_point": "#/components/schemas/share_point_ConnectorResponseV1", "shareasale": "#/components/schemas/shareasale_ConnectorResponseV1", "sharetribe": "#/components/schemas/sharetribe_ConnectorResponseV1", "shiphero": "#/components/schemas/shiphero_ConnectorResponseV1", "shipmonk": "#/components/schemas/shipmonk_ConnectorResponseV1", "shipnetwork": "#/components/schemas/shipnetwork_ConnectorResponseV1", "shipstation": "#/components/schemas/shipstation_ConnectorResponseV1", "shopify": "#/components/schemas/shopify_ConnectorResponseV1", "shopware": "#/components/schemas/shopware_ConnectorResponseV1", "shortcut": "#/components/schemas/shortcut_ConnectorResponseV1", "shortio": "#/components/schemas/shortio_ConnectorResponseV1", "showpad": "#/components/schemas/showpad_ConnectorResponseV1", "siemens_building_x_openness": "#/components/schemas/siemens_building_x_openness_ConnectorResponseV1", "sigma_computing_source": "#/components/schemas/sigma_computing_source_ConnectorResponseV1", "simplecast": "#/components/schemas/simplecast_ConnectorResponseV1", "simplesat": "#/components/schemas/simplesat_ConnectorResponseV1", "singlestore_source": "#/components/schemas/singlestore_source_ConnectorResponseV1", "sistrix": "#/components/schemas/sistrix_ConnectorResponseV1", "skilljar": "#/components/schemas/skilljar_ConnectorResponseV1", "skillstx": "#/components/schemas/skillstx_ConnectorResponseV1", "skimlinks": "#/components/schemas/skimlinks_ConnectorResponseV1", "skuvault": "#/components/schemas/skuvault_ConnectorResponseV1", "slab": "#/components/schemas/slab_ConnectorResponseV1", "slack": "#/components/schemas/slack_ConnectorResponseV1", "slack_admin_data": "#/components/schemas/slack_admin_data_ConnectorResponseV1", "slack_app": "#/components/schemas/slack_app_ConnectorResponseV1", "smadex": "#/components/schemas/smadex_ConnectorResponseV1", "smarthr": "#/components/schemas/smarthr_ConnectorResponseV1", "smartrecruiters": "#/components/schemas/smartrecruiters_ConnectorResponseV1", "smartsheet": "#/components/schemas/smartsheet_ConnectorResponseV1", "smartwaiver": "#/components/schemas/smartwaiver_ConnectorResponseV1", "snapchat_ads": "#/components/schemas/snapchat_ads_ConnectorResponseV1", "snowflake_db": "#/components/schemas/snowflake_db_ConnectorResponseV1", "snowplow": "#/components/schemas/snowplow_ConnectorResponseV1", "snyk": "#/components/schemas/snyk_ConnectorResponseV1", "solarwinds_service_desk": "#/components/schemas/solarwinds_service_desk_ConnectorResponseV1", "sonarqube": "#/components/schemas/sonarqube_ConnectorResponseV1", "sparkpost": "#/components/schemas/sparkpost_ConnectorResponseV1", "splash": "#/components/schemas/splash_ConnectorResponseV1", "splitio": "#/components/schemas/splitio_ConnectorResponseV1", "splunk": "#/components/schemas/splunk_ConnectorResponseV1", "spotify_ads": "#/components/schemas/spotify_ads_ConnectorResponseV1", "sprout": "#/components/schemas/sprout_ConnectorResponseV1", "sql_server": "#/components/schemas/sql_server_ConnectorResponseV1", "sql_server_hva": "#/components/schemas/sql_server_hva_ConnectorResponseV1", "sql_server_rds": "#/components/schemas/sql_server_rds_ConnectorResponseV1", "sql_server_sap_ecc_hva": "#/components/schemas/sql_server_sap_ecc_hva_ConnectorResponseV1", "square": "#/components/schemas/square_ConnectorResponseV1", "squarespace": "#/components/schemas/squarespace_ConnectorResponseV1", "stackadapt_graphql": "#/components/schemas/stackadapt_graphql_ConnectorResponseV1", "standard_metrics": "#/components/schemas/standard_metrics_ConnectorResponseV1", "starrez": "#/components/schemas/starrez_ConnectorResponseV1", "statistics_netherlands_cbs": "#/components/schemas/statistics_netherlands_cbs_ConnectorResponseV1", "statsig": "#/components/schemas/statsig_ConnectorResponseV1", "statuspage": "#/components/schemas/statuspage_ConnectorResponseV1", "stickyio": "#/components/schemas/stickyio_ConnectorResponseV1", "stripe": "#/components/schemas/stripe_ConnectorResponseV1", "stripe_test": "#/components/schemas/stripe_test_ConnectorResponseV1", "stylight": "#/components/schemas/stylight_ConnectorResponseV1", "subscript": "#/components/schemas/subscript_ConnectorResponseV1", "sugarcrm": "#/components/schemas/sugarcrm_ConnectorResponseV1", "survey_monkey": "#/components/schemas/survey_monkey_ConnectorResponseV1", "survicate": "#/components/schemas/survicate_ConnectorResponseV1", "swoogo": "#/components/schemas/swoogo_ConnectorResponseV1", "tableau_source": "#/components/schemas/tableau_source_ConnectorResponseV1", "taboola": "#/components/schemas/taboola_ConnectorResponseV1", "talkdesk": "#/components/schemas/talkdesk_ConnectorResponseV1", "talkwalker": "#/components/schemas/talkwalker_ConnectorResponseV1", "teads": "#/components/schemas/teads_ConnectorResponseV1", "teamtailor": "#/components/schemas/teamtailor_ConnectorResponseV1", "teamwork": "#/components/schemas/teamwork_ConnectorResponseV1", "tempo": "#/components/schemas/tempo_ConnectorResponseV1", "testrail": "#/components/schemas/testrail_ConnectorResponseV1", "textus": "#/components/schemas/textus_ConnectorResponseV1", "the_movie_database": "#/components/schemas/the_movie_database_ConnectorResponseV1", "the_trade_desk": "#/components/schemas/the_trade_desk_ConnectorResponseV1", "thinkific": "#/components/schemas/thinkific_ConnectorResponseV1", "ticket_tailor": "#/components/schemas/ticket_tailor_ConnectorResponseV1", "tiktok_ads": "#/components/schemas/tiktok_ads_ConnectorResponseV1", "tiktok_organic": "#/components/schemas/tiktok_organic_ConnectorResponseV1", "tiktok_organic_app": "#/components/schemas/tiktok_organic_app_ConnectorResponseV1", "tiktok_shop_partner_center": "#/components/schemas/tiktok_shop_partner_center_ConnectorResponseV1", "tive": "#/components/schemas/tive_ConnectorResponseV1", "toggl_track": "#/components/schemas/toggl_track_ConnectorResponseV1", "totango": "#/components/schemas/totango_ConnectorResponseV1", "tracksuit_source": "#/components/schemas/tracksuit_source_ConnectorResponseV1", "transcend": "#/components/schemas/transcend_ConnectorResponseV1", "trelica": "#/components/schemas/trelica_ConnectorResponseV1", "trello": "#/components/schemas/trello_ConnectorResponseV1", "tremendous": "#/components/schemas/tremendous_ConnectorResponseV1", "triple_whale": "#/components/schemas/triple_whale_ConnectorResponseV1", "trisolute": "#/components/schemas/trisolute_ConnectorResponseV1", "trustpilot": "#/components/schemas/trustpilot_ConnectorResponseV1", "twilio": "#/components/schemas/twilio_ConnectorResponseV1", "twitter": "#/components/schemas/twitter_ConnectorResponseV1", "twitter_ads": "#/components/schemas/twitter_ads_ConnectorResponseV1", "tymeshift": "#/components/schemas/tymeshift_ConnectorResponseV1", "typeform": "#/components/schemas/typeform_ConnectorResponseV1", "udemy_business": "#/components/schemas/udemy_business_ConnectorResponseV1", "ukg_pro": "#/components/schemas/ukg_pro_ConnectorResponseV1", "ukg_pro_workforce_management": "#/components/schemas/ukg_pro_workforce_management_ConnectorResponseV1", "unicommerce": "#/components/schemas/unicommerce_ConnectorResponseV1", "upland": "#/components/schemas/upland_ConnectorResponseV1", "uppromote": "#/components/schemas/uppromote_ConnectorResponseV1", "uptempo": "#/components/schemas/uptempo_ConnectorResponseV1", "uservoice": "#/components/schemas/uservoice_ConnectorResponseV1", "validio": "#/components/schemas/validio_ConnectorResponseV1", "veeqo": "#/components/schemas/veeqo_ConnectorResponseV1", "veeva_vault": "#/components/schemas/veeva_vault_ConnectorResponseV1", "venminder": "#/components/schemas/venminder_ConnectorResponseV1", "vimeo": "#/components/schemas/vimeo_ConnectorResponseV1", "visit_by_ges": "#/components/schemas/visit_by_ges_ConnectorResponseV1", "visma": "#/components/schemas/visma_ConnectorResponseV1", "vitally": "#/components/schemas/vitally_ConnectorResponseV1", "vonage_contact_center": "#/components/schemas/vonage_contact_center_ConnectorResponseV1", "vts": "#/components/schemas/vts_ConnectorResponseV1", "vwo": "#/components/schemas/vwo_ConnectorResponseV1", "walmart_dsp": "#/components/schemas/walmart_dsp_ConnectorResponseV1", "walmart_marketplace": "#/components/schemas/walmart_marketplace_ConnectorResponseV1", "web_scraper": "#/components/schemas/web_scraper_ConnectorResponseV1", "webconnex": "#/components/schemas/webconnex_ConnectorResponseV1", "webhooks": "#/components/schemas/webhooks_ConnectorResponseV1", "when_i_work": "#/components/schemas/when_i_work_ConnectorResponseV1", "wherefour": "#/components/schemas/wherefour_ConnectorResponseV1", "wicked_reports": "#/components/schemas/wicked_reports_ConnectorResponseV1", "woocommerce": "#/components/schemas/woocommerce_ConnectorResponseV1", "wordpress": "#/components/schemas/wordpress_ConnectorResponseV1", "workable": "#/components/schemas/workable_ConnectorResponseV1", "workday": "#/components/schemas/workday_ConnectorResponseV1", "workday_adaptive": "#/components/schemas/workday_adaptive_ConnectorResponseV1", "workday_financial_management": "#/components/schemas/workday_financial_management_ConnectorResponseV1", "workday_hcm": "#/components/schemas/workday_hcm_ConnectorResponseV1", "workday_strategic_sourcing": "#/components/schemas/workday_strategic_sourcing_ConnectorResponseV1", "workleap_officevibe": "#/components/schemas/workleap_officevibe_ConnectorResponseV1", "workramp": "#/components/schemas/workramp_ConnectorResponseV1", "wrike": "#/components/schemas/wrike_ConnectorResponseV1", "writesonic": "#/components/schemas/writesonic_ConnectorResponseV1", "xactly": "#/components/schemas/xactly_ConnectorResponseV1", "xandr": "#/components/schemas/xandr_ConnectorResponseV1", "xero": "#/components/schemas/xero_ConnectorResponseV1", "xray": "#/components/schemas/xray_ConnectorResponseV1", "xsolla": "#/components/schemas/xsolla_ConnectorResponseV1", "yahoo_display_ads_on_yahoo_japan": "#/components/schemas/yahoo_display_ads_on_yahoo_japan_ConnectorResponseV1", "yahoo_dsp": "#/components/schemas/yahoo_dsp_ConnectorResponseV1", "yahoo_gemini": "#/components/schemas/yahoo_gemini_ConnectorResponseV1", "yahoo_search_ads_yahoo_japan": "#/components/schemas/yahoo_search_ads_yahoo_japan_ConnectorResponseV1", "yext": "#/components/schemas/yext_ConnectorResponseV1", "yotpo": "#/components/schemas/yotpo_ConnectorResponseV1", "yougov_brandindex": "#/components/schemas/yougov_brandindex_ConnectorResponseV1", "yougov_sport": "#/components/schemas/yougov_sport_ConnectorResponseV1", "younium": "#/components/schemas/younium_ConnectorResponseV1", "youtube_analytics": "#/components/schemas/youtube_analytics_ConnectorResponseV1", "zendesk": "#/components/schemas/zendesk_ConnectorResponseV1", "zendesk_chat": "#/components/schemas/zendesk_chat_ConnectorResponseV1", "zendesk_sell": "#/components/schemas/zendesk_sell_ConnectorResponseV1", "zendesk_sunshine": "#/components/schemas/zendesk_sunshine_ConnectorResponseV1", "zendesk_workforce_management": "#/components/schemas/zendesk_workforce_management_ConnectorResponseV1", "zenefits": "#/components/schemas/zenefits_ConnectorResponseV1", "zingtree": "#/components/schemas/zingtree_ConnectorResponseV1", "zip": "#/components/schemas/zip_ConnectorResponseV1", "zoho_books": "#/components/schemas/zoho_books_ConnectorResponseV1", "zoho_campaigns": "#/components/schemas/zoho_campaigns_ConnectorResponseV1", "zoho_crm": "#/components/schemas/zoho_crm_ConnectorResponseV1", "zoho_desk": "#/components/schemas/zoho_desk_ConnectorResponseV1", "zoho_inventory": "#/components/schemas/zoho_inventory_ConnectorResponseV1", "zoho_people": "#/components/schemas/zoho_people_ConnectorResponseV1", "zoho_recruit": "#/components/schemas/zoho_recruit_ConnectorResponseV1", "zonka_feedback": "#/components/schemas/zonka_feedback_ConnectorResponseV1", "zoom": "#/components/schemas/zoom_ConnectorResponseV1", "zuora": "#/components/schemas/zuora_ConnectorResponseV1", "zuora_sandbox": "#/components/schemas/zuora_sandbox_ConnectorResponseV1" } } }, "ConnectorSchedule": { "type": "object", "properties": { "cron": { "type": "string", "description": "A UNIX cron expression defining the sync schedule. Set when `schedule_type` is `CRON`.", "example": "0 */6 * * *" }, "interval": { "type": "integer", "description": "The sync interval in minutes. Set when `schedule_type` is `INTERVAL`.", "format": "int32", "example": 360 }, "schedule_type": { "type": "string", "description": "The type of sync schedule. Determines which other `schedule` fields are populated. Possible values: `INTERVAL` - syncs repeat on a fixed cadence; `interval` is set. `TIME_OF_DAY` - syncs run at a specific time on the configured `days_of_week`; `time_of_day` is set. `CRON` - syncs run on a cron expression (requires an Enterprise or Business Critical plan); `cron` is set. `MANUAL` - automatic scheduling is disabled; syncs run only when triggered via the Sync Connection endpoint; `days_of_week` and `interval` are not set.", "example": "INTERVAL", "enum": [ "TIME_OF_DAY", "INTERVAL", "CRON", "MANUAL" ] }, "days_of_week": { "uniqueItems": true, "type": "array", "description": "The days of the week on which the connection can sync. Set only when `schedule_type` is `INTERVAL` or `TIME_OF_DAY`. When omitted or empty in the request with these schedule types set, the connection syncs on all days.", "example": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "items": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } }, "time_of_day": { "type": "string", "description": "The time of day at which the connection syncs, in `HH:MM` format. Interpreted in the destination group's configured UTC offset. Set when `schedule_type` is `TIME_OF_DAY`.", "example": "14:00" } } }, "ConnectorStatusResponse": { "required": [ "is_historical_sync", "setup_state", "sync_state", "update_state" ], "type": "object", "properties": { "tasks": { "type": "array", "description": "The collection of tasks for the connection", "items": { "$ref": "#/components/schemas/ConnectionTask" } }, "warnings": { "type": "array", "description": "The collection of warnings for the connection", "items": { "$ref": "#/components/schemas/ConnectionWarning" } }, "setup_state": { "type": "string", "description": "The current setup state of the connection. The available values are:
- incomplete - the setup config is incomplete, the setup tests never succeeded
- connected - the connection is properly set up
- broken - the connection setup config is broken.", "example": "connected" }, "schema_status": { "type": "string", "description": "Schema status. Returned only for connectors that support [Universal Column Masking flow](https://fivetran.com/docs/rest-api/tutorials/schema-status).", "example": "ready" }, "sync_state": { "type": "string", "description": "The current sync state of the connection. The available values are:
- scheduled - the sync is waiting to be run
- syncing - the sync is currently running
- paused - the sync is currently paused
- rescheduled - the sync is waiting until more API calls are available in the source service.", "example": "scheduled" }, "update_state": { "type": "string", "description": "The current data update state of the connection. The available values are:
- on_schedule - the sync is running smoothly, no delays
- delayed - the data is delayed for a longer time than expected for the update.", "example": "delayed" }, "is_historical_sync": { "type": "boolean", "description": "The boolean specifying whether the connection should be triggered to re-sync all historical data. If you set this parameter to TRUE, a [historical sync](https://fivetran.com/docs/getting-started/glossary#historicalsync) starts immediately. If a sync is currently running, it's canceled and restarted as a historical sync. All subsequent syncs after the historical sync completes will be incremental. If the value is FALSE or not specified, the connection doesn't re-sync historical data. This parameter is automatically reset to FALSE once the historical sync is completed.", "example": false }, "rescheduled_for": { "type": "string", "description": "The UTC timestamp of the next scheduled sync attempt. Non-null only when `sync_state` is `\"rescheduled\"`. If `schedule_type` is `manual`, the connection expects the sync to be triggered at the designated time through the [Sync Connection Data](https://fivetran.com/docs/rest-api/api-reference/connections/sync-connection) endpoint.", "format": "date-time", "example": "2024-12-01T15:43:29.013729Z" } } }, "SetupTestResultResponse": { "required": [ "status", "title" ], "type": "object", "properties": { "title": { "type": "string", "description": "A human-readable name for the setup test step. For example: Validate Login, Test Connection, Check Permissions.", "example": "Validate Login" }, "status": { "type": "string", "description": "The result of the individual setup test step. Possible values: PASSED, FAILED, SKIPPED.", "example": "FAILED", "enum": [ "PASSED", "SKIPPED", "WARNING", "FAILED", "JOB_FAILED" ] }, "message": { "type": "string", "description": "The result message for the setup test step. For example: Invalid login credentials.", "example": "Invalid login credentials." }, "details": { "type": "object", "description": "Additional diagnostic information about the setup test result. Populated when the status is FAILED and more context is available beyond the message.", "example": "Authentication failed (401 Unauthorized). Verify the provided credentials and permissions." } } }, "ConnectorConnectCardResponse": { "required": [ "connector_id" ], "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connection for which this Connect Card token was issued. This is the same value as the `connectionId` path parameter.", "example": "connection_id" }, "connect_card": { "$ref": "#/components/schemas/ConnectCardResponse" }, "connect_card_config": { "$ref": "#/components/schemas/ConnectCardConfig" } } }, "MoveConnectionJobResponse": { "required": [ "connection_id", "created_at", "destination_group_id", "id", "source_group_id", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the move job. Use this value to check the status of the move operation.", "example": "01234567-89ab-cdef-0123-456789abcdef" }, "status": { "type": "string", "description": "The current status of the move job. Possible values: PENDING, IN_PROGRESS, SUCCESS, FAILED.", "example": "IN_PROGRESS", "enum": [ "PENDING", "IN_PROGRESS", "SUCCESS", "FAILED" ] }, "connection_id": { "type": "string", "description": "The unique identifier of the connection that was moved.", "example": "connection_id" }, "source_group_id": { "type": "string", "description": "The unique identifier of the destination group the connection was moved from.", "example": "source_group_id" }, "destination_group_id": { "type": "string", "description": "The unique identifier of the destination group to move the connection to. Retrieve group IDs from the [List All Groups](https://fivetran.com/docs/rest-api/api-reference/groups/list-all-groups) endpoint.", "example": "destination_group_id" }, "created_at": { "type": "string", "description": "The timestamp of when the move job was created.", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "started_at": { "type": "string", "description": "The timestamp of when the move job started processing. Null if the job has not started yet.", "format": "date-time", "example": "2024-01-01T00:00:30Z" }, "completed_at": { "type": "string", "description": "The timestamp of when the move job completed (successfully or with failure). Null if the job has not completed yet.", "format": "date-time", "example": "2024-01-01T00:05:00Z" }, "error_message": { "type": "string", "description": "The error message if the move job failed. Null if the job has not failed.", "example": "Error details if the job failed" } } }, "ConnectorStateResponse": { "required": [ "state" ], "type": "object", "properties": { "state": { "type": "object", "description": "A freeform JSON object representing the connector's cursor or internal state. The structure is defined by the connector implementation and varies by connector type. Returns 400 if no state has been written yet.", "example": { "cursor": "2024-01-01T00:00:00Z" } } } }, "ConnectorSyncHistoryResponse": { "required": [ "stages", "status", "sync_id" ], "type": "object", "properties": { "start": { "type": "string", "description": "The UTC timestamp of when the sync started, in ISO 8601 format. Null if the sync has not started yet." }, "end": { "type": "string", "description": "The UTC timestamp of when the sync finished, in ISO 8601 format. Null if the sync is still in progress." }, "status": { "type": "string", "description": "The outcome of the sync. Possible values: `COMPLETED`, `FAILURE`, `CANCELED`, `INCOMPLETE`, `RESCHEDULED`, `PAUSED`." }, "reason": { "type": "string", "description": "The failure reason if the sync did not complete successfully. Omitted if the sync completed without errors." }, "stages": { "description": "The data volume processed in each stage of the sync pipeline.", "allOf": [ { "$ref": "#/components/schemas/Stages" } ] }, "sync_id": { "type": "string", "description": "The unique identifier of the sync." } } }, "Stage": { "type": "object", "properties": { "volume": { "type": "number", "description": "The volume of data processed in this stage, in megabytes. Null if volume data is not available for this stage.", "format": "double" } } }, "Stages": { "type": "object", "properties": { "extract": { "description": "Data volume metrics for the extract stage, in which data is read from the source system.", "allOf": [ { "$ref": "#/components/schemas/Stage" } ] }, "process": { "description": "Data volume metrics for the process stage, in which data is transformed and prepared for loading.", "allOf": [ { "$ref": "#/components/schemas/Stage" } ] }, "load": { "description": "Data volume metrics for the load stage, in which data is written to the destination.", "allOf": [ { "$ref": "#/components/schemas/Stage" } ] } } }, "ConnectionWarningItem": { "required": [ "code", "created_at", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "A machine-readable identifier for the condition type. Use this value to programmatically detect and respond to specific connection conditions." }, "message": { "type": "string", "description": "A human-readable label describing the condition. For example: Reconnect, Resync Table Warning." }, "error_message": { "type": "string", "description": "Additional error details extracted from the warning", "example": "Connection refused" }, "created_at": { "type": "string", "description": "ISO 8601 timestamp when the warning was created", "format": "date-time", "example": "2024-03-17T12:31:40.870504Z" } } }, "ConnectionWarningsResponse": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "description": "Array of warnings grouped by destination table", "items": { "$ref": "#/components/schemas/TableWarnings" } }, "next_cursor": { "type": "string", "description": "Pagination cursor for the next page of results", "example": "next_cursor_value" } } }, "TableWarnings": { "required": [ "warnings" ], "type": "object", "properties": { "schema": { "type": "string", "description": "The destination schema name. Omitted for warnings that are not scoped to a specific table.", "example": "my_schema" }, "table": { "type": "string", "description": "The destination table name. Omitted for warnings that are not scoped to a specific table.", "example": "my_table" }, "warnings": { "type": "array", "description": "List of warnings for this table", "items": { "$ref": "#/components/schemas/ConnectionWarningItem" } } } }, "ConnectorResponse": { "required": [ "connected_by", "created_at", "group_id", "id", "pause_after_trial", "paused", "schedule_type", "schema", "service", "status", "sync_frequency" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the group within the Fivetran system.", "example": "connection_id" }, "service": { "type": "string", "description": "The name for the connector type within the Fivetran system.", "example": "google_sheets" }, "schema": { "type": "string", "description": "The name used both as the connection's name within the Fivetran system and as the source schema's name within your destination.", "example": "gsheets.table" }, "paused": { "type": "boolean", "description": "Specifies whether the connection is paused.", "example": false }, "status": { "description": "The current state of the connection. ", "allOf": [ { "$ref": "#/components/schemas/ConnectorStatusResponse" } ] }, "config": { "type": "object", "additionalProperties": { "type": "object" }, "description": "The connection setup configuration." }, "schedule": { "$ref": "#/components/schemas/ConnectorSchedule" }, "group_id": { "type": "string", "description": "The unique identifier for the group within the Fivetran system.", "example": "group_id" }, "service_version": { "type": "integer", "description": "The connector type version within the Fivetran system.", "format": "int32", "example": 0 }, "connected_by": { "type": "string", "description": "The unique identifier of the user who has created the connection in your account.", "example": "user_id" }, "created_at": { "type": "string", "description": "The timestamp of when the group was created in your account.", "format": "date-time", "example": "2024-12-01T15:43:29.013729Z" }, "succeeded_at": { "type": "string", "description": "The timestamp of the time the connection sync succeeded last time.", "format": "date-time", "example": "2024-12-01T15:43:29.013729Z" }, "failed_at": { "type": "string", "description": "The timestamp of the time the connection sync failed last time.", "format": "date-time", "example": "2024-12-01T15:43:29.013729Z" }, "pause_after_trial": { "type": "boolean", "description": "Specifies whether the connection should be paused after the free trial period has ended.", "example": false }, "sync_frequency": { "type": "integer", "description": "The connection sync frequency in minutes. `null` when the connection's schedule has no single cadence to report, such as a custom cron or multiple-time-of-day schedule.", "format": "int32", "example": 360 }, "data_delay_threshold": { "type": "integer", "format": "int32" }, "data_delay_sensitivity": { "type": "string", "enum": [ "LOW", "NORMAL", "HIGH", "CUSTOM", "SYNC_FREQUENCY" ] }, "daily_sync_time": { "type": "string", "description": "The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use the baseline sync start time. This parameter has no effect on the 0 to 60 minutes offset used to determine the actual sync start time.", "example": "14:00" }, "schedule_type": { "type": "string", "description": "The connection schedule config type. Supported values: auto, manual. Lets you disable or enable an automatic data sync on a schedule.", "example": "auto" }, "setup_tests": { "type": "array", "description": "Setup tests results", "items": { "$ref": "#/components/schemas/SetupTestResultResponse" } }, "private_link_id": { "type": "string" }, "networking_method": { "type": "string", "enum": [ "Directly", "SshTunnel", "PrivateLink", "ProxyAgent", "UnmanagedProxyAgent", "Unknown" ] }, "proxy_agent_id": { "type": "string" }, "source_sync_details": { "type": "object", "description": "Read-only, connector-specific sync state. Depending on the connector type, this object may include source scope identifiers such as accounts, profiles, or projects; per-entity cursors or checkpoints; or last-synced timestamps. This field is optional, and its schema varies by connector type. To determine whether a connector exposes this information and inspect its returned fields, use [Retrieve Connection Details](https://fivetran.com/docs/rest-api/api-reference/connections/connection-details)." }, "hybrid_deployment_agent_id": { "type": "string" }, "connect_card": { "$ref": "#/components/schemas/ConnectCardResponse" }, "connect_card_config": { "$ref": "#/components/schemas/ConnectCardConfig" }, "destination_configuration": { "$ref": "#/components/schemas/DestinationConfiguration" }, "destination_schema_names": { "type": "string", "enum": [ "FIVETRAN_NAMING", "SOURCE_NAMING" ] }, "external_secrets_manager_id": { "type": "string" }, "external_secrets_keys_config": { "type": "object", "additionalProperties": { "type": "string" } }, "data_checks": { "type": "boolean" } } }, "MoveConnectionsResponse": { "required": [ "connection_id", "destination_group_id", "source_group_id", "sync_behavior" ], "type": "object", "properties": { "connection_id": { "type": "string", "description": "The unique identifier of the connection that was moved.", "example": "connection_id" }, "source_group_id": { "type": "string", "description": "The unique identifier of the destination group the connection was moved from.", "example": "source_group_id" }, "destination_group_id": { "type": "string", "description": "The unique identifier of the destination group to move the connection to. Retrieve group IDs from the [List All Groups](https://fivetran.com/docs/rest-api/api-reference/groups/list-all-groups) endpoint.", "example": "destination_group_id" }, "sync_behavior": { "type": "string", "description": "Controls how data syncs after the move. Use `CONTINUE` to preserve the existing sync cursor so the connection resumes incremental sync from where it left off. Use `BACKFILL` to reset the cursor and trigger a historical sync. Use `CONTINUE_WITH_DATA` to preserve the cursor and additionally migrate existing data to the new destination by starting an asynchronous job—use the `job_id` returned in the response to monitor progress. `CONTINUE_WITH_DATA` is supported only when moving a connection from Snowflake Native tables to a MDLS-linked Snowflake Lakehouse destination.", "example": "CONTINUE", "enum": [ "CONTINUE", "BACKFILL", "CONTINUE_WITH_DATA" ] }, "moved_at": { "type": "string", "description": "The timestamp of when the connection was moved. Null when `sync_behavior` is `CONTINUE_WITH_DATA` (since the move runs asynchronously).", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "job_id": { "type": "string", "description": "The unique identifier of the move job. Use this value to check the status of the move operation.", "example": "01234567-89ab-cdef-0123-456789abcdef" } } }, "ConnectorSyncTriggerResponse": { "required": [ "result" ], "type": "object", "properties": { "result": { "type": "string", "description": "The result of starting a connection sync. Available values are:\n- `STARTED` – the sync started successfully.\n- `PAUSED` – the sync has not started because the connection is paused.\n- `INCOMPLETE` – the sync has not started because the connection setup is incomplete.\n- `ALREADY_RUNNING` – the sync has not started because it is already running.\n- `NOT_STARTED` – the sync has not started without a specific reason.", "example": "STARTED", "enum": [ "STARTED", "PAUSED", "INCOMPLETE", "ALREADY_RUNNING", "NOT_STARTED" ] } } }, "DropColumnSchemaRequest": { "required": [ "tables" ], "type": "object", "properties": { "tables": { "title": "Tables", "type": "object", "properties": { "table": { "$ref": "#/components/schemas/DropColumnsTableRequest" } }, "description": "The set of tables within your database schema config. Each key is the table name as stored in the connection schema config. Table names are case-sensitive; an incorrect case results in an HTTP 404 error." } } }, "DropColumnsRequest": { "required": [ "schemas" ], "type": "object", "properties": { "schemas": { "title": "Schemas", "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/DropColumnSchemaRequest" } }, "description": "The set of schemas within your connection schema config. Each key is the schema name as stored in the connection schema config. Schema names are case-sensitive; an incorrect case results in an HTTP 404 error." } } }, "DropColumnsTableRequest": { "required": [ "columns" ], "type": "object", "properties": { "columns": { "type": "array", "description": "The set of columns within your table schema config. Each key is the column name as stored in the connection schema config. Column names are case-sensitive; an incorrect case results in an HTTP 404 error. The `columns` object in the response contains the columns whose `enabled` value has been set by the user after the initial sync.", "items": { "type": "string" } } } }, "ColumnUpdateRequest": { "required": [ "enabled" ], "type": "object", "properties": { "enabled": { "type": "boolean", "description": "The boolean value specifying whether the sync for the table into the destination is enabled.", "example": true }, "hashed": { "type": "boolean", "description": "The boolean value specifying whether a column should be hashed", "example": false }, "is_primary_key": { "type": "boolean" }, "target_data_type": { "type": "string", "description": "The target data type for this column in the destination. Overrides Fivetran's default type mapping. Available target types depend on the column's source data type and destination. Set to null to remove an existing mapping and revert to the default.", "example": "String", "enum": [ "Unknown", "Boolean", "String", "Short", "Int", "Long", "Float", "Double", "BigDecimal", "Instant", "LocalDateTime", "LocalDate", "LocalTime", "Json", "Binary", "Xml" ] } } }, "RowFilterClauseDto": { "required": [ "columnType", "operator", "values" ], "type": "object", "properties": { "column": { "maxLength": 500, "minLength": 0, "type": "string", "description": "The name of the source column the clause applies to. Maximum 500 characters.", "example": "status" }, "operator": { "type": "string", "description": "The operator applied to the column. The operator must be compatible with `column_type`, and the number of `values` required depends on the operator:
- `EQUALS`, `NOT_EQUALS` - valid for `LONG`, `FLOAT`, `DOUBLE`, `BIGDECIMAL`, `DATE`, `DATETIME`, and `STRING`; require exactly 1 value.
- `LESS`, `LESS_OR_EQUALS`, `GREATER`, `GREATER_OR_EQUALS` - valid for `LONG`, `FLOAT`, `DOUBLE`, `BIGDECIMAL`, `DATE`, `DATETIME`, and `STRING`; require exactly 1 value.
- `STARTS_WITH`, `CONTAINS` - valid for `STRING` only; require exactly 1 value.
- `IN` - valid for `LONG`, `STRING`, `FLOAT`, and `DOUBLE` only; require at least 1 value.
- `IS_NULL`, `IS_NOT_NULL` - valid for all types; require no values.", "example": "EQUALS", "enum": [ "EQUALS", "NOT_EQUALS", "LESS", "LESS_OR_EQUALS", "GREATER", "GREATER_OR_EQUALS", "STARTS_WITH", "CONTAINS", "IN", "IS_NULL", "IS_NOT_NULL" ] }, "values": { "type": "array", "description": "The list of values the operator compares against. Each value is a string of at most 1,000 characters; the API parses it according to column_type. The number of values must match the operator: exactly 1 for the comparison and string operators, at least 1 for `IN`, and 0 for `IS_NULL` and `IS_NOT_NULL`. For the `IN` operator on a STRING column, the combined length of all values must not exceed 10,000 characters.", "example": [ "ACTIVE" ], "items": { "maxLength": 1000, "minLength": 0, "type": "string" } }, "column_type": { "type": "string", "description": "The data type of the column. It determines which operators are valid and the required format of each value:
- `LONG` - integer types (short, int, long).
- `FLOAT` - single-precision floating-point number.
- `DOUBLE` - double-precision floating-point number.
- `BIGDECIMAL` - arbitrary-precision decimal number; each value is capped at 50 characters.
- `STRING` - text.
- `BOOLEAN` - accepts only the string values `true` or `false` (lowercase).
- `DATE` - a date with no time component, in `yyyy-MM-dd` format (for example, `2024-01-01`).
- `DATETIME` - a UTC timestamp ending in `Z`, in `yyyy-MM-ddTHH:mm:ssZ` format (for example, `2024-01-01T00:00:00Z`). Offsets other than `Z` are not accepted.", "example": "STRING", "enum": [ "LONG", "FLOAT", "DOUBLE", "BIGDECIMAL", "STRING", "BOOLEAN", "DATE", "DATETIME" ] } } }, "RowFilterDto": { "type": "object", "properties": { "name": { "type": "string", "description": "A human-readable name for the row filter. Required when a row filter object is provided (upsert).", "example": "active_orders" }, "description": { "type": "string", "description": "A human-readable description for the row filter. Required when a row filter object is provided (upsert).", "example": "Sync only active orders" }, "operator": { "type": "string", "description": "The logical operator applied to the column clauses. `AND` means a row is synced only when it satisfies every clause; `OR` means a row is synced when it satisfies at least one clause. If omitted, defaults to `AND`. Only valid when `column_clauses` contains 2 or more clauses; setting it explicitly on a single-clause filter returns an error. For a single-clause filter, omit this field.", "example": "AND", "enum": [ "AND", "OR" ] }, "column_clauses": { "maxItems": 10, "minItems": 0, "type": "array", "description": "The list of column clauses that make up the row filter. Clauses are combined according to the `operator` field (defaults to AND when omitted). The list must contain 1 to 10 clauses. If `operator` is explicitly set to `AND` or `OR`, the list must contain at least 2 clauses; for a single-clause filter, omit `operator` rather than setting it explicitly.", "items": { "$ref": "#/components/schemas/RowFilterClauseDto" } } }, "nullable": true }, "SchemaUpdateRequest": { "required": [ "enabled" ], "type": "object", "properties": { "enabled": { "type": "boolean", "description": "The boolean value specifying whether the sync for the table into the destination is enabled.", "example": true }, "tables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TableUpdateRequest" }, "description": "The set of tables within your database schema config. Each key is the table name as stored in the connection schema config. Table names are case-sensitive; an incorrect case results in an HTTP 404 error." } } }, "StandardConfigCreateRequest": { "required": [ "schemas" ], "type": "object", "properties": { "schemas": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SchemaUpdateRequest" }, "description": "The set of schemas within your connection schema config. Each key is the schema name as stored in the connection schema config. Schema names are case-sensitive; an incorrect case results in an HTTP 404 error.", "example": { "schema_name": { "enabled": true, "tables": { "table_name": { "enabled": true, "columns": { "column_name": { "enabled": true } } } } } } }, "schema_change_handling": { "type": "string", "description": "The possible values for the schema_change_handling parameter are as follows:
- `ALLOW_ALL` - all new schemas, tables, and columns which appear in the source after the initial setup are included in syncs
- `ALLOW_COLUMNS` - all new schemas and tables which appear in the source after the initial setup are excluded from syncs, but new columns are included
- `BLOCK_ALL` - all new schemas, tables, and columns which appear in the source after the initial setup are excluded from syncs", "example": "ALLOW_COLUMNS", "enum": [ "ALLOW_ALL", "ALLOW_COLUMNS", "BLOCK_ALL" ] } } }, "TableUpdateRequest": { "required": [ "enabled" ], "type": "object", "properties": { "enabled": { "type": "boolean", "description": "The boolean value specifying whether the sync for the table into the destination is enabled.", "example": true }, "columns": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ColumnUpdateRequest" }, "description": "The set of columns within your table schema config. Each key is the column name as stored in the connection schema config. Column names are case-sensitive; an incorrect case results in an HTTP 404 error. The `columns` object in the response contains the columns whose `enabled` value has been set by the user after the initial sync." }, "sync_mode": { "type": "string", "description": "This field appears in the response if the connection supports switching sync modes for tables", "example": "SOFT_DELETE", "enum": [ "SOFT_DELETE", "HISTORY", "LIVE" ] }, "row_filter": { "description": "The [row filter](/docs/core-concepts/features/row-filter) for the table. A row filter restricts the rows synced to your destination to those that satisfy its clauses. This field uses three-state semantics:
- `Absent` (the `row_filter` key is omitted from the request): The table's existing row filter is left unchanged.
- `null` (the `row_filter` key is present with a JSON null value): The table's existing row filter, if any, is deleted.
- `Object`: The provided object creates or replaces (upserts) the table's existing row filter.
Row filtering must be available for the connection; see the `row_filtering_supported` response field.", "example": { "name": "active_us_orders", "description": "Sync only active orders created on or after 2024 for US and Canadian customers", "column_clauses": [ { "column": "status", "column_type": "STRING", "operator": "EQUALS", "values": [ "ACTIVE" ] }, { "column": "country", "column_type": "STRING", "operator": "IN", "values": [ "US", "CA" ] }, { "column": "created_at", "column_type": "DATETIME", "operator": "GREATER_OR_EQUALS", "values": [ "2024-01-01T00:00:00Z" ] } ] }, "allOf": [ { "$ref": "#/components/schemas/RowFilterDto" } ] } } }, "ReloadStandardConfigRequest": { "type": "object", "properties": { "exclude_mode": { "type": "string", "description": "Specifies whether all schemas and tables will be enabled or disabled in the standard config. By specifying the `exclude_mode` parameter value, you can enable or disable syncing for all schemas and tables when reloading the connection schema config.\n\nWhen the default `PRESERVE` value is set, all selected schemas and tables in the standard config preserve their state.\n\nWhen the `EXCLUDE` value is set, the columns that haven't been updated by user yet are not excluded from the sync. Such columns may be present in the source and not displayed in the response, but they are considered to be included in the sync by default. If you enable syncing of their table, then all of these columns from the source will be synced in the next sync cycle. See also [Troubleshooting: How to enable syncs only for the columns you need](https://fivetran.com/docs/rest-api/tutorials/enable-sync-for-columns-you-need).\n", "example": "PRESERVE" } } }, "StandardConfigUpdateRequest": { "type": "object", "properties": { "schemas": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SchemaUpdateRequest" }, "description": "The set of schemas within your connection schema config. Each key is the schema name as stored in the connection schema config. Schema names are case-sensitive; an incorrect case results in an HTTP 404 error.", "example": { "schema_name": { "enabled": true, "tables": { "table_name": { "enabled": true, "columns": { "column_name": { "enabled": true } } } } } } }, "schema_change_handling": { "type": "string", "description": "The possible values for the schema_change_handling parameter are as follows:
- `ALLOW_ALL` - all new schemas, tables, and columns which appear in the source after the initial setup are included in syncs
- `ALLOW_COLUMNS` - all new schemas and tables which appear in the source after the initial setup are excluded from syncs, but new columns are included
- `BLOCK_ALL` - all new schemas, tables, and columns which appear in the source after the initial setup are excluded from syncs", "example": "BLOCK_ALL", "enum": [ "ALLOW_ALL", "ALLOW_COLUMNS", "BLOCK_ALL" ] }, "is_type_locked": { "type": "boolean", "description": "The boolean value specifying whether the connection's destination data types are locked to the types determined from the source. If enabled before or immediately after the initial sync, the [type lock](https://fivetran.com/docs/using-fivetran/features/type-locking) captures the types determined at the initial sync; if enabled later, it captures the types determined on the first sync after enabling. Re-enabling an already-enabled lock does not change previously locked types.", "example": false } } }, "ColumnConfigResponse": { "required": [ "enabled", "enabled_patch_settings", "hashed", "name_in_destination" ], "type": "object", "properties": { "name_in_destination": { "type": "string", "description": "The schema name within your destination in accordance with Fivetran conventional rules", "example": "email_address" }, "enabled": { "type": "boolean", "description": "The boolean value specifying whether the sync for the table into the destination is enabled.", "example": true }, "hashed": { "type": "boolean", "description": "The boolean value specifying whether a column should be hashed", "example": false }, "enabled_patch_settings": { "$ref": "#/components/schemas/ColumnEnabledPatchSettings" }, "is_primary_key": { "type": "boolean" }, "target_data_type": { "type": "string", "description": "The target data type for this column in the destination. Overrides Fivetran's default type mapping. Available target types depend on the column's source data type and destination. Set to null to remove an existing mapping and revert to the default.", "example": "String" } } }, "ColumnEnabledPatchSettings": { "required": [ "allowed" ], "type": "object", "properties": { "allowed": { "type": "boolean", "description": "The boolean value specifying whether the enabled property can be updated", "example": false }, "reason": { "type": "string", "description": "The additional message indicating the reason why the enabled property cannot be updated. This field appears in the response only when the reason_code value is OTHER", "example": "..." }, "reason_code": { "type": "string", "description": "The reason code indicating the reason why the enabled property cannot be updated:
SYSTEM_TABLE - the table is a system table
DELETED - the table was deleted in the source
OTHER - the table was excluded by the system for some reason
This field appears in the response when the allowed property value is FALSE", "example": "SYSTEM_COLUMN", "enum": [ "SYSTEM_COLUMN", "DELETED", "OTHER" ] } } }, "SchemaConfigResponse": { "required": [ "enabled", "name_in_destination", "tables" ], "type": "object", "properties": { "name_in_destination": { "type": "string", "description": "The schema name within your destination in accordance with Fivetran conventional rules", "example": "schema_name_in_destination" }, "enabled": { "type": "boolean", "description": "The boolean value specifying whether the sync for the table into the destination is enabled.", "example": true }, "tables": { "title": "Tables", "type": "object", "properties": { "table": { "$ref": "#/components/schemas/TableConfigResponse" } }, "description": "The set of tables within your database schema config. Each key is the table name as stored in the connection schema config. Table names are case-sensitive; an incorrect case results in an HTTP 404 error." } } }, "StandardConfigResponse": { "required": [ "schema_change_handling", "schemas" ], "type": "object", "properties": { "enable_new_by_default": { "type": "boolean", "description": "The boolean value specifying whether to enable new schemas, tables, and columns by default", "example": true }, "schemas": { "title": "Schemas", "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/SchemaConfigResponse" } }, "description": "The set of schemas within your connection schema config. Each key is the schema name as stored in the connection schema config. Schema names are case-sensitive; an incorrect case results in an HTTP 404 error." }, "row_filtering_supported": { "type": "boolean", "description": "A boolean value that specifies whether row filtering is available for the tables in this connection. It is `true` only when the row filtering feature is enabled for the connection, the connector type supports row filtering. It is `false` when the connector type does not support row filtering. This field is omitted from the response when the row filtering feature is not enabled for the connection.", "example": true }, "schema_change_handling": { "type": "string", "description": "The possible values for the schema_change_handling parameter are as follows:
- `ALLOW_ALL` - all new schemas, tables, and columns which appear in the source after the initial setup are included in syncs
- `ALLOW_COLUMNS` - all new schemas and tables which appear in the source after the initial setup are excluded from syncs, but new columns are included
- `BLOCK_ALL` - all new schemas, tables, and columns which appear in the source after the initial setup are excluded from syncs", "example": "ALLOW_ALL", "enum": [ "ALLOW_ALL", "ALLOW_COLUMNS", "BLOCK_ALL" ] } } }, "TableConfigResponse": { "required": [ "columns", "enabled", "enabled_patch_settings", "name_in_destination", "supports_columns_config", "supports_history_mode" ], "type": "object", "properties": { "sync_mode": { "type": "string", "description": "This field appears in the response if the connection supports switching sync modes for tables", "example": "SOFT_DELETE", "enum": [ "SOFT_DELETE", "HISTORY", "LIVE" ] }, "name_in_destination": { "type": "string", "description": "The schema name within your destination in accordance with Fivetran conventional rules", "example": "table_name_in_destination" }, "enabled": { "type": "boolean", "description": "The boolean value specifying whether the sync for the table into the destination is enabled.", "example": true }, "columns": { "title": "Columns", "type": "object", "properties": { "column": { "$ref": "#/components/schemas/ColumnConfigResponse" } }, "description": "The set of columns within your table schema config. Each key is the column name as stored in the connection schema config. Column names are case-sensitive; an incorrect case results in an HTTP 404 error. The `columns` object in the response contains the columns whose `enabled` value has been set by the user after the initial sync." }, "enabled_patch_settings": { "$ref": "#/components/schemas/TableEnabledPatchSettings" }, "supports_columns_config": { "type": "boolean", "description": "A boolean value that specifies if the table supports a column-level configuration.", "example": true }, "supports_history_mode": { "type": "boolean", "description": "The boolean value that specifies if the table supports history mode.", "example": true }, "row_filter": { "description": "The row filter configured for the table. Omitted when no row filter is configured for the table. The clauses are combined according to the `operator` field; `OR` is returned explicitly, while the default `AND` is represented by an omitted `operator` field. Row filtering must be available for the connection; see the `row_filtering_supported` response field.", "allOf": [ { "$ref": "#/components/schemas/RowFilterDto" } ] }, "parent_table": { "type": "string", "description": "The name of the table that this table is grouped under, if any. This field appears in the response only for tables that belong to a group (for example, a core table's child tables).", "example": "core_table_name" } } }, "TableEnabledPatchSettings": { "required": [ "allowed" ], "type": "object", "properties": { "allowed": { "type": "boolean", "description": "The boolean value specifying whether the enabled property can be updated", "example": false }, "reason": { "type": "string", "description": "The additional message indicating the reason why the enabled property cannot be updated. This field appears in the response only when the reason_code value is OTHER", "example": "..." }, "reason_code": { "type": "string", "description": "The reason code indicating the reason why the enabled property cannot be updated:
SYSTEM_TABLE - the table is a system table
DELETED - the table was deleted in the source
OTHER - the table was excluded by the system for some reason
This field appears in the response when the allowed property value is FALSE", "example": "SYSTEM_TABLE", "enum": [ "SYSTEM_TABLE", "DELETED", "OTHER" ] } } }, "TableColumnsConfigResponse": { "required": [ "columns" ], "type": "object", "properties": { "columns": { "title": "Columns", "type": "object", "properties": { "column": { "$ref": "#/components/schemas/ColumnConfigResponse" } }, "description": "The set of columns within your table schema config. Each key is the column name as stored in the connection schema config. Column names are case-sensitive; an incorrect case results in an HTTP 404 error. The `columns` object in the response contains the columns whose `enabled` value has been set by the user after the initial sync." } } }, "ConnectorSdkPackageResponse": { "required": [ "connection_ids", "created_at", "created_by", "id", "last_updated_by", "updated_at" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the Connector SDK package.", "example": "package_id" }, "connection_id": { "type": "string", "description": "Deprecated. The connection identifier associated with this package. Each package can only be associated with one connection at a time. Returns null if the package is not yet associated with any connection. Use `connection_ids` instead.", "example": "connection_id" }, "connection_ids": { "type": "array", "description": "The connection identifiers associated with this package. Empty if the package is not yet associated with any connection.", "example": [ "connection_id" ], "items": { "type": "string" } }, "created_by": { "type": "string", "description": "The unique identifier of the user who created the package.", "example": "user_id" }, "last_updated_by": { "type": "string", "description": "The unique identifier of the user who last updated the package.", "example": "user_id" }, "created_at": { "type": "string", "description": "The timestamp when the package was created.", "format": "date-time", "example": "2024-01-14T19:30:00Z" }, "updated_at": { "type": "string", "description": "The timestamp when the package was last updated.", "format": "date-time", "example": "2024-01-14T20:15:00Z" }, "file_sha256_hash": { "type": "string", "description": "The SHA-256 hash of the uploaded package file. Used for integrity verification and change detection.", "example": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" } } }, "Feature": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of a feature supported by the connector", "example": "API_CONFIGURABLE", "enum": [ "CUSTOM_DATA", "CAPTURE_DELETES", "DATA_BLOCKING", "COLUMN_HASHING", "RE_SYNC", "HISTORY", "API_CONFIGURABLE", "PRIORITY_FIRST_SYNC", "FIVETRAN_DATA_MODELS", "PRIVATE_NETWORKING", "AUTHORIZATION_VIA_API", "ROW_FILTERING" ] }, "notes": { "type": "string", "description": "Additional information about the feature support of a specific connector", "example": "..." } } }, "MetadataResponse": { "required": [ "id", "name", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "The connector type identifier within the Fivetran system", "example": "google_ads" }, "name": { "type": "string", "description": "The connector service name within the Fivetran system", "example": "Google Ads" }, "type": { "type": "string", "description": "The connector service type", "example": "Marketing", "enum": [ "API", "Dbt", "Marketing", "HumanResources", "Finance", "Productivity", "Engineering", "Support", "Sales", "Security", "SuperConnectorTest", "Free", "File", "Database", "Events", "Function", "BITool", "Warehouse", "Log", "Hvr" ] }, "description": { "type": "string", "description": "The description characterizing the purpose of the connector", "example": "Google Ads is an online advertising platform" }, "icons": { "type": "array", "description": "The set of additional icon resource URLs in different formats (.svg, .png). Updating this list is not a breaking change. The set of icon URLs or the icons themselves may be changed", "items": { "type": "string" } }, "config": { "type": "object", "description": "Metadata for configuration fields" }, "auth": { "type": "object", "description": "Metadata for authorization fields (optional)" }, "icon_url": { "type": "string", "description": "The icon resource URL", "example": "https://fivetran.com/integrations/google_ads/resources/google-ads.png" }, "link_to_docs": { "type": "string", "description": "The link to the connector documentation", "example": "https://fivetran.com/docs/connectors/applications/google-ads" }, "connector_class": { "type": "string", "enum": [ "standard", "lite" ] }, "supported_features": { "type": "array", "items": { "$ref": "#/components/schemas/Feature" } }, "link_to_erd": { "type": "string", "description": "The link to the connector ERD (entity–relationship diagram)", "example": "https://docs.google.com/presentation/d/1f16zOPxwT1AXoOcNkvwT82ApKqU1yhtJ04f-73M91nw/embed" }, "service_status": { "type": "string", "description": "The current availability status of the connector", "example": "general_availability", "enum": [ "general_availability", "beta", "private_preview", "sunset", "development" ] }, "service_status_updated_at": { "type": "string", "description": "The date (yyyy-MM-dd) the connector status was updated to the current availability status", "format": "date-time" }, "supports_schema_reload": { "type": "boolean" }, "external_secrets_keys_config": { "type": "object" } } }, "MetadataResponseShort": { "required": [ "id", "name", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "The connector type identifier within the Fivetran system", "example": "google_ads" }, "name": { "type": "string", "description": "The connector service name within the Fivetran system", "example": "Google Ads" }, "type": { "type": "string", "description": "The connector service type", "example": "Marketing", "enum": [ "API", "Dbt", "Marketing", "HumanResources", "Finance", "Productivity", "Engineering", "Support", "Sales", "Security", "SuperConnectorTest", "Free", "File", "Database", "Events", "Function", "BITool", "Warehouse", "Log", "Hvr" ] }, "description": { "type": "string", "description": "The description characterizing the purpose of the connector", "example": "Google Ads is an online advertising platform" }, "icons": { "type": "array", "description": "The set of additional icon resource URLs in different formats (.svg, .png). Updating this list is not a breaking change. The set of icon URLs or the icons themselves may be changed", "items": { "type": "string" } }, "icon_url": { "type": "string", "description": "The icon resource URL", "example": "https://fivetran.com/integrations/google_ads/resources/google-ads.png" }, "link_to_docs": { "type": "string", "description": "The link to the connector documentation", "example": "https://fivetran.com/docs/connectors/applications/google-ads" }, "connector_class": { "type": "string", "enum": [ "standard", "lite" ] }, "supported_features": { "type": "array", "items": { "$ref": "#/components/schemas/Feature" } }, "link_to_erd": { "type": "string", "description": "The link to the connector ERD (entity–relationship diagram)", "example": "https://docs.google.com/presentation/d/1f16zOPxwT1AXoOcNkvwT82ApKqU1yhtJ04f-73M91nw/embed" }, "service_status": { "type": "string", "description": "The current availability status of the connector", "example": "general_availability", "enum": [ "general_availability", "beta", "private_preview", "sunset", "development" ] }, "service_status_updated_at": { "type": "string", "description": "The date (yyyy-MM-dd) the connector status was updated to the current availability status", "format": "date-time" }, "supports_schema_reload": { "type": "boolean" } } }, "NewDestinationRequest": { "required": [ "group_id", "service", "time_zone_offset" ], "type": "object", "properties": { "group_id": { "type": "string", "description": "The unique identifier for the group within the Fivetran system.", "example": "group_id" }, "service": { "type": "string", "description": "The name for the destination type within the Fivetran system.", "example": "snowflake" }, "region": { "type": "string", "description": "Data processing location. This is where Fivetran will operate and run computation on data.", "example": "GCP_US_WEST1", "enum": [ "GCP_US_EAST4", "GCP_US_WEST1", "GCP_US_CENTRAL1", "GCP_EUROPE_WEST3", "GCP_AUSTRALIA_SOUTHEAST1", "GCP_NORTHAMERICA_NORTHEAST1", "GCP_EUROPE_WEST2", "GCP_ASIA_SOUTHEAST1", "GCP_ASIA_SOUTHEAST2", "GCP_ASIA_SOUTH1", "GCP_ASIA_NORTHEAST1", "GCP_ASIA_NORTHEAST3", "GCP_ME_CENTRAL2", "AWS_US_EAST_1", "AWS_US_EAST_2", "AWS_US_WEST_2", "AWS_AP_NORTHEAST_1", "AWS_AP_NORTHEAST_2", "AWS_AP_SOUTHEAST_1", "AWS_AP_SOUTHEAST_2", "AWS_EU_CENTRAL_1", "AWS_EU_NORTH_1", "AWS_EU_WEST_1", "AWS_EU_WEST_2", "AWS_EU_WEST_3", "AWS_AP_SOUTH_1", "AWS_CA_CENTRAL_1", "AWS_US_GOV_WEST_1", "AZURE_EASTUS2", "AZURE_AUSTRALIAEAST", "AZURE_UKSOUTH", "AZURE_WESTEUROPE", "AZURE_CENTRALUS", "AZURE_CANADACENTRAL", "AZURE_UAENORTH", "AZURE_SOUTHEASTASIA", "AZURE_EASTUS", "AZURE_JAPANEAST", "AZURE_CENTRALINDIA", "AZURE_GERMANYWESTCENTRAL", "AZURE_WESTUS3", "AZURE_SWITZERLANDNORTH", "AZURE_KOREACENTRAL" ] }, "time_zone_offset": { "type": "string", "description": "Determines the time zone for the Fivetran sync schedule.", "example": "+3", "enum": [ "-11", "-10", "-9", "-8", "-7", "-6", "-5", "-4", "-3", "-2", "-1", "0", "+1", "+2", "+3", "+4", "+5", "+6", "+7", "+8", "+9", "+10", "+11", "+12" ] }, "trust_certificates": { "type": "boolean", "description": "Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved by calling the [Approve destination certificate endpoint](/docs/rest-api/api-reference/certificates/approve-destination-certificate).\n\n> IMPORTANT: To capture the `hash` and `encoded_cert` values needed for approval, omit this field or set it to `false`.\n", "example": true }, "trust_fingerprints": { "type": "boolean", "description": "Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved by calling the [Approve destination fingerprint endpoint](/docs/rest-api/api-reference/certificates/approve-destination-fingerprint).\n\n> IMPORTANT: To capture the `hash` and `public_key` values needed for approval, omit this field or set it to `false`.\n", "example": true }, "run_setup_tests": { "type": "boolean", "description": "Specifies whether setup tests should be run automatically.", "example": true }, "daylight_saving_time_enabled": { "type": "boolean", "description": "Shift my UTC offset with daylight savings time (US Only)", "example": true }, "hybrid_deployment_agent_id": { "type": "string", "description": "The unique identifier for the hybrid deployment agent within the Fivetran system", "example": "hybrid_deployment_agent_id" }, "private_link_id": { "type": "string", "description": "The unique identifier for the self-served private link that is used by the connection", "example": "private_link_id" }, "networking_method": { "type": "string", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "proxy_agent_id": { "type": "string", "description": "The unique identifier for the proxy agent within the Fivetran system", "example": "proxy_agent_id" }, "external_secrets_manager_id": { "type": "string", "description": "The unique identifier of the [External Secrets Manager](/docs/rest-api/api-reference/external-secrets-managers) instance. Destination service must [support](/docs/core-concepts/features/external-secret-managers#destinations) External Secrets Manager feature to use this field." } }, "discriminator": { "propertyName": "service", "mapping": { "aiven_kafka_wh": "#/components/schemas/aiven_kafka_wh_NewDestinationRequest", "aurora_postgres_warehouse": "#/components/schemas/aurora_postgres_warehouse_NewDestinationRequest", "aurora_warehouse": "#/components/schemas/aurora_warehouse_NewDestinationRequest", "aws_msk_wh": "#/components/schemas/aws_msk_wh_NewDestinationRequest", "azure_postgres_warehouse": "#/components/schemas/azure_postgres_warehouse_NewDestinationRequest", "azure_sql_data_warehouse": "#/components/schemas/azure_sql_data_warehouse_NewDestinationRequest", "azure_sql_database": "#/components/schemas/azure_sql_database_NewDestinationRequest", "azure_sql_managed_db_warehouse": "#/components/schemas/azure_sql_managed_db_warehouse_NewDestinationRequest", "big_query": "#/components/schemas/big_query_NewDestinationRequest", "big_query_dts": "#/components/schemas/big_query_dts_NewDestinationRequest", "clickhouse": "#/components/schemas/clickhouse_NewDestinationRequest", "confluent_cloud_wh": "#/components/schemas/confluent_cloud_wh_NewDestinationRequest", "databricks": "#/components/schemas/databricks_NewDestinationRequest", "databricks_via_managed_data_lake": "#/components/schemas/databricks_via_managed_data_lake_NewDestinationRequest", "managed_big_query": "#/components/schemas/managed_big_query_NewDestinationRequest", "managed_data_lake": "#/components/schemas/managed_data_lake_NewDestinationRequest", "maria_rds_warehouse": "#/components/schemas/maria_rds_warehouse_NewDestinationRequest", "maria_warehouse": "#/components/schemas/maria_warehouse_NewDestinationRequest", "materialize": "#/components/schemas/materialize_NewDestinationRequest", "milvus": "#/components/schemas/milvus_NewDestinationRequest", "motherduck": "#/components/schemas/motherduck_NewDestinationRequest", "mysql_rds_warehouse": "#/components/schemas/mysql_rds_warehouse_NewDestinationRequest", "mysql_warehouse": "#/components/schemas/mysql_warehouse_NewDestinationRequest", "oracle_rac_warehouse": "#/components/schemas/oracle_rac_warehouse_NewDestinationRequest", "oracle_rds_warehouse": "#/components/schemas/oracle_rds_warehouse_NewDestinationRequest", "oracle_warehouse": "#/components/schemas/oracle_warehouse_NewDestinationRequest", "postgres_databricks_warehouse": "#/components/schemas/postgres_databricks_warehouse_NewDestinationRequest", "postgres_gcp_warehouse": "#/components/schemas/postgres_gcp_warehouse_NewDestinationRequest", "postgres_rds_warehouse": "#/components/schemas/postgres_rds_warehouse_NewDestinationRequest", "postgres_warehouse": "#/components/schemas/postgres_warehouse_NewDestinationRequest", "postgres_wh": "#/components/schemas/postgres_wh_NewDestinationRequest", "redshift": "#/components/schemas/redshift_NewDestinationRequest", "singlestore": "#/components/schemas/singlestore_NewDestinationRequest", "snowflake": "#/components/schemas/snowflake_NewDestinationRequest", "sql_server_rds_warehouse": "#/components/schemas/sql_server_rds_warehouse_NewDestinationRequest", "sql_server_warehouse": "#/components/schemas/sql_server_warehouse_NewDestinationRequest", "surrealdb_destination": "#/components/schemas/surrealdb_destination_NewDestinationRequest", "teradata_destination": "#/components/schemas/teradata_destination_NewDestinationRequest" } } }, "UpdateDestinationRequest": { "required": [ "time_zone_offset" ], "type": "object", "properties": { "region": { "type": "string", "description": "Data processing location. This is where Fivetran will operate and run computation on data.", "example": "GCP_US_EAST4", "enum": [ "GCP_US_EAST4", "GCP_US_WEST1", "GCP_US_CENTRAL1", "GCP_EUROPE_WEST3", "GCP_AUSTRALIA_SOUTHEAST1", "GCP_NORTHAMERICA_NORTHEAST1", "GCP_EUROPE_WEST2", "GCP_ASIA_SOUTHEAST1", "GCP_ASIA_SOUTHEAST2", "GCP_ASIA_SOUTH1", "GCP_ASIA_NORTHEAST1", "GCP_ASIA_NORTHEAST3", "GCP_ME_CENTRAL2", "AWS_US_EAST_1", "AWS_US_EAST_2", "AWS_US_WEST_2", "AWS_AP_NORTHEAST_1", "AWS_AP_NORTHEAST_2", "AWS_AP_SOUTHEAST_1", "AWS_AP_SOUTHEAST_2", "AWS_EU_CENTRAL_1", "AWS_EU_NORTH_1", "AWS_EU_WEST_1", "AWS_EU_WEST_2", "AWS_EU_WEST_3", "AWS_AP_SOUTH_1", "AWS_CA_CENTRAL_1", "AWS_US_GOV_WEST_1", "AZURE_EASTUS2", "AZURE_AUSTRALIAEAST", "AZURE_UKSOUTH", "AZURE_WESTEUROPE", "AZURE_CENTRALUS", "AZURE_CANADACENTRAL", "AZURE_UAENORTH", "AZURE_SOUTHEASTASIA", "AZURE_EASTUS", "AZURE_JAPANEAST", "AZURE_CENTRALINDIA", "AZURE_GERMANYWESTCENTRAL", "AZURE_WESTUS3", "AZURE_SWITZERLANDNORTH", "AZURE_KOREACENTRAL" ] }, "config": { "description": "The setup configuration. Check possible config formats in [create method](/docs/rest-api/api-reference/destinations/create-destination/)", "allOf": [ { "$ref": "#/components/schemas/JsonNode" } ] }, "trust_certificates": { "type": "boolean", "description": "Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved by calling the [Approve destination certificate endpoint](/docs/rest-api/api-reference/certificates/approve-destination-certificate).\n\n> IMPORTANT: To capture the `hash` and `encoded_cert` values needed for approval, omit this field or set it to `false`.\n", "example": true }, "trust_fingerprints": { "type": "boolean", "description": "Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved by calling the [Approve destination fingerprint endpoint](/docs/rest-api/api-reference/certificates/approve-destination-fingerprint).\n\n> IMPORTANT: To capture the `hash` and `public_key` values needed for approval, omit this field or set it to `false`.\n", "example": true }, "time_zone_offset": { "type": "string", "description": "Determines the time zone for the Fivetran sync schedule.", "example": "+3", "enum": [ "-11", "-10", "-9", "-8", "-7", "-6", "-5", "-4", "-3", "-2", "-1", "0", "+1", "+2", "+3", "+4", "+5", "+6", "+7", "+8", "+9", "+10", "+11", "+12" ] }, "run_setup_tests": { "type": "boolean", "description": "Specifies whether setup tests should be run automatically.", "example": true }, "daylight_saving_time_enabled": { "type": "boolean", "description": "Shift my UTC offset with daylight savings time (US Only)", "example": true }, "hybrid_deployment_agent_id": { "type": "string" }, "private_link_id": { "type": "string", "description": "The unique identifier for the self-served private link that is used by the connection", "example": "private_link_id" }, "networking_method": { "type": "string", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "proxy_agent_id": { "type": "string", "description": "The unique identifier for the proxy agent within the Fivetran system", "example": "proxy_agent_id" }, "external_secrets_manager_id": { "type": "string", "description": "The unique identifier of the [External Secrets Manager](/docs/rest-api/api-reference/external-secrets-managers) instance. Destination service must [support](/docs/core-concepts/features/external-secret-managers#destinations) External Secrets Manager feature to use this field." }, "external_secrets_keys_config": { "description": "The setup configuration keys to be stored in external secrets manager. Check possible config formats in [create method](/docs/rest-api/api-reference/destinations/create-destination/)" } } }, "DestinationExtendedResponse": { "required": [ "group_id", "id", "region", "service", "setup_status", "time_zone_offset" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the destination within the Fivetran system", "example": "destination_id" }, "service": { "type": "string", "description": "The name for the destination type within the Fivetran system.", "example": "snowflake" }, "region": { "type": "string", "description": "Data processing location. This is where Fivetran will operate and run computation on data.", "example": "GCP_US_EAST4", "enum": [ "GCP_US_EAST4", "GCP_US_WEST1", "GCP_US_CENTRAL1", "GCP_EUROPE_WEST3", "GCP_AUSTRALIA_SOUTHEAST1", "GCP_NORTHAMERICA_NORTHEAST1", "GCP_EUROPE_WEST2", "GCP_ASIA_SOUTHEAST1", "GCP_ASIA_SOUTHEAST2", "GCP_ASIA_SOUTH1", "GCP_ASIA_NORTHEAST1", "GCP_ASIA_NORTHEAST3", "GCP_ME_CENTRAL2", "AWS_US_EAST_1", "AWS_US_EAST_2", "AWS_US_WEST_2", "AWS_AP_NORTHEAST_1", "AWS_AP_NORTHEAST_2", "AWS_AP_SOUTHEAST_1", "AWS_AP_SOUTHEAST_2", "AWS_EU_CENTRAL_1", "AWS_EU_NORTH_1", "AWS_EU_WEST_1", "AWS_EU_WEST_2", "AWS_EU_WEST_3", "AWS_AP_SOUTH_1", "AWS_CA_CENTRAL_1", "AWS_US_GOV_WEST_1", "AZURE_EASTUS2", "AZURE_AUSTRALIAEAST", "AZURE_UKSOUTH", "AZURE_WESTEUROPE", "AZURE_CENTRALUS", "AZURE_CANADACENTRAL", "AZURE_UAENORTH", "AZURE_SOUTHEASTASIA", "AZURE_EASTUS", "AZURE_JAPANEAST", "AZURE_CENTRALINDIA", "AZURE_GERMANYWESTCENTRAL", "AZURE_WESTUS3", "AZURE_SWITZERLANDNORTH", "AZURE_KOREACENTRAL" ] }, "group_id": { "type": "string", "description": "The unique identifier for the group within the Fivetran system.", "example": "group_id" }, "time_zone_offset": { "type": "string", "description": "Determines the time zone for the Fivetran sync schedule.", "example": "+3", "enum": [ "-11", "-10", "-9", "-8", "-7", "-6", "-5", "-4", "-3", "-2", "-1", "0", "+1", "+2", "+3", "+4", "+5", "+6", "+7", "+8", "+9", "+10", "+11", "+12" ] }, "setup_status": { "type": "string", "description": "Destination setup status", "example": "CONNECTED", "enum": [ "INCOMPLETE", "CONNECTED", "BROKEN" ] }, "daylight_saving_time_enabled": { "type": "boolean", "description": "Shift my UTC offset with daylight savings time (US Only)", "example": true }, "private_link_id": { "type": "string", "description": "The unique identifier for the self-served private link that is used by the connection", "example": "private_link_id" }, "networking_method": { "type": "string", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "local_processing_agent_id": { "type": "string", "description": "(Deprecated) The unique identifier for the hybrid deployment agent within the Fivetran system", "example": "local_processing_agent_id" }, "hybrid_deployment_agent_id": { "type": "string", "description": "The unique identifier for the hybrid deployment agent within the Fivetran system", "example": "hybrid_deployment_agent_id" }, "proxy_agent_id": { "type": "string", "description": "The unique identifier for the proxy agent within the Fivetran system", "example": "proxy_agent_id" }, "external_secrets_manager_id": { "type": "string", "description": "The unique identifier of the [External Secrets Manager](/docs/rest-api/api-reference/external-secrets-managers) instance. Destination service must [support](/docs/core-concepts/features/external-secret-managers#destinations) External Secrets Manager feature to use this field." }, "setup_tests": { "type": "array", "description": "Setup tests results for this destination", "items": { "$ref": "#/components/schemas/SetupTestResultResponse" } } }, "discriminator": { "propertyName": "service", "mapping": { "aiven_kafka_wh": "#/components/schemas/aiven_kafka_wh_DestinationExtendedResponse", "aurora_postgres_warehouse": "#/components/schemas/aurora_postgres_warehouse_DestinationExtendedResponse", "aurora_warehouse": "#/components/schemas/aurora_warehouse_DestinationExtendedResponse", "aws_msk_wh": "#/components/schemas/aws_msk_wh_DestinationExtendedResponse", "azure_postgres_warehouse": "#/components/schemas/azure_postgres_warehouse_DestinationExtendedResponse", "azure_sql_data_warehouse": "#/components/schemas/azure_sql_data_warehouse_DestinationExtendedResponse", "azure_sql_database": "#/components/schemas/azure_sql_database_DestinationExtendedResponse", "azure_sql_managed_db_warehouse": "#/components/schemas/azure_sql_managed_db_warehouse_DestinationExtendedResponse", "big_query": "#/components/schemas/big_query_DestinationExtendedResponse", "big_query_dts": "#/components/schemas/big_query_dts_DestinationExtendedResponse", "clickhouse": "#/components/schemas/clickhouse_DestinationExtendedResponse", "confluent_cloud_wh": "#/components/schemas/confluent_cloud_wh_DestinationExtendedResponse", "databricks": "#/components/schemas/databricks_DestinationExtendedResponse", "databricks_via_managed_data_lake": "#/components/schemas/databricks_via_managed_data_lake_DestinationExtendedResponse", "managed_big_query": "#/components/schemas/managed_big_query_DestinationExtendedResponse", "managed_data_lake": "#/components/schemas/managed_data_lake_DestinationExtendedResponse", "maria_rds_warehouse": "#/components/schemas/maria_rds_warehouse_DestinationExtendedResponse", "maria_warehouse": "#/components/schemas/maria_warehouse_DestinationExtendedResponse", "materialize": "#/components/schemas/materialize_DestinationExtendedResponse", "milvus": "#/components/schemas/milvus_DestinationExtendedResponse", "motherduck": "#/components/schemas/motherduck_DestinationExtendedResponse", "mysql_rds_warehouse": "#/components/schemas/mysql_rds_warehouse_DestinationExtendedResponse", "mysql_warehouse": "#/components/schemas/mysql_warehouse_DestinationExtendedResponse", "oracle_rac_warehouse": "#/components/schemas/oracle_rac_warehouse_DestinationExtendedResponse", "oracle_rds_warehouse": "#/components/schemas/oracle_rds_warehouse_DestinationExtendedResponse", "oracle_warehouse": "#/components/schemas/oracle_warehouse_DestinationExtendedResponse", "postgres_databricks_warehouse": "#/components/schemas/postgres_databricks_warehouse_DestinationExtendedResponse", "postgres_gcp_warehouse": "#/components/schemas/postgres_gcp_warehouse_DestinationExtendedResponse", "postgres_rds_warehouse": "#/components/schemas/postgres_rds_warehouse_DestinationExtendedResponse", "postgres_warehouse": "#/components/schemas/postgres_warehouse_DestinationExtendedResponse", "postgres_wh": "#/components/schemas/postgres_wh_DestinationExtendedResponse", "redshift": "#/components/schemas/redshift_DestinationExtendedResponse", "singlestore": "#/components/schemas/singlestore_DestinationExtendedResponse", "snowflake": "#/components/schemas/snowflake_DestinationExtendedResponse", "sql_server_rds_warehouse": "#/components/schemas/sql_server_rds_warehouse_DestinationExtendedResponse", "sql_server_warehouse": "#/components/schemas/sql_server_warehouse_DestinationExtendedResponse", "surrealdb_destination": "#/components/schemas/surrealdb_destination_DestinationExtendedResponse", "teradata_destination": "#/components/schemas/teradata_destination_DestinationExtendedResponse" } } }, "DestinationResponse": { "required": [ "group_id", "id", "region", "service", "setup_status", "time_zone_offset" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the destination within the Fivetran system", "example": "destination_id" }, "service": { "type": "string", "description": "The name for the destination type within the Fivetran system.", "example": "snowflake" }, "region": { "type": "string", "description": "Data processing location. This is where Fivetran will operate and run computation on data.", "example": "GCP_US_EAST4", "enum": [ "GCP_US_EAST4", "GCP_US_WEST1", "GCP_US_CENTRAL1", "GCP_EUROPE_WEST3", "GCP_AUSTRALIA_SOUTHEAST1", "GCP_NORTHAMERICA_NORTHEAST1", "GCP_EUROPE_WEST2", "GCP_ASIA_SOUTHEAST1", "GCP_ASIA_SOUTHEAST2", "GCP_ASIA_SOUTH1", "GCP_ASIA_NORTHEAST1", "GCP_ASIA_NORTHEAST3", "GCP_ME_CENTRAL2", "AWS_US_EAST_1", "AWS_US_EAST_2", "AWS_US_WEST_2", "AWS_AP_NORTHEAST_1", "AWS_AP_NORTHEAST_2", "AWS_AP_SOUTHEAST_1", "AWS_AP_SOUTHEAST_2", "AWS_EU_CENTRAL_1", "AWS_EU_NORTH_1", "AWS_EU_WEST_1", "AWS_EU_WEST_2", "AWS_EU_WEST_3", "AWS_AP_SOUTH_1", "AWS_CA_CENTRAL_1", "AWS_US_GOV_WEST_1", "AZURE_EASTUS2", "AZURE_AUSTRALIAEAST", "AZURE_UKSOUTH", "AZURE_WESTEUROPE", "AZURE_CENTRALUS", "AZURE_CANADACENTRAL", "AZURE_UAENORTH", "AZURE_SOUTHEASTASIA", "AZURE_EASTUS", "AZURE_JAPANEAST", "AZURE_CENTRALINDIA", "AZURE_GERMANYWESTCENTRAL", "AZURE_WESTUS3", "AZURE_SWITZERLANDNORTH", "AZURE_KOREACENTRAL" ] }, "group_id": { "type": "string", "description": "The unique identifier for the group within the Fivetran system.", "example": "group_id" }, "time_zone_offset": { "type": "string", "description": "Determines the time zone for the Fivetran sync schedule.", "example": "+3", "enum": [ "-11", "-10", "-9", "-8", "-7", "-6", "-5", "-4", "-3", "-2", "-1", "0", "+1", "+2", "+3", "+4", "+5", "+6", "+7", "+8", "+9", "+10", "+11", "+12" ] }, "setup_status": { "type": "string", "description": "Destination setup status", "example": "CONNECTED", "enum": [ "INCOMPLETE", "CONNECTED", "BROKEN" ] }, "daylight_saving_time_enabled": { "type": "boolean", "description": "Shift my UTC offset with daylight savings time (US Only)", "example": true }, "private_link_id": { "type": "string", "description": "The unique identifier for the self-served private link that is used by the connection", "example": "private_link_id" }, "networking_method": { "type": "string", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "local_processing_agent_id": { "type": "string", "description": "(Deprecated) The unique identifier for the hybrid deployment agent within the Fivetran system", "example": "local_processing_agent_id" }, "hybrid_deployment_agent_id": { "type": "string", "description": "The unique identifier for the hybrid deployment agent within the Fivetran system", "example": "hybrid_deployment_agent_id" }, "proxy_agent_id": { "type": "string", "description": "The unique identifier for the proxy agent within the Fivetran system", "example": "proxy_agent_id" }, "external_secrets_manager_id": { "type": "string", "description": "The unique identifier of the [External Secrets Manager](/docs/rest-api/api-reference/external-secrets-managers) instance. Destination service must [support](/docs/core-concepts/features/external-secret-managers#destinations) External Secrets Manager feature to use this field." } } }, "RunSetupTestsRequest_run_destination_setup_tests": { "type": "object", "properties": { "trust_certificates": { "type": "boolean" }, "trust_fingerprints": { "type": "boolean" } } }, "ApproveFingerprintRequest": { "required": [ "hash", "public_key" ], "type": "object", "properties": { "hash": { "type": "string", "description": "Hash of the fingerprint.", "example": "eUtPirI6yy..." }, "public_key": { "type": "string", "description": "The SSH public key.", "example": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key" } } }, "FingerprintDetailsResponse": { "required": [ "hash", "id", "public_key", "validated_by", "validated_date" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the fingerprint (Base64URL encoded hash of the fingerprint).", "example": "Y29ubmVjdG9yIGZpbmdlcnByaW50IGhhc2g" }, "hash": { "type": "string", "description": "Hash of the fingerprint.", "example": "eUtPirI6yy..." }, "public_key": { "type": "string", "description": "The SSH public key.", "example": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key" }, "validated_date": { "type": "string", "description": "Date when fingerprint has been validated and approved.", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "validated_by": { "type": "string", "description": "The unique identified for the user who has approved the fingerprint.", "example": "user_id" } } }, "ApproveFingerprintRequest_approve_destination_fingerprint": { "required": [ "hash", "public_key" ], "type": "object", "properties": { "hash": { "type": "string", "description": "Hash of the fingerprint.", "example": "eUtPirI6yy..." }, "public_key": { "type": "string", "description": "The SSH public key.", "example": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key" } } }, "AddUserToGroupRequest": { "type": "object", "properties": { "email": { "type": "string", "description": "The email address that the user has associated with their user profile.", "example": "user@email.value" }, "role": { "type": "string", "description": "The group role that you would like to assign this new user to. Supported group roles: ‘Manage Destination‘, ‘View Destination‘, ‘Edit Destination‘, ‘Create Connection‘, or a custom destination role", "example": "Owner" } } }, "NewGroupRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the group within your account.", "example": "Group_Name" } } }, "UpdateGroupRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the group within your account.", "example": "Updated_Group_Name" } } }, "GroupResponse": { "required": [ "created_at", "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the group within the Fivetran system.", "example": "group_id" }, "name": { "type": "string", "description": "The name of the group within your account.", "example": "Group_Name" }, "created_at": { "type": "string", "description": "The timestamp of when the group was created in your account.", "format": "date-time", "example": "2024-01-01T00:00:00Z" } } }, "GroupServiceAccountResponse": { "required": [ "service_account" ], "type": "object", "properties": { "service_account": { "type": "string", "example": "service_account" } } }, "GroupSshKeyResponse": { "required": [ "public_key" ], "type": "object", "properties": { "public_key": { "type": "string", "example": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6 ... fivetran user key" } } }, "UserResponse": { "required": [ "active", "created_at", "email", "id", "logged_in_at", "role", "verified" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the user within the Fivetran system.", "example": "user_id" }, "email": { "type": "string", "description": "The email address that the user has associated with their user profile. Optional for service accounts (`user_type: SERVICE_ACCOUNT`).", "example": "user@email.value" }, "verified": { "type": "boolean", "description": "The field indicates whether the user has verified their email address in the account creation process.", "example": true }, "invited": { "type": "boolean", "description": "The field indicates whether the user has been invited to your account.", "example": true }, "picture": { "type": "string", "description": "The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')", "example": "AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==" }, "phone": { "type": "string", "description": "The phone number of the user.", "example": "+1234567890" }, "role": { "type": "string", "description": "The role that you would like to assign to the user ", "example": "Account Administrator" }, "active": { "type": "boolean", "description": "The field indicates if the user is an active Fivetran account user.", "example": true }, "given_name": { "type": "string", "description": "The first name of the user.", "example": "John" }, "family_name": { "type": "string", "description": "The last name of the user.", "example": "Doe" }, "logged_in_at": { "type": "string", "description": "The last time that the user has logged into their Fivetran account.", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "created_at": { "type": "string", "description": "The timestamp that the user created their Fivetran account", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "user_type": { "type": "string", "description": "The type of user. Possible values: `REGULAR_USER`: A human user who can log in to the Fivetran dashboard and interact with the API, and `SERVICE_ACCOUNT`: A non-human identity for machine-to-machine API access that cannot log in to the dashboard.", "example": "SERVICE_ACCOUNT", "enum": [ "REGULAR_USER", "SERVICE_ACCOUNT" ] }, "has_api_key": { "type": "boolean", "description": "Indicates whether the user has an assigned API key, including expired keys. Accepted values: `true` or `false`.", "example": true } } }, "HvrHubRegistrationRequest": { "required": [ "fingerprint", "hubServerUrl" ], "type": "object", "properties": { "fingerprint": { "type": "string", "description": "Installation fingerprint.", "example": "fingerprint_value" }, "port": { "type": "integer", "description": "Installation port.", "format": "int32", "example": 1234 }, "hub_server_url": { "type": "string", "description": "URL of Hub server.", "example": "hub_server_url" } } }, "HvrHubRegistrationResponse": { "type": "object", "properties": { "access_token": { "type": "string", "description": "Access token.", "example": "access_token_value" }, "registration_id": { "type": "string", "description": "Registration identifier.", "example": "registration_id" } } }, "HybridDeploymentAgentCreateRequest": { "required": [ "accept_terms", "display_name", "env_type" ], "type": "object", "properties": { "group_id": { "type": "string", "description": "The unique identifier for the group within your Fivetran account.", "example": "group_id" }, "display_name": { "type": "string", "description": "Hybrid Deployment Agent display name.", "example": "display_name" }, "env_type": { "type": "string", "description": "Environment type.", "example": "DOCKER", "enum": [ "DOCKER", "PODMAN", "KUBERNETES", "SNOWPARK" ] }, "accept_terms": { "type": "boolean", "description": "Boolean, must be true to indicate that the caller accepts the Fivetran On-Prem Software License Addendum.", "example": true }, "auth_type": { "type": "string", "description": "Agent Auth Mode. Defines how agent should be authorised.", "example": "AUTO", "enum": [ "AUTO", "MANUAL" ] } } }, "HybridDeploymentAgentReAuthRequest": { "type": "object", "properties": { "auth_type": { "type": "string", "enum": [ "AUTO", "MANUAL" ] } } }, "HybridDeploymentAgentCreateResponse": { "required": [ "created_by", "deployment_type", "display_name", "enabled", "group_id", "id", "last_used_at", "online", "registered_at", "updated_at", "version" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the hybrid deployment agent within the Fivetran system.", "example": "agent_id" }, "version": { "type": "string", "description": "Version of the Hybrid Deployment Agent", "example": "version" }, "enabled": { "type": "boolean", "description": "The boolean value specifying whether the Hybrid Deployment Agent is enabled.", "example": true }, "online": { "type": "boolean", "description": "The boolean value specifying whether the Hybrid Deployment Agent is online.", "example": true }, "files": { "$ref": "#/components/schemas/HybridDeploymentAgentFilesResponse" }, "token": { "type": "string", "description": "Base64 encoded content of token", "example": "token_value" }, "display_name": { "type": "string", "description": "Hybrid Deployment Agent display name.", "example": "display_name" }, "group_id": { "type": "string", "description": "The unique identifier for the group within your Fivetran account.", "example": "group_id" }, "registered_at": { "type": "string", "description": "Time when this Hybrid Deployment Agent was created.", "format": "date-time", "example": "2024-12-01T15:43:29.013729Z" }, "created_by": { "type": "string", "description": "The actor who created the Hybrid Deployment Agent", "example": "created_by" }, "deployment_type": { "type": "string", "description": "Environment type.", "example": "DOCKER", "enum": [ "DOCKER", "PODMAN", "KUBERNETES", "SNOWPARK" ] }, "updated_at": { "type": "string", "description": "Time when this Hybrid Deployment Agent was updated.", "format": "date-time", "example": "2024-12-01T15:43:29.013729Z" }, "last_used_at": { "type": "string", "description": "The time this Hybrid Deployment Agent was last used.", "format": "date-time", "example": "2024-12-01T15:43:29.013729Z" } } }, "HybridDeploymentAgentFilesResponse": { "required": [ "auth_json", "config_json", "docker_compose_yaml" ], "type": "object", "properties": { "config_json": { "type": "string", "description": "Base64 encoded content of the config.json", "format": "byte", "example": "Base64 {... config.json contents ...}" }, "auth_json": { "type": "string", "description": "Base64 encoded content of the auth.json", "format": "byte", "example": "Base64 {... auth.json contents ...}" }, "docker_compose_yaml": { "type": "string", "description": "Base64 encoded content of the docker-compose.yaml", "format": "byte", "example": "Base64 {... docker-compose.yaml contents ...}" } } }, "HybridDeploymentAgentUsageResponse": { "required": [ "connection_id", "schema", "service" ], "type": "object", "properties": { "schema": { "type": "string", "description": "The name used both as the connection's name within the Fivetran system and as the source schema's name within your group.", "example": "schema_name" }, "service": { "type": "string", "description": "The connector type name within the Fivetran system.", "example": "service" }, "connection_id": { "type": "string", "description": "The unique identifier for the connection within the Fivetran", "example": "connection_id" } } }, "HybridDeploymentAgentWithUsageResponse": { "required": [ "created_by", "deployment_type", "display_name", "enabled", "group_id", "id", "last_used_at", "online", "registered_at", "updated_at", "version" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the hybrid deployment agent within the Fivetran system.", "example": "agent_id" }, "version": { "type": "string", "description": "Version of the Hybrid Deployment Agent", "example": "version" }, "enabled": { "type": "boolean", "description": "The boolean value specifying whether the Hybrid Deployment Agent is enabled.", "example": true }, "online": { "type": "boolean", "description": "The boolean value specifying whether the Hybrid Deployment Agent is online.", "example": true }, "usage": { "type": "array", "items": { "$ref": "#/components/schemas/HybridDeploymentAgentUsageResponse" } }, "display_name": { "type": "string", "description": "Hybrid Deployment Agent display name.", "example": "display_name" }, "group_id": { "type": "string", "description": "The unique identifier for the group within your Fivetran account.", "example": "group_id" }, "registered_at": { "type": "string", "description": "Time when this Hybrid Deployment Agent was created.", "format": "date-time", "example": "2024-12-01T15:43:29.013729Z" }, "created_by": { "type": "string", "description": "The actor who created the Hybrid Deployment Agent", "example": "created_by" }, "deployment_type": { "type": "string", "description": "Environment type.", "example": "DOCKER", "enum": [ "DOCKER", "PODMAN", "KUBERNETES", "SNOWPARK" ] }, "updated_at": { "type": "string", "description": "Time when this Hybrid Deployment Agent was updated.", "format": "date-time", "example": "2024-12-01T15:43:29.013729Z" }, "last_used_at": { "type": "string", "description": "The time this Hybrid Deployment Agent was last used.", "format": "date-time", "example": "2024-12-01T15:43:29.013729Z" } } }, "AddAccountLogRequest": { "type": "object", "properties": { "service": { "type": "string", "description": "The name of the log service type within the Fivetran system. We support the following log services: `azure_monitor_log`, `cloudwatch`, `datadog_log`, `dynatrace`, `grafana_loki`, `splunkLog`, `new_relic_log`, `stackdriver` (Google Cloud Logging).", "example": "log_service_type" }, "enabled": { "type": "boolean", "description": "The boolean value specifying whether the log service is enabled.", "example": true }, "config": { "$ref": "#/components/schemas/JsonNode" }, "run_setup_tests": { "type": "boolean", "description": "When `true`, Fivetran runs setup tests immediately after creating or updating the log service and returns the results in the `setup_tests` field of the response. Defaults to `false`.", "example": false } } }, "AddLogRequest": { "type": "object", "properties": { "group_id": { "type": "string", "description": "The unique identifier for the group within the Fivetran system", "example": "group_id" }, "service": { "type": "string", "description": "The name of the log service type within the Fivetran system. We support the following log services: `azure_monitor_log`, `cloudwatch`, `datadog_log`, `dynatrace`, `grafana_loki`, `splunkLog`, `new_relic_log`, `stackdriver` (Google Cloud Logging).", "example": "log_service_type" }, "enabled": { "type": "boolean", "description": "The boolean value specifying whether the log service is enabled.", "example": true }, "run_setup_tests": { "type": "boolean", "description": "When `true`, Fivetran runs setup tests immediately after creating or updating the log service and returns the results in the `setup_tests` field of the response. Defaults to `false`.", "example": false } }, "discriminator": { "propertyName": "service", "mapping": { "azure_monitor_log": "#/components/schemas/azure_monitor_log_AddLogRequest", "cloudwatch": "#/components/schemas/cloudwatch_AddLogRequest", "datadog_log": "#/components/schemas/datadog_log_AddLogRequest", "dynatrace": "#/components/schemas/dynatrace_AddLogRequest", "grafana_loki": "#/components/schemas/grafana_loki_AddLogRequest", "new_relic_log": "#/components/schemas/new_relic_log_AddLogRequest", "splunkLog": "#/components/schemas/splunkLog_AddLogRequest", "stackdriver": "#/components/schemas/stackdriver_AddLogRequest" } } }, "UpdateLogRequest": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "The boolean value specifying whether the log service is enabled.", "example": true }, "config": { "description": "The setup configuration. Check possible config formats in [create method](/docs/rest-api/api-reference/log-service-management/add-log-service/)" }, "run_setup_tests": { "type": "boolean", "description": "When `true`, Fivetran runs setup tests immediately after creating or updating the log service and returns the results in the `setup_tests` field of the response. Defaults to `false`.", "example": false } } }, "LogAlert": { "type": "object", "properties": { "code": { "type": "string", "description": "Alert code identifying the type of issue.", "example": "reconnect_log" }, "message": { "type": "string", "description": "Human-readable description of the issue.", "example": "Reconnect Logging Service" }, "details": { "type": "string", "description": "Additional context or details for the alert.", "example": "Please provide required permissions" } } }, "LogExtendedResponse": { "required": [ "enabled", "id", "service" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the log service within the Fivetran system.", "example": "log_id" }, "service": { "type": "string", "description": "The name of the log service type within the Fivetran system. We support the following log services: `azure_monitor_log`, `cloudwatch`, `datadog_log`, `dynatrace`, `grafana_loki`, `splunkLog`, `new_relic_log`, `stackdriver` (Google Cloud Logging).", "example": "log_service_type" }, "enabled": { "type": "boolean", "description": "The boolean value specifying whether the log service is enabled.", "example": true }, "status": { "description": "Setup status of the log service. Present when a setup status exists for the log service.", "allOf": [ { "$ref": "#/components/schemas/LogStatusResponse" } ] }, "setup_tests": { "type": "array", "description": "Results of the most recent setup test run.", "items": { "$ref": "#/components/schemas/SetupTestResultResponse" } } }, "discriminator": { "propertyName": "service", "mapping": { "azure_monitor_log": "#/components/schemas/azure_monitor_log_LogExtendedResponse", "cloudwatch": "#/components/schemas/cloudwatch_LogExtendedResponse", "datadog_log": "#/components/schemas/datadog_log_LogExtendedResponse", "dynatrace": "#/components/schemas/dynatrace_LogExtendedResponse", "grafana_loki": "#/components/schemas/grafana_loki_LogExtendedResponse", "new_relic_log": "#/components/schemas/new_relic_log_LogExtendedResponse", "splunkLog": "#/components/schemas/splunkLog_LogExtendedResponse", "stackdriver": "#/components/schemas/stackdriver_LogExtendedResponse" } } }, "LogStatusResponse": { "type": "object", "properties": { "tasks": { "type": "array", "description": "List of alerts describing issues with the log service configuration.", "items": { "$ref": "#/components/schemas/LogAlert" } }, "setup_state": { "type": "string", "description": "Current setup state of the log service. Possible values: `connected` — log service is reachable and forwarding events; `broken` — configuration errors prevent log delivery; `incomplete` — setup has not been completed and log delivery is paused. Example: `connected`.", "example": "connected" } } }, "LogResponse": { "required": [ "enabled", "id", "service" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the log service within the Fivetran system.", "example": "log_id" }, "service": { "type": "string", "description": "The name of the log service type within the Fivetran system. We support the following log services: `azure_monitor_log`, `cloudwatch`, `datadog_log`, `dynatrace`, `grafana_loki`, `splunkLog`, `new_relic_log`, `stackdriver` (Google Cloud Logging).", "example": "log_service_type" }, "enabled": { "type": "boolean", "description": "The boolean value specifying whether the log service is enabled.", "example": true }, "status": { "description": "Setup status of the log service. Present when a setup status exists for the log service.", "allOf": [ { "$ref": "#/components/schemas/LogStatusResponse" } ] } } }, "LoggingServiceSetupTestResponse": { "type": "object", "properties": { "setup_tests": { "type": "array", "items": { "$ref": "#/components/schemas/SetupTestResultResponse" } } } }, "UpdateLogRequest_update_log_service": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "The boolean value specifying whether the log service is enabled.", "example": true }, "config": { "$ref": "#/components/schemas/JsonNode" }, "run_setup_tests": { "type": "boolean", "description": "When `true`, Fivetran runs setup tests immediately after creating or updating the log service and returns the results in the `setup_tests` field of the response. Defaults to `false`.", "example": false } } }, "AccountInfoResponse": { "required": [ "account_id" ], "type": "object", "properties": { "account_id": { "type": "string", "description": "The unique identifier for the account within the Fivetran system.", "example": "account_id" }, "account_name": { "type": "string" }, "user_id": { "type": "string", "description": "The user ID from the API key. Returned if the user API key is used to authenticate the request.", "example": "user_id" }, "system_key_id": { "type": "string", "description": "The system ID from the API key. Returned if the system API key is used to authenticate the request.", "example": "system_key_id" } } }, "PrivateLinkCreateRequest": { "required": [ "config", "name", "region", "service" ], "type": "object", "properties": { "name": { "type": "string", "description": "Private link name", "example": "PrivateLinkName" }, "region": { "type": "string", "description": "Data processing location. This is where Fivetran will operate and run computation on data.", "example": "GCP_US_EAST4", "enum": [ "GCP_US_EAST4", "GCP_US_WEST1", "GCP_US_CENTRAL1", "GCP_EUROPE_WEST3", "GCP_AUSTRALIA_SOUTHEAST1", "GCP_NORTHAMERICA_NORTHEAST1", "GCP_EUROPE_WEST2", "GCP_ASIA_SOUTHEAST1", "GCP_ASIA_SOUTHEAST2", "GCP_ASIA_SOUTH1", "GCP_ASIA_NORTHEAST1", "GCP_ASIA_NORTHEAST3", "GCP_ME_CENTRAL2", "AWS_US_EAST_1", "AWS_US_EAST_2", "AWS_US_WEST_2", "AWS_AP_NORTHEAST_1", "AWS_AP_NORTHEAST_2", "AWS_AP_SOUTHEAST_1", "AWS_AP_SOUTHEAST_2", "AWS_EU_CENTRAL_1", "AWS_EU_NORTH_1", "AWS_EU_WEST_1", "AWS_EU_WEST_2", "AWS_EU_WEST_3", "AWS_AP_SOUTH_1", "AWS_CA_CENTRAL_1", "AWS_US_GOV_WEST_1", "AZURE_EASTUS2", "AZURE_AUSTRALIAEAST", "AZURE_UKSOUTH", "AZURE_WESTEUROPE", "AZURE_CENTRALUS", "AZURE_CANADACENTRAL", "AZURE_UAENORTH", "AZURE_SOUTHEASTASIA", "AZURE_EASTUS", "AZURE_JAPANEAST", "AZURE_CENTRALINDIA", "AZURE_GERMANYWESTCENTRAL", "AZURE_WESTUS3", "AZURE_SWITZERLANDNORTH", "AZURE_KOREACENTRAL" ] }, "service": { "type": "string", "description": "The name for the service type within the Fivetran system.", "example": "DATABRICKS", "enum": [ "DATABRICKS_AWS", "SNOWFLAKE_AWS", "REDSHIFT_AWS", "SOURCE_AWS", "DATABRICKS_AZURE", "SNOWFLAKE_AZURE", "ONELAKE_AZURE", "POSTGRES_WAREHOUSE_AZURE", "SQL_DATA_WAREHOUSE_AZURE", "SOURCE_AZURE", "SNOWFLAKE_GCP", "SOURCE_GCP", "DATABRICKS_GCP" ] } }, "discriminator": { "propertyName": "service", "mapping": { "DATABRICKS_AWS": "#/components/schemas/databricks_aws_PrivateLinkCreateRequest", "SNOWFLAKE_AWS": "#/components/schemas/snowflake_aws_PrivateLinkCreateRequest", "REDSHIFT_AWS": "#/components/schemas/redshift_aws_PrivateLinkCreateRequest", "SOURCE_AWS": "#/components/schemas/source_aws_PrivateLinkCreateRequest", "DATABRICKS_AZURE": "#/components/schemas/databricks_azure_PrivateLinkCreateRequest", "SNOWFLAKE_AZURE": "#/components/schemas/snowflake_azure_PrivateLinkCreateRequest", "ONELAKE_AZURE": "#/components/schemas/onelake_azure_PrivateLinkCreateRequest", "POSTGRES_WAREHOUSE_AZURE": "#/components/schemas/postgres_warehouse_azure_PrivateLinkCreateRequest", "SQL_DATA_WAREHOUSE_AZURE": "#/components/schemas/sql_data_warehouse_azure_PrivateLinkCreateRequest", "SOURCE_AZURE": "#/components/schemas/source_azure_PrivateLinkCreateRequest", "SNOWFLAKE_GCP": "#/components/schemas/snowflake_gcp_PrivateLinkCreateRequest", "SOURCE_GCP": "#/components/schemas/source_gcp_PrivateLinkCreateRequest", "DATABRICKS_GCP": "#/components/schemas/databricks_gcp_PrivateLinkCreateRequest" } } }, "PrivateLinkUpdateRequest": { "type": "object", "properties": {}, "discriminator": { "propertyName": "service", "mapping": { "DATABRICKS_AWS": "#/components/schemas/databricks_aws_PrivateLinkUpdateRequest", "SNOWFLAKE_AWS": "#/components/schemas/snowflake_aws_PrivateLinkUpdateRequest", "REDSHIFT_AWS": "#/components/schemas/redshift_aws_PrivateLinkUpdateRequest", "SOURCE_AWS": "#/components/schemas/source_aws_PrivateLinkUpdateRequest", "DATABRICKS_AZURE": "#/components/schemas/databricks_azure_PrivateLinkUpdateRequest", "SNOWFLAKE_AZURE": "#/components/schemas/snowflake_azure_PrivateLinkUpdateRequest", "ONELAKE_AZURE": "#/components/schemas/onelake_azure_PrivateLinkUpdateRequest", "POSTGRES_WAREHOUSE_AZURE": "#/components/schemas/postgres_warehouse_azure_PrivateLinkUpdateRequest", "SQL_DATA_WAREHOUSE_AZURE": "#/components/schemas/sql_data_warehouse_azure_PrivateLinkUpdateRequest", "SOURCE_AZURE": "#/components/schemas/source_azure_PrivateLinkUpdateRequest", "SNOWFLAKE_GCP": "#/components/schemas/snowflake_gcp_PrivateLinkUpdateRequest", "SOURCE_GCP": "#/components/schemas/source_gcp_PrivateLinkUpdateRequest", "DATABRICKS_GCP": "#/components/schemas/databricks_gcp_PrivateLinkUpdateRequest" } } }, "PrivateLinkResponse": { "required": [ "cloud_provider", "config", "created_at", "created_by", "id", "name", "region", "service", "state", "state_summary" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the private link within the Fivetran system.", "example": "private_link_id" }, "name": { "type": "string", "description": "Private link name", "example": "PrivateLinkName" }, "region": { "type": "string", "description": "Data processing location. This is where Fivetran will operate and run computation on data.", "example": "AWS_US_EAST_1", "enum": [ "GCP_US_EAST4", "GCP_US_WEST1", "GCP_US_CENTRAL1", "GCP_EUROPE_WEST3", "GCP_AUSTRALIA_SOUTHEAST1", "GCP_NORTHAMERICA_NORTHEAST1", "GCP_EUROPE_WEST2", "GCP_ASIA_SOUTHEAST1", "GCP_ASIA_SOUTHEAST2", "GCP_ASIA_SOUTH1", "GCP_ASIA_NORTHEAST1", "GCP_ASIA_NORTHEAST3", "GCP_ME_CENTRAL2", "AWS_US_EAST_1", "AWS_US_EAST_2", "AWS_US_WEST_2", "AWS_AP_NORTHEAST_1", "AWS_AP_NORTHEAST_2", "AWS_AP_SOUTHEAST_1", "AWS_AP_SOUTHEAST_2", "AWS_EU_CENTRAL_1", "AWS_EU_NORTH_1", "AWS_EU_WEST_1", "AWS_EU_WEST_2", "AWS_EU_WEST_3", "AWS_AP_SOUTH_1", "AWS_CA_CENTRAL_1", "AWS_US_GOV_WEST_1", "AZURE_EASTUS2", "AZURE_AUSTRALIAEAST", "AZURE_UKSOUTH", "AZURE_WESTEUROPE", "AZURE_CENTRALUS", "AZURE_CANADACENTRAL", "AZURE_UAENORTH", "AZURE_SOUTHEASTASIA", "AZURE_EASTUS", "AZURE_JAPANEAST", "AZURE_CENTRALINDIA", "AZURE_GERMANYWESTCENTRAL", "AZURE_WESTUS3", "AZURE_SWITZERLANDNORTH", "AZURE_KOREACENTRAL" ] }, "service": { "type": "string", "description": "The name for the service type within the Fivetran system.", "example": "DATABRICKS", "enum": [ "DATABRICKS_AWS", "SNOWFLAKE_AWS", "REDSHIFT_AWS", "SOURCE_AWS", "DATABRICKS_AZURE", "SNOWFLAKE_AZURE", "ONELAKE_AZURE", "POSTGRES_WAREHOUSE_AZURE", "SQL_DATA_WAREHOUSE_AZURE", "SOURCE_AZURE", "SNOWFLAKE_GCP", "SOURCE_GCP", "DATABRICKS_GCP" ] }, "state": { "type": "string", "description": "Private link state", "example": "OK", "enum": [ "CREATING", "UPDATING", "DESTROYING", "OK", "FAIL" ] }, "host": { "type": "string", "description": "The DNS name of the PrivateLink endpoint service.", "example": "example.host.com" }, "account_id": { "type": "string" }, "cloud_provider": { "type": "string", "description": "Private link cloud provider", "example": "AWS", "enum": [ "AWS", "GCP", "AZURE" ] }, "created_at": { "type": "string", "description": "The timestamp of the time the private link was created in your account", "format": "date-time", "example": "2023-12-01T15:43:29.013729Z" }, "created_by": { "type": "string", "description": "The actor who created the private link", "example": "user_id" }, "state_summary": { "type": "string", "description": "Private link state summary", "example": "..." }, "resource_upstream_status": { "type": "string", "description": "The upstream status of the PrivateLink resource as reported by the cloud provider.", "example": "IDLE" } }, "discriminator": { "propertyName": "service", "mapping": { "DATABRICKS_AWS": "#/components/schemas/databricks_aws_PrivateLinkResponse", "SNOWFLAKE_AWS": "#/components/schemas/snowflake_aws_PrivateLinkResponse", "REDSHIFT_AWS": "#/components/schemas/redshift_aws_PrivateLinkResponse", "SOURCE_AWS": "#/components/schemas/source_aws_PrivateLinkResponse", "DATABRICKS_AZURE": "#/components/schemas/databricks_azure_PrivateLinkResponse", "SNOWFLAKE_AZURE": "#/components/schemas/snowflake_azure_PrivateLinkResponse", "ONELAKE_AZURE": "#/components/schemas/onelake_azure_PrivateLinkResponse", "POSTGRES_WAREHOUSE_AZURE": "#/components/schemas/postgres_warehouse_azure_PrivateLinkResponse", "SQL_DATA_WAREHOUSE_AZURE": "#/components/schemas/sql_data_warehouse_azure_PrivateLinkResponse", "SOURCE_AZURE": "#/components/schemas/source_azure_PrivateLinkResponse", "SNOWFLAKE_GCP": "#/components/schemas/snowflake_gcp_PrivateLinkResponse", "SOURCE_GCP": "#/components/schemas/source_gcp_PrivateLinkResponse", "DATABRICKS_GCP": "#/components/schemas/databricks_gcp_PrivateLinkResponse" } } }, "ProxyParamRequest": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Proxy agent name.", "example": "display_name" }, "group_region": { "type": "string", "description": "Data processing location. This is where Fivetran will operate and run computation on data (optional).", "example": "GCP_US_EAST4", "enum": [ "GCP_US_EAST4", "GCP_US_WEST1", "GCP_US_CENTRAL1", "GCP_EUROPE_WEST3", "GCP_AUSTRALIA_SOUTHEAST1", "GCP_NORTHAMERICA_NORTHEAST1", "GCP_EUROPE_WEST2", "GCP_ASIA_SOUTHEAST1", "GCP_ASIA_SOUTHEAST2", "GCP_ASIA_SOUTH1", "GCP_ASIA_NORTHEAST1", "GCP_ASIA_NORTHEAST3", "GCP_ME_CENTRAL2", "AWS_US_EAST_1", "AWS_US_EAST_2", "AWS_US_WEST_2", "AWS_AP_NORTHEAST_1", "AWS_AP_NORTHEAST_2", "AWS_AP_SOUTHEAST_1", "AWS_AP_SOUTHEAST_2", "AWS_EU_CENTRAL_1", "AWS_EU_NORTH_1", "AWS_EU_WEST_1", "AWS_EU_WEST_2", "AWS_EU_WEST_3", "AWS_AP_SOUTH_1", "AWS_CA_CENTRAL_1", "AWS_US_GOV_WEST_1", "AZURE_EASTUS2", "AZURE_AUSTRALIAEAST", "AZURE_UKSOUTH", "AZURE_WESTEUROPE", "AZURE_CENTRALUS", "AZURE_CANADACENTRAL", "AZURE_UAENORTH", "AZURE_SOUTHEASTASIA", "AZURE_EASTUS", "AZURE_JAPANEAST", "AZURE_CENTRALINDIA", "AZURE_GERMANYWESTCENTRAL", "AZURE_WESTUS3", "AZURE_SWITZERLANDNORTH", "AZURE_KOREACENTRAL" ] } } }, "ProxyAgentCreatedResponse": { "required": [ "agent_id", "auth_token", "client_cert", "client_private_key", "orchestrator_host", "orchestrator_port" ], "type": "object", "properties": { "agent_id": { "type": "string", "description": "The unique identifier for the proxy agent within the Fivetran system.", "example": "id" }, "auth_token": { "type": "string", "description": "The auth token.", "example": "auth_token" }, "client_cert": { "type": "string", "description": "Client certificate.", "example": "client_cert" }, "client_private_key": { "type": "string", "description": "Client private key.", "example": "client_private_key" }, "orchestrator_host": { "type": "string", "description": "The hostname that the Proxy Agent uses to connect to the Fivetran orchestrator.", "example": "orchestrator.fivetran.com" }, "orchestrator_port": { "type": "integer", "description": "The port that the Proxy Agent uses to connect to the Fivetran orchestrator.", "format": "int32", "example": 443 } } }, "ProxyAgentUsageResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for either source connection or destination within the Fivetran system.", "example": "two_words" }, "schema": { "type": "string", "description": "The schema name of the source connection. Null for destinations.", "example": "schema" }, "service": { "type": "string", "description": "Source connector service or connection destination type.", "example": "service" } } }, "ProxyAgentWithUsageResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the proxy agent within the Fivetran system.", "example": "id" }, "account_id": { "type": "string", "description": "Fivetran Account ID.", "example": "account_id" }, "registered_at": { "type": "string", "description": "The timestamp of the time the proxy agent was created in your account.", "format": "date-time", "example": "2018-12-01T15:43:29.013729Z" }, "region": { "type": "string", "description": "Data processing location. This is where Fivetran will operate and run computation on data.", "example": "GCP_US_EAST4", "enum": [ "GCP_US_EAST4", "GCP_US_WEST1", "GCP_US_CENTRAL1", "GCP_EUROPE_WEST3", "GCP_AUSTRALIA_SOUTHEAST1", "GCP_NORTHAMERICA_NORTHEAST1", "GCP_EUROPE_WEST2", "GCP_ASIA_SOUTHEAST1", "GCP_ASIA_SOUTHEAST2", "GCP_ASIA_SOUTH1", "GCP_ASIA_NORTHEAST1", "GCP_ASIA_NORTHEAST3", "GCP_ME_CENTRAL2", "AWS_US_EAST_1", "AWS_US_EAST_2", "AWS_US_WEST_2", "AWS_AP_NORTHEAST_1", "AWS_AP_NORTHEAST_2", "AWS_AP_SOUTHEAST_1", "AWS_AP_SOUTHEAST_2", "AWS_EU_CENTRAL_1", "AWS_EU_NORTH_1", "AWS_EU_WEST_1", "AWS_EU_WEST_2", "AWS_EU_WEST_3", "AWS_AP_SOUTH_1", "AWS_CA_CENTRAL_1", "AWS_US_GOV_WEST_1", "AZURE_EASTUS2", "AZURE_AUSTRALIAEAST", "AZURE_UKSOUTH", "AZURE_WESTEUROPE", "AZURE_CENTRALUS", "AZURE_CANADACENTRAL", "AZURE_UAENORTH", "AZURE_SOUTHEASTASIA", "AZURE_EASTUS", "AZURE_JAPANEAST", "AZURE_CENTRALINDIA", "AZURE_GERMANYWESTCENTRAL", "AZURE_WESTUS3", "AZURE_SWITZERLANDNORTH", "AZURE_KOREACENTRAL" ] }, "created_by": { "type": "string", "description": "The actor who created the proxy agent.", "example": "created_by" }, "display_name": { "type": "string", "description": "Proxy agent name.", "example": "display_name" }, "version": { "type": "string", "description": "The version of the proxy agent.", "example": "1.0.0" }, "status": { "type": "string", "description": "The connection status of the proxy agent.", "example": "CONNECTED", "enum": [ "NOT_FOUND", "CONNECTED", "NOT_CONNECTED" ] }, "usage": { "type": "array", "description": "List of source connections and destinations using this proxy agent.", "items": { "$ref": "#/components/schemas/ProxyAgentUsageResponse" } } } }, "ProxyIntegrationResponse": { "type": "object", "properties": { "connection_id": { "type": "string", "description": "The unique identifier for the connection within the Fivetran system.", "example": "connection_id" } } }, "ProxyAgentWithCountsResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the proxy agent within the Fivetran system.", "example": "id" }, "account_id": { "type": "string", "description": "Fivetran Account ID.", "example": "account_id" }, "registered_at": { "type": "string", "description": "The timestamp of the time the proxy agent was created in your account.", "format": "date-time", "example": "2018-12-01T15:43:29.013729Z" }, "region": { "type": "string", "description": "Data processing location. This is where Fivetran will operate and run computation on data.", "example": "GCP_US_EAST4", "enum": [ "GCP_US_EAST4", "GCP_US_WEST1", "GCP_US_CENTRAL1", "GCP_EUROPE_WEST3", "GCP_AUSTRALIA_SOUTHEAST1", "GCP_NORTHAMERICA_NORTHEAST1", "GCP_EUROPE_WEST2", "GCP_ASIA_SOUTHEAST1", "GCP_ASIA_SOUTHEAST2", "GCP_ASIA_SOUTH1", "GCP_ASIA_NORTHEAST1", "GCP_ASIA_NORTHEAST3", "GCP_ME_CENTRAL2", "AWS_US_EAST_1", "AWS_US_EAST_2", "AWS_US_WEST_2", "AWS_AP_NORTHEAST_1", "AWS_AP_NORTHEAST_2", "AWS_AP_SOUTHEAST_1", "AWS_AP_SOUTHEAST_2", "AWS_EU_CENTRAL_1", "AWS_EU_NORTH_1", "AWS_EU_WEST_1", "AWS_EU_WEST_2", "AWS_EU_WEST_3", "AWS_AP_SOUTH_1", "AWS_CA_CENTRAL_1", "AWS_US_GOV_WEST_1", "AZURE_EASTUS2", "AZURE_AUSTRALIAEAST", "AZURE_UKSOUTH", "AZURE_WESTEUROPE", "AZURE_CENTRALUS", "AZURE_CANADACENTRAL", "AZURE_UAENORTH", "AZURE_SOUTHEASTASIA", "AZURE_EASTUS", "AZURE_JAPANEAST", "AZURE_CENTRALINDIA", "AZURE_GERMANYWESTCENTRAL", "AZURE_WESTUS3", "AZURE_SWITZERLANDNORTH", "AZURE_KOREACENTRAL" ] }, "created_by": { "type": "string", "description": "The actor who created the proxy agent.", "example": "created_by" }, "display_name": { "type": "string", "description": "Proxy agent name.", "example": "display_name" }, "version": { "type": "string", "description": "The version of the proxy agent.", "example": "1.0.0" }, "status": { "type": "string", "description": "The connection status of the proxy agent.", "example": "CONNECTED", "enum": [ "NOT_FOUND", "CONNECTED", "NOT_CONNECTED" ] }, "connector_count": { "type": "integer", "description": "The number of source connections using the proxy agent.", "format": "int32", "example": 3 }, "destination_count": { "type": "integer", "description": "The number of destinations using the proxy agent.", "format": "int32", "example": 1 } } }, "RoleResponse": { "required": [ "is_custom", "is_deprecated", "name", "replacement_role_name", "scope" ], "type": "object", "properties": { "name": { "type": "string", "description": "The role name", "example": "Destination Administrator" }, "description": { "type": "string", "description": "The role description", "example": "Role Description" }, "scope": { "uniqueItems": true, "type": "array", "description": "Defines the list of resources the role manages", "example": [ "DESTINATION" ], "items": { "type": "string" }, "enum": [ "ACCOUNT", "DESTINATION", "CONNECTOR", "TEAM" ] }, "is_custom": { "type": "boolean", "description": "Defines whether the role is standard or custom", "example": false }, "is_deprecated": { "type": "boolean", "description": "Defines whether the role is deprecated", "example": true }, "replacement_role_name": { "type": "string", "description": "The name of the new role replacing the deprecated role", "example": "Manage Destination" } } }, "SecretsManagerCreateRequest": { "required": [ "config", "name", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "The ESM provider type. Supported values: AWS_SECRET_MANAGER, AZURE_KEY_VAULT, HASHICORP_VAULT.", "example": "AWS_SECRET_MANAGER", "enum": [ "AWS_SECRET_MANAGER", "AZURE_KEY_VAULT", "HASHICORP_VAULT" ] }, "name": { "type": "string", "description": "The name of the External Secrets Manager instance. Must be unique within the account.", "example": "My AWS Secrets Manager" }, "config": { "description": "Provider-specific configuration object. For AWS_SECRET_MANAGER: role_arn (required). For AZURE_KEY_VAULT: vault_url (required), tenant_id (required for SaaS). For HASHICORP_VAULT: vault_address (required), role_id and secret_id (required for SaaS), namespace (optional).", "allOf": [ { "$ref": "#/components/schemas/JsonNode" } ] }, "is_hybrid_deployment": { "type": "boolean", "description": "Whether this External Secrets Manager instance is compatible with Hybrid Deployment environments.", "example": false } } }, "SecretsManagerUpdateRequest": { "required": [ "config" ], "type": "object", "properties": { "config": { "description": "Provider-specific configuration object. For AWS_SECRET_MANAGER: role_arn (required). For AZURE_KEY_VAULT: vault_url (required), tenant_id (required for SaaS). For HASHICORP_VAULT: vault_address (required), role_id and secret_id (required for SaaS), namespace (optional).", "allOf": [ { "$ref": "#/components/schemas/JsonNode" } ] } } }, "SecretsManagerResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the External Secrets Manager instance.", "example": "lucky_tiger" }, "type": { "type": "string", "description": "The ESM provider type", "example": "AWS_SECRET_MANAGER", "enum": [ "AWS_SECRET_MANAGER", "AZURE_KEY_VAULT", "HASHICORP_VAULT" ] }, "name": { "type": "string", "description": "The name of the ESM instance", "example": "My AWS Secrets Manager" }, "config": { "type": "object", "additionalProperties": { "type": "object" }, "description": "Provider-specific configuration." }, "is_hybrid_deployment": { "type": "boolean", "description": "Whether this External Secrets Manager instance is compatible with Hybrid Deployment environments.", "example": true }, "created_at": { "type": "string", "description": "The timestamp when the ESM instance was created.", "format": "date-time", "example": "2026-05-20T00:00:00Z" }, "updated_at": { "type": "string", "description": "The timestamp when the ESM instance was last updated.", "format": "date-time", "example": "2026-05-20T00:00:00Z" } } }, "SecretsManagerEntityItem": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the source connection or destination.", "example": "connection_id" }, "name": { "type": "string", "description": "The schema name of the source connection, or the name of the destination group.", "example": "my_schema" }, "enabled": { "type": "boolean", "description": "Whether the source connection or destination is currently active and connected.", "example": true }, "type": { "type": "string", "description": "The type of entity using this External Secrets Manager. Possible values: SOURCE, DESTINATION.", "example": "SOURCE", "enum": [ "SOURCE", "DESTINATION" ] }, "secret_manager_id": { "type": "string", "description": "The unique identifier of the External Secrets Manager instance.", "example": "lucky_tiger" }, "created_at": { "type": "string", "description": "Timestamp when the entity was created", "format": "date-time", "example": "2024-01-01T00:00:00Z" } }, "description": "An entity (connection or destination) that uses an External Secrets Manager" }, "NewSystemKeyRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The system key name within the account", "example": "MySystemKey" }, "expiration_period": { "type": "string", "description": "The system key's expiration period", "example": "SIX_MONTHS", "enum": [ "ONE_WEEK", "ONE_MONTH", "THREE_MONTHS", "SIX_MONTHS", "INFINITE" ] }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/SystemKeyPermissionRequest" } } } }, "SystemKeyPermissionRequest": { "type": "object", "properties": { "resource_type": { "type": "string", "description": "The resource type for the permission", "example": "CONNECTOR", "enum": [ "ACCOUNT", "USER", "WEBHOOK", "TEAM", "ROLES", "DESTINATION", "TRANSFORMATION", "REMOTE_EXECUTION_AGENT", "CONNECTOR" ] }, "access_level": { "type": "string", "description": "The access level for the permission", "example": "MANAGE", "enum": [ "NONE", "READ", "MANAGE" ] }, "resource_filter": { "$ref": "#/components/schemas/SystemKeyPermissionResourceFilter" } } }, "SystemKeyPermissionResourceFilter": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of managed entities", "example": {}, "items": { "type": "string" } }, "group_ids": { "type": "array", "description": "The IDs of managed groups", "example": {}, "items": { "type": "string" } } } }, "RotateSystemKeyRequest": { "type": "object", "properties": { "expiration_period": { "type": "string", "description": "The system key's expiration period", "example": "SIX_MONTHS", "enum": [ "ONE_WEEK", "ONE_MONTH", "THREE_MONTHS", "SIX_MONTHS", "INFINITE" ] } } }, "UpdateSystemKeyRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The system key name within the account", "example": "MySystemKey" }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/SystemKeyPermissionRequest" } } } }, "SystemKeyPermissionResponse": { "type": "object", "properties": { "resource_type": { "type": "string", "description": "The resource type for the permission", "example": "DESTINATION", "enum": [ "ACCOUNT", "USER", "WEBHOOK", "TEAM", "ROLES", "DESTINATION", "TRANSFORMATION", "REMOTE_EXECUTION_AGENT", "CONNECTOR" ] }, "access_level": { "type": "string", "description": "The access level for the permission", "example": "MANAGE", "enum": [ "NONE", "READ", "MANAGE" ] }, "resource_filter": { "$ref": "#/components/schemas/SystemKeyPermissionResourceFilter" } } }, "SystemKeyResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the system key within the Fivetran system", "example": "key_id" }, "name": { "type": "string", "description": "The system key name within the account", "example": "MySystemKey" }, "key": { "type": "string", "description": "The key value of the system key", "example": "ft_rDefAFDSgFdAGdFG" }, "secret": { "type": "string", "description": "The secret value of rotated system key", "example": "uytFfdSfDADFgfCgFBVsdCSFg4fsGfFg87fhRuuFASuTHkETSfg" }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/SystemKeyPermissionResponse" } }, "created_at": { "type": "string", "description": "The system key creation timestamp", "format": "date-time", "example": "2023-08-20T10:15:20.677566Z" }, "updated_at": { "type": "string", "description": "The system key update timestamp", "format": "date-time", "example": "2023-08-20T10:15:20.677566Z" }, "expired_at": { "type": "string", "description": "The system key expiration timestamp", "format": "date-time", "example": "2024-08-20T10:15:20.677566Z" }, "last_used_at": { "type": "string", "description": "The timestamp of last usage", "format": "date-time", "example": "2023-08-20T10:15:20.677566Z" } } }, "MembershipRequest": { "required": [ "id", "role" ], "type": "object", "properties": { "id": { "type": "string", "description": "The connection unique identifier", "example": "connection_id" }, "role": { "type": "string", "description": "The team's role", "example": "View Connection" } } }, "TeamMembershipRequest": { "required": [ "user_id" ], "type": "object", "properties": { "user_id": { "type": "string", "description": "The unique identifier of user", "example": "user_id" }, "role": { "type": "string", "description": "The user's role within the team", "example": "Team Manager" } } }, "TeamRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the team within your account", "example": "Team Title" }, "description": { "type": "string", "description": "The description of the team within your account", "example": "Team Description" }, "role": { "type": "string", "description": "The account role of the team", "example": "Account Analyst" } } }, "UpdateTeamRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the team within your account", "example": "Team Name" }, "description": { "type": "string", "description": "The description of the team within your account", "example": "Team description" }, "role": { "type": "string", "description": "The account role of the team", "example": "Account Analyst" } } }, "UpdateMembershipRequest": { "required": [ "role" ], "type": "object", "properties": { "role": { "type": "string", "description": "The team's role", "example": "Edit Connection" } } }, "MembershipResponse": { "required": [ "created_at", "id", "role" ], "type": "object", "properties": { "id": { "type": "string", "description": "The membership entity unique identifier", "example": "resource_id" }, "role": { "type": "string", "description": "The role the user has within the entity", "example": "Role Title" }, "created_at": { "type": "string", "description": "The timestamp that the user created their Fivetran account", "format": "date-time", "example": "2024-01-01T00:00:00Z" } } }, "TeamMembershipResponse": { "required": [ "created_at", "role", "user_id" ], "type": "object", "properties": { "user_id": { "type": "string", "description": "The unique identifier of user", "example": "user_id" }, "role": { "type": "string", "description": "The user's role within the team", "example": "Team Member" }, "created_at": { "type": "string", "description": "The date and time the membership was created", "format": "date-time", "example": "2023-08-20T10:15:20.677566Z" } } }, "TeamResponse": { "required": [ "id", "role" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the team within your account", "example": "team_id" }, "name": { "type": "string", "description": "The name of the team within your account", "example": "Team Title" }, "description": { "type": "string", "description": "The description of the team within your account", "example": "Team Description" }, "role": { "type": "string", "description": "The account role of the team", "example": "Account Reviewer" } } }, "MembershipRequest_add_team_membership_in_group": { "required": [ "id", "role" ], "type": "object", "properties": { "id": { "type": "string", "description": "The group unique identifier", "example": "group_id" }, "role": { "type": "string", "description": "The team's role", "example": "Manage Destination" } } }, "UpdateMembershipRequest_update_team_membership_in_group": { "required": [ "role" ], "type": "object", "properties": { "role": { "type": "string", "description": "The user's role within the team", "example": "Manage Destination" } } }, "UpdateMembershipRequest_update_user_membership": { "required": [ "role" ], "type": "object", "properties": { "role": { "type": "string", "description": "The user's role within the team", "example": "Team Member" } } }, "NewTransformationProjectRequest": { "type": "object", "properties": { "group_id": { "type": "string", "description": "The unique identifier for the group within the Fivetran system" }, "type": { "type": "string", "description": "Transformation project type", "enum": [ "DBT_CORE" ] }, "run_tests": { "type": "boolean", "description": "The boolean flag specifies if the project should be tested after creation or update operation" } }, "discriminator": { "propertyName": "type", "mapping": { "DBT_CORE": "#/components/schemas/DBT_CORE_NewTransformationProjectRequest" } } }, "UpdateTransformationProjectRequest": { "type": "object", "properties": { "run_tests": { "type": "boolean", "description": "The boolean flag specifies if the project should be tested after creation or update operation" } }, "discriminator": { "propertyName": "type", "mapping": { "DBT_CORE": "#/components/schemas/DBT_CORE_UpdateTransformationProjectRequest" } } }, "TransformationProjectDetailsResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the transformation project within the Fivetran system" }, "type": { "type": "string", "description": "Transformation project type", "enum": [ "DBT_CORE" ] }, "status": { "type": "string", "description": "The status of transformation project", "enum": [ "NOT_READY", "READY", "ERROR" ] }, "errors": { "type": "array", "description": "The list of errors occurred during project processing and setup", "items": { "type": "string" } }, "created_at": { "type": "string", "description": "The timestamp when the transformation project was created", "format": "date-time" }, "created_by_id": { "type": "string", "description": "The unique identifier for the actor (user or system key) within the Fivetran system" }, "group_id": { "type": "string", "description": "The unique identifier for the group within the Fivetran system" }, "setup_tests": { "type": "array", "description": "The setup tests results", "items": { "$ref": "#/components/schemas/SetupTestResultResponse" } } }, "discriminator": { "propertyName": "type", "mapping": { "DBT_CORE": "#/components/schemas/DBT_CORE_TransformationProjectDetailsResponse" } } }, "TransformationProjectResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the transformation project within the Fivetran system" }, "type": { "type": "string", "description": "Transformation project type", "enum": [ "DBT_CORE" ] }, "created_at": { "type": "string", "description": "The timestamp when the transformation project was created", "format": "date-time" }, "created_by_id": { "type": "string", "description": "The unique identifier for the actor (user or system key) within the Fivetran system" }, "group_id": { "type": "string", "description": "The unique identifier for the group within the Fivetran system" } } }, "NewTransformationRequest": { "type": "object", "properties": { "schedule": { "$ref": "#/components/schemas/TransformationSchedule" }, "type": { "type": "string", "enum": [ "DBT_CORE", "QUICKSTART" ] }, "paused": { "type": "boolean" } }, "discriminator": { "propertyName": "type", "mapping": { "DBT_CORE": "#/components/schemas/DBT_CORE_NewTransformationRequest", "QUICKSTART": "#/components/schemas/QUICKSTART_NewTransformationRequest" } } }, "TransformationSchedule": { "required": [ "schedule_type" ], "type": "object", "properties": { "cron": { "type": "array", "description": "Cron schedule: list of CRON strings.", "example": [ "0 */1 * * *" ], "items": { "type": "string" } }, "interval": { "type": "integer", "description": "The interval in minutes", "format": "int32", "example": 60 }, "schedule_type": { "type": "string", "description": "The schedule type. The following values are supported: 'INTEGRATED', 'TIME_OF_DAY', 'INTERVAL', 'CRON'", "example": "TIME_OF_DAY", "enum": [ "INTEGRATED", "TIME_OF_DAY", "INTERVAL", "CRON" ] }, "days_of_week": { "uniqueItems": true, "type": "array", "description": "The set of days of the week, where an empty set represents a daily schedule", "example": [ "MONDAY", "FRIDAY" ], "items": { "type": "string", "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] } }, "time_of_day": { "type": "string", "description": "The time of the day the transformation should be launched at. The following values are supported: '00:00', '00:30', '01:00', '01:30', '02:00', '02:30', '03:00', '03:30', '04:00', '04:30', '05:00', '05:30', '06:00', '06:30', '07:00', '07:30', '08:00', '08:30', '09:00', '09:30', '10:00', '10:30', '11:00', '11:30', '12:00', '12:30', '13:00', '13:30', '14:00', '14:30', '15:00', '15:30', '16:00', '16:30', '17:00', '17:30', '18:00', '18:30', '19:00', '19:30', '20:00', '20:30', '21:00', '21:30', '22:00', '22:30', '23:00', '23:30'", "example": "14:00" }, "connection_ids": { "uniqueItems": true, "type": "array", "description": "The list of connection IDs that the Transformation for dbt depends on when using the integrated schedule (`schedule_type: INTEGRATED`) or custom schedules (`schedule_type: TIME_OF_DAY` or `schedule_type: INTERVAL`) with smart syncing enabled (`smart_syncing: true`). These connections must belong to the same group as the dbt project. This field should not be used for Quickstart transformations.", "example": [ "connection_id" ], "items": { "type": "string" } }, "transformation_ids": { "uniqueItems": true, "type": "array", "description": "The list of the transformation identifiers to be used for the integrated schedule or custom scheduling with smart syncing enabled", "example": [ "transformation_id" ], "items": { "type": "string" } }, "smart_syncing": { "type": "boolean", "description": "The boolean flag that enables the Smart Syncing schedule" } } }, "RunTransformationRequest": { "type": "object", "properties": { "full_refresh": { "type": "boolean" } } }, "UpdateTransformationRequest": { "type": "object", "properties": { "schedule": { "$ref": "#/components/schemas/TransformationSchedule" }, "paused": { "type": "boolean" } }, "discriminator": { "propertyName": "type", "mapping": { "DBT_CORE": "#/components/schemas/DBT_CORE_UpdateTransformationRequest", "QUICKSTART": "#/components/schemas/QUICKSTART_UpdateTransformationRequest" } } }, "TransformationResponse": { "required": [ "created_at", "created_by_id", "id", "paused", "schedule", "status", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the transformation within the Fivetran system", "example": "transformation_id" }, "status": { "type": "string", "description": "The status of transformation", "example": "RUNNING", "enum": [ "NEW", "SCHEDULING", "RUNNING", "TERMINATING", "SUCCEEDED", "FAILED", "BLOCKED", "CANCELED", "PARTIALLY_SUCCEEDED" ] }, "schedule": { "description": "The transformation schedule", "allOf": [ { "$ref": "#/components/schemas/TransformationSchedule" } ] }, "type": { "type": "string", "description": "Transformation type", "example": "DBT_CORE", "enum": [ "DBT_CORE", "QUICKSTART" ] }, "paused": { "type": "boolean", "description": "The field indicates whether transformation is in paused state", "example": true }, "created_at": { "type": "string", "description": "The timestamp when the transformation was created", "format": "date-time", "example": "2024-01-02T00:00:00.743708Z" }, "created_by_id": { "type": "string", "description": "The unique identifier for the actor (user or system key) within the Fivetran system", "example": "user_id" }, "last_started_at": { "type": "string", "description": "The timestamp when the transformation was started last time", "format": "date-time", "example": "2024-01-02T00:00:00.000001Z" }, "last_ended_at": { "type": "string", "description": "The timestamp when the transformation was ended last time", "format": "date-time", "example": "2024-01-02T00:00:00.000001Z" }, "output_model_names": { "uniqueItems": true, "type": "array", "description": "The list of transformation output models", "items": { "type": "string" } } }, "discriminator": { "propertyName": "type", "mapping": { "DBT_CORE": "#/components/schemas/DBT_CORE_TransformationResponse", "QUICKSTART": "#/components/schemas/QUICKSTART_TransformationResponse" } } }, "ConfigurableVariable": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "STRING", "INTEGER", "BOOLEAN", "FLOAT", "NUMBER", "LIST", "DICTIONARY", "OBJECT", "DATE" ] }, "description": { "type": "string" }, "allowed_values": { "type": "array", "items": { "type": "string" } } } }, "TransformationPackageMetadataResponse": { "required": [ "id", "name", "version" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the Quickstart transformation package definition within the Fivetran system", "example": "package_definition_id" }, "name": { "type": "string", "description": "The Quickstart transformation package name", "example": "package_definition_name" }, "version": { "type": "string", "description": "The Quickstart package definition version", "example": "version" }, "connector_types": { "uniqueItems": true, "type": "array", "description": "The set of connector types", "items": { "type": "string" } }, "output_model_names": { "type": "array", "description": "The list of transformation output models", "items": { "type": "string" } }, "configurable_variables": { "type": "object", "description": "The map of configurable variable values keyed by variable name." } } }, "GroupMembershipRequest": { "required": [ "id", "role" ], "type": "object", "properties": { "id": { "type": "string", "description": "The membership entity unique identifier", "example": "group_id" }, "role": { "type": "string", "description": "The role that you would like to assign to the user ", "example": "Manage Connection" } } }, "NewUserRequest": { "required": [ "email", "family_name", "given_name" ], "type": "object", "properties": { "email": { "type": "string", "description": "The email address that the user has associated with their user profile. Optional for service accounts (`user_type: SERVICE_ACCOUNT`).", "example": "user@email.value" }, "family_name": { "type": "string", "description": "The last name of the user.", "example": "Doe" }, "given_name": { "type": "string", "description": "The first name of the user.", "example": "John" }, "phone": { "type": "string", "description": "The phone number of the user.", "example": "+1234567890" }, "picture": { "type": "string", "description": "The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')", "example": "AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==" }, "role": { "type": "string", "description": "The role that you would like to assign to the user ", "example": "Account Administrator" }, "user_type": { "type": "string", "description": "The type of user. Possible values: `REGULAR_USER`: A human user who can log in to the Fivetran dashboard and interact with the API, and `SERVICE_ACCOUNT`: A non-human identity for machine-to-machine API access that cannot log in to the dashboard.", "example": "SERVICE_ACCOUNT" } } }, "CreateApiKeyRequest": { "type": "object", "properties": { "expiration_period_days": { "type": "integer", "description": "The number of days until the API key expires. Defaults to 90. Maximum is 365.", "format": "int32", "example": 90 } } }, "RotateApiKeyRequest": { "type": "object", "properties": { "expiration_period_days": { "type": "integer", "description": "The number of days until the API key expires. Defaults to 90. Maximum is 365.", "format": "int32", "example": 90 }, "overlap_days": { "type": "integer", "description": "The number of days the old and new API keys both remain valid after rotation. Maximum is 30 days.", "format": "int32", "example": 7 } } }, "UpdateUserRequest": { "type": "object", "properties": { "phone": { "type": "string", "description": "The phone number of the user.", "example": "+9876543210" }, "picture": { "type": "string", "description": "The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')", "example": "AFg65aoa7af4r3feaAa6bi7se ... base64 encoded image ... blDFSs87gQ==" }, "role": { "type": "string", "description": "The account role that you would like to assign to the user. You cannot change your own role. ", "example": "Account Administrator" }, "family_name": { "type": "string", "description": "The last name of the user.", "example": "Doe" }, "given_name": { "type": "string", "description": "The first name of the user.", "example": "Jane" } } }, "CreateApiKeyResponse": { "required": [ "created_at", "key_secret", "key_status", "key_value" ], "type": "object", "properties": { "key_value": { "type": "string", "description": "The public identifier of the API key.", "example": "key_abc123" }, "key_secret": { "type": "string", "description": "The secret portion of the API key. Only returned at creation time and cannot be retrieved again.", "example": "secret_xyz789" }, "key_status": { "type": "string", "description": "The status of the API key. Possible values: `ACTIVE`: The key has a single active secret, `ACTIVE_GRACE`: The key has two active secrets during rotation overlap, and `EXPIRED`: The key has expired.", "example": "ACTIVE" }, "created_at": { "type": "string", "description": "The timestamp that the user created their API key", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "expires_at": { "type": "string", "description": "The timestamp when the API key expires.", "format": "date-time", "example": "2024-04-01T00:00:00Z" } } }, "ApiKeyResponse": { "required": [ "created_at", "key_status", "key_value", "user_id", "user_type" ], "type": "object", "properties": { "user_id": { "type": "string", "description": "The unique identifier for the user within the Fivetran system.", "example": "user_id" }, "user_type": { "type": "string", "description": "The type of user. Possible values: `REGULAR_USER`: A human user who can log in to the Fivetran dashboard and interact with the API, and `SERVICE_ACCOUNT`: A non-human identity for machine-to-machine API access that cannot log in to the dashboard.", "example": "SERVICE_ACCOUNT", "enum": [ "REGULAR_USER", "SERVICE_ACCOUNT" ] }, "key_value": { "type": "string", "description": "The public identifier of the API key.", "example": "key_abc123" }, "created_at": { "type": "string", "description": "The timestamp that the user created their API key", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "key_status": { "type": "string", "description": "The status of the API key. Possible values: `ACTIVE`: The key has a single active secret, `ACTIVE_GRACE`: The key has two active secrets during rotation overlap, and `EXPIRED`: The key has expired.", "example": "ACTIVE", "enum": [ "ACTIVE", "ACTIVE_GRACE", "EXPIRED" ] }, "expires_at": { "type": "string", "description": "The timestamp when the API key expires.", "format": "date-time", "example": "2024-04-01T00:00:00Z" }, "overlap_expires_at": { "type": "string", "description": "The timestamp when the previous secret expires after rotation. Only present during the overlap period.", "format": "date-time", "example": "2024-03-08T00:00:00Z" }, "last_rotated_at": { "type": "string", "format": "date-time" } } }, "RotateApiKeyResponse": { "required": [ "expires_at", "key_secret", "key_status", "key_value" ], "type": "object", "properties": { "key_value": { "type": "string", "description": "The public identifier of the API key.", "example": "key_abc123" }, "key_secret": { "type": "string", "description": "The secret portion of the API key. Only returned at creation time and cannot be retrieved again.", "example": "secret_xyz789" }, "key_status": { "type": "string", "description": "The status of the API key. Possible values: `ACTIVE`: The key has a single active secret, `ACTIVE_GRACE`: The key has two active secrets during rotation overlap, and `EXPIRED`: The key has expired.", "example": "ACTIVE", "enum": [ "ACTIVE", "ACTIVE_GRACE", "EXPIRED" ] }, "expires_at": { "type": "string", "description": "The timestamp when the API key expires.", "format": "date-time", "example": "2024-04-01T00:00:00Z" }, "overlap_expires_at": { "type": "string", "description": "The timestamp when the previous secret expires after rotation. Only present during the overlap period.", "format": "date-time", "example": "2024-03-08T00:00:00Z" }, "last_rotated_at": { "type": "string", "format": "date-time" } } }, "MembershipRequest_add_user_membership_in_connection": { "required": [ "id", "role" ], "type": "object", "properties": { "id": { "type": "string", "description": "The membership entity unique identifier", "example": "connection_id" }, "role": { "type": "string", "description": "The role that you would like to assign to the user ", "example": "Manage Connection" } } }, "UpdateMembershipRequest_update_user_membership_in_connection": { "required": [ "role" ], "type": "object", "properties": { "role": { "type": "string", "description": "The role that you would like to assign to the user " } } }, "UpdateMembershipRequest_update_user_membership_in_group": { "required": [ "role" ], "type": "object", "properties": { "role": { "type": "string", "description": "The role that you would like to assign to the user ", "example": "Manage Destination" } } }, "WebhookRequest": { "required": [ "events", "url" ], "type": "object", "properties": { "url": { "type": "string", "description": "The endpoint URL where webhook events will be delivered.", "example": "https://your-host.your-domain/webhook" }, "events": { "type": "array", "description": "List of event types that trigger the webhook.", "example": [ "sync_start", "sync_end" ], "items": { "type": "string" } }, "active": { "type": "boolean", "description": "Indicates if the webhook is enabled to send events immediately upon occurrence.", "example": true }, "secret": { "type": "string", "description": "A secret string used to sign webhook payloads for verification.", "example": "your_webhook_secret" } } }, "WebhookTestRequest": { "required": [ "event" ], "type": "object", "properties": { "event": { "type": "string", "description": "Type of event to be sent during webhook testing.", "example": "sync_end" } } }, "WebhookResponse": { "required": [ "active", "created_at", "created_by", "events", "id", "type", "url" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the webhook.", "example": "webhook_id" }, "type": { "type": "string", "description": "The type of the webhook. Specifies whether the webhook is associated with a group or an account.", "example": "group", "enum": [ "group", "account" ] }, "url": { "type": "string", "description": "The endpoint URL where webhook events will be delivered.", "example": "https://your-host.your-domain/webhook" }, "events": { "type": "array", "description": "List of event types that trigger the webhook.", "example": [ "sync_start", "sync_end" ], "items": { "type": "string" } }, "active": { "type": "boolean", "description": "Indicates if the webhook is enabled to send events immediately upon occurrence.", "example": true }, "secret": { "type": "string", "description": "A secret string used to sign webhook payloads for verification.", "example": "******" }, "group_id": { "type": "string", "description": "Unique identifier for the group associated with the webhook.", "example": "group_id" }, "created_at": { "type": "string", "description": "Timestamp indicating when the webhook was created.", "format": "date-time", "example": "2024-01-01T00:00:00Z" }, "created_by": { "type": "string", "description": "Identifier of the user who created the webhook setting.", "example": "user_id" } } }, "WebhookTestResponse": { "required": [ "status", "succeed" ], "type": "object", "properties": { "succeed": { "type": "boolean", "description": "Indicates whether the webhook test was successful.", "example": true }, "status": { "type": "integer", "description": "HTTP status code returned by the webhook test.", "format": "int32", "example": 200 }, "message": { "type": "string", "description": "Additional information or result message from the webhook test.", "example": "Success" } } }, "WebhookRequest_create_group_webhook": { "required": [ "events", "url" ], "type": "object", "properties": { "url": { "type": "string", "description": "The endpoint URL where webhook events will be delivered.", "example": "https://your-host.your-domain/webhook" }, "events": { "type": "array", "description": "List of event types that trigger the webhook.", "example": [ "sync_start", "sync_end" ], "items": { "type": "string" } }, "active": { "type": "boolean", "description": "Indicates if the webhook is enabled to send events immediately upon occurrence.", "example": true }, "secret": { "type": "string", "description": "A secret string used to sign webhook payloads for verification.", "example": "your_webhook_secret" } } }, "WebhookRequest_modify_webhook": { "type": "object", "properties": { "url": { "type": "string", "description": "The endpoint URL where webhook events will be delivered.", "example": "https://your-host.your-domain/webhook" }, "events": { "type": "array", "description": "List of event types that trigger the webhook.", "example": [ "sync_start", "sync_end" ], "items": { "type": "string" } }, "active": { "type": "boolean", "description": "Indicates if the webhook is enabled to send events immediately upon occurrence.", "example": true }, "secret": { "type": "string", "description": "A secret string used to sign webhook payloads for verification.", "example": "your_webhook_secret" } } }, "aiven_kafka_wh_config_V1": { "properties": { "config": { "type": "object", "properties": { "bootstrap_servers": { "title": "", "type": "array", "description": "", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "connection_method": { "title": "", "type": "object", "description": "", "example": "privatelink | direct", "enum": [ "privatelink", "direct" ] }, "data_format": { "title": "", "type": "object", "description": "", "example": "JSON | AVRO", "enum": [ "JSON", "AVRO" ] }, "enable_single_topic": { "title": "", "type": "boolean", "description": "", "example": true }, "num_of_partitions": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 }, "replication_factor": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 }, "sasl_mechanism": { "title": "", "type": "object", "description": "", "example": "SCRAM_SHA_512 | SCRAM_SHA_256", "enum": [ "SCRAM_SHA_512", "SCRAM_SHA_256" ] }, "sasl_plain_key": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "sasl_plain_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "schema_registry": { "title": "", "type": "object", "description": "", "example": "AIVEN_KARAPACE | CONFLUENT_CLOUD", "enum": [ "AIVEN_KARAPACE", "CONFLUENT_CLOUD" ] }, "schema_registry_api_key": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "schema_registry_api_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "schema_registry_url": { "title": "", "type": "string", "description": "", "example": "string" }, "security_protocol": { "title": "", "type": "object", "description": "", "example": "SASL | SASL_PLAINTEXT", "enum": [ "SASL", "SASL_PLAINTEXT" ] } }, "description": "" } } }, "aiven_kafka_wh_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/aiven_kafka_wh_config_V1" } ] }, "aurora_postgres_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Authentication method. Default value: `PASSWORD`.", "example": "PASSWORD | AWS_IAM", "enum": [ "PASSWORD", "AWS_IAM" ] }, "aws_region_code": { "title": "", "type": "object", "description": "AWS region where the Aurora cluster is located. Required when `auth_method` is set to `AWS_IAM`.", "example": "us-east-1", "enum": [ "me-central-1", "aws-cn-global", "us-isof-south-1", "ap-east-2", "us-west-1", "us-west-2", "af-south-1", "ap-northeast-3", "ap-northeast-2", "ap-northeast-1", "me-south-1", "sa-east-1", "cn-north-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ap-southeast-5", "us-east-1", "us-east-2", "ap-southeast-7", "aws-iso-e-global", "cn-northwest-1", "ap-south-2", "ap-south-1", "eu-south-1", "eu-south-2", "us-gov-east-1", "il-central-1", "ca-central-1", "mx-central-1", "eu-central-1", "eusc-de-east-1", "us-iso-west-1", "eu-central-2", "eu-isoe-west-1", "aws-global", "eu-north-1", "eu-west-3", "eu-west-2", "eu-west-1", "aws-iso-global", "ap-east-1", "ca-west-1", "us-gov-west-1", "us-iso-east-1", "aws-iso-b-global", "aws-iso-f-global", "aws-us-gov-global", "us-isob-east-1", "us-isof-east-1" ] }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "Database name", "example": "production" }, "external_id": { "title": "", "type": "string", "description": "AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.", "example": "external-id-12345" }, "host": { "title": "", "type": "string", "description": "Server name", "example": "87a8z-3da23-3da8d-cloud.sql.com" }, "password": { "title": "", "type": "string", "description": "Database user password", "format": "password", "example": "fresh_air_267@83" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 443 }, "role_arn": { "title": "", "type": "string", "description": "AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.", "example": "arn:aws:iam::123456789012:role/MyRole" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "ssh.server.com" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.", "format": "int32", "example": 564 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "Fivetran" }, "user": { "title": "", "type": "string", "description": "Database user name", "example": "admin" } }, "description": "" } } }, "aurora_postgres_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/aurora_postgres_warehouse_config_V1" } ] }, "aurora_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel", "enum": [ "Directly", "PrivateLink", "SshTunnel" ] }, "database": { "title": "", "type": "string", "description": "Database name", "example": "production" }, "host": { "title": "", "type": "string", "description": "Server name", "example": "87a8z-3da23-3da8d-cloud.sql.com" }, "password": { "title": "", "type": "string", "description": "Database user password", "format": "password", "example": "fresh_air_267@83" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 443 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "ssh.server.com" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.", "format": "int32", "example": 564 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "Fivetran" }, "user": { "title": "", "type": "string", "description": "Database user name", "example": "admin" } }, "description": "" } } }, "aurora_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/aurora_warehouse_config_V1" } ] }, "aws_msk_wh_config_V1": { "properties": { "config": { "type": "object", "properties": { "bootstrap_servers": { "title": "", "type": "array", "description": "", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "connection_method": { "title": "", "type": "object", "description": "", "example": "privatelink | direct", "enum": [ "privatelink", "direct" ] }, "data_format": { "title": "", "type": "object", "description": "", "example": "JSON | AVRO", "enum": [ "JSON", "AVRO" ] }, "enable_single_topic": { "title": "", "type": "boolean", "description": "", "example": true }, "fivetran_glue_role_arn": { "title": "", "type": "string", "description": "", "example": "string" }, "fivetran_msk_role_arn": { "title": "", "type": "string", "description": "", "example": "string" }, "msk_sts_region": { "title": "", "type": "string", "description": "", "example": "string" }, "num_of_partitions": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 }, "registry_name": { "title": "", "type": "string", "description": "", "example": "string" }, "registry_sts_region": { "title": "", "type": "string", "description": "", "example": "string" }, "replication_factor": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 }, "sasl_mechanism": { "title": "", "type": "object", "description": "", "example": "SCRAM_SHA_512 | AWS_IAM", "enum": [ "SCRAM_SHA_512", "AWS_IAM" ] }, "sasl_plain_key": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "sasl_plain_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "schema_compatibility": { "title": "", "type": "object", "description": "", "example": "DISABLED | BACKWARD | BACKWARD_ALL | FORWARD_ALL | FORWARD | NONE | FULL | FULL_ALL", "enum": [ "DISABLED", "BACKWARD", "BACKWARD_ALL", "FORWARD_ALL", "FORWARD", "NONE", "FULL", "FULL_ALL" ] }, "schema_registry": { "title": "", "type": "object", "description": "", "example": "CONFLUENT_CLOUD | AWS_GLUE", "enum": [ "CONFLUENT_CLOUD", "AWS_GLUE" ] }, "schema_registry_api_key": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "schema_registry_api_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "schema_registry_url": { "title": "", "type": "string", "description": "", "example": "string" }, "security_protocol": { "title": "", "type": "object", "description": "", "example": "SASL | SASL_PLAINTEXT", "enum": [ "SASL", "SASL_PLAINTEXT" ] } }, "description": "" } } }, "aws_msk_wh_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/aws_msk_wh_config_V1" } ] }, "azure_postgres_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Authentication method. Default value: `PASSWORD`.", "example": "ENTRA_ID", "enum": [ "ENTRA_ID", "PASSWORD", "CLIENT_CERTIFICATE", "AWS_IAM" ] }, "aws_region_code": { "title": "", "type": "string", "description": "AWS region code. Required when `auth_method` is set to `AWS_IAM`.", "example": "us-east-1" }, "connection_type": { "title": "", "type": "object", "description": "", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "", "example": "string" }, "external_id": { "title": "", "type": "string", "description": "AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.", "example": "external-id-12345" }, "host": { "title": "", "type": "string", "description": "", "example": "string" }, "password": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "port": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 }, "role_arn": { "title": "", "type": "string", "description": "AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.", "example": "arn:aws:iam::123456789012:role/MyRole" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "", "example": "string" }, "tunnel_port": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 }, "tunnel_user": { "title": "", "type": "string", "description": "", "example": "string" }, "user": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "azure_postgres_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/azure_postgres_warehouse_config_V1" } ] }, "azure_sql_data_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel", "enum": [ "Directly", "PrivateLink", "SshTunnel" ] }, "database": { "title": "", "type": "string", "description": "Database name", "example": "production" }, "host": { "title": "", "type": "string", "description": "Server name", "example": "87a8z-3da23-3da8d-cloud.sql.com" }, "password": { "title": "", "type": "string", "description": "Database user password", "format": "password", "example": "fresh_air_267@83" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 443 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "storage_account_key": { "title": "", "type": "string", "description": "The access key of the Azure storage account you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.", "example": "string" }, "storage_account_name": { "title": "", "type": "string", "description": "The name of the Azure storage account you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.", "example": "string" }, "tunnel_host": { "title": "", "type": "string", "description": "SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "ssh.server.com" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.", "format": "int32", "example": 564 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "Fivetran" }, "user": { "title": "", "type": "string", "description": "Database user name", "example": "admin" } }, "description": "" } } }, "azure_sql_data_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/azure_sql_data_warehouse_config_V1" } ] }, "azure_sql_database_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "", "example": true }, "connection_type": { "title": "", "type": "object", "description": "", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "", "example": "string" }, "host": { "title": "", "type": "string", "description": "", "example": "string" }, "password": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "port": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "", "example": "string" }, "tunnel_port": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 }, "tunnel_user": { "title": "", "type": "string", "description": "", "example": "string" }, "user": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "azure_sql_database_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "", "example": "USER_KEY" } }, "description": "" } } }, "azure_sql_database_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/azure_sql_database_config_V1" }, { "$ref": "#/components/schemas/azure_sql_database_esm_keys_config_V1" } ] }, "azure_sql_managed_db_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "", "example": true }, "connection_type": { "title": "", "type": "object", "description": "", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "", "example": "string" }, "host": { "title": "", "type": "string", "description": "", "example": "string" }, "password": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "port": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "", "example": "string" }, "tunnel_port": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 }, "tunnel_user": { "title": "", "type": "string", "description": "", "example": "string" }, "user": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "azure_sql_managed_db_warehouse_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "", "example": "USER_KEY" } }, "description": "" } } }, "azure_sql_managed_db_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/azure_sql_managed_db_warehouse_config_V1" }, { "$ref": "#/components/schemas/azure_sql_managed_db_warehouse_esm_keys_config_V1" } ] }, "big_query_config_V1": { "properties": { "config": { "type": "object", "properties": { "bucket": { "title": "", "type": "string", "description": "Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location.", "example": "customer-bucket" }, "data_set_location": { "title": "", "type": "string", "description": "Data location. Datasets will reside in this location.", "example": "US" }, "project_id": { "title": "", "type": "string", "description": "BigQuery project ID", "example": "my-bigquery-project" }, "secret_key": { "title": "", "type": "string", "description": "Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.", "format": "password", "example": "private-key-of-the-customer-service-account" }, "support_json_type": { "title": "", "type": "boolean", "description": "Stores JSON columns as JSON instead of STRING. This parameter is applicable only to destinations created before August 1, 2025.", "example": true } }, "description": "" } } }, "big_query_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/big_query_config_V1" } ] }, "big_query_dts_config_V1": { "properties": { "config": { "type": "object", "properties": { "bucket": { "title": "", "type": "string", "description": "", "example": "string" }, "data_set_location": { "title": "", "type": "string", "description": "", "example": "string" }, "project_id": { "title": "", "type": "string", "description": "", "example": "string" }, "secret_key": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "support_json_type": { "title": "", "type": "boolean", "description": "Stores JSON columns as JSON instead of STRING. This parameter is applicable only to destinations created before August 1, 2025.", "example": true } }, "description": "" } } }, "big_query_dts_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/big_query_dts_config_V1" } ] }, "clickhouse_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "clickhouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/clickhouse_config_V1" } ] }, "confluent_cloud_wh_config_V1": { "properties": { "config": { "type": "object", "properties": { "bootstrap_servers": { "title": "", "type": "array", "description": "Comma-separated list of Confluent Cloud servers in the `server:port` format.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "connection_method": { "title": "", "type": "object", "description": "", "example": "privatelink | direct", "enum": [ "privatelink", "direct" ] }, "data_format": { "title": "", "type": "object", "description": "Confluent Cloud message format.", "example": "JSON | AVRO", "enum": [ "JSON", "AVRO" ] }, "enable_single_topic": { "title": "", "type": "boolean", "description": "Populate all tables in a single topic.", "example": true }, "num_of_partitions": { "title": "", "type": "integer", "description": "Number of partitions per topic.", "format": "int32", "example": 4 }, "replication_factor": { "title": "", "type": "integer", "description": "Replication factor.", "format": "int32", "example": 3 }, "sasl_mechanism": { "title": "", "type": "object", "description": "Security protocol for Confluent Cloud interaction.", "example": "PLAIN | SCRAM_SHA_512 | SCRAM_SHA_256 | AWS_IAM", "enum": [ "PLAIN", "SCRAM_SHA_512", "SCRAM_SHA_256", "AWS_IAM" ] }, "sasl_plain_key": { "title": "", "type": "string", "description": "Confluent Cloud SASL key.", "format": "password", "example": "your_API_key" }, "sasl_plain_secret": { "title": "", "type": "string", "description": "Confluent Cloud SASL secret.", "format": "password", "example": "your_API_secret" }, "schema_registry": { "title": "", "type": "object", "description": "Schema Registry", "example": "AIVEN_KARAPACE | CONFLUENT_CLOUD | AWS_GLUE", "enum": [ "AIVEN_KARAPACE", "CONFLUENT_CLOUD", "AWS_GLUE" ] }, "schema_registry_api_key": { "title": "", "type": "string", "description": "Schema registry API key.", "format": "password", "example": "your_schema_registry_API_key" }, "schema_registry_api_secret": { "title": "", "type": "string", "description": "Schema registry API secret.", "format": "password", "example": "your_schema_registry_API_secret" }, "schema_registry_url": { "title": "", "type": "string", "description": "Schema registry URL.", "example": "http" }, "security_protocol": { "title": "", "type": "object", "description": "Security protocol for Confluent Cloud interaction.", "example": "SASL | SASL_PLAINTEXT", "enum": [ "SASL", "SASL_PLAINTEXT" ] } }, "description": "" } } }, "confluent_cloud_wh_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/confluent_cloud_wh_config_V1" } ] }, "databricks_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_type": { "title": "", "type": "object", "description": "Authentication type", "example": "PERSONAL_ACCESS_TOKEN | OAUTH2", "enum": [ "PERSONAL_ACCESS_TOKEN", "OAUTH2" ] }, "aws_access_key_id": { "title": "", "type": "string", "description": "Your user's access key ID", "example": "string" }, "aws_secret_access_key": { "title": "", "type": "string", "description": "Your user's secret access key", "format": "password", "example": "string" }, "azure_client_id": { "title": "", "type": "string", "description": "Your Azure AD application (client) ID for Client Credentials authentication to the Azure container used as external staging for Hybrid Deployment.", "example": "string" }, "azure_client_secret": { "title": "", "type": "string", "description": "Your Azure AD application client secret for Client Credentials authentication to the Azure container used as external staging for Hybrid Deployment.", "format": "password", "example": "string" }, "azure_storage_account_auth_type": { "title": "", "type": "string", "description": "Authentication method for the Azure container you want to use as the external staging for Hybrid Deployment.", "example": "Storage Account Key" }, "azure_tenant_id": { "title": "", "type": "string", "description": "Your Azure AD tenant ID for Client Credentials authentication to the Azure container used as external staging for Hybrid Deployment.", "example": "string" }, "bucket": { "title": "", "type": "string", "description": "Your bucket", "example": "string" }, "bucket_region": { "title": "", "type": "string", "description": "Your bucket's region", "example": "string" }, "catalog": { "title": "", "type": "string", "description": "Catalog name", "example": "string" }, "cloud_provider": { "title": "", "type": "object", "description": "Databricks deployment cloud", "example": "AZURE | GCP | AWS", "enum": [ "AZURE", "GCP", "AWS" ] }, "connection_type": { "title": "", "type": "object", "description": "", "example": "Directly | PrivateLink", "enum": [ "Directly", "PrivateLink" ] }, "create_external_tables": { "title": "", "type": "boolean", "description": "Whether to create external tables", "example": true }, "create_external_volumes": { "title": "", "type": "boolean", "description": "Specifies whether you want Fivetran to create external volumes for unstructured data files.", "example": true }, "disable_vacuum": { "title": "", "type": "boolean", "description": "Specifies whether you want Fivetran to disable Vacuum operations on Delta tables.", "example": true }, "external_location": { "title": "", "type": "string", "description": "External location to store Delta tables. Default value: `\"\"` (null). By default, the external tables will reside in the `/{schema}/{table}` path, and if you specify an external location in the `{externalLocation}/{schema}/{table}` path.", "example": "/some_external_location" }, "external_storage_cloud_provider": { "title": "", "type": "object", "description": "", "example": "AZURE | GCP | AWS", "enum": [ "AZURE", "GCP", "AWS" ] }, "external_volume_location": { "title": "", "type": "string", "description": "Specifies the external volume path where you want Fivetran to create the unstructured files.", "example": "s3://bucket/prefix_path" }, "http_path": { "title": "", "type": "string", "description": "HTTP path", "example": "sql/protocolv1/o/2873663545782684434-15262-272625-fives565" }, "oauth2_client_id": { "title": "", "type": "string", "description": "OAuth 2.0 client ID", "example": "your_oauth_client_id" }, "oauth2_secret": { "title": "", "type": "string", "description": "OAuth 2.0 secret", "format": "password", "example": "your_oauth_secret" }, "personal_access_token": { "title": "", "type": "string", "description": "Personal access token", "format": "password", "example": "your_databricks_personal_access_token" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 443 }, "s3_bucket_auth_type": { "title": "", "type": "object", "description": "Authentication method for the S3 bucket you want to use as the external staging for Hybrid Deployment.", "example": "IAM_ROLE | IAM_USER", "enum": [ "IAM_ROLE", "IAM_USER" ] }, "server_host_name": { "title": "", "type": "string", "description": "Server name", "example": "87a8z-3da23-3da8d-cloud.databricks.com" }, "storage_account_key": { "title": "", "type": "string", "description": "Your storage account key", "format": "password", "example": "string" }, "storage_account_name": { "title": "", "type": "string", "description": "Your storage account name", "example": "string" } }, "description": "" } } }, "databricks_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "oauth2_client_id": { "title": "", "type": "string", "description": "ESM key for oAuth 2.0 client ID", "example": "OAUTH2_CLIENT_ID_KEY" }, "oauth2_secret": { "title": "", "type": "string", "description": "ESM key for oAuth 2.0 secret", "example": "OAUTH2_SECRET_KEY" }, "personal_access_token": { "title": "", "type": "string", "description": "ESM key for personal access token", "example": "PERSONAL_ACCESS_TOKEN_KEY" } }, "description": "" } } }, "databricks_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/databricks_config_V1" }, { "$ref": "#/components/schemas/databricks_esm_keys_config_V1" } ] }, "databricks_via_managed_data_lake_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_type": { "title": "", "type": "object", "description": "Specifies the authentication types for Fivetran to connect to Databricks.", "example": "PERSONAL_ACCESS_TOKEN | OAUTH2", "enum": [ "PERSONAL_ACCESS_TOKEN", "OAUTH2" ] }, "bucket": { "title": "", "type": "string", "description": "(Immutable) Name of the S3 or Google Cloud Storage (GCS) bucket you want to use to store your data. Use this parameter only if you want to deploy your data lake on Amazon Web Services (AWS) or GCS.", "example": "s3_bucket_name" }, "catalog": { "title": "", "type": "string", "description": "Name of the specific catalog in Unity Catalog that you want to use to manage your Delta Lake tables.", "example": "string" }, "client_id": { "title": "", "type": "string", "description": "Client ID of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.", "example": "service_principal_client_id" }, "connection_type": { "title": "", "type": "object", "description": "connection type", "example": "Directly", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "container_name": { "title": "", "type": "string", "description": "(Immutable) Name of the ADLS container you want to use to store your data. Use this parameter only if you want to deploy your data lake on ADLS.", "example": "adls_container_name" }, "databricks_connection_type": { "title": "", "type": "object", "description": "Specifies how you want Fivetran to connect to the Databricks account associated with Unity Catalog. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "fivetran_role_arn": { "title": "", "type": "string", "description": "(Immutable) ARN of the IAM role you created for the IAM policy associated with your S3 bucket or Glue catalog. Use this parameter only if you want to deploy your data lake on AWS.", "example": "iam_role_arn" }, "gcs_project_id": { "title": "", "type": "string", "description": "GCS Project ID of your Google Cloud Storage bucket. Use this parameter only if you want to deploy your data lake on GCS.", "example": "false" }, "http_path": { "title": "", "type": "string", "description": "HTTP path of the Databricks account associated with Unity Catalog.", "example": "string" }, "lakehouse_guid": { "title": "", "type": "string", "description": "(Immutable) OneLake lakehouse GUID.", "example": "onelake_lakehouse_guid" }, "oauth2_client_id": { "title": "", "type": "string", "description": "The OAuth 2.0 client ID you created for authenticating Fivetran.", "example": "string" }, "oauth2_secret": { "title": "", "type": "string", "description": "OAuth 2.0 secret you created for authenticating Fivetran.", "format": "password", "example": "string" }, "one_lake_auth_type": { "title": "", "type": "object", "description": "(Immutable) Authentication type for OneLake. Default value: `ServicePrincipal`.", "example": "SERVICE_PRINCIPAL | WORKSPACE_IDENTITY", "enum": [ "SERVICE_PRINCIPAL", "WORKSPACE_IDENTITY" ] }, "onelake_client_id": { "title": "", "type": "string", "description": "(Immutable) Client ID of OneLake service principal.", "example": "onelake_client_id" }, "onelake_client_secret": { "title": "", "type": "string", "description": "Secret value for OneLake service principal.", "format": "password", "example": "onelake_client_secret" }, "onelake_tenant_id": { "title": "", "type": "string", "description": "(Immutable) Tenant ID of OneLake service principal", "example": "onelake_tenant_id" }, "personal_access_token": { "title": "", "type": "string", "description": "The personal access token you created for authenticating Fivetran.", "format": "password", "example": "string" }, "polaris_catalog_configuration": { "type": "object", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" }, "polaris_catalog": { "type": "string", "description": "Polaris Catalog" }, "polaris_server_endpoint": { "type": "string", "description": "Polaris Server Endpoint" } }, "description": "Polaris Catalog Base Configuration. Universal connection settings for any query engine or analytics tool." }, "port": { "title": "", "type": "integer", "description": "Server port number of the Databricks account associated with Unity Catalog.", "format": "int32", "example": 0 }, "prefix_path": { "title": "", "type": "string", "description": "(Immutable) Prefix path or virtual folder path within your bucket or container where you want Fivetran to store your data. Skip this parameter for AWS-based data lakes if the IAM policy configured for your S3 bucket grants access to the entire bucket.", "example": "s3_bucket_path_prefix" }, "region": { "title": "", "type": "string", "description": "(Immutable) AWS Region of your S3 bucket. Use this parameter only if you want to deploy your data lake on AWS.", "example": "s3_bucket_region" }, "secret_value": { "title": "", "type": "string", "description": "Secret value of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.", "format": "password", "example": "service_principal_secret_value" }, "server_host_name": { "title": "", "type": "string", "description": "Server host name of the Databricks account associated with Unity Catalog.", "example": "string" }, "should_maintain_tables_in_bqms": { "title": "", "type": "boolean", "description": "Specifies whether you want to manage your Iceberg tables in BQMS. Use this parameter only if you want to deploy your data lake on GCS.", "example": true }, "should_maintain_tables_in_databricks": { "title": "", "type": "boolean", "description": "Specifies whether you want to manage your Delta Lake tables in Databricks Unity Catalog.", "example": true }, "should_maintain_tables_in_glue": { "title": "", "type": "boolean", "description": "Specifies whether you want to manage your Iceberg tables in AWS Glue. Use this parameter only if you want to deploy your data lake on AWS.", "example": true }, "should_maintain_tables_in_one_lake": { "title": "", "type": "boolean", "description": "Specifies whether you want to create shortcut for you table in OneLake. Use this parameter only if you want to deploy your data lake on ADLS.", "example": true }, "should_write_delta": { "title": "", "type": "boolean", "description": "Specifies whether Fivetran writes Delta Lake metadata in addition to Iceberg tables. Databricks via Managed Data Lake requires Delta Lake metadata, so Fivetran always uses `true` for this destination.", "example": true }, "snapshot_retention_period": { "title": "", "type": "object", "description": "Specifies how long you want us to retain your table snapshots. We delete the snapshots that are older than the retention period during our table maintenance operations. Default value: `ONE_WEEK`.", "example": "ONE_WEEK", "enum": [ "TWO_WEEKS", "SIX_WEEKS", "RETAIN_ALL_SNAPSHOTS", "ONE_WEEK", "FOUR_WEEKS", "ONE_DAY" ] }, "storage_account_name": { "title": "", "type": "string", "description": "(Immutable) Name of your Azure Data Lake Storage Gen2 (ADLS Gen2) storage account. Use this parameter only if you want to deploy your data lake on ADLS.", "example": "adls_storage_account_name" }, "storage_provider": { "title": "", "type": "object", "description": "The cloud storage provider you want to use for your data lake.", "example": "AWS", "enum": [ "ADLS", "GCS", "AWS" ] }, "tenant_id": { "title": "", "type": "string", "description": "Tenant ID of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.", "example": "service_principal_tenant_id" }, "workspace_guid": { "title": "", "type": "string", "description": "(Immutable) OneLake workspace GUID.", "example": "workspace_guid" } }, "description": "" } } }, "databricks_via_managed_data_lake_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "oauth2_client_id": { "title": "", "type": "string", "description": "ESM key for the OAuth 2.0 client ID you created for authenticating Fivetran.", "example": "OAUTH2_CLIENT_ID_KEY" }, "oauth2_secret": { "title": "", "type": "string", "description": "ESM key for oAuth 2.0 secret you created for authenticating Fivetran.", "example": "OAUTH2_SECRET_KEY" }, "personal_access_token": { "title": "", "type": "string", "description": "ESM key for the personal access token you created for authenticating Fivetran.", "example": "PERSONAL_ACCESS_TOKEN_KEY" } }, "description": "" } } }, "databricks_via_managed_data_lake_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/databricks_via_managed_data_lake_config_V1" }, { "$ref": "#/components/schemas/databricks_via_managed_data_lake_esm_keys_config_V1" } ] }, "managed_big_query_config_V1": { "properties": { "config": { "type": "object", "properties": { "bucket": { "title": "", "type": "string", "description": "", "example": "string" }, "data_set_location": { "title": "", "type": "object", "description": "", "example": "string", "enum": [ "EU", "asia-east2", "australia-southeast1", "US" ] }, "project_id": { "title": "", "type": "string", "description": "", "example": "string" }, "secret_key": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "support_json_type": { "title": "", "type": "boolean", "description": "Stores JSON columns as JSON instead of STRING. This parameter is applicable only to destinations created before August 1, 2025.", "example": true } }, "description": "" } } }, "managed_big_query_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/managed_big_query_config_V1" } ] }, "managed_data_lake_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_type": { "title": "", "type": "object", "description": "Specifies the authentication types for Fivetran to connect to Databricks. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.", "example": "PERSONAL_ACCESS_TOKEN | OAUTH2", "enum": [ "PERSONAL_ACCESS_TOKEN", "OAUTH2" ] }, "bucket": { "title": "", "type": "string", "description": "(Immutable) Name of the S3 or Google Cloud Storage (GCS) bucket you want to use to store your data. Use this parameter only if you want to deploy your data lake on Amazon Web Services (AWS) or GCS.", "example": "s3_bucket_name" }, "catalog": { "title": "", "type": "string", "description": "Name of the specific catalog in Unity Catalog that you want to use to manage your Delta Lake tables. Use this parameter only if you want to use Unity Catalog with your data lake.", "example": "string" }, "client_id": { "title": "", "type": "string", "description": "Client ID of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.", "example": "service_principal_client_id" }, "connection_type": { "title": "", "type": "object", "description": "connection type", "example": "Directly", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "container_name": { "title": "", "type": "string", "description": "(Immutable) Name of the ADLS container you want to use to store your data. Use this parameter only if you want to deploy your data lake on ADLS.", "example": "adls_container_name" }, "databricks_connection_type": { "title": "", "type": "object", "description": "Specifies how you want Fivetran to connect to the Databricks account associated with Unity Catalog. Default value: `Directly`. Use this parameter only if you want to use Unity Catalog with your data lake.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "fivetran_role_arn": { "title": "", "type": "string", "description": "(Immutable) ARN of the IAM role you created for the IAM policy associated with your S3 bucket or Glue catalog. Use this parameter only if you want to deploy your data lake on AWS.", "example": "iam_role_arn" }, "gcs_project_id": { "title": "", "type": "string", "description": "GCS Project ID of your Google Cloud Storage bucket. Use this parameter only if you want to deploy your data lake on GCS.", "example": "false" }, "http_path": { "title": "", "type": "string", "description": "HTTP path of the Databricks account associated with Unity Catalog. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.", "example": "string" }, "lakehouse_guid": { "title": "", "type": "string", "description": "(Immutable) OneLake lakehouse GUID.", "example": "onelake_lakehouse_guid" }, "oauth2_client_id": { "title": "", "type": "string", "description": "The OAuth 2.0 client ID you created for authenticating Fivetran. Use this parameter only if you want to use OAuth 2.0 as the authentication type for Fivetran to connect to Databricks.", "example": "string" }, "oauth2_secret": { "title": "", "type": "string", "description": "OAuth 2.0 secret you created for authenticating Fivetran. Use this parameter only if you want to use OAuth 2.0 as the authentication type for Fivetran to connect to Databricks.", "format": "password", "example": "string" }, "one_lake_auth_type": { "title": "", "type": "object", "description": "(Immutable) Authentication type for OneLake. Default value: `ServicePrincipal`.", "example": "SERVICE_PRINCIPAL | WORKSPACE_IDENTITY", "enum": [ "SERVICE_PRINCIPAL", "WORKSPACE_IDENTITY" ] }, "onelake_client_id": { "title": "", "type": "string", "description": "(Immutable) Client ID of OneLake service principal.", "example": "onelake_client_id" }, "onelake_client_secret": { "title": "", "type": "string", "description": "Secret value for OneLake service principal.", "format": "password", "example": "onelake_client_secret" }, "onelake_tenant_id": { "title": "", "type": "string", "description": "(Immutable) Tenant ID of OneLake service principal", "example": "onelake_tenant_id" }, "personal_access_token": { "title": "", "type": "string", "description": "The personal access token you created for authenticating Fivetran. Use this parameter only if you want to use a personal access token as the authentication type for Fivetran to connect to Databricks.", "format": "password", "example": "string" }, "polaris_catalog_configuration": { "type": "object", "properties": { "client_id": { "type": "string", "description": "Client ID" }, "client_secret": { "type": "string", "description": "Client Secret" }, "polaris_catalog": { "type": "string", "description": "Polaris Catalog" }, "polaris_server_endpoint": { "type": "string", "description": "Polaris Server Endpoint" } }, "description": "Polaris Catalog Base Configuration. Universal connection settings for any query engine or analytics tool." }, "port": { "title": "", "type": "integer", "description": "Server port number of the Databricks account associated with Unity Catalog. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.", "format": "int32", "example": 0 }, "prefix_path": { "title": "", "type": "string", "description": "(Immutable) Prefix path or virtual folder path within your bucket or container where you want Fivetran to store your data. Skip this parameter for AWS-based data lakes if the IAM policy configured for your S3 bucket grants access to the entire bucket.", "example": "s3_bucket_path_prefix" }, "region": { "title": "", "type": "string", "description": "(Immutable) AWS Region of your S3 bucket. Use this parameter only if you want to deploy your data lake on AWS.", "example": "s3_bucket_region" }, "secret_value": { "title": "", "type": "string", "description": "Secret value of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.", "format": "password", "example": "service_principal_secret_value" }, "server_host_name": { "title": "", "type": "string", "description": "Server host name of the Databricks account associated with Unity Catalog. Use this parameter only if you want to use Unity Catalog to manage your Delta Lake tables.", "example": "string" }, "should_maintain_tables_in_bqms": { "title": "", "type": "boolean", "description": "Specifies whether you want to manage your Iceberg tables in BQMS. Use this parameter only if you want to deploy your data lake on GCS.", "example": true }, "should_maintain_tables_in_databricks": { "title": "", "type": "boolean", "description": "Specifies whether you want to manage your Delta Lake tables in Databricks Unity Catalog.", "example": true }, "should_maintain_tables_in_glue": { "title": "", "type": "boolean", "description": "Specifies whether you want to manage your Iceberg tables in AWS Glue. Use this parameter only if you want to deploy your data lake on AWS.", "example": true }, "should_maintain_tables_in_one_lake": { "title": "", "type": "boolean", "description": "Specifies whether you want to create shortcut for you table in OneLake. Use this parameter only if you want to deploy your data lake on ADLS.", "example": true }, "should_write_delta": { "title": "", "type": "boolean", "description": "Specifies whether Fivetran writes Delta Lake metadata in addition to Iceberg tables. Default value: `false` for new destinations and `true` for existing destinations. Destinations with Unity Catalog or OneLake catalog enabled always write Delta Lake metadata.", "example": true }, "snapshot_retention_period": { "title": "", "type": "object", "description": "Specifies how long you want us to retain your table snapshots. We delete the snapshots that are older than the retention period during our table maintenance operations. Default value: `ONE_WEEK`.", "example": "ONE_WEEK", "enum": [ "TWO_WEEKS", "SIX_WEEKS", "RETAIN_ALL_SNAPSHOTS", "ONE_WEEK", "FOUR_WEEKS", "ONE_DAY" ] }, "storage_account_name": { "title": "", "type": "string", "description": "(Immutable) Name of your Azure Data Lake Storage Gen2 (ADLS Gen2) storage account. Use this parameter only if you want to deploy your data lake on ADLS.", "example": "adls_storage_account_name" }, "storage_provider": { "title": "", "type": "object", "description": "The cloud storage provider you want to use for your data lake.", "example": "AWS", "enum": [ "ADLS", "GCS", "AWS" ] }, "tenant_id": { "title": "", "type": "string", "description": "Tenant ID of the service principal you created for Fivetran. Use this parameter only if you want to deploy your data lake on ADLS.", "example": "service_principal_tenant_id" }, "workspace_guid": { "title": "", "type": "string", "description": "(Immutable) OneLake workspace GUID.", "example": "workspace_guid" } }, "description": "" } } }, "managed_data_lake_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "oauth2_client_id": { "title": "", "type": "string", "description": "ESM key for the OAuth 2.0 client ID you created for authenticating Fivetran", "example": "OAUTH2_CLIENT_ID_KEY" }, "oauth2_secret": { "title": "", "type": "string", "description": "ESM key for oAuth 2.0 secret you created for authenticating Fivetran", "example": "OAUTH2_SECRET_KEY" }, "personal_access_token": { "title": "", "type": "string", "description": "ESM key for the personal access token you created for authenticating Fivetran", "example": "PERSONAL_ACCESS_TOKEN_KEY" } }, "description": "" } } }, "managed_data_lake_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/managed_data_lake_config_V1" }, { "$ref": "#/components/schemas/managed_data_lake_esm_keys_config_V1" } ] }, "maria_rds_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "", "example": true }, "connection_type": { "title": "", "type": "object", "description": "", "example": "Directly | PrivateLink | SshTunnel", "enum": [ "Directly", "PrivateLink", "SshTunnel" ] }, "database": { "title": "", "type": "string", "description": "", "example": "string" }, "host": { "title": "", "type": "string", "description": "", "example": "string" }, "password": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "port": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "", "example": "string" }, "tunnel_port": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 }, "tunnel_user": { "title": "", "type": "string", "description": "", "example": "string" }, "user": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "maria_rds_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/maria_rds_warehouse_config_V1" } ] }, "maria_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "", "example": true }, "connection_type": { "title": "", "type": "object", "description": "", "example": "Directly | PrivateLink | SshTunnel", "enum": [ "Directly", "PrivateLink", "SshTunnel" ] }, "database": { "title": "", "type": "string", "description": "", "example": "string" }, "host": { "title": "", "type": "string", "description": "", "example": "string" }, "password": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "port": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "", "example": "string" }, "tunnel_port": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 }, "tunnel_user": { "title": "", "type": "string", "description": "", "example": "string" }, "user": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "maria_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/maria_warehouse_config_V1" } ] }, "materialize_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "materialize_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/materialize_config_V1" } ] }, "milvus_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "milvus_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/milvus_config_V1" } ] }, "motherduck_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "motherduck_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/motherduck_config_V1" } ] }, "mysql_rds_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel", "enum": [ "Directly", "PrivateLink", "SshTunnel" ] }, "database": { "title": "", "type": "string", "description": "Database name", "example": "production" }, "host": { "title": "", "type": "string", "description": "Server name", "example": "87a8z-3da23-3da8d-cloud.sql.com" }, "password": { "title": "", "type": "string", "description": "Database user password", "format": "password", "example": "fresh_air_267@83" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 443 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "ssh.server.com" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.", "format": "int32", "example": 564 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "Fivetran" }, "user": { "title": "", "type": "string", "description": "Database user name", "example": "admin" } }, "description": "" } } }, "mysql_rds_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/mysql_rds_warehouse_config_V1" } ] }, "mysql_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel", "enum": [ "Directly", "PrivateLink", "SshTunnel" ] }, "database": { "title": "", "type": "string", "description": "Database name", "example": "production" }, "host": { "title": "", "type": "string", "description": "Server name", "example": "87a8z-3da23-3da8d-cloud.sql.com" }, "password": { "title": "", "type": "string", "description": "Database user password", "format": "password", "example": "fresh_air_267@83" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 443 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "ssh.server.com" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.", "format": "int32", "example": 564 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "Fivetran" }, "user": { "title": "", "type": "string", "description": "Database user name", "example": "admin" } }, "description": "" } } }, "mysql_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/mysql_warehouse_config_V1" } ] }, "oracle_rac_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | SshTunnel | ProxyAgent", "enum": [ "Directly", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "SID/Service name", "example": "production" }, "host": { "title": "", "type": "string", "description": "Server name", "example": "myoracleinstance.com" }, "password": { "title": "", "type": "string", "description": "Database user password", "format": "password", "example": "12345678" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 1521 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "ssh.server.com" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.", "format": "int32", "example": 564 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "Fivetran User" }, "user": { "title": "", "type": "string", "description": "Database user name", "example": "admin" } }, "description": "" } } }, "oracle_rac_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/oracle_rac_warehouse_config_V1" } ] }, "oracle_rds_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | SshTunnel | ProxyAgent", "enum": [ "Directly", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "SID/Service name", "example": "production" }, "host": { "title": "", "type": "string", "description": "Server name", "example": "myoracleinstance.abc123xyz456.us-west-2.rds.amazonaws.com" }, "password": { "title": "", "type": "string", "description": "Database user password", "format": "password", "example": "12345678" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 1521 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "ssh.server.com" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.", "format": "int32", "example": 564 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "Fivetran User" }, "user": { "title": "", "type": "string", "description": "Database user name", "example": "admin" } }, "description": "" } } }, "oracle_rds_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/oracle_rds_warehouse_config_V1" } ] }, "oracle_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | SshTunnel | ProxyAgent", "enum": [ "Directly", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "SID/Service name", "example": "production" }, "host": { "title": "", "type": "string", "description": "Server name", "example": "myoracleinstance.com" }, "password": { "title": "", "type": "string", "description": "Database user password", "format": "password", "example": "12345678" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 1521 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "ssh.server.com" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.", "format": "int32", "example": 564 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "Fivetran User" }, "user": { "title": "", "type": "string", "description": "Database user name", "example": "admin" } }, "description": "" } } }, "oracle_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/oracle_warehouse_config_V1" } ] }, "postgres_databricks_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Authentication method. Default value: `PASSWORD`.", "example": "ENTRA_ID", "enum": [ "ENTRA_ID", "PASSWORD", "CLIENT_CERTIFICATE", "AWS_IAM" ] }, "aws_region_code": { "title": "", "type": "string", "description": "AWS region code. Required when `auth_method` is set to `AWS_IAM`.", "example": "us-east-1" }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | SshTunnel", "enum": [ "Directly", "SshTunnel" ] }, "database": { "title": "", "type": "string", "description": "Database name", "example": "production" }, "external_id": { "title": "", "type": "string", "description": "AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.", "example": "external-id-12345" }, "host": { "title": "", "type": "string", "description": "Server name", "example": "87a8z-3da23-3da8d-cloud.sql.com" }, "password": { "title": "", "type": "string", "description": "Database user password", "format": "password", "example": "fresh_air_267@83" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 443 }, "role_arn": { "title": "", "type": "string", "description": "AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.", "example": "arn:aws:iam::123456789012:role/MyRole" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "ssh.server.com" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.", "format": "int32", "example": 564 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "Fivetran" }, "user": { "title": "", "type": "string", "description": "Database user name", "example": "admin" } }, "description": "" } } }, "postgres_databricks_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/postgres_databricks_warehouse_config_V1" } ] }, "postgres_gcp_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Authentication method. Default value: `PASSWORD`.", "example": "ENTRA_ID", "enum": [ "ENTRA_ID", "PASSWORD", "CLIENT_CERTIFICATE", "AWS_IAM" ] }, "aws_region_code": { "title": "", "type": "string", "description": "AWS region code. Required when `auth_method` is set to `AWS_IAM`.", "example": "us-east-1" }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "Database name", "example": "production" }, "external_id": { "title": "", "type": "string", "description": "AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.", "example": "external-id-12345" }, "host": { "title": "", "type": "string", "description": "Server name", "example": "87a8z-3da23-3da8d-cloud.sql.com" }, "password": { "title": "", "type": "string", "description": "Database user password", "format": "password", "example": "fresh_air_267@83" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 443 }, "role_arn": { "title": "", "type": "string", "description": "AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.", "example": "arn:aws:iam::123456789012:role/MyRole" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "ssh.server.com" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.", "format": "int32", "example": 564 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "Fivetran" }, "user": { "title": "", "type": "string", "description": "Database user name", "example": "admin" } }, "description": "" } } }, "postgres_gcp_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/postgres_gcp_warehouse_config_V1" } ] }, "postgres_rds_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Authentication method. Default value: `PASSWORD`.", "example": "PASSWORD | AWS_IAM", "enum": [ "PASSWORD", "AWS_IAM" ] }, "aws_region_code": { "title": "", "type": "object", "description": "AWS region where the RDS instance is located. Required when `auth_method` is set to `AWS_IAM`.", "example": "us-east-1", "enum": [ "me-central-1", "aws-cn-global", "us-isof-south-1", "ap-east-2", "us-west-1", "us-west-2", "af-south-1", "ap-northeast-3", "ap-northeast-2", "ap-northeast-1", "me-south-1", "sa-east-1", "cn-north-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ap-southeast-5", "us-east-1", "us-east-2", "ap-southeast-7", "aws-iso-e-global", "cn-northwest-1", "ap-south-2", "ap-south-1", "eu-south-1", "eu-south-2", "us-gov-east-1", "il-central-1", "ca-central-1", "mx-central-1", "eu-central-1", "eusc-de-east-1", "us-iso-west-1", "eu-central-2", "eu-isoe-west-1", "aws-global", "eu-north-1", "eu-west-3", "eu-west-2", "eu-west-1", "aws-iso-global", "ap-east-1", "ca-west-1", "us-gov-west-1", "us-iso-east-1", "aws-iso-b-global", "aws-iso-f-global", "aws-us-gov-global", "us-isob-east-1", "us-isof-east-1" ] }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "Database name", "example": "production" }, "external_id": { "title": "", "type": "string", "description": "AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.", "example": "external-id-12345" }, "host": { "title": "", "type": "string", "description": "Server name", "example": "87a8z-3da23-3da8d-cloud.sql.com" }, "password": { "title": "", "type": "string", "description": "Database user password", "format": "password", "example": "fresh_air_267@83" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 443 }, "role_arn": { "title": "", "type": "string", "description": "AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.", "example": "arn:aws:iam::123456789012:role/MyRole" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "ssh.server.com" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.", "format": "int32", "example": 564 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "Fivetran" }, "user": { "title": "", "type": "string", "description": "Database user name", "example": "admin" } }, "description": "" } } }, "postgres_rds_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/postgres_rds_warehouse_config_V1" } ] }, "postgres_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Authentication method. Default value: `PASSWORD`.", "example": "PASSWORD", "enum": [ "ENTRA_ID", "PASSWORD", "CLIENT_CERTIFICATE", "AWS_IAM" ] }, "aws_region_code": { "title": "", "type": "string", "description": "AWS region code. Required when `auth_method` is set to `AWS_IAM`.", "example": "us-east-1" }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "Database name", "example": "production" }, "external_id": { "title": "", "type": "string", "description": "AWS external ID for authentication. Required when `auth_method` is set to `AWS_IAM`.", "example": "external-id-12345" }, "host": { "title": "", "type": "string", "description": "Server name", "example": "87a8z-3da23-3da8d-cloud.sql.com" }, "password": { "title": "", "type": "string", "description": "Database user password", "format": "password", "example": "fresh_air_267@83" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 443 }, "role_arn": { "title": "", "type": "string", "description": "AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`.", "example": "arn:aws:iam::123456789012:role/MyRole" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "ssh.server.com" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.", "format": "int32", "example": 564 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "Fivetran" }, "user": { "title": "", "type": "string", "description": "Database user name", "example": "admin" } }, "description": "" } } }, "postgres_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/postgres_warehouse_config_V1" } ] }, "postgres_wh_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Specifies whether TLS is required. Must be set when using `SshTunnel` connection", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Authentication method. Supported values: `PASSWORD`, `AWS_IAM`. Default: `PASSWORD`.", "example": "AWS_IAM", "enum": [ "ENTRA_ID", "PASSWORD", "CLIENT_CERTIFICATE", "AWS_IAM" ] }, "aws_region_code": { "title": "", "type": "string", "description": "AWS region code. Required when `auth_method` is set to `AWS_IAM`", "example": "us-east-1" }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Supported values: `Directly`, `SshTunnel`, `ProxyAgent`, `PrivateLink`. Default: `Directly`. Note: PrivateLink is only supported for cloud-hosted PostgreSQL (RDS, Aurora, Azure, GCP).", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "Database name", "example": "production" }, "external_id": { "title": "", "type": "string", "description": "AWS external ID for authentication. Auto-generated from group ID when `auth_method` is set to `AWS_IAM`", "example": "group_id_12345" }, "host": { "title": "", "type": "string", "description": "Server hostname or IP address", "example": "db.example.com or 10.0.0.1" }, "password": { "title": "", "type": "string", "description": "Database user password. Required for PASSWORD authentication", "format": "password", "example": "********" }, "port": { "title": "", "type": "integer", "description": "Server port number (default: 5432)", "format": "int32", "example": 5432 }, "role_arn": { "title": "", "type": "string", "description": "AWS IAM role ARN for authentication. Required when `auth_method` is set to `AWS_IAM`", "example": "arn:aws:iam::123456789012:role/FivetranRole" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH server hostname. Required when `connection_type` is set to `SshTunnel`", "example": "ssh.example.com" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH server port. Required when `connection_type` is set to `SshTunnel`", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user name. Required when `connection_type` is set to `SshTunnel`", "example": "fivetran" }, "user": { "title": "", "type": "string", "description": "Database user name. Required for PASSWORD authentication", "example": "fivetran" } }, "description": "" } } }, "postgres_wh_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/postgres_wh_config_V1" } ] }, "redshift_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_type": { "title": "", "type": "object", "description": "Authentication type. Default value: `PASSWORD`.", "example": "PASSWORD | IAM", "enum": [ "PASSWORD", "IAM" ] }, "aws_access_key_id": { "title": "", "type": "string", "description": "The unique access key ID of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.", "example": "string" }, "aws_secret_access_key": { "title": "", "type": "string", "description": "The secret access key of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.", "format": "password", "example": "string" }, "bucket": { "title": "", "type": "string", "description": "The name of the storage bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.", "example": "string" }, "bucket_region": { "title": "", "type": "string", "description": "The AWS Region of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment.", "example": "string" }, "cluster_id": { "title": "", "type": "string", "description": "Cluster ID. Must be populated if `connection_type` is set to `SshTunnel` and `auth_type` is set to `IAM`.", "example": "clu5734-id" }, "cluster_region": { "title": "", "type": "string", "description": "Cluster region. Must be populated if `connection_type` is set to `SshTunnel` and `auth_type` is set to `IAM`.", "example": "us-east-1" }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "Database name", "example": "production" }, "enable_super_type": { "title": "", "type": "boolean", "description": "Enable to convert JSON data type to SUPER", "example": true }, "external_id": { "title": "", "type": "string", "description": "Fivetran generated External ID", "example": "string" }, "host": { "title": "", "type": "string", "description": "Server name", "example": "87a8z-3da23-3da8d-cloud.sql.com" }, "is_redshift_serverless": { "title": "", "type": "boolean", "description": "Is your destination Redshift Serverless", "example": true }, "password": { "title": "", "type": "string", "description": "Database user password. Required if authentication type is `PASSWORD`.", "format": "password", "example": "fresh_air_267@83" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 443 }, "role_arn": { "title": "", "type": "string", "description": "Role ARN with Redshift permissions. Required if authentication type is `IAM`.", "example": "arn" }, "s3_bucket_auth_type": { "title": "", "type": "object", "description": "Type of authentication configured for the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment", "example": "IAM_ROLE | IAM_USER", "enum": [ "IAM_ROLE", "IAM_USER" ] }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "ssh.server.com" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.", "format": "int32", "example": 564 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "Fivetran" }, "user": { "title": "", "type": "string", "description": "Database user name", "example": "admin" } }, "description": "" } } }, "redshift_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for database user password", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for database user name", "example": "USER_KEY" } }, "description": "" } } }, "redshift_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/redshift_config_V1" }, { "$ref": "#/components/schemas/redshift_esm_keys_config_V1" } ] }, "singlestore_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "singlestore_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/singlestore_config_V1" } ] }, "snowflake_config_V1": { "properties": { "config": { "type": "object", "properties": { "application_id": { "title": "", "type": "string", "description": "Application ID of your app created in Azure", "example": "string" }, "auth": { "title": "", "type": "object", "description": "Password-based or key-based authentication type", "example": "PASSWORD | KEY_PAIR | WORKLOAD_IDENTITY_FEDERATION | OAUTH", "enum": [ "PASSWORD", "KEY_PAIR", "WORKLOAD_IDENTITY_FEDERATION", "OAUTH" ] }, "aws_access_key_id": { "title": "", "type": "string", "description": "The unique access key ID of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment, want to use an S3 bucket to stage your data, and `awsBucketAuthType` is set to `IAM_USER`.", "example": "string" }, "aws_bucket_auth_type": { "title": "", "type": "object", "description": "Type of authentication configured for the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an S3 bucket to stage your data.", "example": "IAM_ROLE | IAM_USER", "enum": [ "IAM_ROLE", "IAM_USER" ] }, "aws_secret_access_key": { "title": "", "type": "string", "description": "The secret access key of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment , want to use an S3 bucket to stage your data, and `awsBucketAuthType` is set to `IAM_USER`.", "format": "password", "example": "string" }, "bucket": { "title": "", "type": "string", "description": "The name of the storage bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an S3 or GCS bucket to stage your data.", "example": "string" }, "bucket_region": { "title": "", "type": "string", "description": "The AWS Region of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an S3 bucket to stage your data.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "SshTunnel", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "Database name", "example": "fivetran" }, "default_virtual_warehouse": { "title": "", "type": "string", "description": "The virtual warehouse to use for running queries.", "example": "VIRTUAL_WAREHOUSE" }, "directory_id": { "title": "", "type": "string", "description": "Tenant ID of your app created in Azure", "example": "string" }, "enable_external_storage_for_unstructured_files": { "title": "", "type": "boolean", "description": "Set to `true` if you want to enable external storage for unstructured files.", "example": true }, "external_stage_storage_provider": { "title": "", "type": "object", "description": "External stage storage provider[Internal, S3, Azure,GCS]", "example": "S3", "enum": [ "S3", "AZURE", "GCS", "INTERNAL" ] }, "external_storage_cloud_provider": { "title": "", "type": "object", "description": "The cloud service provider you want to use for staging data. Use this parameter only if you are using Hybrid Deployment.", "example": "AZURE | GCP | INTERNAL_STAGE | AWS", "enum": [ "AZURE", "GCP", "INTERNAL_STAGE", "AWS" ] }, "external_storage_integration": { "title": "", "type": "string", "description": "External storage integration name", "example": "string" }, "external_storage_parent_folder_uri": { "title": "", "type": "string", "description": "External storage parent folder URL", "example": "s3://fivetran-snowflake-integration/" }, "gcs_service_account_credentials": { "type": "object", "properties": {}, "description": "The service account credentials for the Google Cloud Storage (GCS) bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use a GCS bucket to stage your data." }, "host": { "title": "", "type": "string", "description": "Server name", "example": "your-account.snowflakecomputing.com" }, "is_private_key_encrypted": { "title": "", "type": "boolean", "description": "Indicates that a private key is encrypted. The default value: `false`. The field can be specified if authentication type is `KEY_PAIR`.", "example": true }, "mdls_group_id": { "title": "", "type": "string", "description": "The managed data lake service (MDLS) group to use as storage. Required when tableType is `LAKEHOUSE`; not applicable when tableType is `NATIVE`.", "example": "string" }, "passphrase": { "title": "", "type": "string", "description": "In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is `KEY_PAIR`.", "format": "password", "example": "string" }, "password": { "title": "", "type": "string", "description": "Database user password. The field should be specified if authentication type is `PASSWORD`.", "format": "password", "example": "123456" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 443 }, "private_key": { "title": "", "type": "string", "description": "Private access key. The field should be specified if authentication type is `KEY_PAIR`.", "format": "password", "example": "string" }, "role": { "title": "", "type": "string", "description": "If not specified, Fivetran will use the user's default role", "example": "string" }, "storage_account_key": { "title": "", "type": "string", "description": "The access key of the Azure storage account you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an Azure Blob storage container to stage your data.", "example": "string" }, "storage_account_name": { "title": "", "type": "string", "description": "The name of the Azure storage account you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an Azure Blob storage container to stage your data.", "example": "string" }, "table_type": { "title": "", "type": "object", "description": "Determines how tables are stored: `NATIVE` writes Snowflake Native Tables using Snowflake compute, while `LAKEHOUSE` writes Lakehouse Tables to a managed data lake to reduce Snowflake ingestion cost. `LAKEHOUSE` is not supported for Hybrid Deployment destinations.", "example": "LAKEHOUSE", "enum": [ "NATIVE", "LAKEHOUSE" ] }, "use_customer_staging": { "title": "", "type": "boolean", "description": "Set to `true` if you want to use an S3 bucket to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an S3 bucket to stage your data.", "example": true }, "user": { "title": "", "type": "string", "description": "Database user name", "example": "fivetran_user" } }, "description": "" } } }, "snowflake_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "passphrase": { "title": "", "type": "string", "description": "ESM key for a passphrase that was used to encrypt the private key. The field can be specified if authentication type is `KEY_PAIR`.", "example": "PASSPHRASE_KEY" }, "password": { "title": "", "type": "string", "description": "ESM key for database user password. The field should be specified if authentication type is `PASSWORD` and the password is stored in an external secrets manager.", "example": "PASSWORD_KEY" }, "private_key": { "title": "", "type": "string", "description": "ESM key for private access key. The field should be specified if authentication type is `KEY_PAIR` and the private key is stored in an external secrets manager.", "example": "PRIVATE_KEY_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for database user name", "example": "USER_KEY" } }, "description": "" } } }, "snowflake_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/snowflake_config_V1" }, { "$ref": "#/components/schemas/snowflake_esm_keys_config_V1" } ] }, "sql_server_rds_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "Database name", "example": "production" }, "host": { "title": "", "type": "string", "description": "Server name", "example": "87a8z-3da23-3da8d-cloud.sql.com" }, "password": { "title": "", "type": "string", "description": "Database user password", "format": "password", "example": "fresh_air_267@83" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 443 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "ssh.server.com" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.", "format": "int32", "example": 564 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "Fivetran" }, "user": { "title": "", "type": "string", "description": "Database user name", "example": "admin" } }, "description": "" } } }, "sql_server_rds_warehouse_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for database user password", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for database user name", "example": "USER_KEY" } }, "description": "" } } }, "sql_server_rds_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/sql_server_rds_warehouse_config_V1" }, { "$ref": "#/components/schemas/sql_server_rds_warehouse_esm_keys_config_V1" } ] }, "sql_server_warehouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Specifies whether TLS is required. Must be populated if `connection_type` is set to `SshTunnel`.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "Database name", "example": "production" }, "host": { "title": "", "type": "string", "description": "Server name", "example": "87a8z-3da23-3da8d-cloud.sql.com" }, "password": { "title": "", "type": "string", "description": "Database user password", "format": "password", "example": "fresh_air_267@83" }, "port": { "title": "", "type": "integer", "description": "Server port number", "format": "int32", "example": 443 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH server name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "ssh.server.com" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH server port name. Must be populated if `connection_type` is set to `SshTunnel`.", "format": "int32", "example": 564 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user name. Must be populated if `connection_type` is set to `SshTunnel`.", "example": "Fivetran" }, "user": { "title": "", "type": "string", "description": "Database user name", "example": "admin" } }, "description": "" } } }, "sql_server_warehouse_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for database user password", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for database user name", "example": "USER_KEY" } }, "description": "" } } }, "sql_server_warehouse_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/sql_server_warehouse_config_V1" }, { "$ref": "#/components/schemas/sql_server_warehouse_esm_keys_config_V1" } ] }, "surrealdb_destination_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "surrealdb_destination_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/surrealdb_destination_config_V1" } ] }, "teradata_destination_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "teradata_destination_NewDestinationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewDestinationRequest" }, { "$ref": "#/components/schemas/teradata_destination_config_V1" } ] }, "aiven_kafka_wh_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/aiven_kafka_wh_config_V1" } ] }, "aurora_postgres_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/aurora_postgres_warehouse_config_V1" } ] }, "aurora_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/aurora_warehouse_config_V1" } ] }, "aws_msk_wh_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/aws_msk_wh_config_V1" } ] }, "azure_postgres_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/azure_postgres_warehouse_config_V1" } ] }, "azure_sql_data_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/azure_sql_data_warehouse_config_V1" } ] }, "azure_sql_database_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/azure_sql_database_config_V1" }, { "$ref": "#/components/schemas/azure_sql_database_esm_keys_config_V1" } ] }, "azure_sql_managed_db_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/azure_sql_managed_db_warehouse_config_V1" }, { "$ref": "#/components/schemas/azure_sql_managed_db_warehouse_esm_keys_config_V1" } ] }, "big_query_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/big_query_config_V1" } ] }, "big_query_dts_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/big_query_dts_config_V1" } ] }, "clickhouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/clickhouse_config_V1" } ] }, "confluent_cloud_wh_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/confluent_cloud_wh_config_V1" } ] }, "databricks_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/databricks_config_V1" }, { "$ref": "#/components/schemas/databricks_esm_keys_config_V1" } ] }, "databricks_via_managed_data_lake_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/databricks_via_managed_data_lake_config_V1" }, { "$ref": "#/components/schemas/databricks_via_managed_data_lake_esm_keys_config_V1" } ] }, "managed_big_query_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/managed_big_query_config_V1" } ] }, "managed_data_lake_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/managed_data_lake_config_V1" }, { "$ref": "#/components/schemas/managed_data_lake_esm_keys_config_V1" } ] }, "maria_rds_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/maria_rds_warehouse_config_V1" } ] }, "maria_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/maria_warehouse_config_V1" } ] }, "materialize_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/materialize_config_V1" } ] }, "milvus_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/milvus_config_V1" } ] }, "motherduck_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/motherduck_config_V1" } ] }, "mysql_rds_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/mysql_rds_warehouse_config_V1" } ] }, "mysql_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/mysql_warehouse_config_V1" } ] }, "oracle_rac_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/oracle_rac_warehouse_config_V1" } ] }, "oracle_rds_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/oracle_rds_warehouse_config_V1" } ] }, "oracle_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/oracle_warehouse_config_V1" } ] }, "postgres_databricks_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/postgres_databricks_warehouse_config_V1" } ] }, "postgres_gcp_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/postgres_gcp_warehouse_config_V1" } ] }, "postgres_rds_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/postgres_rds_warehouse_config_V1" } ] }, "postgres_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/postgres_warehouse_config_V1" } ] }, "postgres_wh_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/postgres_wh_config_V1" } ] }, "redshift_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/redshift_config_V1" }, { "$ref": "#/components/schemas/redshift_esm_keys_config_V1" } ] }, "singlestore_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/singlestore_config_V1" } ] }, "snowflake_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/snowflake_config_V1" }, { "$ref": "#/components/schemas/snowflake_esm_keys_config_V1" } ] }, "sql_server_rds_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/sql_server_rds_warehouse_config_V1" }, { "$ref": "#/components/schemas/sql_server_rds_warehouse_esm_keys_config_V1" } ] }, "sql_server_warehouse_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/sql_server_warehouse_config_V1" }, { "$ref": "#/components/schemas/sql_server_warehouse_esm_keys_config_V1" } ] }, "surrealdb_destination_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/surrealdb_destination_config_V1" } ] }, "teradata_destination_DestinationExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/DestinationExtendedResponse" }, { "$ref": "#/components/schemas/teradata_destination_config_V1" } ] }, "azure_monitor_log_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "For Logs Ingestion API authentication. Your application (client) ID.", "example": "your_client_id" }, "client_secret": { "title": "", "type": "string", "description": "For Logs Ingestion API authentication. Your application client secret.", "format": "password", "example": "your_client_secret" }, "data_collection_endpoint": { "title": "", "type": "string", "description": "For Logs Ingestion API authentication. The endpoint URL for your Data Collection Endpoint.", "example": "https://my-endpoint.eastus-1.ingest.monitor.azure.com" }, "dcr_immutable_id": { "title": "", "type": "string", "description": "For Logs Ingestion API authentication. The immutable ID of your Data Collection Rule.", "example": "dcr-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" }, "dcr_stream_name": { "title": "", "type": "string", "description": "For Logs Ingestion API authentication. The stream name of your Data Collection Rule.", "example": "Custom-MyStream_CL" }, "primary_key": { "title": "", "type": "string", "description": "For HTTP Data Collector API authentication. Your Log Analytics primary key.", "format": "password", "example": "your_primary_key" }, "tenant_id": { "title": "", "type": "string", "description": "For Logs Ingestion API authentication. Your Microsoft Entra directory (tenant) ID.", "example": "your_tenant_id" }, "workspace_id": { "title": "", "type": "string", "description": "For HTTP Data Collector API authentication. Your Log Analytics workspace ID.", "example": "your_workspace_id" } } } } }, "azure_monitor_log_AddLogRequest": { "allOf": [ { "$ref": "#/components/schemas/AddLogRequest" }, { "$ref": "#/components/schemas/azure_monitor_log_config_V1" } ] }, "cloudwatch_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_key_id": { "title": "", "type": "string", "description": "", "example": "string" }, "access_key_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "external_id": { "title": "", "type": "string", "description": "", "example": "string" }, "log_group_name": { "title": "", "type": "string", "description": "", "example": "string" }, "region": { "title": "", "type": "string", "description": "", "example": "string" }, "role_arn": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "cloudwatch_AddLogRequest": { "allOf": [ { "$ref": "#/components/schemas/AddLogRequest" }, { "$ref": "#/components/schemas/cloudwatch_config_V1" } ] }, "datadog_log_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "hostname": { "title": "", "type": "string", "description": "", "example": "string" }, "region": { "title": "", "type": "object", "description": "", "example": "EU | US1 | AP1 | AP2 | US3 | US5 | US1_FED", "enum": [ "EU", "US1", "AP1", "AP2", "US3", "US5", "US1_FED" ] } }, "description": "" } } }, "datadog_log_AddLogRequest": { "allOf": [ { "$ref": "#/components/schemas/AddLogRequest" }, { "$ref": "#/components/schemas/datadog_log_config_V1" } ] }, "dynatrace_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "environment_id": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "dynatrace_AddLogRequest": { "allOf": [ { "$ref": "#/components/schemas/AddLogRequest" }, { "$ref": "#/components/schemas/dynatrace_config_V1" } ] }, "grafana_loki_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "loki_url": { "title": "", "type": "string", "description": "", "example": "string" }, "tenant_id": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "username": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "grafana_loki_AddLogRequest": { "allOf": [ { "$ref": "#/components/schemas/AddLogRequest" }, { "$ref": "#/components/schemas/grafana_loki_config_V1" } ] }, "new_relic_log_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "sub_domain": { "title": "", "type": "object", "description": "", "example": "EU | FedRAMP | US", "enum": [ "EU", "FedRAMP", "US" ] } }, "description": "" } } }, "new_relic_log_AddLogRequest": { "allOf": [ { "$ref": "#/components/schemas/AddLogRequest" }, { "$ref": "#/components/schemas/new_relic_log_config_V1" } ] }, "splunkLog_config_V1": { "properties": { "config": { "type": "object", "properties": { "channel": { "title": "", "type": "string", "description": "", "example": "string" }, "enable_ssl": { "title": "", "type": "boolean", "description": "", "example": true }, "host": { "title": "", "type": "string", "description": "", "example": "string" }, "port": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 }, "token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "splunkLog_AddLogRequest": { "allOf": [ { "$ref": "#/components/schemas/AddLogRequest" }, { "$ref": "#/components/schemas/splunkLog_config_V1" } ] }, "stackdriver_config_V1": { "properties": { "config": { "type": "object", "properties": { "project_id": { "title": "", "type": "string", "description": "", "example": "string" }, "service_account_key": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "stackdriver_AddLogRequest": { "allOf": [ { "$ref": "#/components/schemas/AddLogRequest" }, { "$ref": "#/components/schemas/stackdriver_config_V1" } ] }, "azure_monitor_log_LogExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/LogExtendedResponse" }, { "$ref": "#/components/schemas/azure_monitor_log_config_V1" } ] }, "cloudwatch_LogExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/LogExtendedResponse" }, { "$ref": "#/components/schemas/cloudwatch_config_V1" } ] }, "datadog_log_LogExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/LogExtendedResponse" }, { "$ref": "#/components/schemas/datadog_log_config_V1" } ] }, "dynatrace_LogExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/LogExtendedResponse" }, { "$ref": "#/components/schemas/dynatrace_config_V1" } ] }, "grafana_loki_LogExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/LogExtendedResponse" }, { "$ref": "#/components/schemas/grafana_loki_config_V1" } ] }, "new_relic_log_LogExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/LogExtendedResponse" }, { "$ref": "#/components/schemas/new_relic_log_config_V1" } ] }, "splunkLog_LogExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/LogExtendedResponse" }, { "$ref": "#/components/schemas/splunkLog_config_V1" } ] }, "stackdriver_LogExtendedResponse": { "allOf": [ { "$ref": "#/components/schemas/LogExtendedResponse" }, { "$ref": "#/components/schemas/stackdriver_config_V1" } ] }, "15five_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your 15five API key.", "format": "password", "example": "your_15five_api_key" } }, "description": "" } } }, "schema_format_schema": { "properties": { "config": { "required": [ "schema" ], "type": "object", "properties": { "schema": { "title": "Destination schema name", "type": "string", "description": "Destination schema name. Schema name is permanent and cannot be changed after connection creation", "example": "schema_name" } } } } }, "15five_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/15five_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "360learning_config_V1": { "properties": { "config": { "type": "object", "properties": { "base_url": { "type": "object", "description": "Your 360Learning base URL.", "enum": [ "us.360learning", "staging.360learning-dev", "360learning" ] }, "client_id": { "title": "", "type": "string", "description": "Your 360Learning client ID.", "example": "your_360learning_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your 360Learning client secret.", "format": "password", "example": "your_360learning_client_secret" } }, "description": "" } } }, "360learning_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/360learning_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "7shifts_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your 7shifts access token.", "format": "password", "example": "your_7shifts_access_token" } }, "description": "" } } }, "7shifts_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/7shifts_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "absorb_lms_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your Absorb LMS password.", "format": "password", "example": "your_absorb_lms_password" }, "private_key": { "title": "", "type": "string", "description": "Your Absorb LMS REST API private key.", "format": "password", "example": "your_absorb_lms_rest_api_private_key" }, "sub_domain": { "type": "object", "description": "Your Absorb LMS subdomain.", "enum": [ "rest.sandbox.myabsorb.eu", "rest.sandbox.myabsorb.com.au", "rest.sandbox.myabsorb.ca", "rest.sandbox.myabsorb.com", "rest.myabsorb.com.au", "rest.myabsorb.com", "rest.myabsorb.ca", "rest.myabsorb.eu" ] }, "username": { "title": "", "type": "string", "description": "Your Absorb LMS username.", "example": "your_absorb_lms_username" } }, "description": "" } } }, "absorb_lms_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/absorb_lms_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "acculynx_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Acculynx API key.", "format": "password", "example": "your_acculynx_api_key" } }, "description": "" } } }, "acculynx_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/acculynx_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "activecampaign_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your ActiveCampaign API key.", "format": "password", "example": "your_activecampaign_api_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your ActiveCampaign sub-domain.", "example": "your_acumatica_subdomain" } }, "description": "" } } }, "activecampaign_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/activecampaign_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "acumatica_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Acumatica client ID.", "example": "your_acumatica_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Acumatica client secret.", "format": "password", "example": "your_acumatica_client_secret" }, "contract_version": { "title": "", "type": "string", "description": "Your Acumatica contract version.", "example": "your_acumatica_contract_version" }, "sub_domain": { "title": "", "type": "string", "description": "Your Acumatica subdomain.", "example": "your_acumatica_subdomain" } }, "description": "" } } }, "acumatica_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/acumatica_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ada_config_V1": { "properties": { "config": { "type": "object", "properties": { "bearer_token": { "title": "", "type": "string", "description": "Your Ada API key.", "format": "password", "example": "your_ada_bearer_token" }, "sub_domain": { "title": "", "type": "string", "description": "Your Ada sub-domain.", "example": "your_bot_handle" } }, "description": "" } } }, "ada_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ada_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "adform_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Adform client ID.", "example": "your_adform_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Adform client secret.", "format": "password", "example": "your_adform_client_secret" } }, "description": "" } } }, "adform_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/adform_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "adjust_config_V1": { "properties": { "config": { "type": "object", "properties": { "bucket_name": { "title": "", "type": "string", "description": "Your AWS S3 or GCS bucket.", "example": "bucket" }, "csv_definition": { "title": "", "type": "string", "description": "CSV definition for the CSV export (https://help.adjust.com/en/article/csv-uploads#how-do-i-format-my-csv-definition).", "example": "my export definition" }, "export_storage_type": { "title": "", "type": "object", "description": "Your cloud storage.", "example": "GCS | AWS_S3", "enum": [ "GCS", "AWS_S3" ] }, "s3_role_arn": { "title": "", "type": "string", "description": "Used if the `export_storage_type` is `AWS_S3`, the Role ARN required for authentication.", "format": "password", "example": "role_arn" } }, "description": "" } } }, "adjust_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/adjust_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "adobe_analytics_config_V1": { "properties": { "config": { "type": "object", "properties": { "adobe_analytics_configurations": { "title": "", "type": "array", "description": "The list of configurations of tables you want to sync. The number of tables and their configurations is limited to 5. Required for connector creation.", "items": { "title": "", "type": "object", "properties": { "calculated_metrics": { "title": "", "type": "array", "description": "The calculated_metrics that you want to sync.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "elements": { "title": "", "type": "array", "description": "The elements that you want to sync.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "metrics": { "title": "", "type": "array", "description": "The metrics that you want to sync.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_suites": { "title": "", "type": "array", "description": "Specific report suites to sync. Must be populated if `sync_mode` is set to `SpecificReportSuites`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "segments": { "title": "", "type": "array", "description": "The segments that you want to sync.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all report suites or specific report suites. Default value: `AllReportSuites` .", "example": "SpecificReportSuites | AllReportSuites", "enum": [ "SpecificReportSuites", "AllReportSuites" ] }, "table": { "title": "", "type": "string", "description": "The table name unique within the schema to which connector will sync the data. Required for connector creation.", "example": "test_table" } }, "description": "The list of configurations of tables you want to sync. The number of tables and their configurations is limited to 5. Required for connector creation." } }, "client_id": { "title": "", "type": "string", "description": "Client ID from the OAuth Server-to-Server credentials of your Adobe Project.", "example": "clientId" }, "client_secret": { "title": "", "type": "string", "description": "Client Secret from the OAuth Server-to-Server credentials of your Adobe Project.", "format": "password", "example": "clientSecret" }, "date_granularity": { "title": "", "type": "object", "description": "The aggregation duration you want. Default value: `HOUR` .", "example": "MONTH | QUARTER | YEAR | HOUR | WEEK | DAY", "enum": [ "MONTH", "QUARTER", "YEAR", "HOUR", "WEEK", "DAY" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector has been created. Default value: `TWELVE` .", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "adobe_analytics_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "ESM key for client ID from the OAuth Server-to-Server credentials of your Adobe Project.", "example": "CLIENT_ID_KEY" }, "client_secret": { "title": "", "type": "string", "description": "ESM key for client Secret from the OAuth Server-to-Server credentials of your Adobe Project.", "example": "CLIENT_SECRET_KEY" } }, "description": "" } } }, "adobe_analytics_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/adobe_analytics_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/adobe_analytics_esm_keys_config_V1" } ] }, "adobe_analytics_data_feed_config_V1": { "properties": { "config": { "type": "object", "properties": { "abs_connection_method": { "title": "", "type": "object", "description": "Azure Blob Storage connection method", "example": "SSH_TUNNEL | DIRECT | PRIVATE_LINK", "enum": [ "SSH_TUNNEL", "DIRECT", "PRIVATE_LINK" ] }, "abs_connection_string": { "title": "", "type": "string", "description": "Azure Blob Storage connection string.", "format": "password", "example": "connection_string" }, "abs_container_address": { "title": "", "type": "string", "description": "Azure Blob Storage container address", "example": "fivetran.blob.windows.net" }, "abs_container_name": { "title": "", "type": "string", "description": "Azure Blob Storage container name.", "example": "container_name" }, "abs_host_ip": { "title": "", "type": "string", "description": "Azure Blob Storage host IP", "example": "13.120.106.58" }, "abs_host_user": { "title": "", "type": "string", "description": "Azure Blob Storage username", "example": "fivetran" }, "folder_path": { "title": "", "type": "string", "description": "Folder Path", "example": "string" }, "ftp_host": { "title": "", "type": "string", "description": "FTP host.", "example": "host" }, "ftp_password": { "title": "", "type": "string", "description": "FTP password.", "format": "password", "example": "password" }, "ftp_port": { "title": "", "type": "integer", "description": "FTP port.", "format": "int32", "example": 21 }, "ftp_user": { "title": "", "type": "string", "description": "FTP user.", "example": "user" }, "is_ftps": { "title": "", "type": "boolean", "description": "Use Secure FTP (FTPS).", "example": true }, "s3bucket": { "title": "", "type": "string", "description": "The S3 bucket name.", "example": "bucket" }, "s3role_arn": { "title": "", "type": "string", "description": "The Role ARN required for authentication.", "format": "password", "example": "role_arn" }, "sftp_host": { "title": "", "type": "string", "description": "SFTP host.", "example": "host" }, "sftp_is_key_pair": { "title": "", "type": "boolean", "description": "Log in with key pair or password", "example": true }, "sftp_password": { "title": "", "type": "string", "description": "SFTP password required if sftp_is_key_pair is false", "format": "password", "example": "password" }, "sftp_port": { "title": "", "type": "integer", "description": "SFTP port.", "format": "int32", "example": 22 }, "sftp_user": { "title": "", "type": "string", "description": "SFTP user.", "example": "user" }, "source": { "title": "", "type": "object", "description": "The data source.", "example": "S3 | AZURE_BLOB_STORAGE | FTP | SFTP", "enum": [ "S3", "AZURE_BLOB_STORAGE", "FTP", "SFTP" ] }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] } }, "description": "" } } }, "adobe_analytics_data_feed_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/adobe_analytics_data_feed_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "adobe_commerce_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Adobe Commerce access_token", "format": "password", "example": "your_adobe_commerce_access_token" }, "auth_type": { "type": "object", "description": "Your Adobe Commerce auth type.", "enum": [ "access_token", "oauth_2" ] }, "host_url": { "title": "", "type": "string", "description": "Your Adobe Commerce host url.", "example": "your.host.url.com" }, "password": { "title": "", "type": "string", "description": "Your Adobe Commerce password.", "format": "password", "example": "your_adobe_commerce_password" }, "username": { "title": "", "type": "string", "description": "Your Adobe Commerce username.", "example": "your_adobe_commerce_username" } }, "description": "" } } }, "adobe_commerce_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/adobe_commerce_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "adobe_workfront_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Adobe Workfront client ID.", "example": "your_adobe_workfront_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Adobe Workfront client secret.", "format": "password", "example": "your_adobe_workfront_client_secret" }, "environment": { "title": "", "type": "string", "description": "Your Adobe Workfront environment.", "example": "your_adobe_workfront_environment" }, "organization_domain": { "title": "", "type": "string", "description": "Your Adobe Workfront organization domain.", "example": "your_adobe_workfront_organization_domain" } }, "description": "" } } }, "adobe_workfront_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "adobe_workfront_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/adobe_workfront_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/adobe_workfront_auth_V1" } ] }, "adp_workforce_now_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your ADP Client ID.", "example": "test_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your ADP Client Secret.", "format": "password", "example": "test_client_secret" }, "private_key": { "title": "", "type": "string", "description": "Private Key.", "format": "password", "example": "xxxxx-xxxxx-xxxxx-xxxxx" }, "ws_certificate": { "title": "", "type": "string", "description": "Web Services Certificate.", "format": "password", "example": "xxxxx-xxxxx-xxxxx-xxxxx" } }, "description": "" } } }, "adp_workforce_now_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/adp_workforce_now_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "adroll_config_V1": { "properties": { "config": { "type": "object", "properties": { "advertisables": { "title": "", "type": "array", "description": "Specific advertisables to sync. Must be populated if `sync_mode` is set to `SpecificAdvertisables`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "dimensions": { "title": "", "type": "array", "description": "The dimenstions that you want to sync.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "metrics": { "title": "", "type": "array", "description": "The metrics that you want to sync.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_type": { "title": "", "type": "object", "description": "The report type you want. Default value: `ALL_ADS`.", "example": "ALL_ADS | ALL_ADGROUPS | ALL_ADVERTISABLES | ALL_CAMPAIGNS | ALL_AUDIENCE | CONVERSIONS", "enum": [ "ALL_ADS", "ALL_ADGROUPS", "ALL_ADVERTISABLES", "ALL_CAMPAIGNS", "ALL_AUDIENCE", "CONVERSIONS" ] }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all advertisables or specific advertisables. Default value: `AllAdvertisables`.", "example": "AllAdvertisables | SpecificAdvertisables", "enum": [ "AllAdvertisables", "SpecificAdvertisables" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "schema_format_schema_table": { "properties": { "config": { "required": [ "schema", "table" ], "type": "object", "properties": { "schema": { "title": "Destination schema name", "type": "string", "description": "Destination schema name. Schema name is permanent and cannot be changed after connection creation", "example": "schema_name" }, "table": { "title": "Destination table", "type": "string", "description": "Destination table. Table is permanent and cannot be changed after connection creation", "example": "table_name" } } } } }, "adroll_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your AdRoll client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your AdRoll client application.", "example": "my_client_secret" } }, "description": "Your application client access fields" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "adroll_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/adroll_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" }, { "$ref": "#/components/schemas/adroll_auth_V1" } ] }, "adyen_config_V1": { "properties": { "config": { "type": "object", "properties": { "is_test_account": { "title": "", "type": "boolean", "description": "Whether or not your Adyen Account is a Test Account. Default value: `false`.", "example": true }, "report_service_api_key": { "title": "", "type": "string", "description": "Your Report Service API key.", "format": "password", "example": "adyen_report_service_api_key" }, "web_service_api_key": { "title": "", "type": "string", "description": "Your Adyen Web Service API key.", "format": "password", "example": "adyen_web_service_api_key" } }, "description": "" } } }, "adyen_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/adyen_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "affinity_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Affinity API key.", "format": "password", "example": "your_affinity_api_key" } }, "description": "" } } }, "affinity_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/affinity_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "afterpay_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_environment": { "type": "object", "description": "Your Afterpay API environment.", "enum": [ "global-api-sandbox", "global-api" ] }, "merchant_id": { "title": "", "type": "string", "description": "Your Afterpay Merchant ID.", "example": "your_afterpay_merchant_id" }, "secret_key": { "title": "", "type": "string", "description": "Your Afterpay Secret Key.", "format": "password", "example": "your_afterpay_secret_key" } }, "description": "" } } }, "afterpay_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/afterpay_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "aha_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Aha! API key.", "format": "password", "example": "your_aha_api_key" }, "base_url": { "title": "", "type": "string", "description": "Your Aha! subdomain.", "example": "your_aha_subdomain" } }, "description": "" } } }, "aha_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/aha_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ai_generated_config_V1": { "properties": { "config": { "type": "object", "properties": { "sync_files": { "title": "", "type": "boolean", "description": "", "example": true } } } } }, "ai_generated_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ai_generated_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "aircall_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_id": { "title": "", "type": "string", "description": "Your Aircall API ID.", "example": "your_aircall_api_id" }, "api_token": { "title": "", "type": "string", "description": "Your Aircall API token.", "format": "password", "example": "your_aircall_api_token" } }, "description": "" } } }, "aircall_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/aircall_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "airtable_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "schema_format_schema_prefix": { "properties": { "config": { "required": [ "schema_prefix" ], "type": "object", "properties": { "schema_prefix": { "title": "Destination schema prefix", "type": "string", "description": "Destination schema prefix. Prefix for each replicated schema. For example with prefix 'x', source schemas 'foo' and 'bar' get replicated as 'x_foo' and 'x_bar'. The prefix is permanent and cannot be changed after connection creation", "example": "prefix" } } } } }, "airtable_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Airtable client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Airtable client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived refresh token along with the client ID and client secret carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "airtable_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/airtable_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/airtable_auth_V1" } ] }, "akamai_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Akamai client ID.", "example": "your_akamai_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Akamai client secret.", "format": "password", "example": "your_akamai_client_secret" }, "hostname": { "title": "", "type": "string", "description": "Your Akamai hostname.", "example": "your_akamai_hostname" }, "type_name": { "title": "", "type": "string", "description": "Your Akamai type name.", "example": "your_akamai_type_name" } }, "description": "" } } }, "akamai_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/akamai_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "akeneo_config_V1": { "properties": { "config": { "type": "object", "properties": { "base_url": { "title": "", "type": "string", "description": "Your Akeneo base URL.", "example": "your_akeneo_base_url" }, "client_id": { "title": "", "type": "string", "description": "Your Akeneo client ID.", "example": "your_akeneo_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Akeneo client secret.", "format": "password", "example": "your_akeneo_client_secret" }, "password": { "title": "", "type": "string", "description": "Your Akeneo password.", "format": "password", "example": "your_akeneo_password" }, "username": { "title": "", "type": "string", "description": "Your Akeneo username.", "example": "your_akeneo_username" } }, "description": "" } } }, "akeneo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/akeneo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "alation_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Client ID of the OAuth client application registered in Alation for this connection.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Client secret of the OAuth client application registered in Alation for this connection.", "format": "password", "example": "string" }, "subdomain": { "title": "", "type": "string", "description": "Your Alation base URL.", "example": "string" } }, "description": "" } } }, "alation_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/alation_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "alchemer_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_secret_key": { "title": "", "type": "string", "description": "Your Alchemer API Secret key.", "format": "password", "example": "your_alchemer_api_secret_key" }, "query_param_value": { "title": "", "type": "string", "description": "Your Alchemer API key.", "format": "password", "example": "your_alchemer_api_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your Alchemer sub-domain.", "example": "Subdomain name like .com,.eu,-ca.com" } }, "description": "" } } }, "alchemer_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/alchemer_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "algolia_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Algolia API key.", "format": "password", "example": "your_algolia_api_key" }, "application_id": { "title": "", "type": "string", "description": "Your Algolia application ID.", "example": "your_algolia_application_id" }, "region": { "type": "object", "description": "Your Algolia analytics region.", "enum": [ "analytics.us.algolia.com", "analytics.de.algolia.com" ] } }, "description": "" } } }, "algolia_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/algolia_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "alida_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Alida API key.", "format": "password", "example": "your_alida_api_key" }, "community_api_key_name": { "title": "", "type": "string", "description": "Your Alida community API key name.", "example": "your_alida_community_api_key_name" }, "password": { "title": "", "type": "string", "description": "Your Alida client secret.", "format": "password", "example": "your_alida_client_secret" }, "region": { "type": "object", "description": "Your Alida region.", "enum": [ "eu1", "ap2", "eu2", "na2", "na1" ] }, "username": { "title": "", "type": "string", "description": "Your Alida client ID.", "example": "your_alida_client_id" } }, "description": "" } } }, "alida_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/alida_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "amazon_ads_config_V1": { "properties": { "config": { "type": "object", "properties": { "attribution_window": { "title": "", "type": "object", "description": "Time period used to attribute conversions based on clicks.", "example": "DAY_14 | DAY_1 | DAY_30 | DAY_7", "enum": [ "DAY_14", "DAY_1", "DAY_30", "DAY_7" ] }, "profiles": { "title": "", "type": "array", "description": "Specific User Profile IDs to sync. Must be populated if `sync_mode` is set to `SpecificProfiles`.", "example": [ 0 ], "items": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 } }, "region": { "title": "", "type": "object", "description": "The region used by the Amazon Ads profile.", "example": "NORTH_AMERICA | EUROPE | FAR_EAST", "enum": [ "NORTH_AMERICA", "EUROPE", "FAR_EAST" ] }, "sync_mode": { "title": "", "type": "object", "description": "Option to select connector should sync all profiles or specific profiles.", "example": "AllProfiles | SpecificProfiles", "enum": [ "AllProfiles", "SpecificProfiles" ] } }, "description": "" } } }, "amazon_ads_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Amazon Ads client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Amazon Ads client application.", "example": "my_client_secret" } }, "description": "Your application client access fields" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "amazon_ads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/amazon_ads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/amazon_ads_auth_V1" } ] }, "amazon_attribution_config_V1": { "properties": { "config": { "type": "object", "properties": { "region_api_url": { "type": "object", "description": "Your Amazon Attribution API URL region.", "enum": [ "api-fe", "api-eu", "api" ] }, "region_auth_url": { "type": "object", "description": "Your Amazon Attribution auth URL region.", "enum": [ "apac.account", "www", "eu.account" ] }, "region_token_url": { "type": "object", "description": "Your Amazon Attribution token URL region.", "enum": [ "com", "co.uk", "co.jp" ] }, "specific_profiles": { "type": "array", "description": "The Amazon Advertising profiles whose data you want to sync. Leave this parameter blank to sync all profiles available to the authorized Amazon Attribution account. You cannot modify the value after you complete the connection setup.", "items": { "title": "", "type": "string", "description": "The Amazon Advertising profiles whose data you want to sync. Leave this parameter blank to sync all profiles available to the authorized Amazon Attribution account. You cannot modify the value after you complete the connection setup.", "example": "string" } } }, "description": "" } } }, "amazon_attribution_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "amazon_attribution_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/amazon_attribution_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/amazon_attribution_auth_V1" } ] }, "amazon_dsp_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_url_region": { "type": "object", "description": "Your Amazon DSP API URL region.", "enum": [ "api-fe", "api-eu", "api" ] }, "auth_url_region": { "type": "object", "description": "Your Amazon DSP auth grant URL region.", "enum": [ "apac.account", "www", "eu.account" ] }, "profiles": { "type": "array", "description": "your Amazon DSP profiles pass it inside an Array list.", "items": { "title": "", "type": "string", "description": "your Amazon DSP profiles pass it inside an Array list.", "example": "your_amazon_dsp_profiles_in_array" } }, "token_url_region": { "type": "object", "description": "Your Amazon DSP token URL region.", "enum": [ "com", "co.uk", "co.jp" ] } }, "description": "" } } }, "amazon_dsp_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Amazon DSP access token.", "format": "password", "example": "your_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "Your Amazon DSP client access." }, "refresh_token": { "title": "", "type": "string", "description": "Your Amazon DSP refresh token.", "format": "password", "example": "your_refresh_token" } }, "description": "" } } }, "amazon_dsp_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/amazon_dsp_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" }, { "$ref": "#/components/schemas/amazon_dsp_auth_V1" } ] }, "amazon_selling_partner_config_V1": { "properties": { "config": { "type": "object", "properties": { "backward_sync_limit": { "title": "", "type": "string", "description": "The earliest date to sync data from, in YYYY-MM-DD format. Cannot be before 1994-01-01 or in the future.", "example": "2020-01-01" }, "historical_sync_time_frame": { "title": "", "type": "object", "description": "The time frame for historical data synchronization. Default value: `ALL_TIME`.", "example": "ALL_TIME | DATE_LIMIT", "enum": [ "ALL_TIME", "DATE_LIMIT" ] }, "is_vendor": { "title": "", "type": "boolean", "description": "Whether or not you have a Vendor Account. Default value: `false`.", "example": true }, "merchant_id": { "title": "", "type": "string", "description": "The Merchant ID or Vendor Code.", "example": "test_merchant_id" }, "region": { "title": "", "type": "object", "description": "The region used by the Amazon Selling Partner profile.", "example": "NORTH_AMERICA | EUROPE | FAR_EAST", "enum": [ "NORTH_AMERICA", "EUROPE", "FAR_EAST" ] } }, "description": "" } } }, "amazon_selling_partner_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "application_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "example": "string" }, "refresh_token": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "amazon_selling_partner_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/amazon_selling_partner_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/amazon_selling_partner_auth_V1" } ] }, "amplitude_config_V1": { "properties": { "config": { "type": "object", "properties": { "aws_credentials": { "title": "Amazon S3 Credentials", "type": "object", "properties": { "bucket_name": { "title": "Bucket Name", "type": "string", "description": "Your AWS S3 bucket name", "example": "string" }, "home_folder": { "title": "Home Folder", "type": "string", "description": "Prefix to filter out the data", "example": "string" }, "s3_role_arn": { "title": "Role ARN", "type": "string", "description": "Role ARN required for authentication", "format": "password", "example": "string" } }, "description": "Amazon S3 Credentials" }, "export_storage_type": { "title": "Cloud Storage Type", "type": "object", "description": "Your cloud storage type", "example": "GCS", "enum": [ "GCS" ] }, "gcs_credentials": { "title": "GCS Credentials", "type": "object", "properties": { "bucket_name": { "title": "Bucket Name", "type": "string", "description": "Your GCS bucket name", "example": "string" }, "home_folder": { "title": "Home Folder", "type": "string", "description": "Prefix to filter out the data", "example": "string" } }, "description": "GCS Credentials" }, "project_credentials": { "title": "", "type": "array", "description": "* Project(s)", "items": { "title": "", "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "The API key of the project.", "format": "password", "example": "apiKey2" }, "project": { "title": "", "type": "string", "description": "The project name you wish to use with Fivetran.", "example": "projectName2" }, "project_id": { "title": "", "type": "string", "description": "The project ID you wish to use with Fivetran.", "example": "projectId2" }, "secret_key": { "title": "", "type": "string", "description": "The secret key of the project.", "format": "password", "example": "secretKey2" } }, "description": "* Project(s)" } }, "use_cloud_storage": { "title": "", "type": "boolean", "description": "Sync events from cloud storage", "example": true } }, "description": "" } } }, "amplitude_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/amplitude_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "amqp_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_type": { "title": "", "type": "object", "description": "Authentication method (BasicAuth or MutualTLS).", "example": "BasicAuth | MutualTLS", "enum": [ "BasicAuth", "MutualTLS" ] }, "client_certificate": { "title": "", "type": "string", "description": "Client certificate for mutual TLS authentication.", "format": "password", "example": "string" }, "client_private_key": { "title": "", "type": "string", "description": "Client private key for mutual TLS authentication.", "format": "password", "example": "string" }, "host": { "title": "", "type": "string", "description": "AMQP broker host address.", "example": "broker.example.com" }, "json_delivery_mode": { "title": "", "type": "object", "description": "JSON delivery mode (Packed or Unpacked).", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "message_type": { "title": "", "type": "object", "description": "Message type (Text or JSON).", "example": "Text | JSON", "enum": [ "Text", "JSON" ] }, "namespace": { "title": "", "type": "string", "description": "AMQP namespace or virtual host.", "example": "/" }, "password": { "title": "", "type": "string", "description": "Password for basic authentication.", "format": "password", "example": "string" }, "port": { "title": "", "type": "integer", "description": "AMQP broker port.", "format": "int32", "example": 5672 }, "queue_name": { "title": "", "type": "string", "description": "AMQP queue name to consume messages from.", "example": "my_queue" }, "username": { "title": "", "type": "string", "description": "Username for basic authentication.", "example": "admin" } }, "description": "" } } }, "amqp_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/amqp_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "anaplan_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_mode": { "title": "", "type": "object", "description": "The Anaplan authentication method.", "example": "Basic | Certificate", "enum": [ "Basic", "Certificate" ] }, "certificate": { "title": "", "type": "string", "description": "The contents of your PEM certificate file. Must be populated if `auth_mode` is set to `Certificate`.", "format": "password", "example": "xxxxx-xxxxx-xxxxx-xxxxx" }, "password": { "title": "", "type": "string", "description": "Your Anaplan password. Must be populated if `auth_mode` is set to `Basic`.", "format": "password", "example": "password" }, "private_key": { "title": "", "type": "string", "description": "The contents of your private key file. Must be populated if `auth_mode` is set to `Certificate`.", "format": "password", "example": "your_api_secret" }, "region": { "title": "", "type": "object", "description": "Your Anaplan account region", "example": "string", "enum": [ "EU", "CAN", "DEFAULT", "AUS" ] }, "selected_exports": { "title": "", "type": "array", "description": "The list of export IDs in the format `__` that the connector will sync. Must be populated if `sync_mode` is set to `SpecificExports`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all exports or specific exports.", "example": "SpecificExports | AllExports", "enum": [ "SpecificExports", "AllExports" ] }, "username": { "title": "", "type": "string", "description": "Your Anaplan user ID. Must be populated if `auth_mode` is set to `Basic`.", "example": "username" } }, "description": "" } } }, "anaplan_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/anaplan_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "anthropic_claude_config_V1": { "properties": { "config": { "type": "object", "properties": { "analytics_api_key": { "title": "", "type": "string", "description": "Your Claude Enterprise Admin API key for syncing analytics, spend limit, compliance, and audit data based on the scopes assigned to the key.", "format": "password", "example": "your_claude_enterprise_admin_api_key" }, "api_admin_key": { "title": "", "type": "string", "description": "Your Claude Platform Admin API key for syncing organization-level management and reporting data.", "format": "password", "example": "your_claude_admin_api_key" }, "api_key": { "title": "", "type": "string", "description": "Your workspace-scoped API key for syncing data from a specific Claude workspace.", "format": "password", "example": "your_workspace_api_key" } }, "description": "" } } }, "anthropic_claude_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/anthropic_claude_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "anvyl_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Anvyl API key.", "format": "password", "example": "your_anvyl_api_key" } }, "description": "" } } }, "anvyl_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/anvyl_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "apache_kafka_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_cert": { "title": "", "type": "string", "description": "Kafka client certificate.", "format": "password", "example": "string" }, "client_cert_key": { "title": "", "type": "string", "description": "Kafka client certificate key.", "format": "password", "example": "string" }, "consumer_group": { "title": "", "type": "string", "description": "Kafka consumer group name.", "example": "consumer_group" }, "message_type": { "title": "", "type": "object", "description": "Kafka message type.", "example": "Text | Json | Avro | Protobuf", "enum": [ "Text", "Json", "Avro", "Protobuf" ] }, "sasl_mechanism": { "title": "", "type": "object", "description": "SASL Mechanism", "example": "PLAIN | SCRAM_SHA_512 | SCRAM_SHA_256", "enum": [ "PLAIN", "SCRAM_SHA_512", "SCRAM_SHA_256" ] }, "sasl_plain_key": { "title": "", "type": "string", "description": "API Key", "format": "password", "example": "string" }, "sasl_plain_secret": { "title": "", "type": "string", "description": "API Secret", "format": "password", "example": "string" }, "sasl_scram256_key": { "title": "", "type": "string", "description": "API Key", "format": "password", "example": "string" }, "sasl_scram256_secret": { "title": "", "type": "string", "description": "API Secret", "format": "password", "example": "string" }, "sasl_scram512_key": { "title": "", "type": "string", "description": "API Key", "format": "password", "example": "string" }, "sasl_scram512_secret": { "title": "", "type": "string", "description": "API Secret", "format": "password", "example": "string" }, "schema_registry_credentials_source": { "title": "", "type": "string", "description": "Schema Registry Credentials source", "example": "string" }, "schema_registry_key": { "title": "", "type": "string", "description": "Schema Registry Key", "format": "password", "example": "string" }, "schema_registry_secret": { "title": "", "type": "string", "description": "Schema Registry Secret", "format": "password", "example": "string" }, "schema_registry_urls": { "title": "", "type": "array", "description": "Your schema registry URLs", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "security_protocol": { "title": "", "type": "object", "description": "Security protocol for Kafka interaction.", "example": "SASL | PLAINTEXT | TLS", "enum": [ "SASL", "PLAINTEXT", "TLS" ] }, "servers": { "title": "", "type": "array", "description": "Comma-separated list of Kafka servers in the format `server:port`.", "example": "serveraddress1:8080, serveraddress2:8080", "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "sync_type": { "title": "", "type": "object", "description": "Kafka sync type. Unpacked messages must be valid JSON.", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "trusted_cert": { "title": "", "type": "string", "description": "Kafka trusted certificate.", "format": "password", "example": "string" } }, "description": "" } } }, "apache_kafka_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/apache_kafka_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "apollo_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Apollo API key.", "format": "password", "example": "your_apollo_api_key" } }, "description": "" } } }, "apollo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/apollo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "appcues_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_id": { "title": "", "type": "string", "description": "Your Appcues Account ID.", "example": "your_appcues_account_id" }, "api_key": { "title": "", "type": "string", "description": "Your Appcues API key.", "format": "password", "example": "your_appcues_api_key" }, "region": { "type": "object", "description": "Your Appcues region.", "enum": [ "appcues.com", "eu.appcues.com" ] }, "secret": { "title": "", "type": "string", "description": "Your Appcues Secret.", "format": "password", "example": "your_appcues_secret" } }, "description": "" } } }, "appcues_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/appcues_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "appfigures_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_key": { "title": "", "type": "string", "description": "Your Appfigures Client Key.", "format": "password", "example": "your_appfigures_client_key" }, "password": { "title": "", "type": "string", "description": "Your Appfigures Password.", "format": "password", "example": "your_appfigures_password" }, "username": { "title": "", "type": "string", "description": "Your Appfigures Username.", "example": "your_appfigures_username" } }, "description": "" } } }, "appfigures_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/appfigures_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "apple_search_ads_config_V1": { "properties": { "config": { "type": "object", "properties": { "custom_reports": { "title": "", "type": "array", "description": "Allows users to define reports with custom groupBy dimensions.", "items": { "title": "", "type": "object", "properties": { "base_report_type": { "type": "object", "description": "The base report type. It determines the set of available dimensions for the `groupBy` field and the metrics that will be included in the custom report. Only one value is supported: `CAMPAIGN`.", "example": "CAMPAIGN", "enum": [ "CAMPAIGN" ] }, "group_by": { "type": "array", "description": "The list of dimensions to group the data by. The available dimensions depend on the selected `baseReportType`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "table": { "type": "string", "description": "The name of the custom report table. It must be unique within this connection and must comply with Fivetran's naming conventions.", "example": "my_custom_report" } }, "description": "Allows users to define reports with custom groupBy dimensions." } }, "organizations": { "title": "", "type": "array", "description": "Organizations", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "show_records_with_no_metrics": { "title": "", "type": "boolean", "description": "Turn the toggle on if you want the reports to also return records without metrics.", "example": true }, "sync_mode": { "title": "", "type": "object", "description": "Sync Mode", "example": "SpecificOrganizations | AllOrganizations", "enum": [ "SpecificOrganizations", "AllOrganizations" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created.
NOTE: The more months of reporting data you sync, the longer your initial sync will take.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] }, "timezone_mode": { "title": "", "type": "object", "description": "Determines whether to use UTC or the users timezone from the apple account", "example": "UserTimezone | UTC", "enum": [ "UserTimezone", "UTC" ] } }, "description": "" } } }, "apple_search_ads_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Apple Search Ads REST API Client ID. Must be populated if `is_auth2_enabled` is set to `true`.", "example": "your_api_client_id" }, "key_id": { "title": "", "type": "string", "description": "Apple Search Ads REST API Key ID. Must be populated if `is_auth2_enabled` is set to `true`.", "example": "your_api_key_id" }, "team_id": { "title": "", "type": "string", "description": "Apple Search Ads REST API Team ID. Must be populated if `is_auth2_enabled` is set to `true`.", "example": "your_api_team_id" } }, "description": "" } } }, "apple_search_ads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/apple_search_ads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/apple_search_ads_auth_V1" } ] }, "applovin_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your AppLovin API key.", "format": "password", "example": "your_applovin_api_key" } }, "description": "" } } }, "applovin_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/applovin_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "appsflyer_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_key_id": { "title": "", "type": "string", "description": "Your AWS access key ID.", "format": "password", "example": "your_access_key_id" }, "api_token": { "title": "", "type": "string", "description": "API Token for AppsFlyer's PULL API.", "format": "password", "example": "your_appsflyer_api_token" }, "app_ids": { "title": "", "type": "array", "description": "* App ID(s)", "items": { "title": "", "type": "object", "properties": { "app_id": { "title": "", "type": "string", "description": "Your App ID", "example": "string" } }, "description": "* App ID(s)" } }, "bucket": { "title": "", "type": "string", "description": "Customer S3 Bucket", "example": "af-datalocker-your-bucket-name" }, "connection_name": { "title": "", "type": "string", "description": "Your Data Locker Connection Name. Default value: `data-locker-hourly/", "example": "your_connection_name" }, "home_folder": { "title": "", "type": "string", "description": "Your S3 home folder path of the Data Locker.", "example": "your_home_folder" }, "role_arn": { "title": "", "type": "string", "description": "S3 Role ARN", "format": "password", "example": "role_arn_value" }, "rollback_window": { "title": "", "type": "integer", "description": "Rollback window", "format": "int32" }, "secret_key": { "title": "", "type": "string", "description": "Your AWS secret key.", "format": "password", "example": "your_secret_key" }, "sync_data_locker": { "title": "", "type": "boolean", "description": "Sync AppsFlyer Data Locker. Default value is `true`, set it to `false` to sync AppsFlyer data using only webhooks.", "example": true }, "sync_pull_api": { "title": "", "type": "boolean", "description": "These options are for Appsflyer's Pull API, and are only necessary for syncing events from Pull API.", "example": true }, "use_customer_bucket": { "title": "", "type": "boolean", "description": "Use Custom Bucket. Set it to 'true' if the data is being synced to your S3 bucket instead of an AppsFlyer-managed bucket.", "example": true } }, "description": "" } } }, "appsflyer_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/appsflyer_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "asana_config_V1": { "properties": { "config": { "type": "object", "properties": { "authentication_method": { "title": "", "type": "object", "description": "The authentication method to use. Can be either `OAUTH` or `PERSONAL_ACCESS_TOKEN`.", "example": "PERSONAL_ACCESS_TOKEN | OAUTH", "enum": [ "PERSONAL_ACCESS_TOKEN", "OAUTH" ] }, "personal_access_token": { "title": "", "type": "string", "description": "Your Asana `Personal Access Token`. Required if `authenticationMethod` is set to `PERSONAL_ACCESS_TOKEN`.", "format": "password", "example": "my_personal_access_token" }, "projects": { "title": "", "type": "array", "description": "Specific Project IDs to sync. Must be populated if `syncMode` is set to `SpecificProjects`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all projects or specific projects.", "example": "AllProjects | SpecificProjects", "enum": [ "AllProjects", "SpecificProjects" ] }, "team_id": { "title": "", "type": "string", "description": "Team ID", "example": "string" } }, "description": "" } } }, "asana_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Asana client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Asana client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "asana_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/asana_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/asana_auth_V1" } ] }, "ascend_by_partnerize_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Ascend by Partnerize API Key", "format": "password", "example": "your_ascend_by_partnerize_api_key" }, "historical_sync_time_frame": { "type": "object", "description": "Your Ascend by Partnerize Historical sync time frame", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "ascend_by_partnerize_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ascend_by_partnerize_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ashby_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Ashby API key.", "format": "password", "example": "your_ashby_api_key" } }, "description": "" } } }, "ashby_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ashby_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "assembled_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Assembled API key.", "format": "password", "example": "your_assembled_api_key" }, "return_full_schedule": { "type": "object", "description": "Your Assembled ReturnFullSchedule Query param for Activity table.", "enum": [ "false", "true" ] } }, "description": "" } } }, "assembled_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/assembled_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "asset_panda_config_V1": { "properties": { "config": { "type": "object", "properties": { "email": { "title": "", "type": "string", "description": "Your Asset Panda email.", "example": "your_asset_panda_email" }, "password": { "title": "", "type": "string", "description": "Your Asset Panda password.", "format": "password", "example": "your_asset_panda_password" } }, "description": "" } } }, "asset_panda_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/asset_panda_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "atlassian_compass_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Atlassian Compass API token.", "format": "password", "example": "your_atlassian_compass_api_token" }, "email_id": { "title": "", "type": "string", "description": "The email ID associated with the Atlassian Compass account you want Fivetran to use to access your data.", "example": "your_atlassian_compass_email_id" }, "sub_domain": { "title": "", "type": "string", "description": "Your Atlassian Compass subdomain.", "example": "your_atlassian_compass_subdomain" } }, "description": "" } } }, "atlassian_compass_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/atlassian_compass_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "atlassian_jira_align_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Jira Align API key.", "format": "password", "example": "your_jira_align_api_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your Jira Align base URL.", "example": "your_jira_align_base_url" } }, "description": "" } } }, "atlassian_jira_align_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/atlassian_jira_align_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "atlassian_ops_genie_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Opsgenie API key", "format": "password", "example": "your_api_key" }, "region": { "title": "", "type": "string", "description": "Your company's Osgenie region (usually **company**.opsgenie.com)", "example": "your_region" } }, "description": "" } } }, "atlassian_ops_genie_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/atlassian_ops_genie_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "attentive_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Attentive API key.", "format": "password", "example": "your_attentive_api_key" } }, "description": "" } } }, "attentive_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/attentive_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "attio_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "attio_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "attio_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/attio_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/attio_auth_V1" } ] }, "aumni_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Aumni API key.", "format": "password", "example": "your_aumni_api_key" } }, "description": "" } } }, "aumni_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/aumni_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "aura_from_unity_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Aura from Unity API token.", "format": "password", "example": "your_aura_from_unity_api_token" } }, "description": "" } } }, "aura_from_unity_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/aura_from_unity_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "aurora_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Database authentication method", "example": "PASSWORD | AWS_IAM", "enum": [ "PASSWORD", "AWS_IAM" ] }, "aws_region_code": { "title": "", "type": "object", "description": "The AWS region code for your RDS instance. Required if the authentication method is `AWS_IAM`.", "example": "us-east-1", "enum": [ "me-central-1", "aws-cn-global", "us-isof-south-1", "ap-east-2", "us-west-1", "us-west-2", "af-south-1", "ap-northeast-3", "ap-northeast-2", "ap-northeast-1", "me-south-1", "sa-east-1", "cn-north-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ap-southeast-5", "us-east-1", "us-east-2", "ap-southeast-7", "aws-iso-e-global", "cn-northwest-1", "ap-south-2", "ap-south-1", "eu-south-1", "eu-south-2", "us-gov-east-1", "il-central-1", "ca-central-1", "mx-central-1", "eu-central-1", "eusc-de-east-1", "us-iso-west-1", "eu-central-2", "eu-isoe-west-1", "aws-global", "eu-north-1", "eu-west-3", "eu-west-2", "eu-west-1", "aws-iso-global", "ap-east-1", "ca-west-1", "us-gov-west-1", "us-iso-east-1", "aws-iso-b-global", "aws-iso-f-global", "aws-us-gov-global", "us-isob-east-1", "us-isof-east-1" ] }, "client_private_key": { "title": "", "type": "string", "description": "Client Private Key in .pem format.", "format": "password", "example": "string" }, "client_public_certificate": { "title": "", "type": "string", "description": "Client Certificate in .pem format.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "mysqldb" }, "database_endpoint": { "title": "", "type": "string", "description": "The RDS database endpoint. Required if the connection type is `PrivateLink` and the authentication method is `AWS_IAM`, where `host` is set to the PrivateLink DNS address instead of the actual database endpoint.", "example": "mysqlinstance.mycompany.com" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address. When the connection type is `PrivateLink` and the authentication method is `AWS_IAM`, set this to the PrivateLink DNS address and use `databaseEndpoint` for the actual RDS endpoint.", "example": "mysqlinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 3306 }, "replica_id": { "title": "", "type": "integer", "description": "Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.", "format": "int32", "example": 4573961 }, "role_arn": { "title": "", "type": "string", "description": "The ARN of the IAM role with RDS permissions. Required if the authentication method is `AWS_IAM` in the SaaS Deployment model.", "format": "password", "example": "arn" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method to detect new or changed rows.
Supported values:
`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified.
`TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.", "example": "BINLOG | TELEPORT", "enum": [ "BINLOG", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "aurora_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "aurora_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/aurora_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/aurora_esm_keys_config_V1" } ] }, "aurora_postgres_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Database authentication method", "example": "PASSWORD", "enum": [ "ENTRA_ID", "PASSWORD", "CLIENT_CERTIFICATE", "AWS_IAM" ] }, "client_private_key": { "title": "", "type": "string", "description": "Client Private Key in .pem format.", "format": "password", "example": "string" }, "client_public_certificate": { "title": "", "type": "string", "description": "Client Certificate in .pem format.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "postgres" }, "delete_capture_enabled": { "title": "", "type": "boolean", "description": "", "example": true }, "entra_app_id": { "title": "", "type": "string", "description": "Registered Application ID (for Entra ID authentication).", "example": "string" }, "entra_tenant_id": { "title": "", "type": "string", "description": "Azure Tenant ID (for Entra ID authentication).", "example": "string" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "postgresinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 5432 }, "publication_name": { "title": "", "type": "string", "description": "Publication name. Specify only for `\"updated_method\": \"WAL_PGOUTPUT\"`.", "example": "string" }, "replication_slot": { "title": "", "type": "string", "description": "Replication slot name. Specify only for `\"updated_method\": \"WAL\"` or `\"WAL_PGOUTPUT\"`.", "example": "test_replication_slot" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method to detect new or changed rows.
Specify only for `\"service\": \"postgres\"` or `\"service\": \"postgres_rds\"`.
Supported values:
`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. This is more efficient than the query-based method, but requires more setup and monitoring.
`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns", "example": "QUERY_BASED | WAL_PGOUTPUT", "enum": [ "QUERY_BASED", "WAL_PGOUTPUT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "aurora_postgres_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "aurora_postgres_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/aurora_postgres_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/aurora_postgres_esm_keys_config_V1" } ] }, "auth0_config_V1": { "properties": { "config": { "type": "object", "properties": { "audience": { "title": "", "type": "string", "description": "Your Auth0 API audience.", "format": "password", "example": "your_auth0_audience" }, "client_id": { "title": "", "type": "string", "description": "Your Auth0 client ID.", "example": "your_auth0_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Auth0 client secret.", "format": "password", "example": "your_auth0_client_secret" }, "domain": { "title": "", "type": "string", "description": "Your Auth0 domain.", "example": "your_auth0_domain" } }, "description": "" } } }, "auth0_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/auth0_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "autodesk_bim_360_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Autodesk BIM 360 & Construction Cloud client ID.", "example": "your_autodesk_bim_360_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Autodesk BIM 360 & Construction Cloud client secret.", "format": "password", "example": "your_autodesk_bim_360_client_secret" } }, "description": "" } } }, "autodesk_bim_360_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "autodesk_bim_360_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/autodesk_bim_360_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/autodesk_bim_360_auth_V1" } ] }, "avantlink_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your AvantLink API key.", "format": "password", "example": "your_avantlink_api_key" }, "merchant_id": { "title": "", "type": "string", "description": "Your AvantLink Merchant ID.", "example": "your_avantlink_merchant_id" } }, "description": "" } } }, "avantlink_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/avantlink_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "aveva_pi_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Possible values: `Directly`, `PrivateLink`", "example": "Directly | PrivateLink", "enum": [ "Directly", "PrivateLink" ] }, "database": { "title": "Database Name", "type": "string", "description": "", "example": "my_db" }, "host": { "title": "AF Server IP Address", "type": "string", "description": "IP address of the AF Server", "example": "127.0.0.1" }, "password": { "title": "Database User Password", "type": "string", "description": "", "format": "password", "example": "string" }, "port": { "title": "AF Server Port Number", "type": "integer", "description": "Port number at which the AF Server is running", "format": "int32", "example": 443 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "string" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 0 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "string" }, "user": { "title": "Database User Username", "type": "string", "description": "Username for the user to authenticate as with the AF Server", "example": "myuser" } }, "description": "" } } }, "aveva_pi_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/aveva_pi_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "awin_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Awin API Token.", "format": "password", "example": "your_awin_api_token" }, "region": { "type": "object", "description": "Your Awin Region.", "enum": [ "DE", "NO", "BE", "FI", "CH", "DK", "IT", "FR", "ES", "BR", "SE", "AT", "BU", "AU", "GB", "IE", "PL", "CA", "NL", "US" ] } }, "description": "" } } }, "awin_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/awin_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "aws_cloudtrail_config_V1": { "properties": { "config": { "type": "object", "properties": { "bucket": { "title": "", "type": "string", "description": "The AWS bucket name which is configured for AWS CloudTrail.", "example": "fivetran-cloudtrail" }, "prefix": { "title": "", "type": "string", "description": "If prefix is present when configuring the bucket.", "example": "test_prefix" }, "role_arn": { "title": "", "type": "string", "description": "The Role ARN required for authentication.", "format": "password", "example": "arn:aws:iam::***********" } }, "description": "" } } }, "aws_cloudtrail_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/aws_cloudtrail_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "aws_cost_report_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_key_id": { "title": "", "type": "string", "description": "Access Key ID", "example": "string" }, "access_key_secret": { "title": "", "type": "string", "description": "Access Key Secret", "format": "password", "example": "string" }, "auth_type": { "title": "", "type": "object", "description": "Access approach", "example": "IAM_ROLE | ACCESS_KEY", "enum": [ "IAM_ROLE", "ACCESS_KEY" ] }, "bucket": { "title": "", "type": "string", "description": "The S3 bucket name with the AWS Cost and Usage Report ", "example": "aws_region_code" }, "prefix": { "title": "", "type": "string", "description": "Folder path to the aws_cost_report files within the bucket.", "example": "folder_path" }, "role_arn": { "title": "", "type": "string", "description": "The Role ARN required for authentication.", "format": "password", "example": "arn::your_role_arn" } }, "description": "" } } }, "aws_cost_report_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "access_key_id": { "title": "", "type": "string", "description": "ESM key for access Key ID", "example": "ACCESS_KEY_ID_KEY" }, "access_key_secret": { "title": "", "type": "string", "description": "ESM key for access Key Secret", "example": "ACCESS_KEY_SECRET_KEY" } }, "description": "" } } }, "aws_cost_report_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/aws_cost_report_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" }, { "$ref": "#/components/schemas/aws_cost_report_esm_keys_config_V1" } ] }, "aws_inventory_config_V1": { "properties": { "config": { "type": "object", "properties": { "bucket": { "title": "", "type": "string", "description": "The AWS bucket name that is configured for AWS Config.", "example": "fivetran-config" }, "prefix": { "title": "", "type": "string", "description": "The prefix if you used one when configuring the bucket.", "example": "test_prefix" }, "role_arn": { "title": "", "type": "string", "description": "The Role ARN required for authentication.", "format": "password", "example": "arn:aws:iam::***********" } }, "description": "" } } }, "aws_inventory_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/aws_inventory_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "aws_lambda_config_V1": { "properties": { "config": { "type": "object", "properties": { "bucket": { "title": "", "type": "string", "description": "S3 Bucket", "example": "bucket" }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "custom_payloads": { "title": "", "type": "array", "description": "The list of key-value pairs that can be used to specify custom information to the function at runtime.", "items": { "title": "", "type": "object", "properties": { "key": { "title": "", "type": "string", "description": "Payload Key", "example": "string" }, "value": { "title": "", "type": "string", "description": "Payload Value", "example": "string" } }, "description": "The list of key-value pairs that can be used to specify custom information to the function at runtime." } }, "function": { "title": "", "type": "string", "description": "The name of your AWS Lambda Function.", "example": "function_name" }, "is_private_link_required": { "title": "", "type": "boolean", "description": "We use PrivateLink by default if your AWS Lambda is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to AWS lambda over PrivateLink. Learn more in our [PrivateLink documentation](https://fivetran.com/docs/connectors/databases/connection-options/aws-private-link).", "example": true }, "region": { "title": "", "type": "object", "description": "The AWS region code for the DynamoDB instance.", "example": "us-east-1", "enum": [ "me-central-1", "aws-cn-global", "us-isof-south-1", "ap-east-2", "us-west-1", "us-west-2", "af-south-1", "ap-northeast-3", "ap-northeast-2", "ap-northeast-1", "me-south-1", "sa-east-1", "cn-north-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ap-southeast-5", "us-east-1", "us-east-2", "ap-southeast-7", "cn-northwest-1", "aws-iso-e-global", "ap-south-2", "ap-south-1", "eu-south-1", "eu-south-2", "us-gov-east-1", "il-central-1", "ca-central-1", "mx-central-1", "eu-central-1", "eusc-de-east-1", "us-iso-west-1", "eu-central-2", "eu-isoe-west-1", "aws-global", "eu-north-1", "eu-west-3", "eu-west-2", "eu-west-1", "aws-iso-global", "ap-east-1", "ca-west-1", "us-gov-west-1", "us-iso-east-1", "aws-iso-b-global", "aws-iso-f-global", "us-isob-east-1", "aws-us-gov-global", "us-isof-east-1" ] }, "role_arn": { "title": "", "type": "string", "description": "The Role ARN required for authentication.", "format": "password", "example": "arn::your_role_arn" }, "secrets": { "title": "", "type": "string", "description": "The secrets that should be passed to the function at runtime.", "format": "password", "example": "string" }, "secrets_list": { "title": "", "type": "array", "description": "List of Secrets that should be passed to the function at runtime.", "items": { "title": "", "type": "object", "properties": { "key": { "title": "", "type": "string", "description": "Secret Key.", "example": "apiKey" }, "value": { "title": "", "type": "string", "description": "Secret Value.", "format": "password", "example": "apiSecret" } }, "description": "List of Secrets that should be passed to the function at runtime." } }, "sync_method": { "title": "", "type": "object", "description": "Sync Method", "example": "CLOUD_STORAGE | DIRECT", "enum": [ "CLOUD_STORAGE", "DIRECT" ] } }, "description": "" } } }, "aws_lambda_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/aws_lambda_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "aws_msk_config_V1": { "properties": { "config": { "type": "object", "properties": { "connection_method": { "title": "", "type": "object", "description": "How Fivetran connects to your message brokers in the cluster", "example": "privatelink | direct", "enum": [ "privatelink", "direct" ] }, "consumer_group": { "title": "", "type": "string", "description": "The name of consumer group created for Fivetran.", "example": "consumer_group" }, "key_password": { "title": "", "type": "string", "description": "If `security_protocol` is set to `TLS`, enter your `Key Password`.", "format": "password", "example": "key_password" }, "keystore": { "title": "", "type": "string", "description": "If `security_protocol` is set to `TLS`, add the `Keystore File` as Base64 encoded string.", "format": "password", "example": "test_keystore" }, "keystore_password": { "title": "", "type": "string", "description": "If `security_protocol` is set to `TLS`, enter your `Keystore Password`.", "format": "password", "example": "keystore_password" }, "message_type": { "title": "", "type": "object", "description": "The Message type.", "example": "Text | Json | Avro | Protobuf", "enum": [ "Text", "Json", "Avro", "Protobuf" ] }, "role_arn": { "title": "", "type": "string", "description": "If `sasl_mechanism` is set to `IAM`, enter your Role ARN", "format": "password", "example": "arn::your_role_arn" }, "sasl_mechanism": { "title": "", "type": "object", "description": "If `security_protocol` is set to `SASL`, enter the SASL Mechanism", "example": "IAM | SCRAM_SHA_512", "enum": [ "IAM", "SCRAM_SHA_512" ] }, "sasl_scram512_key": { "title": "", "type": "string", "description": "If `sasl_mechanism` is set to `SCRAM_SHA_512`, enter your secret's `saslScram512Key`.", "format": "password", "example": "sasl_key" }, "sasl_scram512_secret": { "title": "", "type": "string", "description": "If `sasl_mechanism` is set to `SCRAM_SHA_512`, enter your secret's `saslScram512Key`.", "format": "password", "example": "sasl_secret" }, "schema_registry_credentials_source": { "title": "", "type": "string", "description": "Schema Registry Credentials source", "example": "string" }, "schema_registry_key": { "title": "", "type": "string", "description": "Schema Registry Key", "format": "password", "example": "string" }, "schema_registry_secret": { "title": "", "type": "string", "description": "Schema Registry Secret", "format": "password", "example": "string" }, "schema_registry_urls": { "title": "", "type": "array", "description": "Your schema registry URLs", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "security_protocol": { "title": "", "type": "object", "description": "The security protocol for Kafka interaction.", "example": "SASL | PLAINTEXT | TLS", "enum": [ "SASL", "PLAINTEXT", "TLS" ] }, "servers": { "title": "", "type": "array", "description": "Comma-separated list of Kafka servers in the `server:port` format.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "sync_type": { "title": "", "type": "object", "description": "The sync type. Unpacked messages must be valid JSON.", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "truststore": { "title": "", "type": "string", "description": "If `security_protocol` is set to `TLS`, add the `Truststore File` as Base64 encoded string.", "format": "password", "example": "test_truststore" } }, "description": "" } } }, "aws_msk_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/aws_msk_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "azure_blob_storage_config_V1": { "properties": { "config": { "type": "object", "properties": { "append_file_option": { "title": "", "type": "object", "description": "If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.", "example": "upsert_file_with_primary_keys | upsert_file | append_file", "enum": [ "upsert_file_with_primary_keys", "upsert_file", "append_file" ] }, "auth_method": { "title": "", "type": "object", "description": "Authentication Method", "example": "CONNECTION_STRING | SERVICE_PRINCIPAL_SECRET | SERVICE_PRINCIPAL_CERTIFICATE", "enum": [ "CONNECTION_STRING", "SERVICE_PRINCIPAL_SECRET", "SERVICE_PRINCIPAL_CERTIFICATE" ] }, "compression": { "title": "", "type": "object", "description": "The secrets that should be passed to the function at runtime.", "example": "zip | gz | tar_gz | tar | infer | gzip | uncompressed | bz2 | tar_bz2", "enum": [ "zip", "gz", "tar_gz", "tar", "infer", "gzip", "uncompressed", "bz2", "tar_bz2" ] }, "connection_method": { "title": "", "type": "object", "description": "Connection Method. Possible values: `DIRECT`: Fivetran will connect directly to your storage container, `SSH_TUNNEL`: Fivetran will connect to your storage container using a host machine (commonly used for VPN connections), `PRIVATE_LINK`: Fivetran will connect to your storage container using PrivateLink.", "example": "SSH_TUNNEL | DIRECT | PRIVATE_LINK", "enum": [ "SSH_TUNNEL", "DIRECT", "PRIVATE_LINK" ] }, "connection_string": { "title": "", "type": "string", "description": "Connect using a SAS URL or connection string. The SAS determines whether Fivetran can access the storage account or only the specified container", "format": "password", "example": "BlobEndpoint=https://abc123.blob.core.windows.net/;TableEndpoint=https://abc123.table.core.windows.net/;SharedAccessSignature=xxxxxxxxx" }, "container_address": { "title": "", "type": "string", "description": "IP address of the Azure Storage Container which is accessible from host machine.", "example": "192.168.0.1" }, "container_name": { "title": "", "type": "string", "description": "The name of the blob container.", "example": "container_name" }, "delimiter": { "title": "", "type": "string", "description": "You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.", "example": "string" }, "empty_header": { "title": "", "type": "boolean", "description": "Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.", "example": true }, "escape_char": { "title": "", "type": "string", "description": "If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.", "example": "string" }, "extraction_pattern": { "title": "", "type": "string", "description": "Required when `file_mapping_method` = `EXTRACT_TABLES`. A regular expression with a named capture group `(?...)` to extract table names from file paths.", "example": "(?
\\w+)/.*" }, "file_mapping_method": { "title": "", "type": "object", "description": "The method used to map files to destination tables. Use `DEFINE_PER_TABLE` to manually configure each table with its own file pattern, or `EXTRACT_TABLES` to automatically discover tables based on a single extraction pattern.", "example": "EXTRACT_TABLES | DEFINE_PER_TABLE", "enum": [ "EXTRACT_TABLES", "DEFINE_PER_TABLE" ] }, "file_type": { "title": "", "type": "object", "description": "If your files are saved with improper extensions, you can force them to by synced as the selected file type.", "example": "tsv | xml | csv | spreadsheet | json | jsonl | avro | parquet", "enum": [ "tsv", "xml", "csv", "spreadsheet", "json", "jsonl", "avro", "parquet" ] }, "files": { "title": "", "type": "array", "description": "Required when `file_mapping_method` = `DEFINE_PER_TABLE`. Mapped file name patterns to a destination table.", "items": { "title": "", "type": "object", "properties": { "archive_pattern": { "title": "", "type": "string", "description": "All Files inside of compressed archives with filenames matching this regular expression will be synced.", "example": "string" }, "file_pattern": { "title": "", "type": "string", "description": "All files in your search path matching this regular expression will be synced per table.", "example": "string" }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "table_name": { "title": "", "type": "string", "description": "All files matching the above pattern will be synced to this table.", "example": "string" } }, "description": "Required when `file_mapping_method` = `DEFINE_PER_TABLE`. Mapped file name patterns to a destination table." } }, "host_ip": { "title": "", "type": "string", "description": "IP address of host tunnel machine which is used to connect to the Storage container.", "example": "192.168.0.2" }, "host_user": { "title": "", "type": "string", "description": "Username in the host machine.", "example": "host_username" }, "json_delivery_mode": { "title": "", "type": "object", "description": "Control how your JSON data is delivered into your destination", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "line_separator": { "title": "", "type": "string", "description": "You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.", "example": ";" }, "null_sequence": { "title": "", "type": "string", "description": "If your CSVs use a special value indicating null, you can specify it here.", "example": "string" }, "on_error": { "title": "", "type": "object", "description": "If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.", "example": "fail | skip", "enum": [ "fail", "skip" ] }, "pgp_pass_phrase": { "title": "", "type": "string", "description": "The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.", "format": "password", "example": "" }, "pgp_secret_key": { "title": "", "type": "string", "description": "The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.", "format": "password", "example": "" }, "prefix": { "title": "", "type": "string", "description": "All files and folders under this folder path will be searched for files to sync.", "example": "folder_path" }, "quote_char": { "title": "", "type": "string", "description": "You can specify the enclosing character used in your CSVs here. Fivetran will consider \" as the quote character if this field is empty and quote_character_enabled is set to true.", "example": "string" }, "quote_character_enabled": { "title": "", "type": "boolean", "description": "If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered \" as a quote character.", "example": true }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "signer_public_key": { "title": "", "type": "string", "description": "The contents of the signer's public key file. This is optional — if you don't provide the key, we decrypt the files without verifying their signatures.", "example": "" }, "skip_after": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.", "format": "int32", "example": 0 }, "skip_before": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified before syncing data.", "format": "int32", "example": 0 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "storage_account_name": { "title": "", "type": "string", "description": "The name of the Azure Storage account.", "example": "storage_account_name" }, "sync_inconsistent_rows": { "title": "", "type": "boolean", "description": "When enabled, Fivetran syncs rows with fewer or more columns than the header row. For rows with fewer columns, Fivetran adds NULL values for the missing columns. For rows with extra columns, Fivetran names them `column_`. When disabled, Fivetran handles inconsistent rows according to your error-handling settings.", "example": true }, "use_pgp_encryption_options": { "title": "", "type": "boolean", "description": "Set to `true` if files present in the Azure Blob Storage container are encrypted using PGP. Default value: `false`.", "example": true } }, "description": "" } } }, "schema_format_schema_table_group": { "properties": { "config": { "required": [ "schema", "table_group_name" ], "type": "object", "properties": { "schema": { "title": "Destination schema name", "type": "string", "description": "Destination schema name. Schema name is permanent and cannot be changed after connection creation", "example": "schema_name" }, "table_group_name": { "type": "string", "description": "Combined with the schema to form the Fivetran connection name `.`. Lets you create multiple Merge Mode connections per schema." } } } } }, "azure_blob_storage_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_certificate": { "title": "", "type": "string", "description": "`Client Certificate` of your Microsoft client application.", "example": "client_certificate" }, "client_certificate_private_key": { "title": "", "type": "string", "description": "`Certificate Private Key` of your Microsoft client application.", "example": "certificate_private_key" }, "client_certificate_private_key_passphrase": { "title": "", "type": "string", "description": "`Certificate Private Key Passphrase` of your Microsoft client application.", "example": "certificate_private_key_passphrase" }, "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Microsoft client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Microsoft client application.", "example": "my_client_secret" }, "tenant_id": { "title": "", "type": "string", "description": "`Tenant ID` of your Microsoft client application.", "example": "41db1ebd-41a6-4dda-8029-5dd8f227d843" } }, "description": "" } } }, "azure_blob_storage_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/azure_blob_storage_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table_group" }, { "$ref": "#/components/schemas/azure_blob_storage_auth_V1" } ] }, "azure_cosmos_for_mongo_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS", "example": true }, "binary_representation": { "title": "", "type": "object", "description": "How binary data is represented in the database. Possible values: 'Base64' (default), 'Uuid'.", "example": "Base64 | Uuid", "enum": [ "Base64", "Uuid" ] }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`. `Directly` is the default value", "example": "Directly | PrivateLink", "enum": [ "Directly", "PrivateLink" ] }, "database": { "title": "Authentication Database", "type": "string", "description": "Authentication database for the source. Usually 'admin'.", "example": "admin" }, "hosts": { "title": "", "type": "array", "description": "A list of host addresses for Azure Cosmos DB for Mongo DB.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "packed_mode_tables": { "title": "", "type": "array", "description": "List of tables to be synced in packed mode; format:`.
`(case-sensitive).", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "packing_mode": { "title": "", "type": "object", "description": "Indicates the desired sync pack mode. Accepted values are `UsePackedModeOnly` and `UseUnpackedModeOnly`. `SelectTablesForPackedMode` is deprecated. ", "example": "UsePackedModeOnly | UseUnpackedModeOnly", "enum": [ "UsePackedModeOnly", "UseUnpackedModeOnly" ] }, "password": { "title": "", "type": "string", "description": "Password used for source database authentication.", "format": "password", "example": "test_password" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "string" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 0 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "string" }, "user": { "title": "", "type": "string", "description": "Username for source database access.", "example": "test_user" } }, "description": "" } } }, "azure_cosmos_for_mongo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/azure_cosmos_for_mongo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" } ] }, "azure_devops_config_V1": { "properties": { "config": { "type": "object", "properties": { "sub_domain": { "title": "", "type": "string", "description": "Your Azure Organization Name", "example": "your_azure_devops_organization_name" } }, "description": "" } } }, "azure_devops_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } } }, "description": "" } } }, "azure_devops_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/azure_devops_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/azure_devops_auth_V1" } ] }, "azure_event_hub_config_V1": { "properties": { "config": { "type": "object", "properties": { "connection_string": { "title": "", "type": "string", "description": "Connection string of the Event Hub Namespace you want to sync.", "format": "password", "example": "connection_string" }, "consumer_group": { "title": "", "type": "string", "description": "Name of consumer group created for Fivetran.", "example": "consumer_group" }, "message_type": { "title": "", "type": "object", "description": "Message type.", "example": "Text | Json", "enum": [ "Text", "Json" ] }, "sync_type": { "title": "", "type": "object", "description": "Sync type. Unpacked messages must be valid JSON.", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] } }, "description": "" } } }, "azure_event_hub_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/azure_event_hub_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "azure_function_config_V1": { "properties": { "config": { "type": "object", "properties": { "connection_method": { "title": "", "type": "object", "description": "Connection Method. Possible values: `DIRECT`: Fivetran will connect directly to your function, `PRIVATE_LINK`: Fivetran will connect to your storage container using PrivateLink.", "example": "DIRECT | PRIVATE_LINK", "enum": [ "DIRECT", "PRIVATE_LINK" ] }, "custom_payloads": { "title": "", "type": "array", "description": "The list of key-value pairs that can be used to specify custom information to the function at runtime.", "items": { "title": "", "type": "object", "properties": { "key": { "title": "", "type": "string", "description": "Payload Key", "example": "string" }, "value": { "title": "", "type": "string", "description": "Payload Value", "example": "string" } }, "description": "The list of key-value pairs that can be used to specify custom information to the function at runtime." } }, "function_app": { "title": "", "type": "string", "description": "Function app name in Azure portal.", "example": "function_app_name" }, "function_key": { "title": "", "type": "string", "description": "Function key used for authorization.", "format": "password", "example": "function_key" }, "function_name": { "title": "", "type": "string", "description": "Name of the function to be triggered.", "example": "function_name" }, "secrets": { "title": "", "type": "string", "description": "The secrets that should be passed to the function at runtime.", "format": "password", "example": "{\"apiKey\" : \"yourApiKey\"}" }, "secrets_list": { "title": "", "type": "array", "description": "The list of secrets that should be passed to the function at runtime.", "items": { "title": "", "type": "object", "properties": { "key": { "title": "", "type": "string", "description": "Key", "example": "string" }, "value": { "title": "", "type": "string", "description": "Value", "format": "password", "example": "string" } }, "description": "The list of secrets that should be passed to the function at runtime." } } }, "description": "" } } }, "azure_function_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/azure_function_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "azure_postgres_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Database authentication method", "example": "ENTRA_ID | PASSWORD", "enum": [ "ENTRA_ID", "PASSWORD" ] }, "client_private_key": { "title": "", "type": "string", "description": "Client Private Key in .pem format.", "format": "password", "example": "string" }, "client_public_certificate": { "title": "", "type": "string", "description": "Client Certificate in .pem format.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "postgres" }, "delete_capture_enabled": { "title": "", "type": "boolean", "description": "", "example": true }, "entra_app_id": { "title": "", "type": "string", "description": "Registered Application ID (for Entra ID authentication).", "example": "string" }, "entra_tenant_id": { "title": "", "type": "string", "description": "Azure Tenant ID (for Entra ID authentication).", "example": "string" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "postgresinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 5432 }, "publication_name": { "title": "", "type": "string", "description": "Publication name. Specify only for `\"updated_method\": \"WAL_PGOUTPUT\"`.", "example": "string" }, "replication_slot": { "title": "", "type": "string", "description": "Replication slot name. Specify only for `\"updated_method\": \"WAL_PGOUTPUT\"`.", "example": "test_replication_slot" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method to detect new or changed rows.
Specify only for `\"service\": \"postgres\"` or `\"service\": \"postgres_rds\"`.
Supported values:
`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. This is more efficient than the query-based method, but requires more setup and monitoring.
`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns", "example": "QUERY_BASED | WAL_PGOUTPUT", "enum": [ "QUERY_BASED", "WAL_PGOUTPUT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "azure_postgres_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "azure_postgres_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/azure_postgres_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/azure_postgres_esm_keys_config_V1" } ] }, "azure_service_bus_config_V1": { "properties": { "config": { "type": "object", "properties": { "asb_ip": { "title": "asb_ip", "type": "string", "description": "The IP address (or) the URL of ASB namespace", "example": "string" }, "auth_type": { "title": "auth_type", "type": "object", "description": "The authentication mode to access the topic", "example": "ConnectionString | AzureActiveDirectory", "enum": [ "ConnectionString", "AzureActiveDirectory" ] }, "connection_method": { "title": "connection_method", "type": "object", "description": "The connection method", "example": "SSH_TUNNEL | DIRECT | PRIVATE_LINK", "enum": [ "SSH_TUNNEL", "DIRECT", "PRIVATE_LINK" ] }, "connection_string": { "title": "connection_string", "type": "string", "description": "The connection string used for authentication. Required if the authentication type is `ConnectionString` ", "format": "password", "example": "Connection String" }, "has_manage_permissions": { "title": "has_manage_permissions", "type": "boolean", "description": "The boolean value specifying whether the connection string has manage permissions", "example": true }, "host_ip": { "title": "host_ip", "type": "string", "description": "The IP address of the host machine which we use to connect to ASB via ssh", "example": "string" }, "host_user": { "title": "host_user", "type": "string", "description": "The username on the host machine which we use to connect to ASB via ssh", "example": "string" }, "message_type": { "title": "message_type", "type": "object", "description": "The format of messages in the topic", "example": "Xml | Text | Json | Avro", "enum": [ "Xml", "Text", "Json", "Avro" ] }, "namespace": { "title": "namespace", "type": "string", "description": "The ASB namespace which we have to sync. Required for `AzureActiveDirectory` authentication.", "example": "my_namespace" }, "schema_registry_key": { "title": "schema_registry_key", "type": "string", "description": "The key used to access the schema registry. Required for the `avro` and `protobuf` message types", "example": "schema_registry_key" }, "schema_registry_secret": { "title": "schema_registry_secret", "type": "string", "description": "The secret used to access the schema registry. Required for the `avro` and `protobuf` message types", "format": "password", "example": "schema_registry_secret" }, "schema_registry_urls": { "title": "schema_registry_urls", "type": "array", "description": "The comma-separated list of schema registry servers in the `server:port` format", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "subscriber_name": { "title": "subscriber_name", "type": "string", "description": "The subscriber name. If the connection string does not have manage permission, you need to specify a subscriber name we can use to fetch data. If not specified, we default to `fivetran_sub_`", "example": "subscriber_name" }, "sync_type": { "title": "sync_type", "type": "object", "description": "The sync type, which is based on the message type. For `text` and `xml`, `packed` is supported. For `protobuf` and `avro`, `unpacked` is supported. For `json`, both `packed` and `unpacked` are supported", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "topics": { "title": "topics", "type": "array", "description": "The comma-separated list of topics which should be synced. Required if you do not have manage permissions", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } } }, "description": "" } } }, "azure_service_bus_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Azure application. Required if the authentication type is `AzureActiveDirectory`", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Azure application. Required if the authentication type is `AzureActiveDirectory`", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The refresh token. Required if the authentication type is `AzureActiveDirectory`", "example": "refresh_token" } }, "description": "" } } }, "azure_service_bus_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/azure_service_bus_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/azure_service_bus_auth_V1" } ] }, "azure_sql_db_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel.", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Authentication Method.", "example": "EntraIDServicePrincipalSecret | EntraIDServicePrincipalCertificate | ActiveDirectory | Password", "enum": [ "EntraIDServicePrincipalSecret", "EntraIDServicePrincipalCertificate", "ActiveDirectory", "Password" ] }, "connection_type": { "title": "", "type": "object", "description": "Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "sqldb" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "sqlinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 1433 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tenant_id": { "title": "", "type": "string", "description": "Azure AD tenant ID.", "format": "password", "example": "your_tenant_id" }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "(Optional) The incremental update method the connector will use. The possible values are `\"TELEPORT\"` or `\"NATIVE_UPDATE\"`. The type defaults to `\"NATIVE_UPDATE\"` if the value is set to `null` or not specified.", "example": "NATIVE_UPDATE | TELEPORT", "enum": [ "NATIVE_UPDATE", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name. For Azure Databases, the format must be `user@domain`.", "example": "test_user" } }, "description": "" } } }, "azure_sql_db_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The long-lived Access token carries the information necessary to access API resources.", "example": "my_access_token" }, "managed_identity_user_assigned": { "title": "", "type": "string", "description": "User Assigned Managed Identity Client ID.", "example": "managed_identity_user_assigned" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived Refresh token carries the information necessary to get a new access token for API resources.", "example": "my_refresh_token" }, "service_principal_client_cert_pvt_key": { "title": "", "type": "string", "description": "Contents of Service Principal Client Certificate Private Key.", "example": "service_principal_client_cert_pvt_key" }, "service_principal_client_certificate": { "title": "", "type": "string", "description": "Contents of Service Principal Client Certificate.", "example": "service_principal_client_certificate" }, "service_principal_client_secret": { "title": "", "type": "string", "description": "Service Principal Client Secret.", "example": "service_principal_client_secret" }, "service_principal_id": { "title": "", "type": "string", "description": "Service Principal Client ID.", "example": "service_principal_id" } }, "description": "" } } }, "azure_sql_db_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name", "example": "USER_KEY" } }, "description": "" } } }, "azure_sql_db_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/azure_sql_db_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/azure_sql_db_auth_V1" }, { "$ref": "#/components/schemas/azure_sql_db_esm_keys_config_V1" } ] }, "azure_sql_managed_db_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS.", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Authentication Method.", "example": "EntraIDServicePrincipalSecret | EntraIDServicePrincipalCertificate | ActiveDirectory | Password", "enum": [ "EntraIDServicePrincipalSecret", "EntraIDServicePrincipalCertificate", "ActiveDirectory", "Password" ] }, "connection_type": { "title": "", "type": "object", "description": "Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "sqldb" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "sqlinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 1433 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tenant_id": { "title": "", "type": "string", "description": "Azure AD tenant ID.", "format": "password", "example": "your_tenant_id" }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "(Optional) The incremental update method the connector will use. The possible values are `\"TELEPORT\"` or `\"NATIVE_UPDATE\"`. The type defaults to `\"NATIVE_UPDATE\"` if the value is set to `null` or not specified.", "example": "NATIVE_UPDATE | TELEPORT", "enum": [ "NATIVE_UPDATE", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name. For Azure Databases, the format must be `user@domain`.", "example": "test_user" } }, "description": "" } } }, "azure_sql_managed_db_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The long-lived Access token carries the information necessary to access API resources.", "example": "my_access_token" }, "managed_identity_user_assigned": { "title": "", "type": "string", "description": "User Assigned Managed Identity Client ID.", "example": "managed_identity_user_assigned" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived Refresh token carries the information necessary to get a new access token for API resources.", "example": "my_refresh_token" }, "service_principal_client_cert_pvt_key": { "title": "", "type": "string", "description": "Contents of Service Principal Client Certificate Private Key.", "example": "service_principal_client_cert_pvt_key" }, "service_principal_client_certificate": { "title": "", "type": "string", "description": "Contents of Service Principal Client Certificate.", "example": "service_principal_client_certificate" }, "service_principal_client_secret": { "title": "", "type": "string", "description": "Service Principal Client Secret.", "example": "service_principal_client_secret" }, "service_principal_id": { "title": "", "type": "string", "description": "Service Principal Client ID.", "example": "service_principal_id" } }, "description": "" } } }, "azure_sql_managed_db_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name", "example": "USER_KEY" } }, "description": "" } } }, "azure_sql_managed_db_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/azure_sql_managed_db_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/azure_sql_managed_db_auth_V1" }, { "$ref": "#/components/schemas/azure_sql_managed_db_esm_keys_config_V1" } ] }, "backbone_plm_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Backbone PLM API token.", "format": "password", "example": "backbone_plm_api_token" } }, "description": "" } } }, "backbone_plm_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/backbone_plm_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ballotready_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your BallotReady API token.", "format": "password", "example": "your_ballotready_api_key" } }, "description": "" } } }, "ballotready_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ballotready_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "bamboohr_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your API Key.", "format": "password", "example": "your_api_key" }, "subdomain": { "title": "", "type": "string", "description": "The subdomain used to access your account. If you access BambooHR at 'https://mycompany.bamboohr.com', then the subdomain is 'mycompany'.", "example": "your_subdomain" } }, "description": "" } } }, "bamboohr_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/bamboohr_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "bazaarvoice_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Bazaarvoice API key.", "format": "password", "example": "your_bazaarvoice_api_key" }, "environment": { "type": "object", "description": "Your Bazaarvoice environment.", "enum": [ "api.bazaarvoice.com", "stg.api.bazaarvoice.com" ] } }, "description": "" } } }, "bazaarvoice_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/bazaarvoice_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "betterworks_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Betterworks API key.", "format": "password", "example": "string" }, "sub_domain": { "title": "", "type": "string", "description": "Your Betterworks subdomain.", "example": "your_betterworks_sub_domain" } }, "description": "" } } }, "betterworks_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/betterworks_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "big_commerce_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your [API access token ](/docs/connectors/applications/big-commerce/setup-guide#createaccesstoken).", "format": "password", "example": "your_api_access_token" }, "store_hash": { "title": "", "type": "string", "description": "The [store hash](/docs/connectors/applications/big-commerce/setup-guide#createaccesstoken) in your API path.", "example": "your_store_hash" } }, "description": "" } } }, "big_commerce_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/big_commerce_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "bigin_by_zoho_crm_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Bigin by Zoho CRM Client Id", "example": "your_bigin_by_zoho_crm_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Bigin by Zoho CRM Client Secret", "format": "password", "example": "your_bigin_by_zoho_crm_client_secret" }, "edition": { "type": "object", "description": "Your Bigin by Zoho CRM pricing plan", "enum": [ "5000", "100000" ] }, "region": { "type": "object", "description": "Your Bigin by Zoho CRM Region", "enum": [ "com", "eu", "in", "com.cn", "jp", "com.au" ] } }, "description": "" } } }, "bigin_by_zoho_crm_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "bigin_by_zoho_crm_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/bigin_by_zoho_crm_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/bigin_by_zoho_crm_auth_V1" } ] }, "bigmarker_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your BigMarker API key.", "format": "password", "example": "your_bigmarker_api_key" }, "base_url": { "title": "", "type": "string", "description": "Your BigMarker base URL.", "example": "your_bigmarker_base_url" } }, "description": "" } } }, "bigmarker_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/bigmarker_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "bigquery_db_config_V1": { "properties": { "config": { "type": "object", "properties": { "connection_type": { "title": "", "type": "object", "description": "Direct or PrivateLink connection", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "data_set_name": { "title": "", "type": "string", "description": "Data set name", "example": "dataSetName" }, "project_id": { "title": "", "type": "string", "description": "BigQuery project ID", "example": "projectId" }, "quota_project_id": { "title": "Quota project ID", "type": "string", "description": "Specify a different project ID to account for quota and billing of Fivetran query workload", "example": "my-quota-project" }, "secret_key": { "title": "", "type": "string", "description": "Private key of the customer service account. If specified, your service account will be used to process the data instead of the Fivetran-managed service account.", "format": "password", "example": "secretKey" }, "use_service_account": { "title": "", "type": "boolean", "description": "BigQuery use service account; default is false", "example": true }, "use_workspace": { "title": "", "type": "boolean", "description": "Create and drop tables in a query results dataset. Default is false", "example": true }, "workspace_name": { "title": "", "type": "string", "description": "Workspace Dataset Name", "example": "string" }, "workspace_same_as_source": { "title": "", "type": "boolean", "description": "Use the source dataset as the workspace dataset", "example": true } }, "description": "" } } }, "bigquery_db_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/bigquery_db_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" } ] }, "billing_platform_config_V1": { "properties": { "config": { "type": "object", "properties": { "base_url": { "title": "", "type": "string", "description": "Your BillingPlatform subdomain.", "example": "your_billing_platform_base_url" }, "client_id": { "title": "", "type": "string", "description": "Your BillingPlatform client ID.", "example": "billing_platform_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your BillingPlatform client secret.", "format": "password", "example": "billing_platform_client_secret" } }, "description": "" } } }, "billing_platform_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your BillingPlatform access token.", "format": "password", "example": "your_access_token" }, "refresh_token": { "title": "", "type": "string", "description": "Your BillingPlatform refresh token.", "format": "password", "example": "your_refresh_token" } }, "description": "" } } }, "billing_platform_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/billing_platform_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/billing_platform_auth_V1" } ] }, "bing_webmaster_tools_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Bing Webmaster Tools client ID.", "example": "your_bing_webmaster_tools_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Bing Webmaster Tools client secret.", "format": "password", "example": "your_bing_webmaster_tools_client_secret" } }, "description": "" } } }, "bing_webmaster_tools_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/bing_webmaster_tools_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "bingads_config_V1": { "properties": { "config": { "type": "object", "properties": { "accounts": { "title": "", "type": "array", "description": "Specific accounts to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "rollback_window_size": { "title": "", "type": "integer", "description": "A period of time in days during which a conversion is recorded.", "format": "int32", "example": 30 }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.", "example": "AllAccounts | SpecificAccounts", "enum": [ "AllAccounts", "SpecificAccounts" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `SIX`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "bingads_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Microsoft Advertising client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Microsoft Advertising client application.", "example": "my_client_secret" } }, "description": "Your application client access fields." }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "bingads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/bingads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/bingads_auth_V1" } ] }, "birdeye_config_V1": { "properties": { "config": { "type": "object", "properties": { "business_id": { "title": "", "type": "string", "description": "Your Birdeye Business ID.", "format": "password", "example": "your_birdeye_business_id" }, "query_param_value": { "title": "", "type": "string", "description": "Your Birdeye query-param-value.", "format": "password", "example": "your_birdeye_query_param_value" } }, "description": "" } } }, "birdeye_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/birdeye_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "bitly_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Bitly access token.", "format": "password", "example": "your_bitly_access_token" } }, "description": "" } } }, "bitly_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/bitly_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "bizzabo_app_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_id": { "title": "", "type": "string", "description": "Your Bizzabo account ID.", "example": "your_bizzabo_account_id" }, "client_id": { "title": "", "type": "string", "description": "Your Bizzabo client ID.", "example": "bizzabo_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Bizzabo client secret.", "format": "password", "example": "bizzabo_client_secret" } }, "description": "" } } }, "bizzabo_app_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/bizzabo_app_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "boostr_config_V1": { "properties": { "config": { "type": "object", "properties": { "base_url": { "title": "", "type": "string", "description": "Your Boostr base URL.", "example": "your_boostr_base_url" }, "email": { "title": "", "type": "string", "description": "Your Boostr email.", "example": "your_boostr_username" }, "password": { "title": "", "type": "string", "description": "Your Boostr password.", "format": "password", "example": "your_boostr_password" } }, "description": "" } } }, "boostr_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/boostr_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "box_config_V1": { "properties": { "config": { "type": "object", "properties": { "append_file_option": { "title": "", "type": "object", "description": "If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.", "example": "upsert_file_with_primary_keys | upsert_file | append_file", "enum": [ "upsert_file_with_primary_keys", "upsert_file", "append_file" ] }, "compression": { "title": "", "type": "object", "description": "The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.", "example": "zip | gz | tar_gz | tar | infer | gzip | uncompressed | bz2 | tar_bz2", "enum": [ "zip", "gz", "tar_gz", "tar", "infer", "gzip", "uncompressed", "bz2", "tar_bz2" ] }, "delimiter": { "title": "", "type": "string", "description": "You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.", "example": "|" }, "empty_header": { "title": "", "type": "boolean", "description": "Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.", "example": true }, "escape_char": { "title": "", "type": "string", "description": "If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.", "example": "escape_char" }, "file_handling": { "title": "", "type": "object", "description": "Files will be processed and synced according to the selected file handling option. Supported values:
`structured`- (Default) Extract structured data into destination tables for analysis. Commonly used.
`unstructured`- Replicate files in their original format. Best for PDFs, images, and other unstructured content. Learn more about unstructured file replication in our [documentation.](/docs/using-fivetran/features/unstructured-file-replication).", "example": "structured", "enum": [ "unstructured", "structured" ] }, "file_type": { "title": "", "type": "object", "description": "If your files are saved with improper extensions, you can force them to be synced as the selected filetype.", "example": "tsv | xml | csv | spreadsheet | json | jsonl | avro | parquet", "enum": [ "tsv", "xml", "csv", "spreadsheet", "json", "jsonl", "avro", "parquet" ] }, "files": { "title": "", "type": "array", "description": "Mapped file name patterns to a destination table.", "items": { "title": "", "type": "object", "properties": { "archive_pattern": { "title": "", "type": "string", "description": "All Files inside of compressed archives with filenames matching this regular expression will be synced.", "example": "string" }, "file_pattern": { "title": "", "type": "string", "description": "All files in your search path matching this regular expression will be synced per table.", "example": "string" }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "table_name": { "title": "", "type": "string", "description": "All files matching the above pattern will be synced to this table.", "example": "string" } }, "description": "Mapped file name patterns to a destination table." } }, "folder_id": { "title": "", "type": "string", "description": "Folder URL", "example": "folder_id" }, "is_single_table_mode": { "title": "", "type": "boolean", "description": "Allows the creation of connector using Merge Mode strategy.", "example": true }, "json_delivery_mode": { "title": "", "type": "object", "description": "Control how your JSON data is delivered into your destination", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "line_separator": { "title": "", "type": "string", "description": "You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.", "example": ";" }, "null_sequence": { "title": "", "type": "string", "description": "If your CSVs use a special value indicating null, you can specify it here.", "example": "string" }, "on_error": { "title": "", "type": "object", "description": "If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.", "example": "fail | skip", "enum": [ "fail", "skip" ] }, "prefix": { "title": "", "type": "string", "description": "The connection will look for files in this folder path. Choose the lowest common folder in a folder hierarchy that includes all the files you want to sync. This defines a specific location where Fivetran scans for files and helps ensure optimal performance.", "example": "files/exports" }, "quote_char": { "title": "", "type": "string", "description": "You can specify the enclosing character used in your CSVs here. Fivetran will consider \" as the quote character if this field is empty and quote_character_enabled is set to true.", "example": "string" }, "quote_character_enabled": { "title": "", "type": "boolean", "description": "If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered \" as quote character.", "example": true }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "skip_after": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.", "format": "int32", "example": 0 }, "skip_before": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified before syncing data.", "format": "int32", "example": 0 }, "sync_inconsistent_rows": { "title": "", "type": "boolean", "description": "When enabled, Fivetran syncs rows with fewer or more columns than the header row. For rows with fewer columns, Fivetran adds NULL values for the missing columns. For rows with extra columns, Fivetran names them `column_`. When disabled, Fivetran handles inconsistent rows according to your error-handling settings.", "example": true }, "sync_nested_files": { "title": "", "type": "boolean", "description": "Optional. Set this to true to sync files from nested folders within the specified folder.", "example": true } }, "description": "" } } }, "box_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/box_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table_group" } ] }, "braintree_config_V1": { "properties": { "config": { "type": "object", "properties": { "merchant_id": { "title": "", "type": "string", "description": "Your Braintree merchant ID.", "example": "merchant_id" }, "private_key": { "title": "", "type": "string", "description": "The contents of your secret key file.", "format": "password", "example": "your_api_secret" }, "public_key": { "title": "", "type": "string", "description": "The contents of your PEM certificate file.", "example": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } }, "description": "" } } }, "braintree_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/braintree_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "braintree_sandbox_config_V1": { "properties": { "config": { "type": "object", "properties": { "merchant_id": { "title": "", "type": "string", "description": "Your Braintree merchant ID.", "example": "merchant_id" }, "private_key": { "title": "", "type": "string", "description": "The contents of your secret key file.", "format": "password", "example": "your_api_secret" }, "public_key": { "title": "", "type": "string", "description": "The contents of your PEM certificate file.", "example": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } }, "description": "" } } }, "braintree_sandbox_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/braintree_sandbox_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "branch_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "branch_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/branch_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "brave_ads_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Brave Ads API key", "format": "password", "example": "your_brave_ads_api_key" } }, "description": "" } } }, "brave_ads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/brave_ads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "braze_config_V1": { "properties": { "config": { "type": "object", "properties": { "abs_connection_string": { "title": "", "type": "string", "description": "Connection String", "format": "password", "example": "your_abs_connection_string" }, "abs_container_name": { "title": "", "type": "string", "description": "Container Name", "example": "your_abs_container_name" }, "abs_export_connection_string": { "title": "", "type": "string", "description": "Your Azure Blob Storage connection string for exports. Required if `AZURE_BLOB_STORAGE` is the `export_storage_type`", "format": "password", "example": "your_abs_export_connection_string" }, "abs_export_container_name": { "title": "", "type": "string", "description": "Your Azure Blob Storage container name for exports. Required if `AZURE_BLOB_STORAGE` is the `export_storage_type`", "example": "your_abs_export_container_name" }, "abs_export_prefix": { "title": "", "type": "string", "description": "Your Azure Blob Storage prefix for exports. Used if `AZURE_BLOB_STORAGE` is the `export_storage_type`", "example": "your_abs_export_prefix" }, "abs_prefix": { "title": "", "type": "string", "description": "Prefix", "example": "your_abs_prefix" }, "api_key": { "title": "", "type": "string", "description": "Your Braze API Key.", "format": "password", "example": "test_api_key" }, "api_url": { "title": "", "type": "string", "description": "Your Braze API URL.", "example": "test_api_url" }, "cloud_storage_type": { "title": "", "type": "object", "description": "Cloud storage type Braze Current is connected to.", "example": "NONE", "enum": [ "AZURE_BLOB_STORAGE", "GCS", "NONE", "AWS_S3" ] }, "enable_exports": { "title": "", "type": "boolean", "description": "Enable User Profile Exports", "example": true }, "export_storage_type": { "title": "", "type": "object", "description": "Export Storage. Required if `enable_exports` is `true`", "example": "GCS", "enum": [ "AZURE_BLOB_STORAGE", "GCS", "NONE", "AWS_S3" ] }, "gcs_bucket": { "title": "", "type": "string", "description": "Your GCS bucket. Required if `GCS` is the `cloud_storage_type`", "example": "your_gcs_bucket" }, "gcs_export_bucket": { "title": "", "type": "string", "description": "Your GCS bucket. Required if `GCS` is the `export_storage_type`", "example": "your_gcs_bucket" }, "gcs_export_folder": { "title": "", "type": "string", "description": "Your GCS folder name. Required if `GCS` is the `export_storage_type`", "example": "your_gcs_folder" }, "gcs_folder": { "title": "", "type": "string", "description": "Your GCS folder name. Required if `GCS` is the `cloud_storage_type`", "example": "your_gcs_folder" }, "historic_sync_time_frame": { "title": "", "type": "object", "description": "Range of data in history you would like to include in the initial sync.", "example": "ONE_YEAR | ALL_TIME | FIVE_YEARS | TWO_YEARS | THREE_MONTHS | SIX_MONTHS", "enum": [ "ONE_YEAR", "ALL_TIME", "FIVE_YEARS", "TWO_YEARS", "THREE_MONTHS", "SIX_MONTHS" ] }, "historical_sync_limit": { "title": "Historical sync time frame", "type": "object", "description": "Range of data in history you would like to include in the initial sync. Valid values are `ALL_TIME` and `DATE_LIMIT`", "example": "ALL_TIME", "enum": [ "ALL_TIME", "DATE_LIMIT" ] }, "historical_sync_limit_date": { "title": "Historical sync limit date", "type": "string", "description": "The start date (in YYYY-MM-DD) from which to sync historical data. Only used when `historicalSyncLimit` is set to `DATE_LIMIT`.", "example": "2006-01-01" }, "s3_export_bucket": { "title": "", "type": "string", "description": "Your S3 user export bucket. Required if `AWS_S3` is the `export_storage_type`", "example": "your_s3_bucket" }, "s3_export_folder": { "title": "", "type": "string", "description": "Your S3 user export folder name. Required if `AWS_S3` is the `export_storage_type`", "example": "your_s3_folder" }, "s3_export_role_arn": { "title": "", "type": "string", "description": "The Role ARN required for authentication required if `AWS_S3` is the `export_storage_type`", "format": "password", "example": "arn:aws:iam::XXXXXXXXXXXX:role/your_test_bucket" }, "s3bucket": { "title": "", "type": "string", "description": "Your S3 bucket required if `AWS_S3` is the `cloud_storage_type`", "example": "your_s3_bucket" }, "s3folder": { "title": "", "type": "string", "description": "Your S3 folder name required if `AWS_S3` is the `cloud_storage_type`", "example": "your_s3_folder" }, "s3role_arn": { "title": "", "type": "string", "description": "The Role ARN required for authentication required if `AWS_S3` is the `cloud_storage_type`", "format": "password", "example": "arn:aws:iam::XXXXXXXXXXXX:role/your_test_bucket" } }, "description": "" } } }, "braze_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/braze_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "breathe_hr_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Breathe HR API key.", "format": "password", "example": "your_breathe_hr_api_key" }, "environment": { "type": "object", "description": "Your Breathe HR environment.", "enum": [ "api.breathehr.com", "api.sandbox.breathehr.info" ] } }, "description": "" } } }, "breathe_hr_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/breathe_hr_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "brevo_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Brevo API key.", "format": "password", "example": "your_brevo_api_key" } }, "description": "" } } }, "brevo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/brevo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "brex_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Brex API token", "format": "password", "example": "your_brex_api_token" }, "base_url": { "type": "object", "description": "Your Brex Base URL", "enum": [ "platform.brexapis.com", "platform.staging.brexapps.com" ] } }, "description": "" } } }, "brex_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/brex_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "brightcove_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_id": { "title": "", "type": "string", "description": "Your Brightcove account ID.", "example": "your_brightcove_account_id" }, "client_id": { "title": "", "type": "string", "description": "Your Brightcove client ID.", "example": "your_brightcove_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Brightcove client secret.", "format": "password", "example": "your_brightcove_client_secret" } }, "description": "" } } }, "brightcove_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/brightcove_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "brightflag_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Brightflag client ID.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Your Brightflag client secret.", "format": "password", "example": "string" }, "region": { "type": "object", "description": "Your Brightflag region.", "enum": [ "app", "app-test", "enterprise", "aus-test", "enterprise-test", "aus" ] } }, "description": "" } } }, "brightflag_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/brightflag_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "brightpearl_config_V1": { "properties": { "config": { "type": "object", "properties": { "app_reference": { "title": "", "type": "string", "description": "Your Brightpearl app reference.", "example": "your_brightpearl_app_reference" }, "client_id": { "title": "", "type": "string", "description": "Your Brightpearl client ID.", "example": "your_brightpearl_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Brightpearl client secret.", "format": "password", "example": "your_brightpearl_client_secret" }, "data_center": { "type": "object", "description": "Your Brightpearl data center.", "enum": [ "euw1", "ws-use" ] }, "developer_reference": { "title": "", "type": "string", "description": "Your Brightpearl dev reference.", "example": "your_brightpearl_developer_reference" }, "organization_name": { "title": "", "type": "string", "description": "Your Brightpearl organization name.", "example": "your_brightpearl_organization_name" } }, "description": "" } } }, "brightpearl_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "brightpearl_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/brightpearl_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/brightpearl_auth_V1" } ] }, "brivo_config_V1": { "properties": { "config": { "type": "object", "properties": { "admin_username": { "title": "", "type": "string", "description": "Your Brivo Admin username.", "example": "your_brivo_admin_username" }, "api_key": { "title": "", "type": "string", "description": "Your Brivo API key.", "format": "password", "example": "your_brivo_api_key" }, "client_id": { "title": "", "type": "string", "description": "Your Brivo client ID.", "example": "your_brivo_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Brivo client secret.", "format": "password", "example": "your_brivo_client_secret" }, "password": { "title": "", "type": "string", "description": "Your Brivo password.", "format": "password", "example": "your_brivo_password" } }, "description": "" } } }, "brivo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/brivo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "buildium_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Buildium API client ID.", "example": "your_buildium_client_id" }, "environment": { "type": "object", "description": "Your Buildium environment.", "enum": [ "apisandbox", "api" ] }, "secret": { "title": "", "type": "string", "description": "Your Buildium API secret.", "format": "password", "example": "your_buildium_secret" } }, "description": "" } } }, "buildium_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/buildium_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "buildkite_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Buildkite API token.", "format": "password", "example": "your_buildkite_api_token" } }, "description": "" } } }, "buildkite_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/buildkite_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "business_central_config_V1": { "properties": { "config": { "type": "object", "properties": { "companies": { "title": "", "type": "array", "description": "List of companies to sync", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "environment_name": { "title": "", "type": "string", "description": "Name of the environment", "example": "your_business_central_environment_name" }, "tenant_id": { "title": "", "type": "string", "description": "`Tenant ID` of your Business Central application", "example": "your_business_central_tenant_id" } }, "description": "" } } }, "business_central_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Airtable client application.", "example": "your_business_central_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Airtable client application.", "example": "your_business_central_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived refresh token along with the client ID and client secret parameters carry the information necessary to get a new access token for API resources.", "example": "your_refresh_token" } }, "description": "" } } }, "business_central_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/business_central_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/business_central_auth_V1" } ] }, "buzzsprout_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Buzzsprout API token.", "format": "password", "example": "your_buzzsprout_api_token" } }, "description": "" } } }, "buzzsprout_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/buzzsprout_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "bynder_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Client ID of the OAuth app that you created in Bynder for the connection.", "example": "your_bynder_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Client secret of the OAuth app that you created in Bynder for the connection.", "format": "password", "example": "your_bynder_client_secret" }, "subdomain": { "title": "", "type": "string", "description": "Your Bynder subdomain.", "example": "your_bynder_subdomain" } }, "description": "" } } }, "bynder_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "bynder_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/bynder_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/bynder_auth_V1" } ] }, "cabcharge_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Cabcharge client ID.", "example": "string" }, "email_id": { "title": "", "type": "string", "description": "Your Cabcharge email ID.", "example": "string" }, "password": { "title": "", "type": "string", "description": "Your Cabcharge password.", "format": "password", "example": "string" }, "subscription_key": { "title": "", "type": "string", "description": "Your Cabcharge subscription key.", "format": "password", "example": "string" } }, "description": "" } } }, "cabcharge_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/cabcharge_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "calabrio_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Calabrio access token.", "format": "password", "example": "your_calabrio_access_token" }, "domain_name": { "title": "", "type": "string", "description": "Your Calabrio domain name", "example": "your_calabrio_domain_name" } }, "description": "" } } }, "calabrio_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/calabrio_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "calcom_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Cal.com API key.", "format": "password", "example": "your_calcom_api_key" }, "domain": { "type": "object", "description": "Your Cal.com API server region.", "enum": [ "api.cal.eu", "api.cal.com" ] } }, "description": "" } } }, "calcom_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/calcom_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "calendly_config_V1": { "properties": { "config": { "type": "object", "properties": { "calendly_plan": { "type": "object", "description": "Your Calendly Plan.", "enum": [ "45", "480" ] } }, "description": "" } } }, "calendly_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Calendly access token.", "format": "password", "example": "calendly_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "Your Calendly refresh token.", "format": "password", "example": "calendly_refresh_token" } }, "description": "" } } }, "calendly_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/calendly_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/calendly_auth_V1" } ] }, "callrail_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your CallRail API key.", "format": "password", "example": "your_callrail_api_key" } }, "description": "" } } }, "callrail_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/callrail_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "campaignmonitor_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Campaign Monitor API key.", "format": "password", "example": "your_campaignmonitor_api_key" } }, "description": "" } } }, "campaignmonitor_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/campaignmonitor_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "campfire_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Campfire API key.", "format": "password", "example": "your_campfire_api_key" } }, "description": "" } } }, "campfire_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/campfire_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "canny_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Canny API key.", "format": "password", "example": "your_canny_api_key" } }, "description": "" } } }, "canny_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/canny_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "canvas_by_instructure_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Canvas by Instructure client ID.", "example": "your_canvas_by_instructure_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Canvas by Instructure client secret.", "format": "password", "example": "your_canvas_by_instructure_client_secret" }, "sub_domain": { "title": "", "type": "string", "description": "Your Canvas by Instructure domain.", "example": "your_canvas_by_instructure_account_domain" } }, "description": "" } } }, "canvas_by_instructure_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "canvas_by_instructure_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/canvas_by_instructure_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/canvas_by_instructure_auth_V1" } ] }, "canvas_data_2_by_instructure_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Canvas Data 2 by Instructure client ID.", "example": "your_canvas_data_2_by_instructure_client_id" }, "secret": { "title": "", "type": "string", "description": "Your Canvas Data 2 by Instructure secret.", "format": "password", "example": "your_canvas_data_2_by_instructure_secret" } }, "description": "" } } }, "canvas_data_2_by_instructure_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/canvas_data_2_by_instructure_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "captivateiq_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your CaptivateIQ API key.", "format": "password", "example": "your_captivateiq_api_key" } }, "description": "" } } }, "captivateiq_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/captivateiq_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "care_quality_commission_config_V1": { "properties": { "config": { "type": "object", "properties": { "primary_key": { "title": "", "type": "string", "description": "Your Care Quality Commission primary key.", "format": "password", "example": "your_care_quality_commission_primary_key" } }, "description": "" } } }, "care_quality_commission_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/care_quality_commission_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "castor_edc_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Castor EDC client Id.", "example": "your_castor_edc_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Castor EDC client secret.", "format": "password", "example": "your_castor_edc_client_secret" }, "server": { "type": "object", "description": "Your Castor EDC server.", "enum": [ "data", "au", "uk", "us" ] } }, "description": "" } } }, "castor_edc_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/castor_edc_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "centra_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Centra API token.", "format": "password", "example": "centra_api_token" }, "base_url": { "title": "", "type": "string", "description": "Your Centra base URL.", "example": "centra_base_url" } }, "description": "" } } }, "centra_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/centra_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ceridian_dayforce_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_confirmation": { "title": "", "type": "string", "description": "Your confirmation that you have granted Fivetran access to all the RESTful services and fields you want to sync. Possible values: `true`, `false`.", "example": "true" }, "client_host": { "title": "", "type": "string", "description": "Your Ceridian Dayforce client host.", "example": "your_ceridian_dayforce_client_host" }, "client_namespace": { "title": "", "type": "string", "description": "Your Ceridian Dayforce client namespace.", "example": "your_ceridian_dayforce_client_namespace" }, "password": { "title": "", "type": "string", "description": "Your Ceridian Dayforce password.", "format": "password", "example": "your_ceridian_dayforce_password" }, "username": { "title": "", "type": "string", "description": "Your Ceridian Dayforce username.", "example": "your_ceridian_dayforce_username" } }, "description": "" } } }, "ceridian_dayforce_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ceridian_dayforce_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "chameleon_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Chameleon API token.", "format": "password", "example": "your_chameleon_api_token" } }, "description": "" } } }, "chameleon_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/chameleon_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "chargebee_product_catalog_1_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Chargebee Product Catalog 1 API key.", "format": "password", "example": "your_chargebee_API_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your Chargebee Product Catalog 1 subdomain.", "example": "http://your.sub.domain/" } }, "description": "" } } }, "chargebee_product_catalog_1_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/chargebee_product_catalog_1_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "chargebee_product_catalog_2_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Chargebee API key.", "format": "password", "example": "your_chargebee_api_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your Chargebee subdomain.", "example": "http://your_chargebee_subdomain/" } }, "description": "" } } }, "chargebee_product_catalog_2_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/chargebee_product_catalog_2_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "chargedesk_config_V1": { "properties": { "config": { "type": "object", "properties": { "token_id": { "title": "", "type": "string", "description": "Your ChargeDesk token ID.", "format": "password", "example": "your_chargedesk_token_id" } }, "description": "" } } }, "chargedesk_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/chargedesk_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "charthop_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your ChartHop app API key.", "format": "password", "example": "your_charthop_app_api_key" } }, "description": "" } } }, "charthop_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/charthop_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "chartmogul_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your ChartMogul API key.", "format": "password", "example": "your_chartmogul_api_key" } }, "description": "" } } }, "chartmogul_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/chartmogul_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "checkout_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_key_id": { "title": "", "type": "string", "description": "Your Checkout.com access key ID.", "example": "your_checkoutcom_access_key_id" }, "access_key_secret": { "title": "", "type": "string", "description": "Your Checkout.com access key secret.", "format": "password", "example": "your_checkoutcom_access_key_secret" }, "entity_id": { "title": "", "type": "string", "description": "Your Checkout.com entity ID.", "example": "your_checkoutcom_entity_id" }, "environment": { "type": "object", "description": "Your Checkout.com environment.", "enum": [ "sandbox.checkout", "checkout" ] } }, "description": "" } } }, "checkout_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/checkout_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "checkr_config_V1": { "properties": { "config": { "type": "object", "properties": { "secret_key": { "title": "", "type": "string", "description": "Your Checkr secret key.", "format": "password", "example": "your_checkr_secret_key" }, "sub_domain": { "type": "object", "description": "Your Checkr subdomain.", "enum": [ "checkr-staging.com", "checkr.com" ] } }, "description": "" } } }, "checkr_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/checkr_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "chorusai_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Chorus API key.", "format": "password", "example": "your_chorus_api_key" } }, "description": "" } } }, "chorusai_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/chorusai_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "churnkey_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Churnkey API Key.", "format": "password", "example": "your_churnkey_api_key" }, "app_id": { "title": "", "type": "string", "description": "Your Churnkey APP ID.", "example": "your_churnkey_app_id" } }, "description": "" } } }, "churnkey_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/churnkey_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "churnzero_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your ChurnZero API key.", "format": "password", "example": "your_churnzero_api_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your ChurnZero subdomain", "example": "your_churnzero_subdomain" }, "username": { "title": "", "type": "string", "description": "Your ChurnZero username.", "example": "your_churnzero_username" } }, "description": "" } } }, "churnzero_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/churnzero_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "cimis_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Cimis API key.", "format": "password", "example": "your_cimis_api_key" } }, "description": "" } } }, "cimis_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/cimis_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "cin7_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your Cin7 API Key.", "format": "password", "example": "your_cin7_api_password" }, "username": { "title": "", "type": "string", "description": "Your Cin7 API Username.", "example": "your_cin7_api_username" } }, "description": "" } } }, "cin7_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/cin7_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "cin7core_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_id": { "title": "", "type": "string", "description": "Your Cin7 Core account ID.", "example": "your_cin7core_account_id" }, "application_key": { "title": "", "type": "string", "description": "Your Cin7 Core application key.", "format": "password", "example": "your_cin7core_application_key" } }, "description": "" } } }, "cin7core_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/cin7core_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "circle_community_platform_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Circle Community Platform API token.", "format": "password", "example": "your_circle_community_platform_api_token" } }, "description": "" } } }, "circle_community_platform_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/circle_community_platform_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "circleci_config_V1": { "properties": { "config": { "type": "object", "properties": { "personal_api_token": { "title": "", "type": "string", "description": "Your CircleCI Personal API token.", "format": "password", "example": "your_circleci_personal_api_token" } }, "description": "" } } }, "circleci_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/circleci_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "cj_commission_detail_config_V1": { "properties": { "config": { "type": "object", "properties": { "company_ids": { "title": "", "type": "string", "description": "Your CJ Commission Detail company IDs.", "example": "your_cj_commission_detail_company_ids" }, "personal_access_token": { "title": "", "type": "string", "description": "Your CJ Commission Detail personal access token.", "format": "password", "example": "your_cj_commission_detail_personal_access_token" } }, "description": "" } } }, "cj_commission_detail_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/cj_commission_detail_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "clari_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Clari API token.", "format": "password", "example": "your_clari_api_token" }, "forecast_id": { "title": "", "type": "string", "description": "Your Clari Forecast id .", "example": "your_clari_forecast_id" } }, "description": "" } } }, "clari_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/clari_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "claude_compliance_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Claude Compliance Access Key.", "format": "password", "example": "your_compliance_access_key" } }, "description": "" } } }, "claude_compliance_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/claude_compliance_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "clazar_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Clazar client ID.", "example": "your_clazar_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Clazar client secret.", "format": "password", "example": "your_clazar_client_secret" } }, "description": "" } } }, "clazar_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/clazar_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "clickup_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your ClickUp API key.", "format": "password", "example": "your_clickup_api_key" } }, "description": "" } } }, "clickup_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/clickup_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "clockify_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Clockify API key.", "format": "password", "example": "your_clockify_api_key" }, "server_region": { "type": "object", "description": "Your Clockify server region.", "enum": [ "euc1", "euw2", "apse2", "api", "use2" ] } }, "description": "" } } }, "clockify_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/clockify_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "clockodo_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Clockodo API key.", "format": "password", "example": "your_clockodo_api_key" }, "company_name": { "title": "", "type": "string", "description": "Your Clockodo company name.", "example": "your_clockodo_company_name" }, "email_address": { "title": "", "type": "string", "description": "Your Clockodo email address.", "example": "your_clockodo_email_address" } }, "description": "" } } }, "clockodo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/clockodo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "close_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Close API key.", "format": "password", "example": "your_close_api_key" } }, "description": "" } } }, "close_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/close_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "cloudbeds_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Cloudbeds client ID.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Your Cloudbeds client secret.", "format": "password", "example": "your_cloudbeds_client_secret" }, "property_id": { "title": "", "type": "string", "description": "Your Cloudbeds property IDs.", "example": "your_cloudbeds_property_id" } }, "description": "" } } }, "cloudbeds_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "cloudbeds_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/cloudbeds_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/cloudbeds_auth_V1" } ] }, "cloudflare_analytics_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Cloudflare Analytics API token.", "format": "password", "example": "your_cloudflare_analytics_api_token" } }, "description": "" } } }, "cloudflare_analytics_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/cloudflare_analytics_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "cloudfront_config_V1": { "properties": { "config": { "type": "object", "properties": { "bucket": { "title": "", "type": "string", "description": "The bucket name for CloudFront.", "example": "bucket_name" }, "prefix": { "title": "", "type": "string", "description": "The name of the CloudFront folder in the bucket.", "example": "cloudfront_folder" }, "role_arn": { "title": "", "type": "string", "description": "The Role ARN required for authentication.", "format": "password", "example": "arn::your_role_arn" } }, "description": "" } } }, "cloudfront_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/cloudfront_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "cloudtalk_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_key_id": { "title": "", "type": "string", "description": "Your CloudTalk Access Key ID.", "format": "password", "example": "your_cloudtalk_access_key_id" }, "access_key_secret": { "title": "", "type": "string", "description": "Your CloudTalk Access Key Secret.", "format": "password", "example": "your_cloudtalk_access_key_secret" } }, "description": "" } } }, "cloudtalk_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/cloudtalk_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "clubspeed_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Clubspeed API key.", "format": "password", "example": "your_clubspeed_api_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your Clubspeed subdomain.", "example": "your_clubspeed_sub_domain" } }, "description": "" } } }, "clubspeed_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/clubspeed_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "coalesce_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Coalesce access token.", "format": "password", "example": "your_coalesce_access_token" }, "base_url": { "type": "object", "description": "Your Coalesce base URL.", "enum": [ "", "app.australia-southeast1.gcp.coalescesoftware.io", "app.us-west-2.aws.coalescesoftware.io", "app.eu.coalescesoftware.io", "app.us-east-1.aws.coalescesoftware.io", "app.us-west-2.aws.privatelink.coalescesoftware.io", "app.coalescesoftware.io", "app.westus2.azure.coalescesoftware.io", "app.us-east-1.aws.privatelink.coalescesoftware.io", "app.northamerica-northeast1.gcp.coalescesoftware.io", "app.eastus2.azure.coalescesoftware.io" ] }, "custom_base_url": { "title": "", "type": "string", "description": "Your Coalesce custom base URL.", "example": "your_coalesce_custom_base_url" } }, "description": "" } } }, "coalesce_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/coalesce_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "coassemble_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Coassemble API key.", "format": "password", "example": "your_coassemble_api_key" }, "host_name": { "title": "", "type": "string", "description": "Your Coassemble Hostname.", "example": "your_coassemble_host_name" }, "user_id": { "title": "", "type": "string", "description": "Your Coassemble user ID.", "example": "your_coassemble_user_id" } }, "description": "" } } }, "coassemble_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/coassemble_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "cockroachdb_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | SshTunnel", "enum": [ "Directly", "SshTunnel" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "string" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "string" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "string" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 0 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "string" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 0 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "string" }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "string" } }, "description": "" } } }, "cockroachdb_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/cockroachdb_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" } ] }, "coda_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Coda API token.", "format": "password", "example": "your_coda_api_token" } }, "description": "" } } }, "coda_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/coda_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "codefresh_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Codefresh API Key.", "format": "password", "example": "your_codefresh_api_key" } }, "description": "" } } }, "codefresh_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/codefresh_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "collibra_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your collibra password.", "format": "password", "example": "your_collibra_password" }, "sub_domain": { "title": "", "type": "string", "description": "Your collibra subdomain.", "example": "your_collibra_subdomain" }, "username": { "title": "", "type": "string", "description": "Your collibra username.", "example": "your_collibra_username" } }, "description": "" } } }, "collibra_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/collibra_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "column_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Column API key.", "format": "password", "example": "your_column_api_key" } }, "description": "" } } }, "column_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/column_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "commercetools_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your commercetools client ID.", "example": "your_commercetools_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your commercetools client secret.", "format": "password", "example": "your_commercetools_client_secret" }, "host": { "title": "", "type": "string", "description": "Your commercetools host.", "example": "your_commercetools_host" }, "project_key": { "title": "", "type": "string", "description": "Your commercetools project key.", "example": "your_commercetools_project_key" } }, "description": "" } } }, "commercetools_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/commercetools_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "compliance_checkpoint_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your Compliance Checkpoint account password.", "format": "password", "example": "string" }, "sub_domain": { "title": "", "type": "string", "description": "Your Compliance Checkpoint subdomain.", "example": "string" }, "username": { "title": "", "type": "string", "description": "Your Compliance Checkpoint account username.", "format": "password", "example": "string" } }, "description": "" } } }, "compliance_checkpoint_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/compliance_checkpoint_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "concord_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Concord API key.", "format": "password", "example": "your_concord_api_key" }, "environment": { "type": "object", "description": "Your Concord environment.", "enum": [ "uat", "api" ] } }, "description": "" } } }, "concord_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/concord_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "concur_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_mode": { "title": "", "type": "object", "description": "The Authentication Mode used by SAP Concur. It can be PasswordGrant or CompanyLevel auth mode", "example": "CompanyLevel | PasswordGrant", "enum": [ "CompanyLevel", "PasswordGrant" ] }, "client_id": { "title": "", "type": "string", "description": "The SAP Concur Client ID.", "example": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx" }, "client_secret": { "title": "", "type": "string", "description": "The SAP Concur Client secret.", "format": "password", "example": "your_application_secret" }, "company_request_token": { "title": "", "type": "string", "description": "The SAP Concur Company Request Token", "format": "password", "example": "your_company_request_token" }, "company_uuid": { "title": "", "type": "string", "description": "The SAP Concur Company UUID", "example": "your_company_uuid" }, "historical_sync_limit": { "title": "", "type": "string", "description": "Historical Sync Limit for the Sync", "example": "1993-01-01" }, "login_password": { "title": "", "type": "string", "description": "The SAP Concur password.", "format": "password", "example": "your_login_password" }, "region": { "title": "", "type": "string", "description": "The region.", "example": "your_region" }, "username": { "title": "", "type": "string", "description": "The SAP Concur username.", "example": "your_sap_concur_username" } }, "description": "" } } }, "concur_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/concur_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "confluence_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "The Confluence API token.", "format": "password", "example": "your_api_token" }, "domain": { "title": "", "type": "string", "description": "Your Confluence domain.", "example": "your_organization_name" }, "username": { "title": "", "type": "string", "description": "Your Confluence username.", "example": "your_confluence_username" } }, "description": "" } } }, "confluence_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/confluence_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "confluent_cloud_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "API Key", "format": "password", "example": "string" }, "api_secret": { "title": "", "type": "string", "description": "API Secret", "format": "password", "example": "string" }, "auth_method": { "title": "", "type": "object", "description": "Authentication method. Use API_KEY for API Key/Secret or OAUTH for OAuth 2.0 client credentials flow.", "example": "API_KEY | OAUTH", "enum": [ "API_KEY", "OAUTH" ] }, "consumer_group": { "title": "", "type": "string", "description": "Confluent Cloud consumer group name.", "example": "consumer_group" }, "message_type": { "title": "", "type": "object", "description": "Confluent Cloud message type.", "example": "Text | Json | Avro | Protobuf", "enum": [ "Text", "Json", "Avro", "Protobuf" ] }, "schema_registry_credentials_source": { "title": "", "type": "string", "description": "Schema Registry Credentials source", "example": "string" }, "schema_registry_key": { "title": "", "type": "string", "description": "Schema Registry Key", "format": "password", "example": "string" }, "schema_registry_secret": { "title": "", "type": "string", "description": "Schema Registry Secret", "format": "password", "example": "string" }, "schema_registry_urls": { "title": "", "type": "array", "description": "Your schema registry URLs", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "security_protocol": { "title": "", "type": "object", "description": "Security protocol for Confluent Cloud interaction.", "example": "SASL | PLAINTEXT", "enum": [ "SASL", "PLAINTEXT" ] }, "servers": { "title": "", "type": "array", "description": "Comma-separated list of Confluent Cloud servers in the format `server:port`.", "example": "serveraddress1:8080, serveraddress2:8080", "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "sync_type": { "title": "", "type": "object", "description": "Kafka sync type. Unpacked messages must be valid JSON.", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] } }, "description": "" } } }, "confluent_cloud_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "identity_pool_id": { "title": "", "type": "string", "description": "Optional Confluent Cloud identity pool ID. When omitted, Confluent auto-maps the token to a matching pool.", "example": "pool-xxxxxx" }, "logical_cluster_id": { "title": "", "type": "string", "description": "Confluent Cloud logical cluster ID. Required for OAuth 2.0 authentication.", "example": "lkc-xxxxxx" }, "oauth_client_id": { "title": "", "type": "string", "description": "OAuth 2.0 client ID issued by the identity provider.", "example": "string" }, "oauth_client_secret": { "title": "", "type": "string", "description": "OAuth 2.0 client secret issued by the identity provider.", "example": "string" }, "oauth_scope": { "title": "", "type": "string", "description": "Optional OAuth 2.0 scope to request with the access token.", "example": "api://your-resource/.default" }, "oauth_token_endpoint_url": { "title": "", "type": "string", "description": "OAuth 2.0 token endpoint URL used to obtain access tokens.", "example": "https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token" } }, "description": "" } } }, "confluent_cloud_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/confluent_cloud_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/confluent_cloud_auth_V1" } ] }, "connector_sdk_config_V1": { "properties": { "config": { "type": "object", "properties": { "package_id": { "title": "", "type": "string", "description": "", "example": "string" }, "python_version": { "title": "", "type": "string", "description": "The Python version to be used at runtime.", "example": "3.12" }, "secrets_list": { "title": "", "type": "array", "description": "The list of secrets that should be passed to the function at runtime.", "items": { "title": "", "type": "object", "properties": { "key": { "title": "", "type": "string", "description": "Key", "example": "string" }, "value": { "title": "", "type": "array", "description": "Value", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "description": "The list of secrets that should be passed to the function at runtime." } } }, "description": "" } } }, "connector_sdk_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/connector_sdk_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "consensus_demo_automation_platform_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Consensus Demo Automation Platform API key.", "format": "password", "example": "your_consensus_demo_automation_platform_api_key" }, "api_secret": { "title": "", "type": "string", "description": "Your Consensus Demo Automation Platform API secret.", "format": "password", "example": "your_consensus_demo_automation_platform_api_secret" }, "email": { "title": "", "type": "string", "description": "The email address of the Consensus Demo Automation Platform account you want Fivetran to use to access your data.", "example": "your_consensus_demo_automation_platform_email_address" }, "source_name": { "title": "", "type": "string", "description": "Your Consensus Demo Automation Platform source name.", "example": "your_consensus_demo_automation_platform_source_name" } }, "description": "" } } }, "consensus_demo_automation_platform_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/consensus_demo_automation_platform_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "constant_contact_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Constant Contact client ID.", "example": "your_constant_contact_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Constant Contact client secret.", "format": "password", "example": "your_constant_contact_client_secret" } }, "description": "" } } }, "constant_contact_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "constant_contact_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/constant_contact_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/constant_contact_auth_V1" } ] }, "contrast_security_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Contrast Security API Key.", "format": "password", "example": "your_contrast_security_api_key" }, "password": { "title": "", "type": "string", "description": "Your Contrast Security API Password.", "format": "password", "example": "your_contrast_security_password" }, "sub_domain": { "title": "", "type": "string", "description": "Your Contrast Security subdomain.", "example": "your contrast_security_subdomain" }, "username": { "title": "", "type": "string", "description": "Your Contrast Security API Username.", "example": "your_contrast_security_username" } }, "description": "" } } }, "contrast_security_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/contrast_security_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "convex_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "convex_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/convex_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "copper_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Copper API key.", "format": "password", "example": "your_copper_api_key" }, "email": { "title": "", "type": "string", "description": "Your Copper email address.", "example": "your_copper_email_address" } }, "description": "" } } }, "copper_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/copper_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "cornerstone_config_V1": { "properties": { "config": { "type": "object", "properties": { "base_url": { "title": "", "type": "string", "description": "Your Cornerstone base URL.", "example": "your_cornerstone_base_url" }, "client_id": { "title": "", "type": "string", "description": "Your Cornerstone client ID.", "example": "your_cornerstone_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Cornerstone client secret.", "format": "password", "example": "your_cornerstone_client_secret" }, "scopes": { "title": "", "type": "string", "description": "Your Cornerstone scopes.", "example": "your_cornerstone_scopes" } }, "description": "" } } }, "cornerstone_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/cornerstone_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "cosmos_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_key": { "title": "", "type": "string", "description": "The read-only primary or secondary account key for the database account. Required for the `ACCOUNT_KEY` data access method.", "format": "password", "example": "account_key" }, "data_access_method": { "title": "", "type": "object", "description": "The source data access method. Supported values:
`ACCOUNT_KEY`- Data access method that uses account keys to authenticate to the source database. It comes in both read-write and read-only variants.
`RESOURCE_TOKEN`- Fine-grained permission model based on native Azure Cosmos DB users and permissions.
Learn more in our [Azure Cosmos DB Data Access Methods documentation](/docs/connectors/databases/cosmos#dataaccessmethods).", "example": "ACCOUNT_KEY | RESOURCE_TOKEN", "enum": [ "ACCOUNT_KEY", "RESOURCE_TOKEN" ] }, "resource_token": { "title": "", "type": "string", "description": "A token that provides access to a specific Azure Cosmos DB resource. Required for the `RESOURCE_TOKEN` data access method.", "format": "password", "example": "resource_token" }, "sync_pack_mode": { "title": "", "type": "object", "description": "The packing mode type. Supported values:
`STANDARD_UNPACKED_MODE`- Unpacks _one_ layer of nested fields and infers types.
`PACKED_MODE`- Delivers packed data as a single destination column value.
Learn more in our [Azure Cosmos DB Sync Pack Mode Options documentation](/docs/connectors/databases/cosmos#packmodeoptions).", "example": "STANDARD_UNPACKED_MODE | PACKED_MODE", "enum": [ "STANDARD_UNPACKED_MODE", "PACKED_MODE" ] }, "token_authenticated_container": { "title": "", "type": "string", "description": "The container name. Required for the `RESOURCE_TOKEN` data access method.", "example": "token_authenticated_container" }, "token_authenticated_database": { "title": "", "type": "string", "description": "The database name. Required for the `RESOURCE_TOKEN` data access method.", "example": "token_authenticated_database" }, "uri": { "title": "", "type": "string", "description": "Cosmos resource instance address.", "example": "cosmos_host_uri" } }, "description": "" } } }, "cosmos_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/cosmos_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" } ] }, "coupa_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Coupa access token fetched using client_id and client_secret", "format": "password", "example": "string" }, "client_id": { "title": "", "type": "string", "description": "Your Coupa client_id", "example": "client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Coupa client_id", "format": "password", "example": "client_secret" }, "instance": { "title": "", "type": "string", "description": "The instance name of your Coupa account in the URL.", "example": "instance" } }, "description": "" } } }, "coupa_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "ESM key for your Coupa client_id", "example": "CLIENT_ID_KEY" }, "client_secret": { "title": "", "type": "string", "description": "ESM key for your Coupa client_id", "example": "CLIENT_SECRET_KEY" } }, "description": "" } } }, "coupa_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/coupa_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/coupa_esm_keys_config_V1" } ] }, "credly_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Credly API token", "format": "password", "example": "your_credly_api_token" } }, "description": "" } } }, "credly_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/credly_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "criteo_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Criteo Client ID.", "example": "xxxxx-xxxxxx-x-xxxx" }, "client_secret": { "title": "", "type": "string", "description": "Your Criteo client secret key.", "format": "password", "example": "your_api_secret" }, "currency": { "title": "", "type": "object", "description": "Currency", "example": "MXN | GTQ | CLP | UGX | HNL | ZAR | TND | BSD | IQD | TWD | RSD | DOP | MYR | XOF | GEL | UYU | MAD | OMR | AZN | SEK | KES | UAH | BTN | MZN | ARS | QAR | CNY | THB | UZS | XPF | BDT | LYD | PHP | KWD | RUB | PYG | ISK | JMD | COP | USD | MKD | DZD | PAB | SGD | ETB | VEF | KGS | LAK | BND | XAF | CHF | HRK | ALL | ZMW | TZS | VND | AUD | ILS | GHS | KHR | BOB | MDL | IDR | AMD | TRY | BWP | LBP | TJS | JOD | HKD | AED | RWF | EUR | DKK | CAD | BGN | MMK | NOK | MUR | GIP | RON | LKR | NGN | CZK | CRC | PKR | HTG | BHD | KZT | SZL | LTL | SAR | TTD | YER | AFN | INR | KRW | NPR | JPY | MNT | PLN | AOA | GBP | HUF | MGA | BAM | EGP | MOP | NAD | NIO | PEN | NZD | BRL", "enum": [ "MXN", "GTQ", "CLP", "UGX", "HNL", "ZAR", "TND", "BSD", "IQD", "TWD", "RSD", "DOP", "MYR", "XOF", "GEL", "UYU", "MAD", "OMR", "AZN", "SEK", "KES", "UAH", "BTN", "MZN", "ARS", "QAR", "CNY", "THB", "UZS", "XPF", "BDT", "LYD", "PHP", "KWD", "RUB", "PYG", "ISK", "JMD", "COP", "USD", "MKD", "DZD", "PAB", "SGD", "ETB", "VEF", "KGS", "LAK", "BND", "XAF", "CHF", "HRK", "ALL", "ZMW", "TZS", "VND", "AUD", "ILS", "GHS", "KHR", "BOB", "MDL", "IDR", "AMD", "TRY", "BWP", "LBP", "TJS", "JOD", "HKD", "AED", "RWF", "EUR", "DKK", "CAD", "BGN", "MMK", "NOK", "MUR", "GIP", "RON", "LKR", "NGN", "CZK", "CRC", "PKR", "HTG", "BHD", "KZT", "SZL", "LTL", "SAR", "TTD", "YER", "AFN", "INR", "KRW", "NPR", "JPY", "MNT", "PLN", "AOA", "GBP", "HUF", "MGA", "BAM", "EGP", "MOP", "NAD", "NIO", "PEN", "NZD", "BRL" ] }, "custom_reports": { "title": "", "type": "array", "description": "Title of Custom Report", "items": { "title": "", "type": "object", "properties": { "dimensions": { "title": "", "type": "array", "description": "Dimensions to be synced", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "metrics": { "title": "", "type": "array", "description": "Metrics to be synced", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_type": { "title": "", "type": "string", "description": "Type of report to be generated", "example": "STATISTICS_REPORT" }, "table_name": { "title": "", "type": "string", "description": "Destination Table name of report", "example": "table_1" }, "time_dimensions": { "title": "", "type": "array", "description": "Time dimensions to be synced", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } } }, "description": "Title of Custom Report" } }, "metrics": { "title": "", "type": "array", "description": "Metrics", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_timezone": { "title": "", "type": "object", "description": "Report Timezone", "example": "string", "enum": [ "Asia/Aden", "America/Cuiaba", "UTC -9", "SCT", "Africa/Nairobi", "UTC -3", "America/Marigot", "UTC -4", "UTC -1", "Asia/Aqtau", "UTC -2", "CHAST", "UTC -7", "UTC -8", "Pacific/Kwajalein", "UTC -5", "America/El_Salvador", "UTC -6", "Asia/Pontianak", "Africa/Cairo", "FJT", "Pacific/Pago_Pago", "CDT", "UTC +13:45", "Africa/Mbabane", "Asia/Kuching", "Pacific/Honolulu", "Pacific/Rarotonga", "AKST", "America/Guatemala", "Australia/Hobart", "Europe/London", "America/Belize", "America/Panama", "NOVT", "TAHT", "UTC +8:30", "GAMT", "LINT", "PONT", "UYST", "TFT", "America/Managua", "America/Indiana/Petersburg", "Asia/Yerevan", "Europe/Brussels", "MYT", "JST", "ACDT", "FKT", "GMT", "Europe/Warsaw", "America/Chicago", "CET", "EASST", "Europe/Jersey", "America/Tegucigalpa", "Europe/Istanbul", "America/Eirunepe", "America/Miquelon", "Europe/Luxembourg", "America/Argentina/Catamarca", "UTC +9", "UTC +7", "UTC +8", "AZST", "Europe/Zaporozhye", "UTC +1", "UTC +2", "UTC +0", "Atlantic/St_Helena", "UTC +5", "UTC +6", "UTC +3", "UTC +4", "Europe/Guernsey", "Z", "America/Grand_Turk", "Asia/Samarkand", "America/Argentina/Cordoba", "YEKST", "Asia/Phnom_Penh", "IST", "Africa/Kigali", "Asia/Almaty", "Asia/Dubai", "Europe/Isle_of_Man", "IRKT", "America/Araguaina", "ACT", "Asia/Novosibirsk", "America/Argentina/Salta", "Africa/Tunis", "Pacific/Fakaofo", "Africa/Tripoli", "Africa/Banjul", "Indian/Comoro", "RET", "Pacific/Port_Moresby", "SGT", "Antarctica/Syowa", "Indian/Reunion", "Pacific/Palau", "Europe/Kaliningrad", "FNT", "America/Montevideo", "Africa/Windhoek", "ADT", "Asia/Karachi", "Africa/Mogadishu", "CLST", "Australia/Perth", "OMST", "Asia/Chita", "Pacific/Easter", "Antarctica/Davis", "TJT", "Antarctica/McMurdo", "America/Manaus", "Africa/Freetown", "Europe/Bucharest", "America/Argentina/Mendoza", "Asia/Macau", "Europe/Malta", "Pacific/Tahiti", "HST", "ANAST", "Europe/Busingen", "America/Argentina/Rio_Gallegos", "UTC+3:30", "Africa/Malabo", "Europe/Skopje", "America/Godthab", "Europe/Sarajevo", "ULAST", "TKT", "UTC -2:30", "Africa/Lagos", "Europe/Rome", "Indian/Mauritius", "America/Regina", "AFT", "America/Dawson_Creek", "Africa/Algiers", "Europe/Mariehamn", "America/St_Thomas", "Europe/Zurich", "America/Anguilla", "Asia/Dili", "America/Denver", "Africa/Bamako", "Europe/Gibraltar", "Africa/Conakry", "UTC +6:30", "Africa/Lubumbashi", "PDT", "America/Havana", "Asia/Choibalsan", "Asia/Omsk", "CKT", "Europe/Vaduz", "Asia/Dhaka", "America/Barbados", "Atlantic/Cape_Verde", "Asia/Yekaterinburg", "TMT", "UTC +12:45", "LHST", "PET", "Europe/Ljubljana", "America/Sao_Paulo", "Asia/Jayapura", "America/Curacao", "AWST", "NZST", "SAST", "Asia/Dushanbe", "CLT", "America/Guyana", "America/Guayaquil", "America/Martinique", "Europe/Berlin", "UTC+4:30", "Europe/Moscow", "Europe/Chisinau", "America/Puerto_Rico", "America/Rankin_Inlet", "WGST", "Europe/Stockholm", "UTC+13:45", "UTC +5:45", "Europe/Budapest", "America/Argentina/Jujuy", "UTC -3:30", "Asia/Shanghai", "Europe/Zagreb", "UTC+7", "America/Port_of_Spain", "UTC+8", "UTC+9", "Europe/Helsinki", "Asia/Beirut", "Pacific/Bougainville", "ULAT", "Africa/Sao_Tome", "Indian/Chagos", "America/Cayenne", "Asia/Yakutsk", "Pacific/Galapagos", "Europe/Paris", "Africa/Ndjamena", "TOT", "UTC+3", "Pacific/Fiji", "UTC+4", "America/Rainy_River", "Indian/Maldives", "UTC+5", "PMST", "UTC+6", "PGT", "UTC+0", "ANAT", "UTC+1", "UTC +5:30", "UTC+2", "VLAT", "Asia/Oral", "America/Yellowknife", "Pacific/Enderbury", "America/Juneau", "America/Indiana/Vevay", "Asia/Tashkent", "Asia/Jakarta", "Africa/Ceuta", "America/Recife", "YEKT", "America/Noronha", "PHT", "America/Swift_Current", "NDT", "America/Metlakatla", "Africa/Djibouti", "America/Paramaribo", "UTC +10", "EST", "UTC +11", "COT", "Europe/Simferopol", "Europe/Sofia", "Africa/Nouakchott", "Europe/Prague", "America/Indiana/Vincennes", "Antarctica/Mawson", "UTC+5:30", "America/Kralendijk", "VUT", "Antarctica/Troll", "Europe/Samara", "Indian/Christmas", "UTC +12", "America/Antigua", "UTC +13", "UTC +14", "Pacific/Gambier", "America/Inuvik", "America/Iqaluit", "Pacific/Funafuti", "UTC", "Antarctica/Macquarie", "BNT", "America/Moncton", "Africa/Gaborone", "Pacific/Chuuk", "Asia/Pyongyang", "America/St_Vincent", "Asia/Gaza", "UTC+5:45", "Asia/Qyzylorda", "AEST", "WAKT", "MDT", "UTC +4:30", "NFT", "America/Kentucky/Louisville", "America/Yakutat", "MAGT", "Asia/Ho_Chi_Minh", "GYT", "Antarctica/Casey", "Europe/Copenhagen", "BOT", "AMT", "Africa/Asmara", "Atlantic/Azores", "Europe/Vienna", "Pacific/Pitcairn", "America/Mazatlan", "Pacific/Nauru", "PKT", "Europe/Tirane", "Europe/Riga", "America/Dominica", "Africa/Abidjan", "FKST", "America/Santarem", "GILT", "America/Asuncion", "America/Boise", "Australia/Currie", "Pacific/Guam", "Pacific/Wake", "Atlantic/Bermuda", "UTC+6:30", "America/Costa_Rica", "America/Dawson", "Europe/Amsterdam", "America/Indiana/Knox", "America/North_Dakota/Beulah", "CHUT", "Africa/Accra", "CHADT", "Atlantic/Faroe", "UTC-9:30", "UTC +10:30", "America/Maceio", "Pacific/Apia", "Pacific/Niue", "CST", "Europe/Dublin", "America/Monterrey", "America/Nassau", "America/Jamaica", "PHOT", "UTC -10", "Asia/Bishkek", "UTC -11", "America/Atikokan", "Atlantic/Stanley", "UTC -12", "UTC +3:30", "Indian/Mahe", "Asia/Aqtobe", "America/Sitka", "Asia/Vladivostok", "BRT", "FJST", "Africa/Libreville", "IRKST", "Africa/Maputo", "America/Kentucky/Monticello", "PYST", "Africa/El_Aaiun", "Africa/Ouagadougou", "TVT", "America/Aruba", "America/North_Dakota/Center", "MHT", "America/Cayman", "Asia/Ulaanbaatar", "Asia/Baghdad", "ACST", "Europe/San_Marino", "America/Indiana/Tell_City", "BST", "America/Tijuana", "AKDT", "Pacific/Saipan", "ACWST", "Africa/Douala", "America/Chihuahua", "America/Ojinaga", "Asia/Hovd", "America/Anchorage", "UYT", "America/Halifax", "Antarctica/Rothera", "America/Indiana/Indianapolis", "Asia/Damascus", "America/Argentina/San_Luis", "America/Santiago", "Asia/Baku", "UTC+14", "UTC+12", "ART", "BTT", "UTC+13", "America/Argentina/Ushuaia", "Atlantic/Reykjavik", "Africa/Brazzaville", "Africa/Porto-Novo", "America/La_Paz", "Antarctica/DumontDUrville", "Asia/Taipei", "UTC+10", "UTC+11", "Asia/Manila", "UZT", "Asia/Bangkok", "Africa/Dar_es_Salaam", "YAKT", "Atlantic/Madeira", "Antarctica/Palmer", "CEST", "America/Thunder_Bay", "Africa/Addis_Ababa", "AST", "Europe/Uzhgorod", "America/Indiana/Marengo", "America/Creston", "America/Mexico_City", "Antarctica/Vostok", "Asia/Jerusalem", "KGT", "Europe/Andorra", "ICT", "CXT", "Asia/Vientiane", "WAST", "Pacific/Kiritimati", "America/Matamoros", "America/Blanc-Sablon", "Asia/Riyadh", "MAGST", "Pacific/Pohnpei", "Atlantic/South_Georgia", "Europe/Lisbon", "Europe/Oslo", "Asia/Novokuznetsk", "IDT", "UTC+8:30", "Atlantic/Canary", "Asia/Kuwait", "Pacific/Efate", "Africa/Lome", "America/Bogota", "America/Menominee", "America/Adak", "EGST", "Pacific/Norfolk", "America/Resolute", "Pacific/Tarawa", "BRST", "Africa/Kampala", "Asia/Krasnoyarsk", "PST", "UTC+12:45", "MMT", "America/Edmonton", "Europe/Podgorica", "UTC+8:45", "Africa/Bujumbura", "America/Santo_Domingo", "Europe/Minsk", "Pacific/Auckland", "Africa/Casablanca", "America/Glace_Bay", "UTC-12", "Asia/Qatar", "Europe/Kiev", "UTC-10", "UTC-11", "Asia/Magadan", "America/Port-au-Prince", "America/St_Barthelemy", "Asia/Ashgabat", "Africa/Luanda", "America/Nipigon", "WAT", "Asia/Muscat", "NPT", "Asia/Bahrain", "Europe/Vilnius", "America/Fortaleza", "America/Hermosillo", "America/Cancun", "Africa/Maseru", "Pacific/Kosrae", "Africa/Kinshasa", "Asia/Seoul", "Australia/Sydney", "YAKST", "America/Lima", "America/St_Lucia", "Europe/Madrid", "America/Bahia_Banderas", "UTC-9", "America/Montserrat", "Asia/Brunei", "KOST", "America/Cambridge_Bay", "Indian/Antananarivo", "Australia/Brisbane", "Indian/Mayotte", "Asia/Urumqi", "MART", "Europe/Volgograd", "UTC-5", "America/Lower_Princes", "America/Vancouver", "UTC-6", "UTC+9:30", "UTC-7", "UTC-8", "Africa/Blantyre", "America/Rio_Branco", "UTC-1", "UTC-2", "America/Danmarkshavn", "America/Detroit", "UTC-3", "UTC-4", "DDUT", "America/Thule", "Africa/Lusaka", "Asia/Hong_Kong", "ALMT", "PETT", "America/Argentina/La_Rioja", "Africa/Dakar", "America/Tortola", "America/Porto_Velho", "Asia/Sakhalin", "CAST", "EEST", "America/Scoresbysund", "YAPT", "PETST", "Asia/Kamchatka", "Africa/Harare", "OMSST", "PWT", "America/Nome", "NST", "LHDT", "Europe/Tallinn", "VLAST", "Africa/Khartoum", "Africa/Johannesburg", "GET", "EAT", "Africa/Bangui", "AZT", "Europe/Belgrade", "Africa/Bissau", "UTC -9:30", "WET", "Africa/Juba", "America/Campo_Grande", "America/Belem", "MAWT", "Pacific/Midway", "GFT", "America/Bahia", "America/Goose_Bay", "MSD", "MSK", "WFT", "America/Pangnirtung", "PMDT", "PYT", "NUT", "America/Phoenix", "MST", "Africa/Niamey", "America/Whitehorse", "Pacific/Noumea", "FET", "Asia/Tbilisi", "NZDT", "UTC-2:30", "Asia/Makassar", "America/Argentina/San_Juan", "VET", "WGT", "Asia/Nicosia", "America/Indiana/Winamac", "America/Boa_Vista", "AMST", "EDT", "America/Grenada", "Asia/Khandyga", "Asia/Kuala_Lumpur", "Asia/Thimphu", "UTC-3:30", "Europe/Bratislava", "America/Argentina/Tucuman", "Pacific/Tongatapu", "NOVST", "America/New_York", "AZOST", "AEDT", "MUT", "HKT", "America/Merida", "EET", "America/St_Kitts", "Arctic/Longyearbyen", "UTC +9:30", "America/Caracas", "AZOT", "America/Guadeloupe", "Asia/Hebron", "Indian/Kerguelen", "GALT", "Africa/Monrovia", "Asia/Ust-Nera", "MVT", "Asia/Srednekolymsk", "America/North_Dakota/New_Salem", "Asia/Anadyr", "Australia/Melbourne", "Asia/Irkutsk", "America/Winnipeg", "UTC+10:30", "Europe/Vatican", "KRAST", "EAST", "Asia/Amman", "Asia/Tokyo", "UTC +8:45", "DAVT", "America/Toronto", "Asia/Singapore", "KST", "Australia/Lindeman", "IOT", "America/Los_Angeles", "Pacific/Majuro", "EGT", "America/Argentina/Buenos_Aires", "CCT", "Pacific/Guadalcanal", "Europe/Athens", "KRAT", "Europe/Monaco" ] }, "timeframe_months": { "title": "", "type": "object", "description": "The number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created.
NOTE: The greater number of months means the initial sync will take more time.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "criteo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/criteo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "criteo_retail_media_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Criteo Retail Media client ID.", "example": "your_criteo_retail_media_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Criteo Retail Media client secret.", "format": "password", "example": "your_criteo_retail_media_client_secret" }, "dimensions": { "type": "array", "description": "Your Criteo Retail Media report revenue dimensions.", "items": { "type": "object", "description": "Your Criteo Retail Media report revenue dimensions.", "enum": [ "date", "taxonomy1Id", "attributionSettings", "taxonomy5Id", "lineItemName", "taxonomy3Id", "taxonomy2Name", "retailerCategoryName", "accountTypeName", "salesChannel", "advProductMpn", "taxonomy3Name", "lineItemStatus", "keyword", "advertiserType", "campaignEndDate", "brandName", "campaignId", "taxonomyBreadcrumb", "lineItemEndDate", "accountId", "retailerCategoryId", "taxonomy1Name", "brandId", "advProductId", "skuRelation", "taxonomy6Id", "advProductGtin", "taxonomy7Name", "placementId", "taxonomy4Id", "accountName", "taxonomy2Id", "soldBy", "targetedKeywordType", "parentAccount", "hour", "taxonomy6Name", "placementName", "retailerName", "pageTypeName", "pageCategory", "lineItemId", "lineItemStartDate", "taxonomy4Name", "retailerId", "environment", "campaignTypeName", "taxonomy5Name", "buyType", "taxonomy7Id", "activityType", "campaignName", "campaignStartDate", "advProductName" ] } }, "version": { "title": "", "type": "string", "description": "Your Criteo Retail Media version.", "example": "your_criteo_retail_media_version" } }, "description": "" } } }, "criteo_retail_media_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/criteo_retail_media_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "crossbeam_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "crossbeam_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "crossbeam_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/crossbeam_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/crossbeam_auth_V1" } ] }, "crowddev_config_V1": { "properties": { "config": { "type": "object", "properties": { "bearer_token": { "title": "", "type": "string", "description": "Your crowd.dev Auth Token.", "format": "password", "example": "your_crowddev_auth_token" }, "tenant_id": { "title": "", "type": "string", "description": "Your crowd.dev Tenant ID.", "format": "password", "example": "your_crowddev_tenant_id" } }, "description": "" } } }, "crowddev_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/crowddev_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "crunchbase_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Crunchbase API key.", "format": "password", "example": "your_crunchbase_api_key" } }, "description": "" } } }, "crunchbase_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/crunchbase_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "cube_software_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Cube client ID.", "example": "your_cube_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Cube client secret.", "format": "password", "example": "your_cube_client_secret" }, "company_id": { "title": "", "type": "string", "description": "Your Cube company ID.", "example": "your_cube_company_id" } }, "description": "" } } }, "cube_software_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "cube_software_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/cube_software_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/cube_software_auth_V1" } ] }, "culture_amp_config_V1": { "properties": { "config": { "type": "object", "properties": { "base_url": { "type": "object", "description": "Your Culture Amp base URL.", "enum": [ "sandbox.public-api.development.cultureamp.net", "api.cultureamp.com" ] }, "client_id": { "title": "", "type": "string", "description": "Your Culture Amp client ID.", "example": "your_culture_amp_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Culture Amp client secret.", "format": "password", "example": "your_culture_amp_client_secret" }, "target_entity_id": { "type": "object", "description": "Your Culture Amp Target entity ID.", "enum": [ "79040b4d-3e2b-4480-a061-2e230eeb83b2", "8ed17dce-9eca-4383-a9e1-54f82c362b6d" ] } }, "description": "" } } }, "culture_amp_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/culture_amp_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "cursor_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Cursor API key.", "format": "password", "example": "your_cursor_api_key" } }, "description": "" } } }, "cursor_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/cursor_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "customerio_config_V1": { "properties": { "config": { "type": "object", "properties": { "bearer_token": { "title": "", "type": "string", "description": "Your Customer.io App API Key.", "format": "password", "example": "your_customerio_app_api_key" }, "sub_domain": { "type": "object", "description": "Your Customer.io region-specific Subdomain.", "enum": [ "api-eu", "api" ] } }, "description": "" } } }, "customerio_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/customerio_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "cvent_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Cvent client ID.", "example": "your_cvent_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Cvent client secret.", "format": "password", "example": "your_cvent_client_secret" }, "region": { "type": "object", "description": "Your Cvent region.", "enum": [ "https://api-platform-eur.cvent.com", "https://api-platform-sandbox.cvent.com", "https://api-platform.cvent.com" ] } }, "description": "" } } }, "cvent_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/cvent_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "d2l_brightspace_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your D2L Brightspace client ID.", "example": "your_d2l_brightspace_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your D2L Brightspace client secret.", "format": "password", "example": "your_d2l_brightspace_client_secret" }, "target_host": { "title": "", "type": "string", "description": "Your D2L Brightspace target host.", "example": "your_d2l_brightspace_target_host" } }, "description": "" } } }, "d2l_brightspace_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "d2l_brightspace_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/d2l_brightspace_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/d2l_brightspace_auth_V1" } ] }, "databricks_db_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth": { "title": "", "type": "object", "description": "Authentication type (TOKEN or OAUTH2)", "example": "TOKEN", "enum": [ "OAUTH2", "TOKEN" ] }, "catalog": { "title": "catalog", "type": "string", "description": "catalog to sync", "example": "catalog_name" }, "host": { "title": "", "type": "string", "description": "The host URL for your Databricks account.", "example": "dbc12345.cloud.databricks.com" }, "http_path": { "title": "http path", "type": "string", "description": "http path", "example": "/sql/1.0/warehouses/pathofsqlwarehouse" }, "personal_access_token": { "title": "personalAccessToken", "type": "string", "description": "Access Token", "format": "password", "example": "personalaccesstoken" }, "port": { "title": "", "type": "integer", "description": "The port of your SQL warehouse.", "format": "int32", "example": 443 } }, "description": "" } } }, "databricks_db_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/databricks_db_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" } ] }, "datadog_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Datadog API key.", "format": "password", "example": "your_datadog_api_key" }, "application_key": { "title": "", "type": "string", "description": "Your Datadog application key.", "example": "your_datadog_application_key" }, "base_url": { "type": "object", "description": "Your Datadog base url.", "enum": [ "", "ap1.datadoghq.com", "api.datadoghq.eu", "us3.datadoghq.com", "api.ddog-gov.com", "api.datadoghq.com", "us5.datadoghq.com" ] }, "custom_base_url": { "title": "", "type": "string", "description": "Your Datadog custom base url.", "example": "your_datadog_custom_base_url" } }, "description": "" } } }, "datadog_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/datadog_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "datastreamer_source_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "datastreamer_source_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/datastreamer_source_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "db2i_hva_config_V1": { "properties": { "config": { "type": "object", "properties": { "agent_host": { "title": "", "type": "string", "description": "The agent host.", "example": "host.com" }, "agent_password": { "title": "", "type": "string", "description": "The agent password.", "format": "password", "example": "agent_password" }, "agent_port": { "title": "", "type": "integer", "description": "The agent port.", "format": "int32", "example": 4343 }, "agent_public_cert": { "title": "", "type": "string", "description": "The public certificate for the agent.", "example": "CERTIFICATE" }, "agent_user": { "title": "", "type": "string", "description": "The agent user name.", "example": "hvr" }, "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and the following parameter's values are specified: `tunnel_host`, `tunnel_port`, `tunnel_user`.", "example": "Directly | SshTunnel | ProxyAgent", "enum": [ "Directly", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "db2i" }, "host": { "title": "", "type": "string", "description": "A host address of the primary node. It should be a DB instance host/IP address with a port number.", "example": "host.com" }, "log_journal": { "title": "", "type": "string", "description": "The log journal name.", "example": "test_log_journal" }, "log_journal_schema": { "title": "", "type": "string", "description": "The log journal schema.", "example": "test_log_journal_schema" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 8471 }, "sap_schema": { "title": "", "type": "string", "description": "The SAP schema.", "example": "string" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation.", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, only specify when connecting via an SSH tunnel. Required for connector creation.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel. Required for connector creation.", "example": "fivetran" }, "use_database_name_for_table_filtering": { "title": "", "type": "boolean", "description": "Restricts schema discovery to libraries (schemas) within the configured database. When enabled, the database parameter must also be specified.", "example": true }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "db2i_hva_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "db2i_hva_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/db2i_hva_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/db2i_hva_esm_keys_config_V1" } ] }, "db2i_sap_hva_config_V1": { "properties": { "config": { "type": "object", "properties": { "agent_host": { "title": "", "type": "string", "description": "The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.", "example": "host.com" }, "agent_password": { "title": "", "type": "string", "description": "The agent user's password. It must have a minimum length of 10 characters.", "format": "password", "example": "agent_password" }, "agent_port": { "title": "", "type": "integer", "description": "The port number of the agent.", "format": "int32", "example": 4343 }, "agent_public_cert": { "title": "", "type": "string", "description": "The agent public certificate.", "example": "CERTIFICATE" }, "agent_user": { "title": "", "type": "string", "description": "The agent's user.", "example": "hvr" }, "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`.", "example": "Directly | SshTunnel | ProxyAgent", "enum": [ "Directly", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "db2i" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "host.com" }, "log_journal": { "title": "", "type": "string", "description": "The log journal name.", "example": "test_log_journal" }, "log_journal_schema": { "title": "", "type": "string", "description": "The log journal schema.", "example": "test_log_journal_schema" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 8471 }, "sap_schema": { "title": "", "type": "string", "description": "SAP schema name.", "example": "test_sap_schema" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "use_database_name_for_table_filtering": { "title": "", "type": "boolean", "description": "Restricts schema discovery to libraries (schemas) within the configured database. When enabled, the database parameter must also be specified. Has no effect on SAP ECC on Db2 for i connectors.", "example": true }, "user": { "title": "", "type": "string", "description": "The username.", "example": "test_user" } }, "description": "" } } }, "db2i_sap_hva_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the username.", "example": "USER_KEY" } }, "description": "" } } }, "db2i_sap_hva_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/db2i_sap_hva_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/db2i_sap_hva_esm_keys_config_V1" } ] }, "db2luw_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and the following parameter's values are specified: `tunnel_host`, `tunnel_port`, `tunnel_user`.", "example": "Directly | PrivateLink | SshTunnel", "enum": [ "Directly", "PrivateLink", "SshTunnel" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "string" }, "host": { "title": "", "type": "string", "description": "A host address of the primary node. It should be a DB instance host/IP address with a port number.", "example": "string" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "string" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 0 }, "schema": { "title": "", "type": "string", "description": "The schema name.", "example": "string" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation.", "example": "string" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, only specify when connecting via an SSH tunnel. Required for connector creation.", "format": "int32", "example": 0 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel. Required for connector creation.", "example": "string" }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "string" } }, "description": "" } } }, "db2luw_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/db2luw_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" } ] }, "db2z_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS", "example": true }, "application_name": { "title": "", "type": "string", "description": "The application name used to generate an RACF PassTicket for user authentication. Specify only when `authentication_method` is `LEGACY_PASS_TICKET` or `ENHANCED_PASS_TICKET`.", "example": "string" }, "authentication_method": { "title": "", "type": "object", "description": "User authentication method. Supported values:
`PASSWORD`- Authenticate with the database server using an RACF user ID and password. If the parameter is omitted, `PASSWORD` is used by default.
`LEGACY_PASS_TICKET`- Authenticate with the database server using an RACF user ID and legacy PassTicket.
`ENHANCED_PASS_TICKET`- Authenticate with the database server using an RACF user ID and an enhanced PassTicket. Enhanced PassTickets are more secure than legacy PassTickets.", "example": "PASSWORD | LEGACY_PASS_TICKET | ENHANCED_PASS_TICKET", "enum": [ "PASSWORD", "LEGACY_PASS_TICKET", "ENHANCED_PASS_TICKET" ] }, "certificate": { "title": "", "type": "string", "description": "Db2 for z/OS host certificate", "format": "password", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values: `Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | SshTunnel | ProxyAgent", "enum": [ "Directly", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "string" }, "enhanced_pass_ticket_type": { "title": "", "type": "object", "description": "Determines whether the Enhanced PassTicket is sent in mixed case or uppercase before authentication. Specify only when `authentication_method` is `ENHANCED_PASS_TICKET`. Supported values:
`UPPER`- The generated PassTicket consist of uppercase alphanumeric characters.
`MIXED`- The generated PassTicket consists of mixed-case alphanumeric characters and may include '-' and '_'.", "example": "UPPER | MIXED", "enum": [ "UPPER", "MIXED" ] }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "string" }, "password": { "title": "", "type": "string", "description": "The user's password. Specify only when `authentication_method` is `PASSWORD`.", "format": "password", "example": "string" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 0 }, "secured_signon_key": { "title": "", "type": "string", "description": "Application secret key registered in RACF for the application. Used to generate a PassTicket when `authentication_method` is `LEGACY_PASS_TICKET` or `ENHANCED_PASS_TICKET`.", "format": "password", "example": "string" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "string" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 0 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "string" }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "string" } }, "description": "" } } }, "db2z_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/db2z_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" } ] }, "dbt_cloud_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your dbt Cloud service token.", "format": "password", "example": "your_dbt_cloud_service_token" }, "custom_url": { "title": "", "type": "string", "description": "Your dbt Cloud access url.", "example": "your_dbt_cloud_custom_api_base_url" }, "sub_domain": { "type": "object", "description": "Your dbt Cloud API server region.", "enum": [ "", "cloud.getdbt.com", "emea.dbt.com", "au.dbt.com" ] } }, "description": "" } } }, "dbt_cloud_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/dbt_cloud_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "dcl_logistics_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your DCL Logistics API key.", "format": "password", "example": "your_dcl_logistics_api_key" }, "username": { "title": "", "type": "string", "description": "Your DCL Logistics username.", "example": "your_dcl_logistics_username" } }, "description": "" } } }, "dcl_logistics_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/dcl_logistics_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "deel_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Deel access token.", "format": "password", "example": "your_deel_access_token" } }, "description": "" } } }, "deel_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/deel_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "deposco_config_V1": { "properties": { "config": { "type": "object", "properties": { "business_unit": { "title": "", "type": "string", "description": "Your Deposco business unit.", "example": "your_deposco_business_unit" }, "custom_base_url": { "title": "", "type": "string", "description": "Your Deposco custom base URL.", "example": "your_deposco_custom_base_url" }, "environment": { "type": "object", "description": "Your Deposco environment.", "enum": [ "", "sandboxapi.deposco.com/config", "sandboxapi.deposco.com/ua", "api.deposco.com" ] }, "password": { "title": "", "type": "string", "description": "Your Deposco password.", "format": "password", "example": "your_deposco_password" }, "tenant_code": { "title": "", "type": "string", "description": "Your Deposco tenant code.", "example": "your_deposco_tenant_code" }, "username": { "title": "", "type": "string", "description": "Your Deposco username.", "example": "your_deposco_username" } }, "description": "" } } }, "deposco_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/deposco_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "deputy_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Deputy API access token.", "format": "password", "example": "your_deputy_access_token" }, "sub_domain": { "title": "", "type": "string", "description": "Your Deputy subdomain.", "example": "your_deputy_subdomain" } }, "description": "" } } }, "deputy_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/deputy_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "destini_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Destini API Key.", "format": "password", "example": "your_destini_api_key" }, "client_name": { "title": "", "type": "string", "description": "Your Destini Client Name.", "example": "your_destini_client_name" } }, "description": "" } } }, "destini_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/destini_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "device_magic_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_access_token": { "title": "", "type": "string", "description": "Your Device Magic API access token.", "format": "password", "example": "string" }, "organization_id": { "title": "", "type": "string", "description": "Your Device Magic organization ID.", "example": "string" } }, "description": "" } } }, "device_magic_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/device_magic_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "dialpad_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Dialpad client ID.", "example": "your_dialpad_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Dialpad client secret.", "format": "password", "example": "your_dialpad_client_secret" }, "environment": { "type": "object", "description": "Your Dialpad environment.", "enum": [ "sandbox.dialpad", "dialpad" ] } }, "description": "" } } }, "dialpad_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "dialpad_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/dialpad_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/dialpad_auth_V1" } ] }, "discourse_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Discourse API key.", "format": "password", "example": "your_discourse_api_key" }, "api_username": { "title": "", "type": "string", "description": "Your Discourse API username.", "format": "password", "example": "your_discourse_api_username" }, "hostname": { "title": "", "type": "string", "description": "Your Discourse hostname.", "format": "password", "example": "your_discourse_hostname" } }, "description": "" } } }, "discourse_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/discourse_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "dixa_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Dixa API token.", "format": "password", "example": "your_dixa_api_token" } }, "description": "" } } }, "dixa_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/dixa_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "docebo_config_V1": { "properties": { "config": { "type": "object", "properties": { "sub_domain": { "title": "", "type": "string", "description": "Your Docebo subdomain.", "example": "your_docebo_domain_name" } }, "description": "" } } }, "docebo_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Docebo Access Token.", "format": "password", "example": "my_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "Your Docebo Refresh Token.", "format": "password", "example": "my_refresh_token" } }, "description": "" } } }, "docebo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/docebo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/docebo_auth_V1" } ] }, "documentdb_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS encryption.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`SshTunnel`, `PrivateLink` . `SshTunnel` is used as a value if this parameter is omitted in the request and the following parameter's values are specified: `tunnel_host`, `tunnel_port`, `tunnel_user`.", "example": "PrivateLink | SshTunnel", "enum": [ "PrivateLink", "SshTunnel" ] }, "host": { "title": "", "type": "string", "description": "Host IP address. Ignored if `hosts` value is provided.", "example": "documentdbinstance.mycompany.com" }, "packing_mode": { "title": "", "type": "object", "description": "Whether to sync all tables in unpacked mode only or all tables in packed mode only. Default value: `UseUnpackedModeOnly`.", "example": "UsePackedModeOnly | UseUnpackedModeOnly", "enum": [ "UsePackedModeOnly", "UseUnpackedModeOnly" ] }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "Port number. Ignored if `hosts` value is provided.", "format": "int32", "example": 27017 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "sync_pack_mode": { "title": "", "type": "object", "description": "Legacy alias for `packing_mode`. Indicates whether synced data will be packed into a single entry(column), or unpacked with one layer of nested fields.", "example": "UNPACKED_MODE", "enum": [ "UNPACKED_MODE", "PACKED_MODE" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation.", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, only specify when connecting via an SSH tunnel. Required for connector creation.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel. Required for connector creation.", "example": "fivetran" }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "documentdb_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/documentdb_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" } ] }, "donus_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Donus API key.", "format": "password", "example": "your_donus_api_key" } }, "description": "" } } }, "donus_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/donus_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "doorloop_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your DoorLoop API key.", "format": "password", "example": "your_doorloop_api_key" } }, "description": "" } } }, "doorloop_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/doorloop_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "double_click_campaign_manager_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_type": { "title": "", "type": "object", "description": "Authentication used by client to authenticate with google", "example": "OAUTH2 | FIVETRAN_SERVICE_ACCOUNT", "enum": [ "OAUTH2", "FIVETRAN_SERVICE_ACCOUNT" ] }, "conversion_dimensions": { "title": "", "type": "array", "description": "Conversion Dimensions.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "custom_floodlight_variables": { "title": "", "type": "array", "description": "Custom Floodlight variables enable you to capture information beyond the basics (visits and revenue) that you can collect with standard parameters in your tags.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "dimensions": { "title": "", "type": "array", "description": "Report dimensions to include into a sync. The `date` dimension is mandatory for all the report types. The `advertiser` dimension is mandatory for `REACH` report type", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "enable_all_dimension_combinations": { "title": "", "type": "boolean", "description": "Whether to enable all reach dimension combinations in the report. Default value: `false`", "example": true }, "metrics": { "title": "", "type": "array", "description": "Report metrics to include into a sync.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "per_interaction_dimensions": { "title": "", "type": "array", "description": "Per Interaction Dimensions.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_configuration_ids": { "title": "", "type": "array", "description": "You can select only one Floodlight Configuration ID per account.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_type": { "title": "", "type": "object", "description": "Type of reporting data to sync. Default value: `STANDARD`.", "example": "REACH | FLOODLIGHT | PATH_TO_CONVERSION | STANDARD", "enum": [ "REACH", "FLOODLIGHT", "PATH_TO_CONVERSION", "STANDARD" ] }, "reports": { "title": "", "type": "array", "description": "List of reports", "items": { "title": "", "type": "object", "properties": { "conversion_dimensions": { "title": "", "type": "array", "description": "Conversion Dimensions.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "custom_floodlight_variables": { "title": "", "type": "array", "description": "Custom Floodlight variables enable you to capture information beyond the basics (visits and revenue) that you can collect with standard parameters in your tags.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "dimensions": { "title": "", "type": "array", "description": "Report dimensions to include in a sync. The `date` dimension is mandatory for all report types. The `advertiser` dimension is mandatory for the `REACH` report type", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "enable_all_dimension_combinations": { "title": "", "type": "boolean", "description": "Specifies whether to enable all reach dimension combinations in the report. Default value: `false`", "example": true }, "metrics": { "title": "", "type": "array", "description": "Report metrics to include into a sync.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "per_interaction_dimensions": { "title": "", "type": "array", "description": "Per Interaction Dimensions.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_configuration_ids": { "title": "", "type": "array", "description": "You can select only one Floodlight Configuration ID per account.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_type": { "title": "", "type": "object", "description": "Type of reporting data to sync. Default value: `STANDARD`.", "example": "REACH | FLOODLIGHT | PATH_TO_CONVERSION | STANDARD", "enum": [ "REACH", "FLOODLIGHT", "PATH_TO_CONVERSION", "STANDARD" ] }, "rollback_window": { "title": "", "type": "integer", "description": "The custom window size for rollback syncs (between 1 and 90).", "format": "int32", "example": 30 }, "table": { "title": "", "type": "string", "description": "Destination table name. It must be unique within this connection and must comply with Fivetran's naming conventions.", "example": "string" } }, "description": "List of reports" } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all user profiles or specific ones. Default value: `AllAccounts`.", "example": "SPECIFIC_PROFILES | ALL_PROFILES", "enum": [ "SPECIFIC_PROFILES", "ALL_PROFILES" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. Default value: `TWELVE`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] }, "user_profiles": { "title": "", "type": "array", "description": "IDs of specific User Profiles to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } } }, "description": "" } } }, "double_click_campaign_manager_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Google Campaign Manager 360 client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Google Campaign Manager 360 client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "double_click_campaign_manager_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/double_click_campaign_manager_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" }, { "$ref": "#/components/schemas/double_click_campaign_manager_auth_V1" } ] }, "double_click_publishers_config_V1": { "properties": { "config": { "type": "object", "properties": { "ad_unit_view": { "title": "", "type": "object", "description": "Ad unit view for the report.", "example": "HIERARCHICAL | TOP_LEVEL | FLAT", "enum": [ "HIERARCHICAL", "TOP_LEVEL", "FLAT" ] }, "auth_type": { "title": "", "type": "object", "description": "Authentication used by client to authenticate with google", "example": "OAUTH2 | FIVETRAN_SERVICE_ACCOUNT", "enum": [ "OAUTH2", "FIVETRAN_SERVICE_ACCOUNT" ] }, "columns": { "title": "", "type": "array", "description": "Columns provide all trafficking statistics and revenue information available for the chosen Dimensions.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "custom_dimension_key_ids": { "title": "", "type": "array", "description": "The list of custom dimension key IDs included in the report. Custom dimension keys can only be selected with the CUSTOM_DIMENSION dimension.", "example": [ 0 ], "items": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 } }, "custom_field_ids": { "title": "", "type": "array", "description": "The list of custom field IDs included in the report. Custom fields can only be selected with their corresponding dimensions.", "example": [ 0 ], "items": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 } }, "dimension_attributes": { "title": "", "type": "array", "description": "Dimension attributes provide additional fields associated with a Dimension. Dimension attributes can only be selected with their corresponding Dimensions.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "dimensions": { "title": "", "type": "array", "description": "Report dimensions to include in the sync. The `date` dimension is mandatory for all the report types.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "network_code": { "title": "", "type": "integer", "description": "Network code is a unique, numeric identifier for your Ad Manager network.", "format": "int32", "example": 1234567 }, "reports": { "title": "", "type": "array", "description": "The list of reports. We create a table within the schema for each report.", "items": { "title": "", "type": "object", "properties": { "ad_unit_view": { "title": "", "type": "object", "description": "Ad unit view for the report.", "example": "HIERARCHICAL | TOP_LEVEL | FLAT", "enum": [ "HIERARCHICAL", "TOP_LEVEL", "FLAT" ] }, "columns": { "title": "", "type": "array", "description": "Columns provide all trafficking statistics and revenue information available for the chosen dimensions.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "custom_dimension_key_ids": { "title": "", "type": "array", "description": "The list of custom dimension key IDs included in the report. Custom dimension keys can only be selected with the CUSTOM_DIMENSION dimension.", "example": [ 0 ], "items": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 } }, "custom_field_ids": { "title": "", "type": "array", "description": "The list of custom field IDs included in the report. Custom fields can only be selected with their corresponding dimensions.", "example": [ 0 ], "items": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 } }, "dimension_attributes": { "title": "", "type": "array", "description": "Dimension attributes provide additional fields associated with a dimension. Dimension attributes can only be selected with their corresponding dimensions.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "dimensions": { "title": "", "type": "array", "description": "Report dimensions to include in the sync. The `date` dimension is mandatory for all the report types.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_type": { "title": "", "type": "object", "description": "Report type. It defines the primary dataset and structure of the report, determining which metrics and dimensions are available for analysis. Possible values: `HISTORICAL` , `FUTURE_SELL_THROUGH`", "example": "HISTORICAL | FUTURE_SELL_THROUGH", "enum": [ "HISTORICAL", "FUTURE_SELL_THROUGH" ] }, "table": { "title": "", "type": "string", "description": "The name of the table within the schema storing the data for a given report.", "example": "line_item_report" } }, "description": "The list of reports. We create a table within the schema for each report." } }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "double_click_publishers_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Google Ad Manager client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Google Ad Manager client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "double_click_publishers_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/double_click_publishers_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" }, { "$ref": "#/components/schemas/double_click_publishers_auth_V1" } ] }, "drata_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Drata API Key.", "format": "password", "example": "your_drata_api_key" }, "sub_domain": { "type": "object", "description": "Your Drata sub_domain.", "enum": [ "", ".eu" ] } }, "description": "" } } }, "drata_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/drata_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "drift_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "drift_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Drift access token.", "format": "password", "example": "my_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "Your Drift refresh token.", "format": "password", "example": "my_refresh_token" } }, "description": "" } } }, "drift_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/drift_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/drift_auth_V1" } ] }, "drip_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Drip API Token.", "format": "password", "example": "string" } }, "description": "" } } }, "drip_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/drip_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "dropbox_config_V1": { "properties": { "config": { "type": "object", "properties": { "append_file_option": { "title": "", "type": "object", "description": "If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.", "example": "upsert_file_with_primary_keys | upsert_file | append_file", "enum": [ "upsert_file_with_primary_keys", "upsert_file", "append_file" ] }, "compression": { "title": "", "type": "object", "description": "The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.", "example": "zip | gz | tar_gz | tar | infer | gzip | uncompressed | bz2 | tar_bz2", "enum": [ "zip", "gz", "tar_gz", "tar", "infer", "gzip", "uncompressed", "bz2", "tar_bz2" ] }, "delimiter": { "title": "", "type": "string", "description": "You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.", "example": "|" }, "empty_header": { "title": "", "type": "boolean", "description": "Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.", "example": true }, "escape_char": { "title": "", "type": "string", "description": "If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.", "example": "escape_char" }, "file_type": { "title": "", "type": "object", "description": "If your files are saved with improper extensions, you can force them to be synced as the selected filetype.", "example": "tsv | xml | csv | spreadsheet | json | jsonl | avro | parquet", "enum": [ "tsv", "xml", "csv", "spreadsheet", "json", "jsonl", "avro", "parquet" ] }, "files": { "title": "", "type": "array", "description": "Mapped file name patterns to a destination table.", "items": { "title": "", "type": "object", "properties": { "archive_pattern": { "title": "", "type": "string", "description": "All Files inside of compressed archives with filenames matching this regular expression will be synced.", "example": "string" }, "file_pattern": { "title": "", "type": "string", "description": "All files in your search path matching this regular expression will be synced per table.", "example": "string" }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "table_name": { "title": "", "type": "string", "description": "All files matching the above pattern will be synced to this table.", "example": "string" } }, "description": "Mapped file name patterns to a destination table." } }, "folder": { "title": "", "type": "string", "description": "Your Dropbox Folder URL.", "example": "folder_url" }, "is_single_table_mode": { "title": "", "type": "boolean", "description": "Allows the creation of connector using Merge Mode strategy.", "example": true }, "json_delivery_mode": { "title": "", "type": "object", "description": "Control how your JSON data is delivered into your destination", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "line_separator": { "title": "", "type": "string", "description": "You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.", "example": ";" }, "null_sequence": { "title": "", "type": "string", "description": "If your CSVs use a special value indicating null, you can specify it here.", "example": "string" }, "on_error": { "title": "", "type": "object", "description": "If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.", "example": "fail | skip", "enum": [ "fail", "skip" ] }, "prefix": { "title": "", "type": "string", "description": "The connection will look for files in this folder path. Choose the lowest common folder in a folder hierarchy that includes all the files you want to sync. This defines a specific location where Fivetran scans for files and helps ensure optimal performance.", "example": "files/exports" }, "quote_char": { "title": "", "type": "string", "description": "You can specify the enclosing character used in your CSVs here. Fivetran will consider \" as the quote character if this field is empty and quote_character_enabled is set to true.", "example": "string" }, "quote_character_enabled": { "title": "", "type": "boolean", "description": "If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered \" as quote character.", "example": true }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "skip_after": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.", "format": "int32", "example": 0 }, "skip_before": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified before syncing data.", "format": "int32", "example": 0 }, "sync_inconsistent_rows": { "title": "", "type": "boolean", "description": "When enabled, Fivetran syncs rows with fewer or more columns than the header row. For rows with fewer columns, Fivetran adds NULL values for the missing columns. For rows with extra columns, Fivetran names them `column_`. When disabled, Fivetran handles inconsistent rows according to your error-handling settings.", "example": true }, "sync_nested_files": { "title": "", "type": "boolean", "description": "Optional. Set this to true to sync files from nested folders within the specified folder.", "example": true } }, "description": "" } } }, "dropbox_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Dropbox client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Dropbox client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "dropbox_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/dropbox_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table_group" }, { "$ref": "#/components/schemas/dropbox_auth_V1" } ] }, "dropbox_sign_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Dropbox Sign API key.", "format": "password", "example": "string" } }, "description": "" } } }, "dropbox_sign_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/dropbox_sign_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "dsv_config_V1": { "properties": { "config": { "type": "object", "properties": { "dsv_password": { "title": "", "type": "string", "description": "Your DSV Password.", "format": "password", "example": "your_dsv_password" }, "dsv_username": { "title": "", "type": "string", "description": "Your DSV Username", "example": "your_dsv_username" }, "environment": { "type": "object", "description": "Your API Development Environment.", "enum": [ "my", "my-demo" ] }, "oauth_subscription_key": { "title": "", "type": "string", "description": "Your OAuth subscription key.", "format": "password", "example": "your_oauth_subscription_key" }, "tracking_subscription_key": { "title": "", "type": "string", "description": "Your DSV Tracking subscription key.", "format": "password", "example": "your_tracking_subscription_key" } }, "description": "" } } }, "dsv_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "dsv_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/dsv_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/dsv_auth_V1" } ] }, "duoplane_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Duoplane API key.", "format": "password", "example": "string" }, "api_password": { "title": "", "type": "string", "description": "Your Duoplane API password.", "format": "password", "example": "string" } }, "description": "" } } }, "duoplane_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/duoplane_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "dutchie_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Dutchie API key.", "format": "password", "example": "your_dutchie_api_key" } }, "description": "" } } }, "dutchie_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/dutchie_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "dynamics_365_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_type": { "title": "", "type": "object", "description": "Authentication mechanism. Either one of `OAUTH2`, or `SERVICE_PRINCIPAL`. Default value `OAUTH2`", "example": "SERVICE_PRINCIPAL | OAUTH2", "enum": [ "SERVICE_PRINCIPAL", "OAUTH2" ] }, "domain_name": { "title": "", "type": "string", "description": "The custom domain name associated with Dynamics 365.", "example": "domain_name" }, "resource_url": { "title": "", "type": "string", "description": "URL at which Dynamics 365 is accessed", "example": "resource_url" } }, "description": "" } } }, "dynamics_365_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Client ID of your Dynamics 365 client application, or service principal.", "example": "service_principal_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Client Secret of your Dynamics 365 client application, or service principal.", "example": "service_principal_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "dynamics_365_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/dynamics_365_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/dynamics_365_auth_V1" } ] }, "dynamodb_config_V1": { "properties": { "config": { "type": "object", "properties": { "aws_region_code": { "title": "", "type": "string", "description": "The AWS region code for the DynamoDB instance, e.g. `us-east-1`.", "example": "aws_region_code" }, "is_private_link_required": { "title": "", "type": "boolean", "description": "We use PrivateLink by default if your DynamoDB instance is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to DynamoDB over PrivateLink. Learn more in our [PrivateLink documentation](https://fivetran.com/docs/connectors/databases/connection-options/aws-private-link).", "example": true }, "packed_mode_tables": { "title": "", "type": "array", "description": "List of tables to be synced in packed mode.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "role_arn": { "title": "", "type": "string", "description": "Role ARN", "format": "password", "example": "arn::your_role_arn" }, "sync_mode": { "title": "", "type": "object", "description": "Which packed mode setting to use. Default value: `UsePackedModeOnly`.", "example": "UsePackedModeOnly | UseUnpackedModeOnly", "enum": [ "UsePackedModeOnly", "UseUnpackedModeOnly" ] } }, "description": "" } } }, "dynamodb_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/dynamodb_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "easypost_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your EasyPost API Key.", "format": "password", "example": "your_easypost_API_Key" } }, "description": "" } } }, "easypost_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/easypost_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ebay_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your eBay app ID.", "example": "ebay_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your eBay cert ID.", "format": "password", "example": "ebay_client_secret" }, "scope": { "title": "", "type": "string", "description": "Your eBay scopes.", "example": "ebay_scope" }, "subdomain": { "type": "object", "description": "Your eBay environment.", "enum": [ "ebay", "sandbox.ebay" ] } }, "description": "" } } }, "ebay_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "ebay_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ebay_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/ebay_auth_V1" } ] }, "economic_config_V1": { "properties": { "config": { "type": "object", "properties": { "agreement_grant_token": { "title": "", "type": "string", "description": "Your E-conomic X-AgreementGrantToken goes here.", "format": "password", "example": "string" }, "app_secret_token": { "title": "", "type": "string", "description": "Your E-conomic X-AppSecretToken goes here.", "format": "password", "example": "string" } }, "description": "" } } }, "economic_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/economic_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "elastic_cloud_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Default value: true. Set to false if TLS is not required when using an SSH tunnel.", "example": true }, "authentication_method": { "title": "", "type": "object", "description": "The authentication method used to connect to your cluster. Supported values: `BASICAUTH` (default), `APIKEY`.", "example": "BASICAUTH | APIKEY", "enum": [ "BASICAUTH", "APIKEY" ] }, "capture_deletes": { "title": "", "type": "boolean", "description": "Whether to capture hard deletes, meaning source documents removed from the index. Set to false to skip hard-delete detection, which may improve connector performance for sources that do not hard-delete documents. This does not affect source-level soft-delete fields; those fields sync as ordinary document updates. If you re-enable delete capture later, resync the affected tables to rebuild an accurate delete baseline. Default value: true.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | SshTunnel", "enum": [ "Directly", "SshTunnel" ] }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "elasticinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 443 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect using an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect using an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect using an SSH tunnel.", "example": "tunnel_user" }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "user" } }, "description": "" } } }, "elastic_cloud_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "The Elasticsearch API key. If omitted, then basic user and password authentication will apply.", "example": "your_elasticsearch_api_key" } }, "description": "" } } }, "elastic_cloud_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "ESM key for the Elasticsearch API key", "example": "API_KEY_KEY" }, "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "elastic_cloud_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/elastic_cloud_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/elastic_cloud_auth_V1" }, { "$ref": "#/components/schemas/elastic_cloud_esm_keys_config_V1" } ] }, "elastic_cloud_serverless_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Default value: true. Set to false if TLS is not required when using an SSH tunnel.", "example": true }, "authentication_method": { "title": "", "type": "object", "description": "The authentication method used to connect to your cluster. Supported values: `BASICAUTH` (default), `APIKEY`.", "example": "BASICAUTH | APIKEY", "enum": [ "BASICAUTH", "APIKEY" ] }, "capture_deletes": { "title": "", "type": "boolean", "description": "Whether to capture hard deletes, meaning source documents removed from the index. Set to false to skip hard-delete detection, which may improve connector performance for sources that do not hard-delete documents. This does not affect source-level soft-delete fields; those fields sync as ordinary document updates. If you re-enable delete capture later, resync the affected tables to rebuild an accurate delete baseline. Default value: true.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | SshTunnel", "enum": [ "Directly", "SshTunnel" ] }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "elasticinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 443 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect using an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect using an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect using an SSH tunnel.", "example": "tunnel_user" }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "user" } }, "description": "" } } }, "elastic_cloud_serverless_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "The Elasticsearch API key. If omitted, then basic user and password authentication will apply.", "example": "your_elasticsearch_api_key" } }, "description": "" } } }, "elastic_cloud_serverless_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "ESM key for the Elasticsearch API key", "example": "API_KEY_KEY" }, "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "elastic_cloud_serverless_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/elastic_cloud_serverless_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/elastic_cloud_serverless_auth_V1" }, { "$ref": "#/components/schemas/elastic_cloud_serverless_esm_keys_config_V1" } ] }, "electronic_tenant_solutions_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Electronic Tenant Solutions API key.", "format": "password", "example": "your_electronic_tenant_solutions_api_key" } }, "description": "" } } }, "electronic_tenant_solutions_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/electronic_tenant_solutions_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "eloqua_config_V1": { "properties": { "config": { "type": "object", "properties": { "historical_sync_limit": { "title": "", "type": "object", "description": "Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.", "example": "ONE_YEAR | ALL_TIME | FIVE_YEARS | TWO_YEARS | THREE_MONTHS | SIX_MONTHS", "enum": [ "ONE_YEAR", "ALL_TIME", "FIVE_YEARS", "TWO_YEARS", "THREE_MONTHS", "SIX_MONTHS" ] } }, "description": "" } } }, "eloqua_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/eloqua_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "email_config_V1": { "properties": { "config": { "type": "object", "properties": { "allowed_senders_list": { "title": "", "type": "array", "description": "Restrict ingestion to emails from these senders only. Supports exact addresses (e.g. reports@vendor.com) or domains (e.g. @vendor.com). Applies to all tables.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "append_file_option": { "title": "", "type": "object", "description": "If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.", "example": "upsert_file_with_primary_keys | append_file", "enum": [ "upsert_file_with_primary_keys", "append_file" ] }, "azure_credential": { "title": "", "type": "object", "properties": { "container_name": { "title": "", "type": "string", "description": "Azure Blob container name.", "example": "string" }, "prefix": { "title": "", "type": "string", "description": "Optional path prefix within the container. Defaults to the root if not set.", "example": "string" }, "storage_account": { "title": "", "type": "string", "description": "Azure storage account name.", "example": "string" } }, "description": "Configuration for Azure Blob storage." }, "cloud_storage_option": { "title": "", "type": "object", "description": "Choose where Fivetran stores your attachments. Default value: `FIVETRAN`.", "example": "FIVETRAN | S3 | AZURE | GCS", "enum": [ "FIVETRAN", "S3", "AZURE", "GCS" ] }, "compression": { "title": "", "type": "object", "description": "The secrets that should be passed to the function at runtime.", "example": "zip | gz | tar_gz | tar | infer | gzip | uncompressed | bz2 | tar_bz2", "enum": [ "zip", "gz", "tar_gz", "tar", "infer", "gzip", "uncompressed", "bz2", "tar_bz2" ] }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "delimiter": { "title": "", "type": "string", "description": "You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.", "example": "string" }, "empty_header": { "title": "", "type": "boolean", "description": "Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.", "example": true }, "escape_char": { "title": "", "type": "string", "description": "If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.", "example": "string" }, "file_type": { "title": "", "type": "object", "description": "If your files are saved with improper extensions, you can force them to by synced as the selected file type.", "example": "tsv | xml | csv | spreadsheet | json | jsonl | avro | parquet", "enum": [ "tsv", "xml", "csv", "spreadsheet", "json", "jsonl", "avro", "parquet" ] }, "files": { "title": "", "type": "array", "description": "Mapped file name patterns to a destination table.", "items": { "title": "", "type": "object", "properties": { "archive_pattern": { "title": "", "type": "string", "description": "All Files inside of compressed archives with filenames matching this regular expression will be synced.", "example": "string" }, "email_subject": { "title": "", "type": "string", "description": "Only attachments from emails with this subject will be synced. Leave this field blank to sync all attachments.", "example": "string" }, "file_pattern": { "title": "", "type": "string", "description": "All files in your search path matching this regular expression will be synced per table.", "example": "string" }, "file_source": { "title": "", "type": "object", "description": "The source of files to sync. `ATTACHMENT` (default) syncs email attachments; `LINKED_URL_ATTACHMENT` fetches files from URLs in the email body.", "example": "ATTACHMENT | LINKED_URL_ATTACHMENT", "enum": [ "ATTACHMENT", "LINKED_URL_ATTACHMENT" ] }, "link_pattern": { "title": "", "type": "string", "description": "URLs in email bodies that match this pattern are fetched and synced as files to this table.", "example": "string" }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "table_name": { "title": "", "type": "string", "description": "All files matching the above pattern will be synced to this table.", "example": "string" } }, "description": "Mapped file name patterns to a destination table." } }, "gcs_credential": { "title": "", "type": "object", "properties": { "gcs_bucket": { "title": "", "type": "string", "description": "Google Cloud Storage bucket name.", "example": "string" }, "prefix": { "title": "", "type": "string", "description": "Optional path prefix within the bucket. Defaults to the root if not set.", "example": "string" } }, "description": "Configuration for Google Cloud Storage." }, "json_delivery_mode": { "title": "", "type": "object", "description": "Control how your JSON data is delivered into your destination", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "line_separator": { "title": "", "type": "string", "description": "You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.", "example": ";" }, "null_sequence": { "title": "", "type": "string", "description": "If your CSVs use a special value indicating null, you can specify it here.", "example": "string" }, "quote_char": { "title": "", "type": "string", "description": "You can specify the enclosing character used in your CSVs here. Fivetran will consider \" as the quote character if this field is empty and quote_character_enabled is set to true.", "example": "string" }, "quote_character_enabled": { "title": "", "type": "boolean", "description": "If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered \" as quote character.", "example": true }, "s3_credential": { "title": "", "type": "object", "properties": { "prefix": { "title": "", "type": "string", "description": "Optional path prefix within the bucket. Defaults to the root if not set.", "example": "string" }, "s3_bucket": { "title": "", "type": "string", "description": "Amazon S3 bucket name.", "example": "string" }, "s3_external_id": { "title": "", "type": "string", "description": "Fivetran-generated external ID.", "example": "string" }, "s3_role_arn": { "title": "", "type": "string", "description": "Amazon S3 Role ARN required for authentication.", "format": "password", "example": "string" } }, "description": "Configuration for Amazon S3 storage." }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "skip_after": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.", "format": "int32", "example": 0 }, "skip_before": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified before syncing data.", "format": "int32", "example": 0 }, "sync_inconsistent_rows": { "title": "", "type": "boolean", "description": "When enabled, Fivetran syncs rows with fewer or more columns than the header row. For rows with fewer columns, Fivetran adds NULL values for the missing columns. For rows with extra columns, Fivetran names them `column_`. When disabled, Fivetran handles inconsistent rows according to your error-handling settings.", "example": true } }, "description": "" } } }, "email_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/email_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table_group" } ] }, "employment_hero_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "employment_hero_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Employment Hero access token.", "format": "password", "example": "employment_hero_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "Your Employment Hero refresh token.", "format": "password", "example": "employment_hero_refresh_token" } }, "description": "" } } }, "employment_hero_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/employment_hero_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/employment_hero_auth_V1" } ] }, "epic_clarity_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "string" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "string" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "string" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 0 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "string" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 0 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "string" }, "update_method": { "title": "", "type": "object", "description": "Required. The incremental update method the connector will use. The possible values are `\"MIXED_TELEPORT_CSA\"` for [CSA and Teleport](/docs/connectors/databases/epic_clarity#csaandteleport) and `\"EPIC_COGITO\"` for [Epic Cogito](/docs/connectors/databases/epic_clarity#epiccogito). There is no default; setup fails if the value is omitted or set to `null`.", "example": "MIXED_TELEPORT_CSA", "enum": [ "BINARY_LOG_READER", "MIXED_TELEPORT_CSA", "NATIVE_UPDATE", "EPIC_CSA", "TELEPORT", "EPIC_COGITO" ] }, "user": { "title": "", "type": "string", "description": "The user name. For Azure Databases, the format must be `user@domain`.", "example": "string" } }, "description": "" } } }, "epic_clarity_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name", "example": "USER_KEY" } }, "description": "" } } }, "epic_clarity_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/epic_clarity_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/epic_clarity_esm_keys_config_V1" } ] }, "es_self_hosted_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Default value: true. Set to false if TLS is not required when using an SSH tunnel.", "example": true }, "authentication_method": { "title": "", "type": "object", "description": "The authentication method used to connect to your cluster.", "example": "BASICAUTH | APIKEY", "enum": [ "BASICAUTH", "APIKEY" ] }, "capture_deletes": { "title": "", "type": "boolean", "description": "Whether to capture hard deletes, meaning source documents removed from the index. Set to false to skip hard-delete detection, which may improve connector performance for sources that do not hard-delete documents. This does not affect source-level soft-delete fields; those fields sync as ordinary document updates. If you re-enable delete capture later, resync the affected tables to rebuild an accurate delete baseline. Default value: true.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | SshTunnel", "enum": [ "Directly", "SshTunnel" ] }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "elasticinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 443 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect using an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect using an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect using an SSH tunnel.", "example": "tunnel_user" }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "user" } }, "description": "" } } }, "es_self_hosted_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "The Elasticsearch API key. If omitted, then basic user and password authentication will apply.", "example": "your_elasticsearch_api_key" } }, "description": "" } } }, "es_self_hosted_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "ESM key for the Elasticsearch API key", "example": "API_KEY_KEY" }, "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "es_self_hosted_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/es_self_hosted_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/es_self_hosted_auth_V1" }, { "$ref": "#/components/schemas/es_self_hosted_esm_keys_config_V1" } ] }, "eventbrite_config_V1": { "properties": { "config": { "type": "object", "properties": { "private_token": { "title": "", "type": "string", "description": "Your Eventbrite private token.", "format": "password", "example": "your_eventbrite_private_token" } }, "description": "" } } }, "eventbrite_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/eventbrite_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "eventsforce_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_name": { "title": "", "type": "string", "description": "Your Eventsforce account name.", "example": "your_eventsforce_account_name" }, "api_key": { "title": "", "type": "string", "description": "Your Eventsforce API secret key.", "format": "password", "example": "your_eventsforce_api_key" } }, "description": "" } } }, "eventsforce_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/eventsforce_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "everflow_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Everflow API key.", "format": "password", "example": "your_everflow_api_key" }, "region": { "type": "object", "description": "Your Everflow region.", "enum": [ "api-eu", "api" ] } }, "description": "" } } }, "everflow_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/everflow_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "everhour_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Everhour API Token.", "format": "password", "example": "your_everhour_api_token" } }, "description": "" } } }, "everhour_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/everhour_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "exact_online_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Exact Online client ID.", "example": "your_exact_online_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Exact Online client secret.", "format": "password", "example": "your_exact_online_client_secret" }, "region": { "type": "object", "description": "Your Exact Online region.", "enum": [ "https://start.exactonline.de", "https://start.exactonline.be", "https://start.exactonline.com", "https://start.exactonline.co.uk", "https://start.exactonline.fr", "https://start.exactonline.nl", "https://start.exactonline.es" ] } }, "description": "" } } }, "exact_online_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "exact_online_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/exact_online_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/exact_online_auth_V1" } ] }, "expensein_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your ExpenseIn API key.", "format": "password", "example": "your_expensein_api_key" } }, "description": "" } } }, "expensein_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/expensein_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "expensify_config_V1": { "properties": { "config": { "type": "object", "properties": { "partner_user_id": { "title": "", "type": "string", "description": "Your Expensify partnerUserID.", "example": "your_expensify_partner_user_id" }, "partner_user_secret": { "title": "", "type": "string", "description": "Your Expensify partnerUserSecret.", "format": "password", "example": "your_expensify_partner_user_secret" } }, "description": "" } } }, "expensify_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/expensify_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ezofficeinventory_config_V1": { "properties": { "config": { "type": "object", "properties": { "secret_key": { "title": "", "type": "string", "description": "Your EZOfficeInventory API secret key.", "format": "password", "example": "your_ezofficeinventory_api_secret_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your EZOfficeInventory Subdomain.", "example": "your_ezofficeinventory_subdomain" } }, "description": "" } } }, "ezofficeinventory_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ezofficeinventory_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "facebook_ads_config_V1": { "properties": { "config": { "type": "object", "properties": { "accounts": { "title": "", "type": "array", "description": "List of accounts of which connector will sync the data.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "custom_tables": { "title": "", "type": "array", "description": "List of custom tables. Each custom table corresponds to a table within the schema to which connector will sync the data.", "items": { "title": "", "type": "object", "properties": { "action_breakdowns": { "title": "", "type": "array", "description": "List of action_breakdowns which connector will sync. [Possible action_breakdowns values](/docs/connectors/applications/facebook-ads#actionbreakdowns).", "example": [ "action_canvas_component_name | action_carousel_card_id | action_video_sound | action_link_click_destination | action_type | action_video_type | action_carousel_card_name | action_target_id | action_destination | action_device | action_reaction" ], "items": { "title": "", "type": "object", "description": "", "example": "action_canvas_component_name | action_carousel_card_id | action_video_sound | action_link_click_destination | action_type | action_video_type | action_carousel_card_name | action_target_id | action_destination | action_device | action_reaction", "enum": [ "action_canvas_component_name", "action_carousel_card_id", "action_video_sound", "action_link_click_destination", "action_type", "action_video_type", "action_carousel_card_name", "action_target_id", "action_destination", "action_device", "action_reaction" ] } }, "action_report_time": { "title": "", "type": "object", "description": "The report time of action stats. [Possible action_report time values](/docs/connectors/applications/facebook-ads#actionreporttime).", "example": "impression | mixed | conversion", "enum": [ "impression", "mixed", "conversion" ] }, "aggregation": { "title": "", "type": "object", "description": "Options to select aggregation duration. [Possible aggregation values](/docs/connectors/applications/facebook-ads#aggregation).", "example": "Month | Lifetime | Day | Week", "enum": [ "Month", "Lifetime", "Day", "Week" ] }, "attribution_windows": { "title": "", "type": "array", "description": "List of attribution windows passed as Meta's `action_attribution_windows` query parameter. Default: `CLICK_7D`, `VIEW_1D`, `INCREMENTALITY`. Possible values: `CLICK_1D`, `CLICK_7D`, `CLICK_28D`, `VIEW_1D`, `ENGAGED_VIEW_1D`, `INCREMENTALITY`, `INCREMENTALITY_FIRST_CONVERSION`, `INCREMENTALITY_ALL_CONVERSIONS`.", "example": [ "VIEW_1D | INCREMENTALITY | CLICK_1D | INCREMENTALITY_FIRST_CONVERSION | CLICK_7D | INCREMENTALITY_ALL_CONVERSIONS | CLICK_28D | ENGAGED_VIEW_1D" ], "items": { "title": "", "type": "object", "description": "", "example": "VIEW_1D | INCREMENTALITY | CLICK_1D | INCREMENTALITY_FIRST_CONVERSION | CLICK_7D | INCREMENTALITY_ALL_CONVERSIONS | CLICK_28D | ENGAGED_VIEW_1D", "enum": [ "VIEW_1D", "INCREMENTALITY", "CLICK_1D", "INCREMENTALITY_FIRST_CONVERSION", "CLICK_7D", "INCREMENTALITY_ALL_CONVERSIONS", "CLICK_28D", "ENGAGED_VIEW_1D" ] } }, "breakdowns": { "title": "", "type": "array", "description": "List of breakdowns which connector will sync. [Possible breakdowns values](/docs/connectors/applications/facebook-ads#breakdowns).", "example": [ "country | skan_campaign_id | gender | hourly_stats_aggregated_by_advertiser_time_zone | skan_conversion_id | link_url_asset | title_asset | action_converted_product_id | fidelity_type | mmm | call_to_action_asset | image_asset | product_id | hsid | app_id | impression_device | user_segment_key | body_asset | frequency_value | place_page_id | video_asset | redownload | hourly_stats_aggregated_by_audience_time_zone | ad_format_asset | platform_position | postback_sequence_index | dma | device_platform | placement | publisher_platform | comscore_market | region | is_conversion_id_modeled | coarse_conversion_value | age | description_asset" ], "items": { "title": "", "type": "object", "description": "", "example": "country | skan_campaign_id | gender | hourly_stats_aggregated_by_advertiser_time_zone | skan_conversion_id | link_url_asset | title_asset | action_converted_product_id | fidelity_type | mmm | call_to_action_asset | image_asset | product_id | hsid | app_id | impression_device | user_segment_key | body_asset | frequency_value | place_page_id | video_asset | redownload | hourly_stats_aggregated_by_audience_time_zone | ad_format_asset | platform_position | postback_sequence_index | dma | device_platform | placement | publisher_platform | comscore_market | region | is_conversion_id_modeled | coarse_conversion_value | age | description_asset", "enum": [ "country", "skan_campaign_id", "gender", "hourly_stats_aggregated_by_advertiser_time_zone", "skan_conversion_id", "link_url_asset", "title_asset", "action_converted_product_id", "fidelity_type", "mmm", "call_to_action_asset", "image_asset", "product_id", "hsid", "app_id", "impression_device", "user_segment_key", "body_asset", "frequency_value", "place_page_id", "video_asset", "redownload", "hourly_stats_aggregated_by_audience_time_zone", "ad_format_asset", "platform_position", "postback_sequence_index", "dma", "device_platform", "placement", "publisher_platform", "comscore_market", "region", "is_conversion_id_modeled", "coarse_conversion_value", "age", "description_asset" ] } }, "click_attribution_window": { "title": "", "type": "object", "description": "Deprecated. Read-only legacy field used only during migration to `attribution_windows`.", "example": "DAY_7", "enum": [ "DAY_1", "DAY_1_EV", "DAY_7", "NONE", "DAY_28" ] }, "config_type": { "title": "", "type": "object", "description": "Option to select Prebuilt Reports or Custom Reports. [Possible config_type values](/docs/connectors/applications/facebook-ads#configtype).", "example": "Prebuilt | Custom", "enum": [ "Prebuilt", "Custom" ] }, "engaged_view_attribution_window": { "title": "", "type": "object", "description": "Deprecated. Read-only legacy field used only during migration to `attribution_windows`.", "example": "DAY_1 | DAY_1_EV | DAY_7 | NONE | DAY_28", "enum": [ "DAY_1", "DAY_1_EV", "DAY_7", "NONE", "DAY_28" ] }, "fields": { "title": "", "type": "array", "description": "List of fields which connector will sync. [Possible field values](/docs/connectors/applications/facebook-ads#fields).", "example": [ "cost_per_estimated_ad_recallers | optimization_goal | video_thruplay_watched_actions | reach | click_to_app_store | cost_per_unique_action_type | total_actions | website_clicks | place_page_name | social_impressions | buying_type | converted_promoted_product_app_custom_event_fb_mobile_purchase_value | objective | video_30_sec_watched_actions | canvas_component_avg_pct_view | cost_per_thruplay | instant_experience_outbound_clicks | unique_clicks | unique_outbound_clicks | total_unique_actions | video_p75_watched_actions | cost_per_unique_inline_link_click | converted_promoted_product_omni_purchase_values | canvas_avg_view_time | social_clicks | inline_link_click_ctr | newsfeed_avg_position | ctr | instagram_upcoming_event_reminders_set | deeplink_clicks | video_avg_time_watched_actions | unique_impressions | video_play_retention_20_to_60s_actions | ad_click_actions | labels | cost_per_ad_click | newsfeed_impressions | unique_link_clicks_ctr | video_p95_watched_actions | ad_id | full_view_reach | converted_product_app_custom_event_fb_mobile_purchase | catalog_segment_value | cost_per_unique_outbound_click | inline_post_engagement | auction_competitiveness | actions | catalog_segment_value_omni_purchase_roas | video_continuous_2_sec_watched_actions | unique_outbound_clicks_ctr | objective_result_rate | conversions | converted_promoted_product_website_pixel_purchase | video_10_sec_watched_actions | estimated_ad_recall_rate | attribution_setting | video_play_retention_0_to_15s_actions | cost_per_action_type | dda_countby_convs | outbound_clicks_ctr | unique_inline_link_click_ctr | cost_per_result | catalog_segment_actions | cost_per_15_sec_video_view | social_reach | objective_results | account_name | video_time_watched_actions | wish_bid | unique_inline_link_clicks | video_p100_watched_actions | cost_per_conversion | video_p50_watched_actions | outbound_clicks | cost_per_one_thousand_ad_impression | app_store_clicks | interactive_component_tap | product_retailer_id | converted_product_quantity | product_content_id | unique_social_clicks | qualifying_question_qualify_answer_rate | ad_name | impressions | full_view_impressions | converted_product_offline_purchase | cost_per_10_sec_video_view | account_id | website_purchase_roas | converted_product_app_custom_event_fb_mobile_purchase_value | converted_product_offline_purchase_value | instant_experience_clicks_to_open | adset_name | social_spend | video_play_curve_actions | converted_product_omni_purchase_values | frequency | action_values | call_to_action_clicks | cpc | converted_promoted_product_website_pixel_purchase_value | cost_per_dda_countby_convs | campaign_id | cpm | created_time | cpp | conversion_rate_ranking | click_to_app_deeplink | cost_per_inline_link_click | video_play_retention_graph_actions | product_name | converted_product_omni_purchase | date_start | conversion_values | converted_product_website_pixel_purchase | adset_id | purchase_roas | estimated_ad_recallers | cost_per_unique_click | account_currency | inline_link_clicks | video_15_sec_watched_actions | website_ctr | auction_max_competitor_bid | converted_product_value | converted_promoted_product_app_custom_event_fb_mobile_purchase | auction_bid | catalog_segment_value_website_purchase_roas | campaign_name | cost_per_inline_post_engagement | converted_product_website_pixel_purchase_value | unique_actions | click_to_website | video_avg_percent_watched_actions | spend | date_stop | video_play_actions | catalog_segment_value_mobile_purchase_roas | converted_promoted_product_omni_purchase | converted_promoted_product_offline_purchase | video_p25_watched_actions | cost_per_outbound_click | canvas_avg_view_percent | quality_ranking | total_action_value | unique_ctr | user_segment_key | cost_per_total_action | instant_experience_clicks_to_start | cost_per_2_sec_continuous_video_view | relevance_score | converted_promoted_product_offline_purchase_value | newsfeed_clicks | clicks | engagement_rate_ranking | location | gender_targeting | mobile_app_purchase_roas | ad_impression_actions" ], "items": { "title": "", "type": "object", "description": "", "example": "cost_per_estimated_ad_recallers | optimization_goal | video_thruplay_watched_actions | reach | click_to_app_store | cost_per_unique_action_type | total_actions | website_clicks | place_page_name | social_impressions | buying_type | converted_promoted_product_app_custom_event_fb_mobile_purchase_value | objective | video_30_sec_watched_actions | canvas_component_avg_pct_view | cost_per_thruplay | instant_experience_outbound_clicks | unique_clicks | unique_outbound_clicks | total_unique_actions | video_p75_watched_actions | cost_per_unique_inline_link_click | converted_promoted_product_omni_purchase_values | canvas_avg_view_time | social_clicks | inline_link_click_ctr | newsfeed_avg_position | ctr | instagram_upcoming_event_reminders_set | deeplink_clicks | video_avg_time_watched_actions | unique_impressions | video_play_retention_20_to_60s_actions | ad_click_actions | labels | cost_per_ad_click | newsfeed_impressions | unique_link_clicks_ctr | video_p95_watched_actions | ad_id | full_view_reach | converted_product_app_custom_event_fb_mobile_purchase | catalog_segment_value | cost_per_unique_outbound_click | inline_post_engagement | auction_competitiveness | actions | catalog_segment_value_omni_purchase_roas | video_continuous_2_sec_watched_actions | unique_outbound_clicks_ctr | objective_result_rate | conversions | converted_promoted_product_website_pixel_purchase | video_10_sec_watched_actions | estimated_ad_recall_rate | attribution_setting | video_play_retention_0_to_15s_actions | cost_per_action_type | dda_countby_convs | outbound_clicks_ctr | unique_inline_link_click_ctr | cost_per_result | catalog_segment_actions | cost_per_15_sec_video_view | social_reach | objective_results | account_name | video_time_watched_actions | wish_bid | unique_inline_link_clicks | video_p100_watched_actions | cost_per_conversion | video_p50_watched_actions | outbound_clicks | cost_per_one_thousand_ad_impression | app_store_clicks | interactive_component_tap | product_retailer_id | converted_product_quantity | product_content_id | unique_social_clicks | qualifying_question_qualify_answer_rate | ad_name | impressions | full_view_impressions | converted_product_offline_purchase | cost_per_10_sec_video_view | account_id | website_purchase_roas | converted_product_app_custom_event_fb_mobile_purchase_value | converted_product_offline_purchase_value | instant_experience_clicks_to_open | adset_name | social_spend | video_play_curve_actions | converted_product_omni_purchase_values | frequency | action_values | call_to_action_clicks | cpc | converted_promoted_product_website_pixel_purchase_value | cost_per_dda_countby_convs | campaign_id | cpm | created_time | cpp | conversion_rate_ranking | click_to_app_deeplink | cost_per_inline_link_click | video_play_retention_graph_actions | product_name | converted_product_omni_purchase | date_start | conversion_values | converted_product_website_pixel_purchase | adset_id | purchase_roas | estimated_ad_recallers | cost_per_unique_click | account_currency | inline_link_clicks | video_15_sec_watched_actions | website_ctr | auction_max_competitor_bid | converted_product_value | converted_promoted_product_app_custom_event_fb_mobile_purchase | auction_bid | catalog_segment_value_website_purchase_roas | campaign_name | cost_per_inline_post_engagement | converted_product_website_pixel_purchase_value | unique_actions | click_to_website | video_avg_percent_watched_actions | spend | date_stop | video_play_actions | catalog_segment_value_mobile_purchase_roas | converted_promoted_product_omni_purchase | converted_promoted_product_offline_purchase | video_p25_watched_actions | cost_per_outbound_click | canvas_avg_view_percent | quality_ranking | total_action_value | unique_ctr | user_segment_key | cost_per_total_action | instant_experience_clicks_to_start | cost_per_2_sec_continuous_video_view | relevance_score | converted_promoted_product_offline_purchase_value | newsfeed_clicks | clicks | engagement_rate_ranking | location | gender_targeting | mobile_app_purchase_roas | ad_impression_actions", "enum": [ "cost_per_estimated_ad_recallers", "optimization_goal", "video_thruplay_watched_actions", "reach", "click_to_app_store", "cost_per_unique_action_type", "total_actions", "website_clicks", "place_page_name", "social_impressions", "buying_type", "converted_promoted_product_app_custom_event_fb_mobile_purchase_value", "objective", "video_30_sec_watched_actions", "canvas_component_avg_pct_view", "cost_per_thruplay", "instant_experience_outbound_clicks", "unique_clicks", "unique_outbound_clicks", "total_unique_actions", "video_p75_watched_actions", "cost_per_unique_inline_link_click", "converted_promoted_product_omni_purchase_values", "canvas_avg_view_time", "social_clicks", "inline_link_click_ctr", "newsfeed_avg_position", "ctr", "instagram_upcoming_event_reminders_set", "deeplink_clicks", "video_avg_time_watched_actions", "unique_impressions", "video_play_retention_20_to_60s_actions", "ad_click_actions", "labels", "cost_per_ad_click", "newsfeed_impressions", "unique_link_clicks_ctr", "video_p95_watched_actions", "ad_id", "full_view_reach", "converted_product_app_custom_event_fb_mobile_purchase", "catalog_segment_value", "cost_per_unique_outbound_click", "inline_post_engagement", "auction_competitiveness", "actions", "catalog_segment_value_omni_purchase_roas", "video_continuous_2_sec_watched_actions", "unique_outbound_clicks_ctr", "objective_result_rate", "conversions", "converted_promoted_product_website_pixel_purchase", "video_10_sec_watched_actions", "estimated_ad_recall_rate", "attribution_setting", "video_play_retention_0_to_15s_actions", "cost_per_action_type", "dda_countby_convs", "outbound_clicks_ctr", "unique_inline_link_click_ctr", "cost_per_result", "catalog_segment_actions", "cost_per_15_sec_video_view", "social_reach", "objective_results", "account_name", "video_time_watched_actions", "wish_bid", "unique_inline_link_clicks", "video_p100_watched_actions", "cost_per_conversion", "video_p50_watched_actions", "outbound_clicks", "cost_per_one_thousand_ad_impression", "app_store_clicks", "interactive_component_tap", "product_retailer_id", "converted_product_quantity", "product_content_id", "unique_social_clicks", "qualifying_question_qualify_answer_rate", "ad_name", "impressions", "full_view_impressions", "converted_product_offline_purchase", "cost_per_10_sec_video_view", "account_id", "website_purchase_roas", "converted_product_app_custom_event_fb_mobile_purchase_value", "converted_product_offline_purchase_value", "instant_experience_clicks_to_open", "adset_name", "social_spend", "video_play_curve_actions", "converted_product_omni_purchase_values", "frequency", "action_values", "call_to_action_clicks", "cpc", "converted_promoted_product_website_pixel_purchase_value", "cost_per_dda_countby_convs", "campaign_id", "cpm", "created_time", "cpp", "conversion_rate_ranking", "click_to_app_deeplink", "cost_per_inline_link_click", "video_play_retention_graph_actions", "product_name", "converted_product_omni_purchase", "date_start", "conversion_values", "converted_product_website_pixel_purchase", "adset_id", "purchase_roas", "estimated_ad_recallers", "cost_per_unique_click", "account_currency", "inline_link_clicks", "video_15_sec_watched_actions", "website_ctr", "auction_max_competitor_bid", "converted_product_value", "converted_promoted_product_app_custom_event_fb_mobile_purchase", "auction_bid", "catalog_segment_value_website_purchase_roas", "campaign_name", "cost_per_inline_post_engagement", "converted_product_website_pixel_purchase_value", "unique_actions", "click_to_website", "video_avg_percent_watched_actions", "spend", "date_stop", "video_play_actions", "catalog_segment_value_mobile_purchase_roas", "converted_promoted_product_omni_purchase", "converted_promoted_product_offline_purchase", "video_p25_watched_actions", "cost_per_outbound_click", "canvas_avg_view_percent", "quality_ranking", "total_action_value", "unique_ctr", "user_segment_key", "cost_per_total_action", "instant_experience_clicks_to_start", "cost_per_2_sec_continuous_video_view", "relevance_score", "converted_promoted_product_offline_purchase_value", "newsfeed_clicks", "clicks", "engagement_rate_ranking", "location", "gender_targeting", "mobile_app_purchase_roas", "ad_impression_actions" ] } }, "level": { "title": "", "type": "object", "example": "ad | adset | campaign | none | account", "enum": [ "ad", "adset", "campaign", "none", "account" ] }, "prebuilt_report_name": { "title": "", "type": "string", "description": "The report name to which connector will sync the data. [Possible prebuilt_report values](/docs/connectors/applications/facebook-ads#prebuiltreport).", "example": "string" }, "table_name": { "title": "", "type": "string", "description": "The table name within the schema to which the connector will sync the data. It must be unique within the connector and must comply with [Fivetran's naming conventions](/docs/getting-started/core-concepts#namingconventions).", "example": "table_1" }, "use_unified_attribution_setting": { "title": "", "type": "boolean", "example": true }, "view_attribution_window": { "title": "", "type": "object", "description": "Deprecated. Read-only legacy field used only during migration to `attribution_windows`.", "example": "DAY_7", "enum": [ "DAY_1", "DAY_1_EV", "DAY_7", "NONE", "DAY_28" ] } }, "description": "List of custom tables. Each custom table corresponds to a table within the schema to which connector will sync the data." } }, "sync_metadata": { "title": "", "type": "boolean", "description": "Parameter defining whether to enable or disable metadata synchronisation. Default value: `TRUE`.", "example": true }, "sync_mode": { "title": "", "type": "object", "description": "Option to select connector should sync all accounts or specific accounts. [Possible sync_mode values](/docs/connectors/applications/facebook-ads#syncmode).", "example": "AllAccounts | SpecificAccounts", "enum": [ "AllAccounts", "SpecificAccounts" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "facebook_ads_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The long-lived `Access token` along with the `client_id` and `client_secret` parameters carry the information necessary to query the Facebook Ads API. Use either `access_token` or `user_access_token`, not both at the same time.", "example": "User access token" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Facebook client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Facebook client application.", "example": "my_client_secret" } }, "description": "Your application client access fields." }, "user_access_token": { "title": "", "type": "string", "description": "System User Token. Use in combination with `client_id` and `client_secret`. Use either `user_access_token` (for system token) or `access_token` (for user access token), not both at the same time.", "example": "System User Token" } }, "description": "" } } }, "facebook_ads_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "user_access_token": { "title": "", "type": "string", "description": "ESM key for system User Token", "example": "USER_ACCESS_TOKEN_KEY" } }, "description": "" } } }, "facebook_ads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/facebook_ads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/facebook_ads_auth_V1" }, { "$ref": "#/components/schemas/facebook_ads_esm_keys_config_V1" } ] }, "facebook_pages_config_V1": { "properties": { "config": { "type": "object", "properties": { "authentication_method": { "title": "", "type": "object", "description": "The authentication method to use for the Facebook Pages connector. Possible values: `USER_ACCESS` (OAuth-based user access, default) or `SYSTEM_TOKEN` (System User Token).", "example": "USER_ACCESS | SYSTEM_TOKEN", "enum": [ "USER_ACCESS", "SYSTEM_TOKEN" ] }, "pages": { "title": "", "type": "array", "description": "Specific pages to sync. Must be populated if `sync_mode` is set to `SpecificPages`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all accounts or specific accounts. Default value: `AllPages`.", "example": "SpecificPages | AllPages", "enum": [ "SpecificPages", "AllPages" ] } }, "description": "" } } }, "facebook_pages_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The `Access Token` carries the information necessary for API resources to fetch data. Use either `access_token` (for user access token) or `system_user_access_token` (for system token), not both at the same time.", "example": "my_access_token" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Facebook client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Facebook client application.", "example": "my_client_secret" } }, "description": "Your application client access fields" }, "system_user_access_token": { "title": "", "type": "string", "description": "System User Token. Use in combination with `client_id` and `client_secret`. Use either `system_user_access_token` (for system token) or `access_token` (for user access token), not both at the same time.", "example": "System User Token" } }, "description": "" } } }, "facebook_pages_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/facebook_pages_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/facebook_pages_auth_V1" } ] }, "factbird_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Factbird API token.", "format": "password", "example": "your_factbird_api_token" }, "base_url": { "type": "object", "description": "Your Factbird base url.", "enum": [ "", "api.cloud.factbird.com" ] }, "custom_url": { "title": "", "type": "string", "description": "Your Factbird custom base url.", "example": "your_factbird_custom_base_url" } }, "description": "" } } }, "factbird_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/factbird_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "factorial_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Factorial API key.", "format": "password", "example": "your_factorial_api_key" } }, "description": "" } } }, "factorial_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/factorial_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "fathom_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Fathom API key.", "format": "password", "example": "your_fathom_api_key" } }, "description": "" } } }, "fathom_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/fathom_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "fillout_config_V1": { "properties": { "config": { "type": "object", "properties": { "base_url": { "title": "", "type": "string", "description": "Your Fillout Base URL.", "example": "your_fillout_base_url." }, "client_id": { "title": "", "type": "string", "description": "Your Fillout client ID.", "example": "your_fillout_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Fillout client secret", "format": "password", "example": "your_fillout_client_secret" } }, "description": "" } } }, "fillout_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "fillout_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/fillout_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/fillout_auth_V1" } ] }, "firebase_config_V1": { "properties": { "config": { "type": "object", "properties": { "capture_deletes": { "title": "", "type": "boolean", "description": "Whether to capture document deletions from Firestore. Set to false to disable delete capture, which may improve connector performance. Default value: true.", "example": true }, "database_name": { "title": "", "type": "string", "description": "Database Name", "example": "string" }, "packed_mode_tables": { "title": "", "type": "array", "description": "Specific tables to sync. Must be populated if `packing_mode` is set to `SelectTablesForPackedMode`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "packing_mode": { "title": "", "type": "object", "description": "Whether to sync all tables in unpacked mode or specific tables in packed mode. Default value: `UseUnpackedModeOnly`.", "example": "UsePackedModeOnly | UseUnpackedModeOnly", "enum": [ "UsePackedModeOnly", "UseUnpackedModeOnly" ] }, "service_account_key": { "title": "", "type": "string", "description": "The contents of your service account key file. Required for authentication.", "format": "password", "example": "your_service_account_key" }, "sub_collections": { "title": "", "type": "array", "description": "List of nested collections to sync. Only specified subCollections can be synced.", "example": "[subCollection1, subCollection2]", "items": { "title": "", "type": "string", "description": "", "example": "string" } } }, "description": "" } } }, "firebase_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/firebase_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "fireflies_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Fireflies API key.", "format": "password", "example": "your_fireflies_api_key" } }, "description": "" } } }, "fireflies_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/fireflies_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "firehydrant_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your FireHydrant API key.", "format": "password", "example": "your_firehydrant_api_key" } }, "description": "" } } }, "firehydrant_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/firehydrant_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "fivetran_log_config_V1": { "properties": { "config": { "type": "object", "properties": { "is_account_level_connector": { "title": "", "type": "boolean", "description": "(Optional) Retrieve account-level logs.", "example": true } }, "description": "" } } }, "fivetran_log_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/fivetran_log_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "flexport_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "The Flexport API Key.", "example": "your_flexport_client_id" }, "client_secret": { "title": "", "type": "string", "description": "The Flexport API Secret.", "format": "password", "example": "your_flexport_client_secret" } }, "description": "" } } }, "flexport_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/flexport_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "float_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Float API key.", "format": "password", "example": "your_float_api_key" } }, "description": "" } } }, "float_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/float_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "flywheel_digital_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_access_token": { "title": "", "type": "string", "description": "Your Flywheel Digital API access token.", "format": "password", "example": "your_flywheel_digital_bearer_token" }, "instance": { "title": "", "type": "string", "description": "Your Flywheel Digital instance.", "example": "your_flywheel_digital_instance" } }, "description": "" } } }, "flywheel_digital_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/flywheel_digital_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "fone_dynamics_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_sid": { "title": "", "type": "string", "description": "Your Fone Dynamics account SID.", "example": "your_fone_dynamics_account_sid" }, "api_token": { "title": "", "type": "string", "description": "Your Fone Dynamics API token.", "format": "password", "example": "your_fone_dynamics_api_token" } }, "description": "" } } }, "fone_dynamics_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/fone_dynamics_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "forethought_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Forethought API token.", "format": "password", "example": "your_forethought_api_token" } }, "description": "" } } }, "forethought_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/forethought_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "forj_community_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Forj Community API key.", "format": "password", "example": "your_forj_community_api_application_key" }, "api_secret": { "title": "", "type": "string", "description": "Your Forj Community API secret.", "format": "password", "example": "your_forj_community_secret_key" } }, "description": "" } } }, "forj_community_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/forj_community_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "formstack_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Formstack client ID.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Your Formstack client secret.", "format": "password", "example": "string" } }, "description": "" } } }, "formstack_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "formstack_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/formstack_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/formstack_auth_V1" } ] }, "fortnox_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Fortnox client ID.", "example": "your_fortnox_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Fortnox client secret.", "format": "password", "example": "your_fortnox_client_secret" }, "scopes": { "title": "", "type": "string", "description": "Your Fortnox app scopes.", "example": "your_fortnox_scopes" } }, "description": "" } } }, "fortnox_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "fortnox_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/fortnox_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/fortnox_auth_V1" } ] }, "fountain_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Fountain API token.", "format": "password", "example": "your_fountain_api_token" }, "sub_domain": { "title": "", "type": "string", "description": "Your Fountain subdomain.", "example": "your_fountain_subdomain" }, "url_format": { "type": "object", "description": "Your Fountain URL format.", "enum": [ "api/v2", "v2" ] } }, "description": "" } } }, "fountain_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/fountain_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "fourkites_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your FourKites API key.", "format": "password", "example": "your_fourkites_api_key" } }, "description": "" } } }, "fourkites_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/fourkites_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "freightview_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_type": { "type": "object", "description": "Your Freightview account type.", "enum": [ "freightview.com", "freightview.dev" ] }, "api_key": { "title": "", "type": "string", "description": "Your Freightview API key.", "format": "password", "example": "string" } }, "description": "" } } }, "freightview_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/freightview_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "freshbooks_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "freshbooks_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your FreshBooks Access Token.", "format": "password", "example": "freshbooks_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "Your FreshBooks application client access." }, "refresh_token": { "title": "", "type": "string", "description": "Your FreshBooks Refresh Token.", "format": "password", "example": "freshbooks_refresh_token" } }, "description": "" } } }, "freshbooks_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/freshbooks_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/freshbooks_auth_V1" } ] }, "freshchat_config_V1": { "properties": { "config": { "type": "object", "properties": { "bearer_token": { "title": "", "type": "string", "description": "Your Freshchat API Token.", "format": "password", "example": "your_api_token" }, "sub_domain": { "title": "", "type": "string", "description": "Your Freshchat Sub Domain", "example": "sub_domain" } }, "description": "" } } }, "freshchat_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/freshchat_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "freshdesk_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Freshdesk API Key.", "format": "password", "example": "your_api_key" }, "subdomain": { "title": "", "type": "string", "description": "Your company's freshdesk subdomain (usually **company**.freshdesk.com).", "example": "company_name" } }, "description": "" } } }, "freshdesk_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/freshdesk_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "freshdesk_contact_center_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_name": { "title": "", "type": "string", "description": "Your Freshdesk Contact Center account name.", "example": "your_account_name" }, "api_key": { "title": "", "type": "string", "description": "Your Freshdesk Contact Center API key.", "format": "password", "example": "your_api_key" } }, "description": "" } } }, "freshdesk_contact_center_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/freshdesk_contact_center_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "freshsales_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Freshsales API key.", "format": "password", "example": "your_freshsales_api_key" }, "base_url": { "type": "object", "description": "Your Freshsales product.", "enum": [ "myfreshworks.com/crm/sales", "freshsales.io" ] }, "subdomain": { "title": "", "type": "string", "description": "Your Freshsales domain.", "example": "your_freshsales_domain" } }, "description": "" } } }, "freshsales_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/freshsales_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "freshservice_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Freshservice API Key.", "format": "password", "example": "your_api_key" }, "subdomain": { "title": "", "type": "string", "description": "Your company's freshservice subdomain (usually **company**.freshservice.com).", "example": "company_name" } }, "description": "" } } }, "freshservice_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/freshservice_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "freshsuccess_config_V1": { "properties": { "config": { "type": "object", "properties": { "api": { "title": "", "type": "string", "description": "Set this parameter to `api`.", "example": "api" }, "api_key": { "title": "", "type": "string", "description": "Your Freshsuccess API key.", "format": "password", "example": "your_freshsuccess_api_key" }, "subdomain": { "title": "", "type": "string", "description": "Your Freshsuccess subdomain.", "example": "your_freshsuccess_subdomain" } }, "description": "" } } }, "freshsuccess_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/freshsuccess_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "freshteam_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Freshteam API key.", "format": "password", "example": "your_api_key" }, "base_domain": { "title": "", "type": "string", "description": "Your company's Freshteam base domain name (usually **company**.freshteam.com).", "example": "your_base_domain" } }, "description": "" } } }, "freshteam_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/freshteam_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "friendbuy_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Friendbuy API key.", "example": "your_friendbuy_api_key" }, "api_secret": { "title": "", "type": "string", "description": "Your Friendbuy API secret.", "format": "password", "example": "your_friendbuy_api_secret" } }, "description": "" } } }, "friendbuy_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/friendbuy_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "front_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "front_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Front client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Front client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "front_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/front_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/front_auth_V1" } ] }, "ftp_config_V1": { "properties": { "config": { "type": "object", "properties": { "append_file_option": { "title": "", "type": "object", "description": "If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.", "example": "upsert_file_with_primary_keys | upsert_file | append_file", "enum": [ "upsert_file_with_primary_keys", "upsert_file", "append_file" ] }, "compression": { "title": "", "type": "object", "description": "The secrets that should be passed to the function at runtime.", "example": "zip | gz | tar_gz | tar | infer | gzip | uncompressed | bz2 | tar_bz2", "enum": [ "zip", "gz", "tar_gz", "tar", "infer", "gzip", "uncompressed", "bz2", "tar_bz2" ] }, "connection_method": { "title": "", "type": "object", "description": "The method used to connect to your FTP server. Use `DIRECT` to connect directly, or `PROXY_AGENT` to connect via a Fivetran Proxy Agent.", "example": "PROXY_AGENT | DIRECT", "enum": [ "PROXY_AGENT", "DIRECT" ] }, "delimiter": { "title": "", "type": "string", "description": "You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.", "example": "string" }, "empty_header": { "title": "", "type": "boolean", "description": "Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.", "example": true }, "escape_char": { "title": "", "type": "string", "description": "If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.", "example": "string" }, "extraction_pattern": { "title": "", "type": "string", "description": "Required when `file_mapping_method` = `EXTRACT_TABLES`. A regular expression with a named capture group `(?
...)` to extract table names from file paths.", "example": "(?
\\w+)/.*" }, "file_mapping_method": { "title": "", "type": "object", "description": "The method used to map files to destination tables. Use `DEFINE_PER_TABLE` to manually configure each table with its own file pattern, or `EXTRACT_TABLES` to automatically discover tables based on a single extraction pattern.", "example": "EXTRACT_TABLES | DEFINE_PER_TABLE", "enum": [ "EXTRACT_TABLES", "DEFINE_PER_TABLE" ] }, "file_type": { "title": "", "type": "object", "description": "If your files are saved with improper extensions, you can force them to by synced as the selected file type.", "example": "tsv | xml | csv | spreadsheet | json | jsonl | avro | parquet", "enum": [ "tsv", "xml", "csv", "spreadsheet", "json", "jsonl", "avro", "parquet" ] }, "files": { "title": "", "type": "array", "description": "Required when `file_mapping_method` = `DEFINE_PER_TABLE`. Mapped file name patterns to a destination table.", "items": { "title": "", "type": "object", "properties": { "archive_pattern": { "title": "", "type": "string", "description": "All Files inside of compressed archives with filenames matching this regular expression will be synced.", "example": "string" }, "file_pattern": { "title": "", "type": "string", "description": "All files in your search path matching this regular expression will be synced per table.", "example": "string" }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "table_name": { "title": "", "type": "string", "description": "All files matching the above pattern will be synced to this table.", "example": "string" } }, "description": "Required when `file_mapping_method` = `DEFINE_PER_TABLE`. Mapped file name patterns to a destination table." } }, "host": { "title": "", "type": "string", "description": "FTP host address.", "example": "ftp.company.com" }, "is_secure": { "title": "", "type": "boolean", "description": "Whether the server supports FTPS.", "example": true }, "json_delivery_mode": { "title": "", "type": "object", "description": "Control how your JSON data is delivered into your destination", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "line_separator": { "title": "", "type": "string", "description": "You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.", "example": "string" }, "null_sequence": { "title": "", "type": "string", "description": "If your CSVs use a special value indicating null, you can specify it here.", "example": "string" }, "on_error": { "title": "", "type": "object", "description": "If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.", "example": "fail | skip", "enum": [ "fail", "skip" ] }, "password": { "title": "", "type": "string", "description": "FTP password.", "format": "password", "example": "password" }, "pgp_pass_phrase": { "title": "", "type": "string", "description": "The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.", "format": "password", "example": "" }, "pgp_secret_key": { "title": "", "type": "string", "description": "The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.", "format": "password", "example": "" }, "port": { "title": "", "type": "integer", "description": "FTP port.", "format": "int32", "example": 21 }, "prefix": { "title": "", "type": "string", "description": "The connection will look for files in this folder path. Choose the lowest common folder in a folder hierarchy that includes all the files you want to sync. This defines a specific location where Fivetran scans for files and helps ensure optimal performance.", "example": "files/exports" }, "quote_char": { "title": "", "type": "string", "description": "You can specify the enclosing character used in your CSVs here. Fivetran will consider \" as the quote character if this field is empty and quote_character_enabled is set to true.", "example": "string" }, "quote_character_enabled": { "title": "", "type": "boolean", "description": "If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered \" as quote character.", "example": true }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "signer_public_key": { "title": "", "type": "string", "description": "The contents of the signer's public key file. This is optional — if you don't provide the key, we decrypt the files without verifying their signatures.", "example": "" }, "skip_after": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.", "format": "int32", "example": 0 }, "skip_before": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified before syncing data.", "format": "int32", "example": 0 }, "sync_inconsistent_rows": { "title": "", "type": "boolean", "description": "When enabled, Fivetran syncs rows with fewer or more columns than the header row. For rows with fewer columns, Fivetran adds NULL values for the missing columns. For rows with extra columns, Fivetran names them `column_`. When disabled, Fivetran handles inconsistent rows according to your error-handling settings.", "example": true }, "use_pgp_encryption_options": { "title": "", "type": "boolean", "description": "Set to `true` if files are encrypted using PGP in the S3 bucket. Default value: `false`.", "example": true }, "user": { "title": "", "type": "string", "description": "FTP user.", "example": "user_name" } }, "description": "" } } }, "ftp_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ftp_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table_group" } ] }, "fulfil_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Fulfil API key.", "format": "password", "example": "your_fulfil_api_key" }, "workspace_id": { "title": "", "type": "string", "description": "Your Fulfil workspace ID.", "example": "your_fulfil_workspace_id" } }, "description": "" } } }, "fulfil_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/fulfil_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "fullstory_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Fullstory API key.", "format": "password", "example": "your_api_key" } }, "description": "" } } }, "fullstory_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/fullstory_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "g2_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your G2 API token.", "format": "password", "example": "string" } }, "description": "" } } }, "g2_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/g2_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "gainsight_customer_success_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_key": { "title": "", "type": "string", "description": "The API key for API authentication.", "format": "password", "example": "test_api_key" }, "authentication_method": { "title": "", "type": "object", "description": "The authentication method to use. Can be either OAUTH or API_KEY.", "example": "API_KEY | OAUTH", "enum": [ "API_KEY", "OAUTH" ] }, "sub_domain": { "title": "", "type": "string", "description": "The subdomain of your Gainsight Customer Success account.", "example": "test_sub_domain" } }, "description": "" } } }, "gainsight_customer_success_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "gainsight_customer_success_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/gainsight_customer_success_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/gainsight_customer_success_auth_V1" } ] }, "gainsight_product_experience_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Gainsight Product Experience API key.", "format": "password", "example": "your_gainsight_product_experience_api_key" }, "sub_domain": { "type": "object", "description": "Your Gainsight Product Experience subdomain.", "enum": [ "https://api-us2.aptrinsic.com", "https://api-eu.aptrinsic.com", "https://api.aptrinsic.com" ] } }, "description": "" } } }, "gainsight_product_experience_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/gainsight_product_experience_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "gcs_config_V1": { "properties": { "config": { "type": "object", "properties": { "append_file_option": { "title": "", "type": "object", "description": "If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.", "example": "upsert_file_with_primary_keys | upsert_file | append_file", "enum": [ "upsert_file_with_primary_keys", "upsert_file", "append_file" ] }, "auth_type": { "title": "", "type": "object", "description": "Authorization type. Required for storage bucket authentication.", "example": "FIVETRAN_SERVICE_ACCOUNT | CUSTOM_SERVICE_ACCOUNT", "enum": [ "FIVETRAN_SERVICE_ACCOUNT", "CUSTOM_SERVICE_ACCOUNT" ] }, "bucket": { "title": "", "type": "string", "description": "The name of the GCS bucket.", "example": "bucket_name" }, "compression": { "title": "", "type": "object", "description": "The secrets that should be passed to the function at runtime.", "example": "zip | gz | tar_gz | tar | infer | gzip | uncompressed | bz2 | tar_bz2", "enum": [ "zip", "gz", "tar_gz", "tar", "infer", "gzip", "uncompressed", "bz2", "tar_bz2" ] }, "delimiter": { "title": "", "type": "string", "description": "You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.", "example": "string" }, "empty_header": { "title": "", "type": "boolean", "description": "Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.", "example": true }, "escape_char": { "title": "", "type": "string", "description": "If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.", "example": "string" }, "extraction_pattern": { "title": "", "type": "string", "description": "Required when `file_mapping_method` = `EXTRACT_TABLES`. A regular expression with a named capture group `(?
...)` to extract table names from file paths.", "example": "(?
\\w+)/.*" }, "file_mapping_method": { "title": "", "type": "object", "description": "The method used to map files to destination tables. Use `DEFINE_PER_TABLE` to manually configure each table with its own file pattern, or `EXTRACT_TABLES` to automatically discover tables based on a single extraction pattern.", "example": "EXTRACT_TABLES | DEFINE_PER_TABLE", "enum": [ "EXTRACT_TABLES", "DEFINE_PER_TABLE" ] }, "file_type": { "title": "", "type": "object", "description": "If your files are saved with improper extensions, you can force them to by synced as the selected file type.", "example": "tsv | xml | csv | spreadsheet | json | jsonl | avro | parquet", "enum": [ "tsv", "xml", "csv", "spreadsheet", "json", "jsonl", "avro", "parquet" ] }, "files": { "title": "", "type": "array", "description": "Required when `file_mapping_method` = `DEFINE_PER_TABLE`. Mapped file name patterns to a destination table.", "items": { "title": "", "type": "object", "properties": { "archive_pattern": { "title": "", "type": "string", "description": "All Files inside of compressed archives with filenames matching this regular expression will be synced.", "example": "string" }, "file_pattern": { "title": "", "type": "string", "description": "All files in your search path matching this regular expression will be synced per table.", "example": "string" }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "table_name": { "title": "", "type": "string", "description": "All files matching the above pattern will be synced to this table.", "example": "string" } }, "description": "Required when `file_mapping_method` = `DEFINE_PER_TABLE`. Mapped file name patterns to a destination table." } }, "json_delivery_mode": { "title": "", "type": "object", "description": "Control how your JSON data is delivered into your destination", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "line_separator": { "title": "", "type": "string", "description": "You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.", "example": ";" }, "non_standard_escape_char": { "title": "", "type": "boolean", "description": "Use this if your CSV generator uses non-standard ways of escaping characters. Default value: `false`.", "example": true }, "null_sequence": { "title": "", "type": "string", "description": "If your CSVs use a special value indicating null, you can specify it here.", "example": "string" }, "on_error": { "title": "", "type": "object", "description": "If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.", "example": "fail | skip", "enum": [ "fail", "skip" ] }, "pgp_pass_phrase": { "title": "", "type": "string", "description": "The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.", "format": "password", "example": "" }, "pgp_secret_key": { "title": "", "type": "string", "description": "The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.", "format": "password", "example": "" }, "prefix": { "title": "", "type": "string", "description": "The connection will look for files in this folder path. Choose the lowest common folder in a folder hierarchy that includes all the files you want to sync. This defines a specific location where Fivetran scans for files and helps ensure optimal performance.", "example": "files/exports" }, "quote_char": { "title": "", "type": "string", "description": "You can specify the enclosing character used in your CSVs here. Fivetran will consider \" as the quote character if this field is empty and quote_character_enabled is set to true.", "example": "string" }, "quote_character_enabled": { "title": "", "type": "boolean", "description": "If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered \" as quote character.", "example": true }, "secret_key": { "title": "", "type": "string", "description": "Your JSON Private Key. Used to authorize service account. Required if you use a Custom Service Account to authenticate the storage bucket.", "format": "password", "example": "secret_key" }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "signer_public_key": { "title": "", "type": "string", "description": "The contents of the signer's public key file. This is optional — if you don't provide the key, we decrypt the files without verifying their signatures.", "example": "" }, "skip_after": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.", "format": "int32", "example": 0 }, "skip_before": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified before syncing data.", "format": "int32", "example": 0 }, "sync_inconsistent_rows": { "title": "", "type": "boolean", "description": "When enabled, Fivetran syncs rows with fewer or more columns than the header row. For rows with fewer columns, Fivetran adds NULL values for the missing columns. For rows with extra columns, Fivetran names them `column_`. When disabled, Fivetran handles inconsistent rows according to your error-handling settings.", "example": true }, "use_pgp_encryption_options": { "title": "", "type": "boolean", "description": "Set to `true` if files are encrypted using PGP in the GCS bucket. Default value: `false`.", "example": true } }, "description": "" } } }, "gcs_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/gcs_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table_group" } ] }, "gem_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Gem API key.", "format": "password", "example": "your_gem_api_key" } }, "description": "" } } }, "gem_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/gem_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "genesys_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_to_sync_conversation_analytics_data": { "type": "object", "description": "Choose the Genesys API you want to use to sync conversation analytics data. Export API retrieves conversation records via an asynchronous export job and is recommended for historical data. Aggregate Query API fetches data using the analytics aggregate query endpoint and produces a different set of tables and schemas. You cannot change this value after you set up the connection.", "enum": [ "export_api", "aggregate_query_api" ] }, "client_id": { "title": "", "type": "string", "description": "Your Genesys client ID.", "example": "your_genesys_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Genesys client secret.", "format": "password", "example": "your_genesys_client_secret" }, "sub_domain": { "title": "", "type": "string", "description": "Your Genesys subdomain.", "example": "your_genesys_sub_domain" } }, "description": "" } } }, "genesys_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/genesys_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "getfeedback_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your GetFeedback Access token.", "format": "password", "example": "your_getfeedback_access_token" }, "region": { "type": "object", "description": "Your GetFeedback region.", "enum": [ "api.eu", "api" ] } }, "description": "" } } }, "getfeedback_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/getfeedback_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "github_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_mode": { "title": "", "type": "object", "description": "Authorization type.", "example": "JWT | PersonalAccessToken | OAuth", "enum": [ "JWT", "PersonalAccessToken", "OAuth" ] }, "client_id": { "title": "", "type": "string", "description": "GitHub App Client ID", "example": "string" }, "default_branch_only": { "title": "", "type": "boolean", "description": "Set to `true` to include commits only from the default branch.", "example": true }, "host_url": { "title": "", "type": "string", "description": "The GHES instance host address. Only for on-premises installations.", "example": "github.mycompany.com/api/v3" }, "pats": { "title": "", "type": "array", "description": "The `Personal Access Tokens`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "private_key": { "title": "", "type": "string", "description": "Your Private Key", "format": "password", "example": "string" }, "repositories": { "title": "", "type": "array", "description": "Specific Repository IDs to sync. Must be populated if `syncMode` is set to `SpecificRepositories`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all repositories or specific repositories.", "example": "SpecificRepositories | AllRepositories", "enum": [ "SpecificRepositories", "AllRepositories" ] }, "use_webhooks": { "title": "", "type": "boolean", "description": "Set to `true` to capture deletes.", "example": true }, "username": { "title": "", "type": "string", "description": "`Login` of your GitHub profile.", "example": "string" } }, "description": "" } } }, "github_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/github_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "gitlab_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth": { "type": "object", "description": "Your GitLab auth type.", "enum": [ "oauth_2", "personal_access_token" ] }, "base_url": { "type": "object", "description": "Your GitLab base URL.", "enum": [ "", "gitlab.com" ] }, "client_certificate": { "title": "", "type": "string", "description": "Your GitLab client certificate content.", "format": "password", "example": "your_gitlab_client_certificate" }, "client_private_key": { "title": "", "type": "string", "description": "Your GitLab client private key content.", "format": "password", "example": "your_gitlab_client_private_key" }, "custom_base_url": { "title": "", "type": "string", "description": "Your GitLab custom base URL.", "example": "your_gitlab_custom_base_url" }, "enable_mtls_connection": { "title": "", "type": "string", "description": "The confirmation that you have allowed Fivetran to connect with your self-hosted instance. Possible values: `true`, `false`.", "example": "true" }, "personal_access_token": { "title": "", "type": "string", "description": "Your GitLab personal access token.", "format": "password", "example": "your_gitlab_personal_access_token" } }, "description": "" } } }, "gitlab_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your GitLab access token.", "format": "password", "example": "gitlab_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "Your GitLab client access." }, "refresh_token": { "title": "", "type": "string", "description": "Your GitLab refresh token.", "format": "password", "example": "gitlab_refresh_token" } }, "description": "" } } }, "gitlab_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/gitlab_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/gitlab_auth_V1" } ] }, "gladly_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Gladly API Token.", "format": "password", "example": "your_gladly_api_token" }, "organization": { "title": "", "type": "string", "description": "Your Gladly Organization Name.", "example": "your_gladly_organization_name" }, "username": { "title": "", "type": "string", "description": "Your Gladly Username.", "example": "your_gladly_username" } }, "description": "" } } }, "gladly_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/gladly_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "globalmeet_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your GlobalMeet Password.", "format": "password", "example": "your_globalmeet_password" }, "username": { "title": "", "type": "string", "description": "Your GlobalMeet Username.", "example": "your_globalmeet_username" } }, "description": "" } } }, "globalmeet_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/globalmeet_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "gmail_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "gmail_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The `Access Token` that carries the information necessary for API resources to fetch data.", "format": "password", "example": "gmail_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Gmail client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Gmail client application.", "format": "password", "example": "my_client_secret" } }, "description": "Your application client access fields" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` of your Gmail client application.", "format": "password", "example": "gmail_refresh_token" } }, "description": "" } } }, "gmail_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/gmail_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/gmail_auth_V1" } ] }, "gocardless_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your GoCardless API token.", "format": "password", "example": "your_gocardless_access_token" }, "sandbox_account": { "type": "object", "description": "Your GoCardless account type.", "enum": [ "api", "api-sandbox" ] } }, "description": "" } } }, "gocardless_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/gocardless_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "gofundme_pro_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Client ID of the API application in your GoFundMe Pro account.", "example": "your_gofundme_pro_api_app_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Client secret of the API application in your GoFundMe Pro account.", "format": "password", "example": "your_gofundme_pro_api_app_client_secret" } }, "description": "" } } }, "gofundme_pro_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/gofundme_pro_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "goldcast_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Goldcast API key.", "format": "password", "example": "your_goldcast_api_key" } }, "description": "" } } }, "goldcast_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/goldcast_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "gongio_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_key": { "title": "", "type": "string", "description": "Your Gongio Access key.", "format": "password", "example": "your_gong_api_access_key" }, "access_key_secret": { "title": "", "type": "string", "description": "Your Gongio Access Key Secret.", "format": "password", "example": "your_gong_api_access_key_secret" }, "api_base_url": { "title": "", "type": "string", "description": "Your Gong API Base URL.", "example": "your_gong_api_base_url" } }, "description": "" } } }, "gongio_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/gongio_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "google_ads_config_V1": { "properties": { "config": { "type": "object", "properties": { "accounts": { "title": "", "type": "array", "description": "The list of Account IDs to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "auth_type": { "title": "", "type": "object", "description": "Authentication used by client to authenticate with google", "example": "OAUTH2 | FIVETRAN_SERVICE_ACCOUNT", "enum": [ "OAUTH2", "FIVETRAN_SERVICE_ACCOUNT" ] }, "conversion_window_size": { "title": "", "type": "integer", "description": "A period of time in days during which a conversion is recorded.", "format": "int32", "example": 30 }, "customer_id": { "title": "", "type": "string", "description": "ID of the customer, can be retrieved from your AdWords dashboard.", "example": "xxx-xxx-xxxx" }, "manager_accounts": { "title": "", "type": "array", "description": "The list of the Manager Account IDs whose clients will be synced. Must be populated if `sync_mode` is set to `ManagerAccounts`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "reports": { "title": "", "type": "array", "description": "The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.", "items": { "title": "", "type": "object", "properties": { "fields": { "title": "", "type": "array", "description": "A list of the fields to sync. Must be populated if `config_type` is set to `Custom`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_type": { "title": "", "type": "string", "description": "The name of the Google Ads report from which the connector will sync the data. [Possible report_type values](https://developers.google.com/adwords/api/docs/appendix/reports#report-types).", "example": "campaign" }, "table": { "title": "", "type": "string", "description": "The table name within the schema to which connector will sync the data of the specific report.", "example": "table_2" } }, "description": "The list of reports. Each report corresponds to a table within the schema to which connector will sync the data." } }, "skip_empty_reports": { "title": "", "type": "boolean", "description": "Toggles the [\"Skip empty reports\"](/docs/connectors/applications/google-ads#skipemptyreports) feature. Enabled by default", "example": true }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all accounts or specific accounts.", "example": "ManagerAccounts | AllAccounts | SpecificAccounts", "enum": [ "ManagerAccounts", "AllAccounts", "SpecificAccounts" ] }, "timeframe_months": { "title": "", "type": "object", "description": "The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled custom and prebuilt reports during the next connector sync. Default value: `TWELVE`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "google_ads_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Google Ads client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Google Ads client application.", "example": "my_client_secret" }, "developer_token": { "title": "", "type": "string", "description": "Not required. You can provide your own developer token with your custom client.", "example": "string" }, "user_agent": { "title": "", "type": "string", "description": "Your company's name in your Google Ads client application.", "example": "my_company_name" } }, "description": "We use a Fivetran developer token to access the Google Ads API. If this is your first Google Ads connector with custom authorization, you should create a new Google API Console project. Each Google API Console project can be associated with the developer token from only one manager account. Once you make a Google Ads API request, the developer token is permanently paired to the Google API Console project. Otherwise, we can't bind the Fivetran developer token to your client. You can reuse the same project to create other Google Ads connectors. You can use your own developer token with your custom client if you have one, but it's not required" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "google_ads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_ads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/google_ads_auth_V1" } ] }, "google_analytics_4_config_V1": { "properties": { "config": { "type": "object", "properties": { "accounts": { "title": "", "type": "array", "description": "The list of specific Account IDs to sync. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "auth_type": { "title": "", "type": "object", "description": "Authentication used by client to authenticate with google", "example": "OAUTH2 | FIVETRAN_SERVICE_ACCOUNT", "enum": [ "OAUTH2", "FIVETRAN_SERVICE_ACCOUNT" ] }, "properties": { "title": "", "type": "array", "description": "The array of strings in the `properties/{id}` format where `id` is a Google Analytics 4 property identifier. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "reports": { "title": "", "type": "array", "description": "The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.", "items": { "title": "", "type": "object", "properties": { "config_type": { "title": "", "type": "object", "description": "Whether to use the Prebuilt Reports or Custom Reports.", "example": "CUSTOM | PREBUILT", "enum": [ "CUSTOM", "PREBUILT" ] }, "dimensions": { "title": "", "type": "array", "description": "The report dimensions to include into a sync.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "filter_field_name": { "title": "", "type": "string", "description": "The dimension name to filter on.", "example": "browser" }, "filter_type": { "title": "", "type": "object", "description": "Filter type for reports request. Possible values are INCLUDE and EXCLUDE", "example": "EXCLUDE | INCLUDE", "enum": [ "EXCLUDE", "INCLUDE" ] }, "filter_value": { "title": "", "type": "string", "example": "string" }, "filters": { "title": "", "type": "array", "description": "The list of filters to apply to the report data.", "items": { "title": "", "type": "object", "properties": { "filter_dimension": { "title": "", "type": "string", "description": "The dimension name to filter on.", "example": "string" }, "filter_type": { "title": "", "type": "object", "description": "Filter type for reports request. Possible values are INCLUDE and EXCLUDE", "example": "EXCLUDE | INCLUDE", "enum": [ "EXCLUDE", "INCLUDE" ] }, "filter_value": { "title": "", "type": "string", "description": "The filter value.", "example": "string" }, "filter_values": { "title": "", "type": "array", "description": "The filter values for EXACT match type.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "match_type": { "title": "", "type": "object", "description": "The filter match type.", "example": "EXACT | CONTAINS", "enum": [ "EXACT", "CONTAINS" ] } }, "description": "The list of filters to apply to the report data." } }, "metrics": { "title": "", "type": "array", "description": "The report metrics to include into a sync.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "prebuilt_report": { "title": "", "type": "object", "description": "The name of the Prebuilt Report from which the connector will sync the data.", "example": "USER_ACQUISITION_FIRST_USER_MEDIUM_REPORT", "enum": [ "ECOMMERCE_PURCHASES_ITEM_CATEGORY_5_REPORT", "USER_ACQUISITION_FIRST_USER_GOOGLE_ADS_AD_GROUP_NAME_REPORT", "TRAFFIC_ACQUISITION_SESSION_SOURCE_PLATFORM_REPORT", "USER_ACQUISITION_FIRST_USER_GOOGLE_ADS_NETWORK_TYPE_REPORT", "ECOMMERCE_PURCHASES_ITEM_CATEGORY_REPORT", "USER_ACQUISITION_FIRST_USER_CAMPAIGN_REPORT", "TECH_BROWSER_REPORT", "AUDIENCES_REPORT", "CONVERSIONS_REPORT", "USER_ACQUISITION_FIRST_USER_MEDIUM_REPORT", "ECOMMERCE_PURCHASES_ITEM_ID_REPORT", "USER_ACQUISITION_FIRST_USER_SOURCE_PLATFORM_REPORT", "TECH_SCREEN_RESOLUTION_REPORT", "PAGES_PATH_REPORT", "PAGES_TITLE_AND_SCREEN_NAME_REPORT", "DEMOGRAPHIC_CITY_REPORT", "DEMOGRAPHIC_LANGUAGE_REPORT", "TRAFFIC_ACQUISITION_SESSION_DEFAULT_CHANNEL_GROUPING_REPORT", "ECOMMERCE_PURCHASES_ITEM_CATEGORY_REPORT_COMBINED", "TECH_OPERATING_SYSTEM_REPORT", "DEMOGRAPHIC_AGE_REPORT", "ECOMMERCE_PURCHASES_ITEM_CATEGORY_3_REPORT", "TECH_OS_WITH_VERSION_REPORT", "PAGES_TITLE_AND_SCREEN_CLASS_REPORT", "DEMOGRAPHIC_REGION_REPORT", "ECOMMERCE_PURCHASES_ITEM_BRAND_REPORT", "TECH_PLATFORM_DEVICE_CATEGORY_REPORT", "USER_ACQUISITION_FIRST_USER_SOURCE_REPORT", "TRAFFIC_ACQUISITION_SESSION_CAMPAIGN_REPORT", "EVENTS_REPORT", "DEMOGRAPHIC_COUNTRY_REPORT", "TRAFFIC_ACQUISITION_SESSION_SOURCE_REPORT", "TRAFFIC_ACQUISITION_SESSION_SOURCE_MEDIUM_REPORT", "DEMOGRAPHIC_GENDER_REPORT", "TECH_DEVICE_CATEGORY_REPORT", "PUBLISHER_ADS_PAGE_PATH_REPORT", "USER_ACQUISITION_FIRST_USER_SOURCE_MEDIUM_REPORT", "TRAFFIC_ACQUISITION_SESSION_MEDIUM_REPORT", "TECH_DEVICE_MODEL_REPORT", "PUBLISHER_ADS_AD_FORMAT_REPORT", "TECH_PLATFORM_REPORT", "TECH_OS_VERSION_REPORT", "TECH_APP_VERSION_REPORT", "DEMOGRAPHIC_INTERESTS_REPORT", "ECOMMERCE_PURCHASES_ITEM_CATEGORY_2_REPORT", "PUBLISHER_ADS_AD_SOURCE_REPORT", "ECOMMERCE_PURCHASES_ITEM_NAME_REPORT", "PUBLISHER_ADS_AD_UNIT_REPORT", "ECOMMERCE_PURCHASES_ITEM_CATEGORY_4_REPORT", "CONTENT_GROUP_REPORT" ] }, "rollback_window": { "title": "", "type": "integer", "description": "The custom window size for rollback syncs.", "format": "int32", "example": 15 }, "table": { "title": "", "type": "string", "description": "The table name within the schema to which connector will sync the data of the specific report.", "example": "table_2" }, "time_aggregation_granularity": { "title": "", "type": "object", "description": "The report data aggregation time granularity.", "example": "YEARLY | WEEKLY | DAILY | MONTHLY", "enum": [ "YEARLY", "WEEKLY", "DAILY", "MONTHLY" ] } }, "description": "The list of reports. Each report corresponds to a table within the schema to which connector will sync the data." } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all accounts or specific accounts.", "example": "ALL_ACCOUNTS | SPECIFIC_ACCOUNTS", "enum": [ "ALL_ACCOUNTS", "SPECIFIC_ACCOUNTS" ] }, "timeframe_months": { "title": "", "type": "object", "description": "The number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. The default value: `TWELVE`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "google_analytics_4_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Google Analytics client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Google Analytics client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "google_analytics_4_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_analytics_4_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/google_analytics_4_auth_V1" } ] }, "google_analytics_4_export_config_V1": { "properties": { "config": { "type": "object", "properties": { "bucket_name": { "title": "", "type": "string", "description": "The name of the bucket.", "example": "test_bucket_name" }, "dataset_id": { "title": "", "type": "string", "description": "The Dataset ID.", "example": "test_dataset_id" }, "list_sync_mode": { "title": "", "type": "object", "description": "The Sync Mode", "example": "COLUMNS | JSON", "enum": [ "COLUMNS", "JSON" ] }, "project_id": { "title": "", "type": "string", "description": "The Project ID.", "example": "test_project_id" }, "sync_tables": { "title": "", "type": "object", "description": "Sync Table", "example": "DAILY_ONLY | FRESH_DAILY | STREAMING", "enum": [ "DAILY_ONLY", "FRESH_DAILY", "STREAMING" ] } }, "description": "" } } }, "google_analytics_4_export_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_analytics_4_export_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "google_business_profile_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "google_business_profile_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Google Business Profile Access token.", "format": "password", "example": "google_business_profile_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "Your Google Business Profile Refresh token.", "format": "password", "example": "google_business_profile_refresh_token" } }, "description": "" } } }, "google_business_profile_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_business_profile_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/google_business_profile_auth_V1" } ] }, "google_calendar_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "google_calendar_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Google Calendar access token.", "format": "password", "example": "google_calendar_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "Your Google Calendar refresh token.", "format": "password", "example": "google_calendar_refresh_token" } }, "description": "" } } }, "google_calendar_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_calendar_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/google_calendar_auth_V1" } ] }, "google_classroom_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "google_classroom_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The `Access Token` that carries the information necessary for API resources to fetch data.", "format": "password", "example": "google_classroom_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` of your Google Calendar client application.", "format": "password", "example": "google_classroom_refresh_token" } }, "description": "" } } }, "google_classroom_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_classroom_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" }, { "$ref": "#/components/schemas/google_classroom_auth_V1" } ] }, "google_cloud_function_config_V1": { "properties": { "config": { "type": "object", "properties": { "custom_payloads": { "title": "", "type": "array", "description": "The list of key-value pairs that can be used to specify custom information to the function at runtime.", "items": { "title": "", "type": "object", "properties": { "key": { "title": "", "type": "string", "description": "Payload Key", "example": "string" }, "value": { "title": "", "type": "string", "description": "Payload Value", "example": "string" } }, "description": "The list of key-value pairs that can be used to specify custom information to the function at runtime." } }, "function_trigger": { "title": "Function Trigger", "type": "string", "description": "The trigger URL of the cloud function.", "format": "password", "example": "https://-.cloudfunctions.net/" }, "secrets": { "title": "Secrets", "type": "string", "description": "The secrets that should be passed to the function at runtime.", "format": "password", "example": "{\"apiKey\" : \"yourApiKey\"}" }, "secrets_list": { "title": "", "type": "array", "description": "The list of secrets that should be passed to the function at runtime.", "items": { "title": "", "type": "object", "properties": { "key": { "title": "", "type": "string", "description": "Key", "example": "string" }, "value": { "title": "", "type": "string", "description": "Value", "format": "password", "example": "string" } }, "description": "The list of secrets that should be passed to the function at runtime." } } }, "description": "" } } }, "google_cloud_function_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_cloud_function_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "google_cloud_mysql_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Database authentication method", "example": "PASSWORD", "enum": [ "ENTRA_ID", "PASSWORD", "CLIENT_CERTIFICATE", "AWS_IAM" ] }, "client_private_key": { "title": "", "type": "string", "description": "Client Private Key in .pem format.", "format": "password", "example": "string" }, "client_public_certificate": { "title": "", "type": "string", "description": "Client Certificate in .pem format.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "mysqldb" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "mysqlinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 3306 }, "replica_id": { "title": "", "type": "integer", "description": "Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.", "format": "int32", "example": 4573961 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method to detect new or changed rows.
Supported values:
`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified.
`TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.", "example": "BINLOG | TELEPORT", "enum": [ "BINLOG", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "google_cloud_mysql_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "google_cloud_mysql_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_cloud_mysql_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/google_cloud_mysql_esm_keys_config_V1" } ] }, "google_cloud_postgresql_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Database authentication method", "example": "PASSWORD | CLIENT_CERTIFICATE", "enum": [ "PASSWORD", "CLIENT_CERTIFICATE" ] }, "client_private_key": { "title": "", "type": "string", "description": "Client Private Key in .pem format.", "format": "password", "example": "string" }, "client_public_certificate": { "title": "", "type": "string", "description": "Client Certificate in .pem format.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "postgres" }, "delete_capture_enabled": { "title": "", "type": "boolean", "description": "", "example": true }, "entra_app_id": { "title": "", "type": "string", "description": "Registered Application ID (for Entra ID authentication).", "example": "string" }, "entra_tenant_id": { "title": "", "type": "string", "description": "Azure Tenant ID (for Entra ID authentication).", "example": "string" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "postgresinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 5432 }, "publication_name": { "title": "", "type": "string", "description": "Publication name. Specify only for `\"updated_method\": \"WAL_PGOUTPUT\"`.", "example": "string" }, "replication_slot": { "title": "", "type": "string", "description": "Replication slot name. Specify only for `\"updated_method\": \"WAL_PGOUTPUT\"`.", "example": "test_replication_slot" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method to detect new or changed rows.
Specify only for `\"service\": \"postgres\"` or `\"service\": \"postgres_rds\"`.
Supported values:
`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. This is more efficient than the query-based method, but requires more setup and monitoring.
`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns", "example": "QUERY_BASED | WAL_PGOUTPUT", "enum": [ "QUERY_BASED", "WAL_PGOUTPUT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "google_cloud_postgresql_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "google_cloud_postgresql_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_cloud_postgresql_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/google_cloud_postgresql_esm_keys_config_V1" } ] }, "google_cloud_sqlserver_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "sqldb" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "sqlinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 1433 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, only specify when connecting via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, only specify when connecting via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "(Optional) The incremental update method the connector will use. The possible values are `\"TELEPORT\"` or `\"NATIVE_UPDATE\"`. The type defaults to `\"NATIVE_UPDATE\"` if the value is set to `null` or not specified.", "example": "NATIVE_UPDATE | TELEPORT", "enum": [ "NATIVE_UPDATE", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name. For Azure Databases, the format must be `user@domain`.", "example": "test_user" } }, "description": "" } } }, "google_cloud_sqlserver_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name", "example": "USER_KEY" } }, "description": "" } } }, "google_cloud_sqlserver_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_cloud_sqlserver_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/google_cloud_sqlserver_esm_keys_config_V1" } ] }, "google_display_and_video_360_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_type": { "title": "", "type": "object", "description": "Authentication used by client to authenticate with google", "example": "OAUTH2 | FIVETRAN_SERVICE_ACCOUNT", "enum": [ "OAUTH2", "FIVETRAN_SERVICE_ACCOUNT" ] }, "reports": { "title": "", "type": "array", "description": "The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.", "items": { "title": "", "type": "object", "properties": { "advertisers": { "title": "", "type": "array", "description": "The list of advertisers to include into a sync. This parameter only takes effect when `config_method` is set to `CREATE_NEW`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "config_method": { "title": "", "type": "object", "description": "The report configuration method. Specifies whether a new configuration is defined manually or an existing configuration is reused. The default value is `CREATE_NEW`.", "example": "CREATE_NEW | REUSE_EXISTING", "enum": [ "CREATE_NEW", "REUSE_EXISTING" ] }, "dimensions": { "title": "", "type": "array", "description": "The report dimensions (filters) to include into a sync. The dimension names are provided in the API format. This is a required parameter when `config_method` is set to `CREATE_NEW`.
NOTE: At least one of the following date dimensions must be included for report data aggregation: `FILTER_DATE` (daily), `FILTER_WEEK` (weekly), or `FILTER_MONTH` (monthly).", "example": "FILTER_ADVERTISER", "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "metrics": { "title": "", "type": "array", "description": "The report metrics to include into a sync. The metric names are provided in the API format. This is a required parameter when `config_method` is set to `CREATE_NEW`.", "example": "METRIC_CLICKS", "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "partners": { "title": "", "type": "array", "description": "The list of partners to include into a sync. This parameter only takes effect when `config_method` is set to `CREATE_NEW`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "query_id": { "title": "", "type": "string", "description": "The ID of the query whose configuration you want to reuse. This is a required parameter when `config_method` is set to `REUSE_EXISTING`.", "example": "123456789" }, "report_type": { "title": "", "type": "object", "description": "The type of the report to create. This is a required parameter when `config_method` is set to `CREATE_NEW`.", "example": "REACH | FLOODLIGHT | FULL_PATH | INVENTORY_AVAILABILITY | REPORT_TYPE_UNSPECIFIED | GRP | PATH_ATTRIBUTION | UNIQUE_REACH_AUDIENCE | YOUTUBE_PROGRAMMATIC_GUARANTEED | YOUTUBE | STANDARD | AUDIENCE_COMPOSITION", "enum": [ "REACH", "FLOODLIGHT", "FULL_PATH", "INVENTORY_AVAILABILITY", "REPORT_TYPE_UNSPECIFIED", "GRP", "PATH_ATTRIBUTION", "UNIQUE_REACH_AUDIENCE", "YOUTUBE_PROGRAMMATIC_GUARANTEED", "YOUTUBE", "STANDARD", "AUDIENCE_COMPOSITION" ] }, "split_by_advertiser": { "title": "", "type": "boolean", "description": "If enabled, the report will be queried separately for each advertiser, and the FILTER_ADVERTISER dimension will be added automatically if not already selected. This parameter only takes effect when `config_method` is set to `CREATE_NEW`. The default value is `false`.", "example": true }, "table_name": { "title": "", "type": "string", "description": "The table name within the schema to which connector will sync the data of the specific report.", "example": "table_2" }, "update_config_on_each_sync": { "title": "", "type": "boolean", "description": "Specifies whether the configuration is updated before each sync or only when the connector settings are saved. This parameter only takes effect when `config_method` is set to `REUSE_EXISTING`. The default value is `true`.", "example": true } }, "description": "The list of reports. Each report corresponds to a table within the schema to which connector will sync the data." } }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync.
NOTE: The more months of reporting data you sync, the longer your initial sync will take.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "google_display_and_video_360_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Google Display & Video 360 client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Google Display & Video 360 client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "google_display_and_video_360_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_display_and_video_360_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" }, { "$ref": "#/components/schemas/google_display_and_video_360_auth_V1" } ] }, "google_drive_config_V1": { "properties": { "config": { "type": "object", "properties": { "append_file_option": { "title": "", "type": "object", "description": "If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.", "example": "upsert_file_with_primary_keys | upsert_file | append_file", "enum": [ "upsert_file_with_primary_keys", "upsert_file", "append_file" ] }, "compression": { "title": "", "type": "object", "description": "The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.", "example": "zip | gz | tar_gz | tar | infer | gzip | uncompressed | bz2 | tar_bz2", "enum": [ "zip", "gz", "tar_gz", "tar", "infer", "gzip", "uncompressed", "bz2", "tar_bz2" ] }, "delimiter": { "title": "", "type": "string", "description": "You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.", "example": "|" }, "empty_header": { "title": "", "type": "boolean", "description": "Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.", "example": true }, "escape_char": { "title": "", "type": "string", "description": "If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.", "example": "escape_char" }, "export_native_types_as_pdf": { "title": "", "type": "boolean", "description": "Optional. Set to true to export your Google Docs and Slides as PDF documents. By default, we export Google Docs and Slides as .docx and .pptx files, respectively.", "example": true }, "file_handling": { "title": "", "type": "object", "description": "Files will be processed and synced according to the selected file handling option. Supported values:
`structured`- (Default) Extract structured data into destination tables for analysis. Commonly used.
`unstructured`- Replicate files in their original format. Best for PDFs, images, and other unstructured content. Learn more about unstructured file replication in our [documentation.](/docs/using-fivetran/features/unstructured-file-replication).", "example": "structured", "enum": [ "unstructured", "structured" ] }, "file_type": { "title": "", "type": "object", "description": "If your files are saved with improper extensions, you can force them to be synced as the selected filetype.", "example": "tsv | xml | csv | spreadsheet | json | jsonl | avro | parquet", "enum": [ "tsv", "xml", "csv", "spreadsheet", "json", "jsonl", "avro", "parquet" ] }, "files": { "title": "", "type": "array", "description": "Mapped file name patterns to a destination table.", "items": { "title": "", "type": "object", "properties": { "archive_pattern": { "title": "", "type": "string", "description": "All Files inside of compressed archives with filenames matching this regular expression will be synced.", "example": "string" }, "file_pattern": { "title": "", "type": "string", "description": "All files in your search path matching this regular expression will be synced per table.", "example": "string" }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "table_name": { "title": "", "type": "string", "description": "All files matching the above pattern will be synced to this table.", "example": "string" } }, "description": "Mapped file name patterns to a destination table." } }, "folder_id": { "title": "", "type": "string", "description": "Folder URL", "example": "folder_id" }, "is_single_table_mode": { "title": "", "type": "boolean", "description": "Allows the creation of connector using Merge Mode strategy.", "example": true }, "json_delivery_mode": { "title": "", "type": "object", "description": "Control how your JSON data is delivered into your destination", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "line_separator": { "title": "", "type": "string", "description": "You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.", "example": ";" }, "null_sequence": { "title": "", "type": "string", "description": "If your CSVs use a special value indicating null, you can specify it here.", "example": "string" }, "on_error": { "title": "", "type": "object", "description": "If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.", "example": "fail | skip", "enum": [ "fail", "skip" ] }, "prefix": { "title": "", "type": "string", "description": "The connection will look for files in the folder of the URL you provide. Choose the lowest common folder in a folder hierarchy that includes all the files you want to sync. This defines a specific location where Fivetran scans for files and helps ensure optimal performance.", "example": "folder_link_url" }, "quote_char": { "title": "", "type": "string", "description": "You can specify the enclosing character used in your CSVs here. Fivetran will consider \" as the quote character if this field is empty and quote_character_enabled is set to true.", "example": "string" }, "quote_character_enabled": { "title": "", "type": "boolean", "description": "If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered \" as quote character.", "example": true }, "skip_after": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.", "format": "int32", "example": 0 }, "skip_before": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified before syncing data.", "format": "int32", "example": 0 }, "sync_inconsistent_rows": { "title": "", "type": "boolean", "description": "When enabled, Fivetran syncs rows with fewer or more columns than the header row. For rows with fewer columns, Fivetran adds NULL values for the missing columns. For rows with extra columns, Fivetran names them `column_`. When disabled, Fivetran handles inconsistent rows according to your error-handling settings.", "example": true }, "sync_nested_files": { "title": "", "type": "boolean", "description": "Optional. Set to true to sync files from nested folders within the specified folder.", "example": true }, "sync_permissions": { "title": "", "type": "boolean", "description": "Optional. Set to true to sync per-user file access permissions to control visibility in downstream applications.", "example": true } }, "description": "" } } }, "google_drive_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_drive_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table_group" } ] }, "google_play_config_V1": { "properties": { "config": { "type": "object", "properties": { "bucket": { "title": "", "type": "string", "description": "The Google Cloud Storage source bucket.", "example": "bucket_name" } }, "description": "" } } }, "google_play_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "authentication_method": { "title": "", "type": "object", "description": "Authentication Method", "example": "OAUTH", "enum": [ "FIVETRAN_SERVICE_ACCOUNT", "CUSTOM_SERVICE_ACCOUNT", "OAUTH" ] }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Google Play client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Google Play client application.", "example": "my_client_secret" } }, "description": "Your application client access fields." }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" }, "svc_acc_secret_key": { "title": "", "type": "string", "description": "Service account secret key", "example": "string" } }, "description": "" } } }, "google_play_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_play_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/google_play_auth_V1" } ] }, "google_search_ads_360_config_V1": { "properties": { "config": { "type": "object", "properties": { "accounts": { "title": "", "type": "array", "description": "Specific accounts to sync. Must be populated if `accountsSyncMode` is set to `SPECIFIC_ACCOUNTS`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "accounts_sync_mode": { "title": "", "type": "object", "description": "Whether to sync all accounts or specific.", "example": "ALL_ACCOUNTS | SPECIFIC_ACCOUNTS", "enum": [ "ALL_ACCOUNTS", "SPECIFIC_ACCOUNTS" ] }, "advertisers": { "title": "", "type": "array", "description": "Specific advertisers to sync. Must be populated if `advertisersSyncMode` is set to `SPECIFIC_ADVERTISERS`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "advertisers_sync_mode": { "title": "", "type": "object", "description": "Whether to sync all or specific advertisers.", "example": "ALL_ADVERTISERS", "enum": [ "SPECIFIC_ADVERTISERS", "ALL_ADVERTISERS" ] }, "auth_type": { "title": "", "type": "object", "description": "Authentication used by client to authenticate with google", "example": "OAUTH2 | FIVETRAN_SERVICE_ACCOUNT", "enum": [ "OAUTH2", "FIVETRAN_SERVICE_ACCOUNT" ] }, "reports": { "title": "", "type": "array", "description": "The list of reports. Each report corresponds to a table within the schema to which connector syncs the data.", "items": { "title": "", "type": "object", "properties": { "attributes": { "title": "", "type": "array", "description": "The report attributes included to sync. Labeled `Fields` in the Fivetran dashboard.", "example": "[\"campaign.id\", \"campaign.name\"]", "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "custom_column_ids": { "title": "", "type": "array", "description": "The report custom column IDs included to sync.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "metrics": { "title": "", "type": "array", "description": "The report metrics included to sync.", "example": "[\"metrics.clicks\", \"metrics.impressions\"]", "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_type": { "title": "", "type": "string", "description": "The type of report. Labeled `Resource type` in the Fivetran dashboard.", "example": "campaign" }, "rollback_window": { "title": "", "type": "integer", "description": "The custom window size for rollback syncs (between 2 and 90).", "format": "int32", "example": 30 }, "segments": { "title": "", "type": "array", "description": "The report segments included to sync.", "example": "[\"segments.date\", \"segments.device\"]", "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "table": { "title": "", "type": "string", "description": "The name of a table within the schema to which connector syncs the data of a given report.", "example": "campaign_report" } }, "description": "The list of reports. Each report corresponds to a table within the schema to which connector syncs the data." } }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync. ", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "google_search_ads_360_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Google Search Ads 360 client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Google Search Ads 360 client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "google_search_ads_360_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_search_ads_360_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/google_search_ads_360_auth_V1" } ] }, "google_search_console_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_type": { "title": "", "type": "object", "description": "Authentication used by client to authenticate with google", "example": "OAUTH2 | FIVETRAN_SERVICE_ACCOUNT", "enum": [ "OAUTH2", "FIVETRAN_SERVICE_ACCOUNT" ] }, "reports": { "title": "", "type": "array", "description": "The list of reports. Each report corresponds to a table within the schema to which connector syncs the data.", "items": { "title": "", "type": "object", "properties": { "aggregation": { "title": "", "type": "object", "description": "(Optional) Aggregation type. Supported only for the `SEARCH_RESULTS` report type", "example": "BY_PROPERTY | BY_PAGE", "enum": [ "BY_PROPERTY", "BY_PAGE" ] }, "dimensions": { "title": "", "type": "array", "description": "The report dimensions included to sync.", "example": [ "DATE | COUNTRY | HOUR | QUERY | DEVICE | PAGE | SEARCH_APPEARANCE" ], "items": { "title": "", "type": "object", "description": "", "example": "DATE | COUNTRY | HOUR | QUERY | DEVICE | PAGE | SEARCH_APPEARANCE", "enum": [ "DATE", "COUNTRY", "HOUR", "QUERY", "DEVICE", "PAGE", "SEARCH_APPEARANCE" ] } }, "filters": { "title": "", "type": "array", "description": "The list of filters to be applied to the report.", "items": { "title": "", "type": "object", "properties": { "dimension": { "title": "", "type": "object", "description": "", "example": "COUNTRY | QUERY | DEVICE | PAGE | SEARCH_APPEARANCE", "enum": [ "COUNTRY", "QUERY", "DEVICE", "PAGE", "SEARCH_APPEARANCE" ] }, "expression": { "title": "", "type": "string", "description": "", "example": "string" }, "filter_type": { "title": "", "type": "object", "description": "", "example": "EXCLUDE | INCLUDE", "enum": [ "EXCLUDE", "INCLUDE" ] }, "match_type": { "title": "", "type": "object", "description": "", "example": "EQUALS | CONTAINS", "enum": [ "EQUALS", "CONTAINS" ] } }, "description": "" } }, "report_type": { "title": "", "type": "object", "description": "The type of report", "example": "DISCOVER | GOOGLE_NEWS | SEARCH_RESULTS", "enum": [ "DISCOVER", "GOOGLE_NEWS", "SEARCH_RESULTS" ] }, "search_types": { "title": "", "type": "array", "description": "Search types included to sync. Supported only for the `SEARCH_RESULTS` report type", "example": [ "IMAGE | WEB | VIDEO | NEWS | DISCOVER | GOOGLE_NEWS" ], "items": { "title": "", "type": "object", "description": "", "example": "IMAGE | WEB | VIDEO | NEWS | DISCOVER | GOOGLE_NEWS", "enum": [ "IMAGE", "WEB", "VIDEO", "NEWS", "DISCOVER", "GOOGLE_NEWS" ] } }, "table": { "title": "", "type": "string", "description": "The name of a table within the schema to which connector syncs the data of a given report.", "example": "search_report" } }, "description": "The list of reports. Each report corresponds to a table within the schema to which connector syncs the data." } }, "site_urls": { "title": "", "type": "array", "description": "Specific Site URLs to sync. Must be populated if `sync_mode` is set to `SpecificSites`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all sites or specific sites.", "example": "AllSites | SpecificSites", "enum": [ "AllSites", "SpecificSites" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync.", "example": "SIX | ALL_TIME | TWELVE | THREE", "enum": [ "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "google_search_console_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Google Search Console client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Google Search Console client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "google_search_console_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_search_console_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/google_search_console_auth_V1" } ] }, "google_sheets_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_type": { "title": "", "type": "object", "description": "The `OAuth` value must be specified for this type of authorization.", "example": "ServiceAccount | OAuth", "enum": [ "ServiceAccount", "OAuth" ] }, "named_range": { "title": "", "type": "string", "description": "The name of the named data range on the sheet that contains the data to be synced.", "example": "range" }, "sheet_id": { "title": "", "type": "string", "description": "The URL of the sheet that can be copied from the browser address bar, or the ID of the sheet that can be found in the sheet's URL between **/d/** and **/edit**.", "example": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" } }, "description": "" } } }, "google_sheets_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Google Sheets client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Google Sheets client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "google_sheets_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_sheets_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" }, { "$ref": "#/components/schemas/google_sheets_auth_V1" } ] }, "google_tag_manager_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "google_tag_manager_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Google Tag Manager access token.", "format": "password", "example": "google_tag_manager_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "Your Google Tag Manager refresh token.", "format": "password", "example": "google_tag_manager_refresh_token" } }, "description": "" } } }, "google_tag_manager_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_tag_manager_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/google_tag_manager_auth_V1" } ] }, "google_tasks_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "google_tasks_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The access token that carries the information necessary for API resources to your Google Tasks fetch data.", "format": "password", "example": "your_google_tasks_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived refresh token of your Google Tasks client application.", "format": "password", "example": "your_google_tasks_refresh_token" } }, "description": "" } } }, "google_tasks_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/google_tasks_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/google_tasks_auth_V1" } ] }, "gorgias_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Gorgias API key.", "format": "password", "example": "your_gorgias_api_key" }, "subdomain": { "title": "", "type": "string", "description": "Your Gorgias subdomain.", "example": "your_gorgias_subdomain" }, "username": { "title": "", "type": "string", "description": "Your Gorgias username.", "example": "your_gorgias_username" } }, "description": "" } } }, "gorgias_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/gorgias_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "green_power_monitor_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your GreenPowerMonitor password.", "format": "password", "example": "your_green_power_monitor_password" }, "sub_domain": { "title": "", "type": "string", "description": "Your GreenPowerMonitor subdomain.", "example": "your_green_power_monitor_subdomain" }, "username": { "title": "", "type": "string", "description": "Your GreenPowerMonitor username.", "example": "your_green_power_monitor_username" } }, "description": "" } } }, "green_power_monitor_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/green_power_monitor_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "greenhouse_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Greenhouse API key.", "format": "password", "example": "xxxxxxxxxxxxxxxx" }, "client_id": { "title": "", "type": "string", "description": "Your Greenhouse client ID.", "example": "your_greenhouse_harvest_v3_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Greenhouse client secret.", "format": "password", "example": "your_greenhouse_harvest_v3_client_secret" } }, "description": "" } } }, "greenhouse_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/greenhouse_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "grepsr_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Grepsr API Key.", "format": "password", "example": "your_grepsr_api_key" } }, "description": "" } } }, "grepsr_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/grepsr_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "grin_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Grin API key.", "format": "password", "example": "your_grin_api_key" } }, "description": "" } } }, "grin_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/grin_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "guidewire_cloud_data_access_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_key_id": { "title": "", "type": "string", "description": "Access Key ID for access key authentication.", "example": "access_key_id_value" }, "access_key_secret": { "title": "", "type": "string", "description": "Access Key Secret for access key authentication.", "format": "password", "example": "access_key_secret_value" }, "application_path": { "title": "", "type": "string", "description": "Path to the CDA application folder relative to the bucket root. Do not include the deployment timestamp folder. Fivetran automatically identifies the active deployment and follows it when Guidewire redeploys CDA.", "example": "application_path" }, "auth_type": { "title": "", "type": "object", "description": "Access approach. Supported values: IAM_ROLE, ACCESS_KEY, PUBLIC_BUCKET.", "example": "IAM_ROLE | PUBLIC_BUCKET | ACCESS_KEY", "enum": [ "IAM_ROLE", "PUBLIC_BUCKET", "ACCESS_KEY" ] }, "bucket": { "title": "", "type": "string", "description": "The S3 bucket name containing the Guidewire CDA export. Required for connector creation.", "example": "bucket_name" }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "is_private_link_required": { "title": "", "type": "boolean", "description": "Set to `true` if you want to connect to S3 bucket over PrivateLink. Default value: `false`.", "example": true }, "role_arn": { "title": "", "type": "string", "description": "The Role ARN required for IAM role authentication.", "format": "password", "example": "arn::your_role_arn" } }, "description": "" } } }, "guidewire_cloud_data_access_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "access_key_id": { "title": "", "type": "string", "description": "ESM key for access Key ID for access key authentication.", "example": "ACCESS_KEY_ID_KEY" }, "access_key_secret": { "title": "", "type": "string", "description": "ESM key for access Key Secret for access key authentication.", "example": "ACCESS_KEY_SECRET_KEY" } }, "description": "" } } }, "guidewire_cloud_data_access_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/guidewire_cloud_data_access_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/guidewire_cloud_data_access_esm_keys_config_V1" } ] }, "guru_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your Guru password.", "format": "password", "example": "your_guru_password" }, "username": { "title": "", "type": "string", "description": "Your Guru username.", "example": "your_guru_username" } }, "description": "" } } }, "guru_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/guru_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "h_level_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your HighLevel client ID.", "example": "your_highlevel_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your HighLevel client secret.", "format": "password", "example": "your_highlevel_client_secret" }, "location_ids": { "title": "", "type": "string", "description": "Your HighLevel location ID.", "example": "your_highlevel_location_id" }, "sub_domain": { "type": "object", "description": "Your HighLevel subdomain.", "enum": [ "leadconnectorhq", "gohighlevel" ] } }, "description": "" } } }, "h_level_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/h_level_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "happyfox_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_name": { "title": "", "type": "string", "description": "Your HappyFox account name.", "example": "your_happyfox_account_name" }, "api_key": { "title": "", "type": "string", "description": "Your HappyFox API key.", "format": "password", "example": "your_happyfox_api_key" }, "auth_code": { "title": "", "type": "string", "description": "Your HappyFox auth code.", "format": "password", "example": "your_happyfox_auth_code" }, "region": { "type": "object", "description": "Your HappyFox region.", "enum": [ "happyfox.net", "happyfox.com" ] } }, "description": "" } } }, "happyfox_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/happyfox_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "harvest_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_id": { "title": "", "type": "string", "description": "Your Harvest Account ID.", "example": "your_harvest_account_id" }, "personal_access_token": { "title": "", "type": "string", "description": "Your Harvest Personal Access Token.", "format": "password", "example": "your_harvest_personal_access_token" } }, "description": "" } } }, "harvest_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/harvest_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "healthie_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Healthie API key.", "format": "password", "example": "string" }, "environment": { "type": "object", "description": "Your Healthie environment.", "enum": [ "staging-api", "api" ] }, "shard_authorization_id": { "title": "", "type": "string", "description": "Your Healthie shard authorization ID.", "format": "password", "example": "string" } }, "description": "" } } }, "healthie_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/healthie_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "heap_config_V1": { "properties": { "config": { "type": "object", "properties": { "bucket": { "title": "", "type": "string", "description": "The S3 bucket name.", "example": "http://your_test_bucket.s3.amazonaws.com" }, "role_arn": { "title": "", "type": "string", "description": "The Role ARN required for authentication.", "format": "password", "example": "arn:aws:s3:::your_test_bucket" } }, "description": "" } } }, "heap_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/heap_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "heartland_retail_pos_config_V1": { "properties": { "config": { "type": "object", "properties": { "sub_domain": { "title": "", "type": "string", "description": "Your Heartland Retail POS subdomain.", "example": "your_heartland_retail_pos_subdomain" } }, "description": "" } } }, "heartland_retail_pos_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } } }, "description": "" } } }, "heartland_retail_pos_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/heartland_retail_pos_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/heartland_retail_pos_auth_V1" } ] }, "helpdesk_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your HelpDesk client ID.", "example": "your_helpdesk_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your HelpDesk client secret.", "format": "password", "example": "your_helpdesk_client_secret" } }, "description": "" } } }, "helpdesk_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "helpdesk_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/helpdesk_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/helpdesk_auth_V1" } ] }, "helpjuice_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_name": { "title": "", "type": "string", "description": "Your Helpjuice account name.", "example": "your_helpjuice_account_name" }, "api_key": { "title": "", "type": "string", "description": "Your Helpjuice API key.", "format": "password", "example": "your_helpjuice_api_key" } }, "description": "" } } }, "helpjuice_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/helpjuice_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "helpscout_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "helpscout_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "format": "password", "example": "string" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Help Scout client application.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Help Scout client application.", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "format": "password", "example": "my_refresh_token" } }, "description": "" } } }, "helpscout_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/helpscout_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/helpscout_auth_V1" } ] }, "helpshift_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Helpshift API Key.", "format": "password", "example": "your_helpshift_api_key" }, "domain_name": { "title": "", "type": "string", "description": "Your Helpshift domain name.", "example": "your_helpshift_domain_name" } }, "description": "" } } }, "helpshift_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/helpshift_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "heroku_kafka_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_cert": { "title": "", "type": "string", "description": "Heroku Kafka client certificate. Required for `TLS` security protocol.", "format": "password", "example": "client_certificate_value" }, "client_cert_key": { "title": "", "type": "string", "description": "Heroku Kafka client certificate key. Required for `TLS` security protocol.", "format": "password", "example": "client_certificate_key" }, "consumer_group": { "title": "", "type": "string", "description": "Heroku Kafka consumer group name.", "example": "consumer_group" }, "key_store_type": { "title": "", "type": "string", "description": "Key Store Type", "example": "PKCS12" }, "message_type": { "title": "", "type": "object", "description": "Heroku Kafka message type.", "example": "Text | Json", "enum": [ "Text", "Json" ] }, "security_protocol": { "title": "", "type": "object", "description": "Security protocol for Heroku Kafka interaction.", "example": "PLAINTEXT | TLS", "enum": [ "PLAINTEXT", "TLS" ] }, "servers": { "title": "", "type": "array", "description": "Comma-separated list of Heroku Kafka servers in the format `server:port`.", "example": "serveraddress1:8080, serveraddress2:8080", "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "sync_type": { "title": "", "type": "object", "description": "Heroku Kafka sync type. Unpacked messages must be valid JSON.", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "trust_store_type": { "title": "", "type": "string", "description": "Trust Store Type", "example": "PKCS12" }, "trusted_cert": { "title": "", "type": "string", "description": "Heroku Kafka trusted certificate. Required for `TLS` security protocol.", "format": "password", "example": "trusted_certificate_value" } }, "description": "" } } }, "heroku_kafka_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/heroku_kafka_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "heroku_postgres_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Database authentication method", "example": "PASSWORD | CLIENT_CERTIFICATE", "enum": [ "PASSWORD", "CLIENT_CERTIFICATE" ] }, "client_private_key": { "title": "", "type": "string", "description": "Client Private Key in .pem format.", "format": "password", "example": "string" }, "client_public_certificate": { "title": "", "type": "string", "description": "Client Certificate in .pem format.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "postgres" }, "delete_capture_enabled": { "title": "", "type": "boolean", "description": "", "example": true }, "entra_app_id": { "title": "", "type": "string", "description": "Registered Application ID (for Entra ID authentication).", "example": "string" }, "entra_tenant_id": { "title": "", "type": "string", "description": "Azure Tenant ID (for Entra ID authentication).", "example": "string" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "postgresinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 5432 }, "publication_name": { "title": "", "type": "string", "description": "Publication name. Specify only for `\"updated_method\": \"WAL_PGOUTPUT\"`.", "example": "string" }, "replication_slot": { "title": "", "type": "string", "description": "Replication slot name. Specify only for `\"updated_method\": \"WAL_PGOUTPUT\"`.", "example": "test_replication_slot" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method to detect new or changed rows.
Specify only for `\"service\": \"postgres\"` or `\"service\": \"postgres_rds\"`.
Supported values:
`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. This is more efficient than the query-based method, but requires more setup and monitoring.
`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns", "example": "QUERY_BASED", "enum": [ "QUERY_BASED" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "heroku_postgres_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "heroku_postgres_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/heroku_postgres_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/heroku_postgres_esm_keys_config_V1" } ] }, "hex_config_V1": { "properties": { "config": { "type": "object", "properties": { "subdomain": { "title": "", "type": "string", "description": "Your Hex subdomain.", "example": "your_hex_subdomain" }, "workspace_token": { "title": "", "type": "string", "description": "Your Hex workspace token.", "format": "password", "example": "your_hex_workspace_token" } }, "description": "" } } }, "hex_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/hex_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "hibob_config_V1": { "properties": { "config": { "type": "object", "properties": { "user_id": { "title": "", "type": "string", "description": "Your HiBob Service User Token.", "example": "your_hibob_service_user_id" }, "user_token": { "title": "", "type": "string", "description": "Your HiBob Service User ID.", "format": "password", "example": "your_hibob_service_user_token" } }, "description": "" } } }, "hibob_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/hibob_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "higher_logic_vanilla_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Higher Logic Vanilla access token.", "format": "password", "example": "your_higher_logic_vanilla_access_token" }, "base_url": { "title": "", "type": "string", "description": "Your Higher Logic Vanilla base URL.", "example": "your_higher_logic_vanilla_base_url" } }, "description": "" } } }, "higher_logic_vanilla_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/higher_logic_vanilla_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "hilti_ontrack_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Hilti On!Track client ID.", "example": "your_hilti_ontrack_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Hilti On!Track client secret.", "format": "password", "example": "your_hilti_ontrack_client_secret" }, "password": { "title": "", "type": "string", "description": "Your Hilti On!Track password.", "format": "password", "example": "your_hilti_ontrack_password" }, "username": { "title": "", "type": "string", "description": "Your Hilti On!Track username.", "example": "your_hilti_ontrack_username" } }, "description": "" } } }, "hilti_ontrack_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/hilti_ontrack_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "hopin_config_V1": { "properties": { "config": { "type": "object", "properties": { "bearer_token": { "title": "", "type": "string", "description": "Your Hopin API key.", "format": "password", "example": "your_hopin_api_key" } }, "description": "" } } }, "hopin_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/hopin_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "hubspot_config_V1": { "properties": { "config": { "type": "object", "properties": { "backward_sync_limit_date": { "title": "", "type": "string", "description": "Date Limit of the Historical Sync Time for selected tables. The Format should be YYYY-MM-DD.", "example": "2023-01-11" }, "client_secret": { "title": "", "type": "string", "description": "Client secret for private custom app authentication.", "format": "password", "example": "string" }, "historical_sync_time_frame": { "title": "", "type": "object", "description": "Used to configure Historical sync timeframe for selected tables.", "example": "ALL_TIME | DATE_LIMIT", "enum": [ "ALL_TIME", "DATE_LIMIT" ] }, "sync_highly_sensitive_data": { "title": "", "type": "boolean", "description": "Enable syncing of highly sensitive data fields from HubSpot. When enabled, sensitive data syncing is also automatically enabled.", "example": true }, "sync_sensitive_data": { "title": "", "type": "boolean", "description": "Enable syncing of sensitive data fields from HubSpot.", "example": true }, "tables_without_access_updated_at": { "title": "", "type": "string", "description": "Timestamp to indicate when tables without access was updated.", "format": "date-time", "example": "string" } }, "description": "" } } }, "hubspot_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your HubSpot client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your HubSpot client application.", "example": "my_client_secret" } }, "description": "Your application client access fields." }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "hubspot_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/hubspot_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/hubspot_auth_V1" } ] }, "ibacos_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your IBACOS client ID.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Your IBACOS client secret.", "format": "password", "example": "string" }, "subdomain": { "type": "object", "description": "Your IBACOS server.", "enum": [ "perform-api-stg.ibacos.org", "perform-api.Indo.site", "ibacos-perform-api.ibacos.com" ] } }, "description": "" } } }, "ibacos_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ibacos_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ilevel_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your iLevel Client ID.", "example": "your_ilevel_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your iLevel Client Secret.", "format": "password", "example": "your_ilevel_client_secret" }, "sub_domain": { "type": "object", "description": "Your iLevel Environment.", "enum": [ "api.ilevelsolutions.com", "sandapi.ilevelsolutions.com", "sandapi.ilevelsolutions.eu", "api.ilevelsolutions.eu" ] } }, "description": "" } } }, "ilevel_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ilevel_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "impact_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_type": { "type": "object", "description": "Your Impact Brand auth type.", "enum": [ "oauth_2", "basic" ] }, "password": { "title": "", "type": "string", "description": "Your Impact Brand Account Token", "format": "password", "example": "string" }, "username": { "title": "", "type": "string", "description": "Your Impact Brand Account SID", "example": "string" } }, "description": "" } } }, "impact_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Impact Brand access token.", "format": "password", "example": "string" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "Your Impact Brand client access." }, "refresh_token": { "title": "", "type": "string", "description": "Your Impact Brand refresh token.", "format": "password", "example": "string" } }, "description": "" } } }, "impact_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/impact_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/impact_auth_V1" } ] }, "impact_partner_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_sid": { "title": "", "type": "string", "description": "Your Impact Partner account SID", "example": "your_impact_partner_account_sid" }, "auth_token": { "title": "", "type": "string", "description": "Your Impact Partner auth token", "format": "password", "example": "your_impact_partner_auth_token" } }, "description": "" } } }, "impact_partner_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/impact_partner_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "incidentio_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your incident.io API key.", "format": "password", "example": "your_incidentio_api_key" } }, "description": "" } } }, "incidentio_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/incidentio_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "infobip_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Infobip API key.", "format": "password", "example": "your_infobip_api_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your Infobip sub_domain.", "example": "your_infobip_subdomain" } }, "description": "" } } }, "infobip_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/infobip_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "insightly_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Insightly API key.", "format": "password", "example": "your_insightly_api_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your company's Insightly subdomain name.", "example": "your_insightly_subdomain" } }, "description": "" } } }, "insightly_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/insightly_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "instagram_business_config_V1": { "properties": { "config": { "type": "object", "properties": { "accounts": { "title": "", "type": "array", "description": "Specific accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.", "example": "AllAccounts | SpecificAccounts", "enum": [ "AllAccounts", "SpecificAccounts" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `SIX`.", "example": "TWENTY_FOUR | SIX | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "TWELVE", "THREE" ] } }, "description": "" } } }, "instagram_business_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The `Access Token` carries the information necessary for API resources to fetch data", "example": "my_access_token" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Facebook client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Facebook client application.", "example": "my_client_secret" } }, "description": "Your application client access fields." }, "system_user_access_token": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "instagram_business_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/instagram_business_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/instagram_business_auth_V1" } ] }, "integral_ad_science_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your integral_ad_science password.", "format": "password", "example": "your_integral_ad_science_password" }, "username": { "title": "", "type": "string", "description": "Your integral_ad_science username.", "example": "your_integral_ad_science_username" } }, "description": "" } } }, "integral_ad_science_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/integral_ad_science_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "integrate_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Integrate API key.", "format": "password", "example": "your_integrate_api_key" }, "api_secret": { "title": "", "type": "string", "description": "Your Integrate API secret.", "format": "password", "example": "your_integrate_api_secret" }, "organization_id": { "title": "", "type": "string", "description": "Your Integrate organization ID.", "example": "your_integrate_organization_id" } }, "description": "" } } }, "integrate_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/integrate_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "intercom_config_V1": { "properties": { "config": { "type": "object", "properties": { "data_region": { "title": "Data Region", "type": "object", "description": "The Intercom region for your app. Options - empty string (US/default), 'eu' (Europe), 'au' (Australia). Based on your Intercom app URL (app.intercom.io for US, app.eu.intercom.io for EU, app.au.intercom.io for AU). Cannot be changed after initial connection creation.", "example": "eu", "enum": [ "", "eu", "au" ] } }, "description": "" } } }, "intercom_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The long-lived `Access Token` carries the information necessary for API resources to fetch data.", "example": "my_access_token" } }, "description": "" } } }, "intercom_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/intercom_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/intercom_auth_V1" } ] }, "invoiced_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Invoiced API key.", "format": "password", "example": "your_invoiced_api_key" }, "environment": { "type": "object", "description": "Your Invoiced environment.", "enum": [ "api.sandbox", "api" ] } }, "description": "" } } }, "invoiced_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/invoiced_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ironclad_config_V1": { "properties": { "config": { "type": "object", "properties": { "base_url": { "title": "", "type": "string", "description": "Your Ironclad base url.", "example": "your_ironclad_base_url" }, "client_id": { "title": "", "type": "string", "description": "Your Ironclad client ID.", "example": "your_ironclad_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Ironclad client secret.", "format": "password", "example": "your_ironclad_client_secret" } }, "description": "" } } }, "ironclad_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "ironclad_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ironclad_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/ironclad_auth_V1" } ] }, "ironclad_clickwrap_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Ironclad Clickwrap client ID.", "example": "your_ironclad_clickwrap_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Ironclad Clickwrap client secret.", "format": "password", "example": "your_ironclad_clickwrap_client_secret" } }, "description": "" } } }, "ironclad_clickwrap_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ironclad_clickwrap_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ironsource_config_V1": { "properties": { "config": { "type": "object", "properties": { "refresh_token": { "title": "", "type": "string", "description": "Your Ironsource `Client Secret`.", "format": "password", "example": "your_ironsource_refresh_token" }, "secret_key": { "title": "", "type": "string", "description": "Your Ironsource `Client ID`.", "format": "password", "example": "your_ironsource_secret_key" } }, "description": "" } } }, "ironsource_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ironsource_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "iterable_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_region": { "title": "", "type": "object", "description": "If your Iterable account URL starts with `https://app.eu.iterable.com` then provide `EU` else `US`", "example": "EU | US", "enum": [ "EU", "US" ] }, "api_key": { "title": "", "type": "string", "description": "Your Iterable API key.", "format": "password", "example": "xxxxxxxxxxxxxxxx" }, "custom_event_sync_mode": { "title": "", "type": "object", "description": "Custom Events Sync Mode.", "example": "SelectedEvents | AllEvents | NoEvents", "enum": [ "SelectedEvents", "AllEvents", "NoEvents" ] }, "custom_events": { "title": "", "type": "array", "description": "List of custom events to sync. Should be specified when `custom_event_sync_mode` is `SelectedEvents`", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "events": { "title": "", "type": "array", "description": "List of events to sync. Should be specified when `sync_mode` is `SelectedEvents`", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "historical_sync_limit": { "title": "", "type": "object", "description": "The time range for which historical data should be synced. Default value: `All Time`.", "example": "ALL_TIME | DATE_LIMIT", "enum": [ "ALL_TIME", "DATE_LIMIT" ] }, "historical_sync_limit_date": { "title": "", "type": "string", "description": "The start date (YYYY-MM-DD) from which to sync historical data.", "example": "2013-01-01" }, "sync_mode": { "title": "", "type": "object", "description": "Events Sync Mode.", "example": "SelectedEvents | AllEvents", "enum": [ "SelectedEvents", "AllEvents" ] }, "webhook_auth_type": { "title": "", "type": "object", "description": "The authentication method for the Iterable webhook. Accepted values: `NoAuth`, `Basic`, `OAuth2`.", "example": "Basic | OAuth2 | NoAuth", "enum": [ "Basic", "OAuth2", "NoAuth" ] } }, "description": "" } } }, "iterable_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/iterable_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "itunes_connect_config_V1": { "properties": { "config": { "type": "object", "properties": { "app_sync_mode": { "title": "", "type": "object", "description": "Whether to sync all apps or specific apps.", "example": "AllApps | SpecificApps", "enum": [ "AllApps", "SpecificApps" ] }, "apps": { "title": "", "type": "array", "description": "Specific apps to sync. Must be populated if `app_sync_mode` is set to `SpecificApps`.", "example": [ 0 ], "items": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 } }, "issuer_id": { "title": "", "type": "string", "description": "Your Issuer ID. Must be populated if `key_type` is set to `Team`", "example": "your_issuer_id" }, "key_id": { "title": "", "type": "string", "description": "Your Key ID", "example": "your_key_id" }, "key_type": { "title": "", "type": "object", "description": "Key Type", "example": "Individual | Team", "enum": [ "Individual", "Team" ] }, "private_key": { "title": "", "type": "string", "description": "Your Private Key", "format": "password", "example": "your_private_key" }, "timeframe_months": { "title": "", "type": "object", "description": "Historical sync time frame in months.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] }, "vendors_id": { "title": "", "type": "array", "description": "Your vendors id", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } } }, "description": "" } } }, "itunes_connect_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/itunes_connect_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ivanti_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Ivanti API Key.", "format": "password", "example": "your_ivanti_api_key" }, "tenant_url": { "title": "", "type": "string", "description": "Your Ivanti Tenant URL.", "example": "your_ivanti_tenant_url" } }, "description": "" } } }, "ivanti_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ivanti_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "jama_software_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Jama Software client ID.", "example": "your_jama_software_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Jama Software client secret.", "format": "password", "example": "your_jama_software_client_secret" }, "subdomain": { "title": "", "type": "string", "description": "Your Jama Software subdomain.", "example": "your_jama_software_subdomain" } }, "description": "" } } }, "jama_software_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/jama_software_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "jamf_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your Jamf password.", "format": "password", "example": "string" }, "sub_domain": { "title": "", "type": "string", "description": "Your Jamf subdomain.", "example": "string" }, "username": { "title": "", "type": "string", "description": "Your Jamf username.", "example": "string" } }, "description": "" } } }, "jamf_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/jamf_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "jibble_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Jibble client ID.", "example": "your_jibble_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Jibble client secret.", "format": "password", "example": "your_jibble_client_secret" }, "environment": { "type": "object", "description": "Your Jibble environment.", "enum": [ "prod", "test" ] } }, "description": "" } } }, "jibble_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/jibble_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "jira_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_cursor_rollback_window": { "title": "", "type": "integer", "description": "The number of hours to roll back the issue search cursor. Allows reprocessing of recently updated issues that may have been missed due to indexing delays. Valid range is 0-48 hours. A value of 0 disables the rollback.", "format": "int32", "example": 2 }, "auth_type": { "title": "", "type": "object", "description": "Authorization type.", "example": "SERVICE_ACCOUNT | BASIC | OAUTH", "enum": [ "SERVICE_ACCOUNT", "BASIC", "OAUTH" ] }, "host": { "title": "", "type": "string", "description": "The Jira service host address.", "example": "mycompany.atlassian.net" }, "on_premise": { "title": "", "type": "boolean", "description": "Whether the Jira instance is local or in cloud.", "example": true }, "password": { "title": "", "type": "string", "description": "The Jira user's password.", "format": "password", "example": "password" }, "path": { "title": "", "type": "string", "description": "A URL subdirectory where the Jira instance is working.", "example": "path" }, "port": { "title": "", "type": "integer", "description": "The Jira service host port.", "format": "int32", "example": 443 }, "projects": { "title": "", "type": "array", "description": "Specific projects to sync. Must be populated if `syncMode` is set to `CUSTOM`.", "example": [ 0 ], "items": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 } }, "sync_files": { "title": "", "type": "boolean", "description": "Specifies whether to sync files in JIRA for supported destinations (true) or not (false).", "example": true }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all projects or specific projects.", "example": "ALL | CUSTOM", "enum": [ "ALL", "CUSTOM" ] }, "user": { "title": "", "type": "string", "description": "The Jira username.", "example": "user" } }, "description": "" } } }, "jira_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "The `Client ID` of your Jira service account. Required if `auth_type` is set to `SERVICE_ACCOUNT`.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "The `Client secret` of your Jira service account. Required if `auth_type` is set to `SERVICE_ACCOUNT`.", "example": "my_client_secret" } }, "description": "" } } }, "jira_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the Jira user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the Jira username.", "example": "USER_KEY" } }, "description": "" } } }, "jira_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/jira_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/jira_auth_V1" }, { "$ref": "#/components/schemas/jira_esm_keys_config_V1" } ] }, "jobnimbus_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your JobNimbus API key.", "format": "password", "example": "string" } }, "description": "" } } }, "jobnimbus_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/jobnimbus_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "jotform_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Jotform API key.", "format": "password", "example": "your_jotform_api_key" }, "base_url": { "type": "object", "description": "Your Jotform base URL.", "enum": [ "", "hipaa-api.jotform.com", "api.jotform.com" ] }, "custom_url": { "title": "", "type": "string", "description": "Your Jotform custom base URL.", "example": "your_jotform_custom_base_url" } }, "description": "" } } }, "jotform_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/jotform_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "justcall_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your JustCall API key.", "format": "password", "example": "your_justcall_api_key" }, "api_secret": { "title": "", "type": "string", "description": "Your JustCall API secret.", "format": "password", "example": "your_justcall_api_secret" }, "plan_type": { "type": "object", "description": "Your JustCall Plan Type.", "enum": [ "57", "27", "85" ] } }, "description": "" } } }, "justcall_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/justcall_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "kandji_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Kandji API token.", "format": "password", "example": "your_kandji_api_token" }, "sub_domain": { "title": "", "type": "string", "description": "Your Kandji Subdomain.", "example": "your_kandji_subdomain" } }, "description": "" } } }, "kandji_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/kandji_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "katana_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Katana API key.", "format": "password", "example": "your_katana_api_key" } }, "description": "" } } }, "katana_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/katana_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "kevel_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Kevel API key.", "format": "password", "example": "your_kevel_api_key" } }, "description": "" } } }, "kevel_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/kevel_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "keypay_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your KeyPay API key.", "format": "password", "example": "your_keypay_api_key" }, "region": { "type": "object", "description": "Your KeyPay region.", "enum": [ "com.my", "co.nz", "co.uk", "com.au", "com.sg" ] } }, "description": "" } } }, "keypay_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/keypay_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "khoros_care_config_V1": { "properties": { "config": { "type": "object", "properties": { "company_key": { "title": "", "type": "string", "description": "Your Khoros Care companyKey.", "format": "password", "example": "your_khoros_care_company_key" }, "password": { "title": "", "type": "string", "description": "Your Khoros Care password.", "format": "password", "example": "your_khoros_care_password" }, "sub_domain": { "title": "", "type": "string", "description": "Your Khoros Care subDomain.", "example": "your_khoros_care_subdomain" }, "username": { "title": "", "type": "string", "description": "Your Khoros Care username.", "example": "your_khoros_care_username" } }, "description": "" } } }, "khoros_care_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/khoros_care_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "khoros_communities_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Khoros Communities client ID.", "example": "string" }, "community_domain": { "title": "", "type": "string", "description": "Your Khoros Communities community domain.", "example": "string" }, "community_id": { "title": "", "type": "string", "description": "Your Khoros Communities community ID.", "example": "string" }, "token": { "title": "", "type": "string", "description": "Your Khoros Communities token.", "format": "password", "example": "string" } }, "description": "" } } }, "khoros_communities_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/khoros_communities_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "khoros_marketing_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Khoros Marketing access token.", "format": "password", "example": "your_khoros_marketing_access_token" } }, "description": "" } } }, "khoros_marketing_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/khoros_marketing_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "kinesis_config_V1": { "properties": { "config": { "type": "object", "properties": { "bucket": { "title": "", "type": "string", "description": "The name of the Kinesis bucket.", "example": "aws_region_code" }, "json_delivery_mode": { "title": "", "type": "object", "description": "Control how your JSON data is delivered into your destination", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "prefix": { "title": "", "type": "string", "description": "Folder path to the Kinesis files within the bucket.", "example": "folder_path" }, "role_arn": { "title": "", "type": "string", "description": "The Role ARN required for authentication.", "format": "password", "example": "arn::your_role_arn" } }, "description": "" } } }, "kinesis_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/kinesis_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "kisi_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Kisi API key.", "format": "password", "example": "your_kisi_api_key" } }, "description": "" } } }, "kisi_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/kisi_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "kissmetrics_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your Kissmetrics API Password.", "format": "password", "example": "your_kissmetrics_api_password" }, "username": { "title": "", "type": "string", "description": "Your Kissmetrics API Username.", "example": "your_kissmetrics_api_username" } }, "description": "" } } }, "kissmetrics_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/kissmetrics_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "klarna_config_V1": { "properties": { "config": { "type": "object", "properties": { "csv_delimiter": { "type": "object", "description": "The CSV delimiter used in your Klarna settlement report.", "enum": [ ":", ";", ",", "|" ] }, "password": { "title": "", "type": "string", "description": "Your Klarna password.", "format": "password", "example": "your_klarna_password" }, "subdomain": { "type": "object", "description": "Your Klarna subdomain.", "enum": [ "api-na", "api-oc", "api" ] }, "username": { "title": "", "type": "string", "description": "Your Klarna username.", "example": "your_klarna_username" } }, "description": "" } } }, "klarna_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/klarna_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "klaviyo_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Klaviyo API key.", "format": "password", "example": "xxxxxxxxxxxxxxxx" }, "historical_sync_limit": { "title": "", "type": "object", "description": "The time range for which historical data should be synced. Default value: `ALL_TIME`.", "example": "ALL_TIME | DATE_LIMIT", "enum": [ "ALL_TIME", "DATE_LIMIT" ] }, "historical_sync_limit_date": { "title": "", "type": "string", "description": "The start date (YYYY-MM-DD) from which to sync historical data.", "example": "2011-01-01" }, "packing_mode": { "title": "", "type": "object", "description": "Packing mode for EVENT and PERSON tables.", "example": "UNPACKED | PACKED", "enum": [ "UNPACKED", "PACKED" ] }, "reports": { "title": "", "type": "array", "description": "* custom report(s)", "items": { "title": "", "type": "object", "properties": { "breakdown": { "title": "", "type": "object", "description": "Optional breakdown for Form Series reports. Select Form version ID to group data by individual form versions, or Form ID to group data by form only.", "example": "form_id", "enum": [ "form_version_id", "form_id" ] }, "conversion_metric_id": { "title": "", "type": "string", "description": "The ID of the conversion metric.", "example": "string" }, "interval": { "title": "", "type": "object", "description": "The interval used in the API calls to retrieve the reports.", "example": "WEEKLY | DAILY | MONTHLY | HOURLY", "enum": [ "WEEKLY", "DAILY", "MONTHLY", "HOURLY" ] }, "name": { "title": "", "type": "string", "description": "The name of the custom report. The same name is used to name the table in the destination.", "example": "flow_report_1" }, "rollback_window_in_days": { "title": "", "type": "integer", "description": "The number of days to look back during each sync to capture late-arriving data. Valid range: 2 to 90 days. Default: 5 days.", "format": "int32", "example": 5 }, "statistics": { "title": "", "type": "array", "description": "The list of statistics to be retrieved.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "type": { "title": "", "type": "object", "description": "The type of the custom report.", "example": "SEGMENT | FORM | FLOW", "enum": [ "SEGMENT", "FORM", "FLOW" ] } }, "description": "* custom report(s)" } }, "should_sync_events_with_deleted_profiles": { "title": "", "type": "boolean", "description": "Sync events linked to deleted profiles.", "example": true }, "should_sync_predictive_analytics": { "title": "", "type": "boolean", "description": "Sync predictive analytics for `PERSON` table.", "example": true } }, "description": "" } } }, "klaviyo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/klaviyo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "konnect_insights_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_token": { "title": "", "type": "string", "description": "Your Konnect Insights Account Token.", "format": "password", "example": "your_konnect_insights_account_token" }, "user_token": { "title": "", "type": "string", "description": "Your Konnect Insights User Token.", "format": "password", "example": "your_konnect_insights_user_token" } }, "description": "" } } }, "konnect_insights_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/konnect_insights_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "kustomer_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Kustomer API key.", "format": "password", "example": "xxxxxxxxxxxxxxxx" }, "api_utilization_percentage": { "title": "", "type": "number", "description": "Api Utilization Percentage", "example": 50 }, "domain": { "title": "", "type": "string", "description": "Domain is the beginning of your kustomer URL going before .kustomerapp.com, e.g. for yourcompany.kustomerapp.com the domain name is yourcompany", "example": "string" }, "eu_region": { "title": "", "type": "boolean", "description": "Turn it on if your app is on EU region", "example": true } }, "description": "" } } }, "kustomer_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/kustomer_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "kyriba_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Kyriba client ID.", "example": "your_kyriba_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Kyriba client secret.", "format": "password", "example": "your_kyriba_client_secret" }, "subdomain": { "title": "", "type": "string", "description": "Your Kyriba subdomain.", "example": "your_kyriba_subdomain" } }, "description": "" } } }, "kyriba_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/kyriba_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "lattice_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Lattice API access token.", "format": "password", "example": "your_lattice_access_token" }, "sub_domain": { "type": "object", "description": "Your Lattice subdomain.", "enum": [ "api.emea", "api" ] } }, "description": "" } } }, "lattice_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/lattice_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "launchdarkly_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your LaunchDarkly access token.", "format": "password", "example": "your_launchdarkly_access_token" } }, "description": "" } } }, "launchdarkly_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/launchdarkly_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "leap_crm_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Leap CRM access token.", "format": "password", "example": "your_leap_crm_access_token" } }, "description": "" } } }, "leap_crm_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/leap_crm_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "leapsome_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_secret": { "title": "", "type": "string", "description": "Your Leapsome API secret.", "format": "password", "example": "your_leapsome_api_secret" } }, "description": "" } } }, "leapsome_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/leapsome_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "learn_amp_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Learn Amp client ID.", "example": "your_learn_amp_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Learn Amp client secret.", "format": "password", "example": "your_learn_amp_client_secret" } }, "description": "" } } }, "learn_amp_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/learn_amp_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "learnupon_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your LearnUpon API key.", "format": "password", "example": "your_learnupon_api_key" }, "custom_region": { "title": "", "type": "string", "description": "Your LearnUpon custom region.", "example": "your_learnupon_custom_region" }, "region": { "type": "object", "description": "Your LearnUpon region.", "enum": [ "learnuponau.com", "", "learnupon.com" ] }, "subdomain": { "title": "", "type": "string", "description": "Your LearnUpon subdomain.", "example": "your_learnupon_subdomain" }, "username": { "title": "", "type": "string", "description": "Your LearnUpon username.", "example": "your_learnupon_username" } }, "description": "" } } }, "learnupon_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/learnupon_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "leave_dates_config_V1": { "properties": { "config": { "type": "object", "properties": { "personal_access_token": { "title": "", "type": "string", "description": "Your Leave Dates personal access token.", "format": "password", "example": "your_leave_dates_personal_access_token" } }, "description": "" } } }, "leave_dates_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/leave_dates_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "lemlist_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Lemlist API key.", "format": "password", "example": "your_lemlist_api_key" } }, "description": "" } } }, "lemlist_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/lemlist_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "lessonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your Lessonly password.", "format": "password", "example": "your_lessonly_password" }, "username": { "title": "", "type": "string", "description": "Your Lessonly username.", "example": "your_lessonly_username" } }, "description": "" } } }, "lessonly_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/lessonly_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "lever_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Lever API key.", "format": "password", "example": "xxxxxxxxxxxxxxxx" } }, "description": "" } } }, "lever_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/lever_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "liftoff_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Liftoff API key.", "format": "password", "example": "your_liftoff_api_key" }, "api_secret": { "title": "", "type": "string", "description": "Your Liftoff API secret.", "format": "password", "example": "your_liftoff_api_secret" } }, "description": "" } } }, "liftoff_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/liftoff_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "light_speed_retail_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "light_speed_retail_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/light_speed_retail_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "lightspeed_retail_xseries_config_V1": { "properties": { "config": { "type": "object", "properties": { "domain_prefix": { "title": "", "type": "string", "description": "Your Lightspeed Retail X-Series store domain prefix.", "example": "your_lightspeed_retail_xseries_store_domain_prefix" } }, "description": "" } } }, "lightspeed_retail_xseries_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Lightspeed Retail X-Series access token.", "format": "password", "example": "your_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Lightspeed Retail X-Series client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Lightspeed Retail X-Series client application.", "format": "password", "example": "my_client_secret" } }, "description": "Your Lightspeed Retail X-Series client access" }, "refresh_token": { "title": "", "type": "string", "description": "Your Lightspeed Retail X-Series refresh token.", "format": "password", "example": "your_refresh_token" } }, "description": "" } } }, "lightspeed_retail_xseries_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/lightspeed_retail_xseries_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/lightspeed_retail_xseries_auth_V1" } ] }, "line_ads_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_key": { "title": "", "type": "string", "description": "Your LINE Ads access key.", "format": "password", "example": "your_line_ads_access_key" }, "group_id": { "title": "", "type": "string", "description": "Your LINE Ads group ID(s).", "example": "your_line_ads_group_id" }, "secret_key": { "title": "", "type": "string", "description": "Your LINE Ads secret key.", "format": "password", "example": "your_line_ads_secret_key" } }, "description": "" } } }, "line_ads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/line_ads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "linear_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Linear API key.", "format": "password", "example": "your_linear_api_key" } }, "description": "" } } }, "linear_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/linear_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "linkedin_ads_config_V1": { "properties": { "config": { "type": "object", "properties": { "accounts": { "title": "", "type": "array", "description": "Specific Account IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "ad_analytics": { "title": "", "type": "object", "description": "Whether to sync all analytic reports or specific. Default value: `AllReports`", "example": "SpecificReports | AllReports", "enum": [ "SpecificReports", "AllReports" ] }, "post_click_attribution_window_size": { "title": "", "type": "object", "description": "The time period to attribute conversions based on clicks. Default value: `DAY_30`", "example": "DAY_1 | DAY_30 | DAY_7 | DAY_28", "enum": [ "DAY_1", "DAY_30", "DAY_7", "DAY_28" ] }, "reports": { "title": "", "type": "array", "description": "Specific analytics reports to sync. Must be populated if adAnalytics is set to 'SpecificReports'.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all accounts or specific accounts. Default value: `AllAccounts`", "example": "AllAccounts | SpecificAccounts", "enum": [ "AllAccounts", "SpecificAccounts" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months for which to query reporting data included in the initial sync. This number cannot be modified once the connector is created. Default value: `ALL_TIME`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] }, "view_through_attribution_window_size": { "title": "", "type": "object", "description": "The time period to attribute conversions based on views. Default value: `DAY_7`", "example": "DAY_1 | DAY_30 | DAY_7 | DAY_28", "enum": [ "DAY_1", "DAY_30", "DAY_7", "DAY_28" ] } }, "description": "" } } }, "linkedin_ads_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your LinkedIn client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your LinkedIn client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "linkedin_ads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/linkedin_ads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/linkedin_ads_auth_V1" } ] }, "linkedin_company_pages_config_V1": { "properties": { "config": { "type": "object", "properties": { "social_data_sync_timeframe": { "title": "", "type": "object", "description": "The social data (UGCPosts, Shares, Comments) sync time frame in months. Default value: `SIX` .", "example": "SIX | TWELVE | THREE", "enum": [ "SIX", "TWELVE", "THREE" ] } }, "description": "" } } }, "linkedin_company_pages_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your LinkedIn client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your LinkedIn client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "linkedin_company_pages_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/linkedin_company_pages_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/linkedin_company_pages_auth_V1" } ] }, "linksquares_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your LinkSquares API key.", "format": "password", "example": "your_linksquares_api_key" } }, "description": "" } } }, "linksquares_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/linksquares_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "listen360_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Listen360 API key.", "format": "password", "example": "your_listen360_api_key" } }, "description": "" } } }, "listen360_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/listen360_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "livechat_partner_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Livechat Partner API Token.", "format": "password", "example": "your_livechat_partner_api_token" } }, "description": "" } } }, "livechat_partner_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/livechat_partner_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "livestorm_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Livestorm API key.", "format": "password", "example": "your_livestorm_api_key" } }, "description": "" } } }, "livestorm_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/livestorm_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "lob_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Lob API key.", "format": "password", "example": "your_lob_api_key" } }, "description": "" } } }, "lob_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/lob_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "local_file_system_config_V1": { "properties": { "config": { "type": "object", "properties": { "append_file_option": { "title": "", "type": "object", "description": "If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.", "example": "upsert_file_with_primary_keys | upsert_file | append_file", "enum": [ "upsert_file_with_primary_keys", "upsert_file", "append_file" ] }, "compression": { "title": "", "type": "object", "description": "The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.", "example": "zip | gz | tar_gz | tar | infer | gzip | uncompressed | bz2 | tar_bz2", "enum": [ "zip", "gz", "tar_gz", "tar", "infer", "gzip", "uncompressed", "bz2", "tar_bz2" ] }, "delimiter": { "title": "", "type": "string", "description": "You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.", "example": "string" }, "empty_header": { "title": "", "type": "boolean", "description": "Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.", "example": true }, "escape_char": { "title": "", "type": "string", "description": "If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.", "example": "string" }, "extraction_pattern": { "title": "", "type": "string", "description": "Required when `file_mapping_method` = `EXTRACT_TABLES`. A regular expression with a named capture group `(?
...)` to extract table names from file paths.", "example": "(?
\\w+)/.*" }, "file_mapping_method": { "title": "", "type": "object", "description": "The method used to map files to destination tables. Use `DEFINE_PER_TABLE` to manually configure each table with its own file pattern, or `EXTRACT_TABLES` to automatically discover tables based on a single extraction pattern.", "example": "EXTRACT_TABLES | DEFINE_PER_TABLE", "enum": [ "EXTRACT_TABLES", "DEFINE_PER_TABLE" ] }, "file_type": { "title": "", "type": "object", "description": "If your files are saved with improper extensions, you can force them to be synced as the selected file type.", "example": "tsv | xml | csv | spreadsheet | json | jsonl | avro | parquet", "enum": [ "tsv", "xml", "csv", "spreadsheet", "json", "jsonl", "avro", "parquet" ] }, "files": { "title": "", "type": "array", "description": "Required when `file_mapping_method` = `DEFINE_PER_TABLE`. Mapped file name patterns to a destination table.", "items": { "title": "", "type": "object", "properties": { "archive_pattern": { "title": "", "type": "string", "description": "All Files inside of compressed archives with filenames matching this regular expression will be synced.", "example": "string" }, "file_pattern": { "title": "", "type": "string", "description": "All files in your search path matching this regular expression will be synced per table.", "example": "string" }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "table_name": { "title": "", "type": "string", "description": "All files matching the above pattern will be synced to this table.", "example": "string" } }, "description": "Required when `file_mapping_method` = `DEFINE_PER_TABLE`. Mapped file name patterns to a destination table." } }, "json_delivery_mode": { "title": "", "type": "object", "description": "Control how your JSON data is delivered into your destination", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "line_separator": { "title": "", "type": "string", "description": "You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.", "example": "string" }, "null_sequence": { "title": "", "type": "string", "description": "If your CSVs use a special value indicating null, you can specify it here.", "example": "string" }, "on_error": { "title": "", "type": "object", "description": "If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.", "example": "fail | skip", "enum": [ "fail", "skip" ] }, "pgp_pass_phrase": { "title": "", "type": "string", "description": "The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.", "format": "password", "example": "" }, "pgp_secret_key": { "title": "", "type": "string", "description": "The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.", "format": "password", "example": "" }, "prefix": { "title": "", "type": "string", "description": "The absolute path on the host machine to the directory containing the files you want to sync. The Hybrid Deployment agent mounts this path read-only into the connector container at runtime.", "example": "/data/exports" }, "quote_char": { "title": "", "type": "string", "description": "You can specify the enclosing character used in your CSVs here. Fivetran will consider \" as the quote character if this field is empty and quote_character_enabled is set to true.", "example": "string" }, "quote_character_enabled": { "title": "", "type": "boolean", "description": "If you don't want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered \" as quote character.", "example": true }, "signer_public_key": { "title": "", "type": "string", "description": "The contents of the signer's public key file. This is optional — if you don't provide the key, we decrypt the files without verifying their signatures.", "example": "" }, "skip_after": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.", "format": "int32", "example": 0 }, "skip_before": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified before syncing data.", "format": "int32", "example": 0 }, "sync_inconsistent_rows": { "title": "", "type": "boolean", "description": "When enabled, Fivetran syncs rows with fewer or more columns than the header row. For rows with fewer columns, Fivetran adds NULL values for the missing columns. For rows with extra columns, Fivetran names them `column_`. When disabled, Fivetran handles inconsistent rows according to your error-handling settings.", "example": true }, "use_pgp_encryption_options": { "title": "", "type": "boolean", "description": "Set to `true` if files are encrypted using PGP. Default value: `false`.", "example": true } }, "description": "" } } }, "local_file_system_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/local_file_system_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table_group" } ] }, "looker_source_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Looker client ID.", "example": "your_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Looker client secret.", "format": "password", "example": "your_client_secret" }, "sub_domain": { "title": "", "type": "string", "description": "Your Looker domain name.", "example": "your_looker_domain" } }, "description": "" } } }, "looker_source_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/looker_source_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "loop_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Loop API key.", "format": "password", "example": "your_loop_api_key" } }, "description": "" } } }, "loop_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/loop_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "loopio_config_V1": { "properties": { "config": { "type": "object", "properties": { "app_key": { "title": "", "type": "string", "description": "Your Loopio App Key.", "example": "your_loopio_app_key" }, "secret": { "title": "", "type": "string", "description": "Your Loopio Secret.", "format": "password", "example": "your_loopio_secret" } }, "description": "" } } }, "loopio_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/loopio_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "lucca_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Lucca API key.", "format": "password", "example": "your_lucca_api_key" }, "environment": { "type": "object", "description": "Your Lucca environment.", "enum": [ "ilucca-test.ch", "ilucca.net", "ilucca-demo.ch", "ilucca-test.net", "ilucca.ch", "ilucca-demo.net" ] }, "sub_domain": { "title": "", "type": "string", "description": "Your Lucca subdomain.", "example": "your_lucca_sub_domain" } }, "description": "" } } }, "lucca_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/lucca_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "luma_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Luma API key.", "format": "password", "example": "your_luma_api_key" } }, "description": "" } } }, "luma_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/luma_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "magento_mysql_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Database authentication method", "example": "PASSWORD", "enum": [ "ENTRA_ID", "PASSWORD", "CLIENT_CERTIFICATE", "AWS_IAM" ] }, "client_private_key": { "title": "", "type": "string", "description": "Client Private Key in .pem format.", "format": "password", "example": "string" }, "client_public_certificate": { "title": "", "type": "string", "description": "Client Certificate in .pem format.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "mysqldb" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "mysqlinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 3306 }, "replica_id": { "title": "", "type": "integer", "description": "Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.", "format": "int32", "example": 4573961 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method to detect new or changed rows.
Supported values:
`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified.
`TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.", "example": "BINLOG | TELEPORT", "enum": [ "BINLOG", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "magento_mysql_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "magento_mysql_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/magento_mysql_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/magento_mysql_esm_keys_config_V1" } ] }, "magento_mysql_rds_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Database authentication method", "example": "PASSWORD | AWS_IAM", "enum": [ "PASSWORD", "AWS_IAM" ] }, "aws_region_code": { "title": "", "type": "object", "description": "The AWS region code for your RDS instance. Required if the authentication method is `AWS_IAM`.", "example": "us-east-1", "enum": [ "me-central-1", "aws-cn-global", "us-isof-south-1", "ap-east-2", "us-west-1", "us-west-2", "af-south-1", "ap-northeast-3", "ap-northeast-2", "ap-northeast-1", "me-south-1", "sa-east-1", "cn-north-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ap-southeast-5", "us-east-1", "us-east-2", "ap-southeast-7", "aws-iso-e-global", "cn-northwest-1", "ap-south-2", "ap-south-1", "eu-south-1", "eu-south-2", "us-gov-east-1", "il-central-1", "ca-central-1", "mx-central-1", "eu-central-1", "eusc-de-east-1", "us-iso-west-1", "eu-central-2", "eu-isoe-west-1", "aws-global", "eu-north-1", "eu-west-3", "eu-west-2", "eu-west-1", "aws-iso-global", "ap-east-1", "ca-west-1", "us-gov-west-1", "us-iso-east-1", "aws-iso-b-global", "aws-iso-f-global", "aws-us-gov-global", "us-isob-east-1", "us-isof-east-1" ] }, "client_private_key": { "title": "", "type": "string", "description": "Client Private Key in .pem format.", "format": "password", "example": "string" }, "client_public_certificate": { "title": "", "type": "string", "description": "Client Certificate in .pem format.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "mysqldb" }, "database_endpoint": { "title": "", "type": "string", "description": "The RDS database endpoint. Required if the connection type is `PrivateLink` and the authentication method is `AWS_IAM`, where `host` is set to the PrivateLink DNS address instead of the actual database endpoint.", "example": "mysqlinstance.mycompany.com" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address. When the connection type is `PrivateLink` and the authentication method is `AWS_IAM`, set this to the PrivateLink DNS address and use `databaseEndpoint` for the actual RDS endpoint.", "example": "mysqlinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 3306 }, "replica_id": { "title": "", "type": "integer", "description": "Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.", "format": "int32", "example": 4573961 }, "role_arn": { "title": "", "type": "string", "description": "The ARN of the IAM role with RDS permissions. Required if the authentication method is `AWS_IAM` in the SaaS Deployment model.", "format": "password", "example": "arn" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method to detect new or changed rows.
Supported values:
`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified.
`TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.", "example": "BINLOG | TELEPORT", "enum": [ "BINLOG", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "magento_mysql_rds_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "magento_mysql_rds_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/magento_mysql_rds_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/magento_mysql_rds_esm_keys_config_V1" } ] }, "mailchimp_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "mailchimp_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mailchimp_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "maileon_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Maileon API key.", "format": "password", "example": "your_maileon_api_key" } }, "description": "" } } }, "maileon_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/maileon_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "mailgun_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Mailgun API key.", "format": "password", "example": "your_mailgun_api_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your Mailgun subdomain.", "example": "string" }, "username": { "title": "", "type": "string", "description": "Your Mailgun API username.", "example": "your_mailgun_api_username" } }, "description": "" } } }, "mailgun_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mailgun_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "mailjet_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Mailjet API key.", "format": "password", "example": "your_mailjet_api_key" }, "secret_key": { "title": "", "type": "string", "description": "Your Mailjet secret key.", "format": "password", "example": "your_mailjet_secret_key" } }, "description": "" } } }, "mailjet_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mailjet_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "maintainx_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your MaintainX API key.", "format": "password", "example": "your_maintainx_api_key" } }, "description": "" } } }, "maintainx_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/maintainx_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "malomo_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Malomo API key.", "format": "password", "example": "your_malomo_api_key" } }, "description": "" } } }, "malomo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/malomo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "mambu_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Mambu API key.", "format": "password", "example": "your_mambu_api_key" }, "tenant_name": { "title": "", "type": "string", "description": "Your Mambu tenant name.", "example": "your_mambu_tenant_name" } }, "description": "" } } }, "mambu_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mambu_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "mandrill_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Mandrill API key.", "format": "password", "example": "xxxxxxxxxxxxxxxx" } }, "description": "" } } }, "mandrill_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mandrill_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "maria_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Database authentication method", "example": "PASSWORD", "enum": [ "ENTRA_ID", "PASSWORD", "CLIENT_CERTIFICATE", "AWS_IAM" ] }, "client_private_key": { "title": "", "type": "string", "description": "Client Private Key in .pem format.", "format": "password", "example": "string" }, "client_public_certificate": { "title": "", "type": "string", "description": "Client Certificate in .pem format.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "mysqldb" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "mysqlinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 3306 }, "replica_id": { "title": "", "type": "integer", "description": "Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.", "format": "int32", "example": 4573961 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method to detect new or changed rows.
Supported values:
`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified.
`TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.", "example": "BINLOG | TELEPORT", "enum": [ "BINLOG", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "maria_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "maria_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/maria_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/maria_esm_keys_config_V1" } ] }, "maria_azure_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Database authentication method", "example": "PASSWORD", "enum": [ "ENTRA_ID", "PASSWORD", "CLIENT_CERTIFICATE", "AWS_IAM" ] }, "client_private_key": { "title": "", "type": "string", "description": "Client Private Key in .pem format.", "format": "password", "example": "string" }, "client_public_certificate": { "title": "", "type": "string", "description": "Client Certificate in .pem format.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "mysqldb" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "mysqlinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 3306 }, "replica_id": { "title": "", "type": "integer", "description": "Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.", "format": "int32", "example": 4573961 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method to detect new or changed rows.
Supported values:
`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified.
`TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.", "example": "BINLOG | TELEPORT", "enum": [ "BINLOG", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "maria_azure_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "maria_azure_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/maria_azure_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/maria_azure_esm_keys_config_V1" } ] }, "maria_rds_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Database authentication method", "example": "PASSWORD | AWS_IAM", "enum": [ "PASSWORD", "AWS_IAM" ] }, "aws_region_code": { "title": "", "type": "object", "description": "The AWS region code for your RDS instance. Required if the authentication method is `AWS_IAM`.", "example": "us-east-1", "enum": [ "me-central-1", "aws-cn-global", "us-isof-south-1", "ap-east-2", "us-west-1", "us-west-2", "af-south-1", "ap-northeast-3", "ap-northeast-2", "ap-northeast-1", "me-south-1", "sa-east-1", "cn-north-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ap-southeast-5", "us-east-1", "us-east-2", "ap-southeast-7", "aws-iso-e-global", "cn-northwest-1", "ap-south-2", "ap-south-1", "eu-south-1", "eu-south-2", "us-gov-east-1", "il-central-1", "ca-central-1", "mx-central-1", "eu-central-1", "eusc-de-east-1", "us-iso-west-1", "eu-central-2", "eu-isoe-west-1", "aws-global", "eu-north-1", "eu-west-3", "eu-west-2", "eu-west-1", "aws-iso-global", "ap-east-1", "ca-west-1", "us-gov-west-1", "us-iso-east-1", "aws-iso-b-global", "aws-iso-f-global", "aws-us-gov-global", "us-isob-east-1", "us-isof-east-1" ] }, "client_private_key": { "title": "", "type": "string", "description": "Client Private Key in .pem format.", "format": "password", "example": "string" }, "client_public_certificate": { "title": "", "type": "string", "description": "Client Certificate in .pem format.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "mysqldb" }, "database_endpoint": { "title": "", "type": "string", "description": "The RDS database endpoint. Required if the connection type is `PrivateLink` and the authentication method is `AWS_IAM`, where `host` is set to the PrivateLink DNS address instead of the actual database endpoint.", "example": "mysqlinstance.mycompany.com" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address. When the connection type is `PrivateLink` and the authentication method is `AWS_IAM`, set this to the PrivateLink DNS address and use `databaseEndpoint` for the actual RDS endpoint.", "example": "mysqlinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 3306 }, "replica_id": { "title": "", "type": "integer", "description": "Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.", "format": "int32", "example": 4573961 }, "role_arn": { "title": "", "type": "string", "description": "The ARN of the IAM role with RDS permissions. Required if the authentication method is `AWS_IAM` in the SaaS Deployment model.", "format": "password", "example": "arn" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method to detect new or changed rows.
Supported values:
`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified.
`TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.", "example": "BINLOG | TELEPORT", "enum": [ "BINLOG", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "maria_rds_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "maria_rds_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/maria_rds_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/maria_rds_esm_keys_config_V1" } ] }, "marin_config_V1": { "properties": { "config": { "type": "object", "properties": { "host": { "title": "", "type": "string", "description": "The Marin host address.", "example": "marin_host_address" }, "password": { "title": "", "type": "string", "description": "The Marin user's password.", "format": "password", "example": "marin_password" }, "prefix": { "title": "", "type": "string", "description": "Folder path to the Marin manifest file.", "example": "string" }, "user": { "title": "", "type": "string", "description": "The Marin username.", "example": "marin_user" } }, "description": "" } } }, "marin_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the Marin user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the Marin username.", "example": "USER_KEY" } }, "description": "" } } }, "marin_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/marin_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/marin_esm_keys_config_V1" } ] }, "marketo_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_quota": { "title": "", "type": "integer", "description": "Allowed number of API requests to Marketo instance per day, the default value is 10000.", "format": "int32", "example": 10000 }, "client_id": { "title": "", "type": "string", "description": "Marketo REST API Client Id.", "example": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }, "client_secret": { "title": "", "type": "string", "description": "Marketo REST API Client Secret.", "format": "password", "example": "your_api_secret" }, "endpoint": { "title": "", "type": "string", "description": "Marketo REST API endpoint.", "example": "https://my.mktorest.com/rest" }, "historical_sync_limit": { "title": "", "type": "object", "description": "The time range for which historical data should be synced. Default value: `All Time`.", "example": "ALL_TIME | DATE_LIMIT", "enum": [ "ALL_TIME", "DATE_LIMIT" ] }, "historical_sync_limit_date": { "title": "", "type": "string", "description": "The start date (YYYY-MM-DD) from which to sync historical data.", "example": "2023-04-20" }, "identity": { "title": "", "type": "string", "description": "Marketo REST API identity url.", "example": "https://my.mktorest.com/identity" }, "prioritise_bulk_export_over_rest": { "title": "", "type": "boolean", "description": "Use BULK for both LEAD and ACTIITIES", "example": true }, "trailing_sync_enabled": { "title": "", "type": "boolean", "description": "Enable lookback window for activities", "example": true } }, "description": "" } } }, "marketo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/marketo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "matomo_config_V1": { "properties": { "config": { "type": "object", "properties": { "sub_domain": { "title": "", "type": "string", "description": "Your Matomo subdomain.", "example": "your_matomo_subdomain" }, "token": { "title": "", "type": "string", "description": "Your Matomo auth token.", "format": "password", "example": "your_matomo_token" } }, "description": "" } } }, "matomo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/matomo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "mavenlink_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "mavenlink_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mavenlink_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "maxio_chargify_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Maxio Chargify API key.", "format": "password", "example": "your_maxio_chargify_api_key" }, "domain": { "type": "object", "description": "The Maxio Chargify domain whose data you want to sync.", "enum": [ "chargify.com", "ebilling.maxio.com" ] }, "sub_domain": { "title": "", "type": "string", "description": "Your Maxio Chargify subdomain.", "example": "your_maxio_chargify_subdomain" } }, "description": "" } } }, "maxio_chargify_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/maxio_chargify_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "maxio_saasoptics_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_name": { "title": "", "type": "string", "description": "Your Maxio SaaSOptics account name.", "example": "your_maxio_saasoptics_account_name" }, "api_domain": { "type": "object", "description": "Your Maxio SaaSOptics API domain.", "enum": [ "saasoptics.com", "platform.maxio.com" ] }, "api_token": { "title": "", "type": "string", "description": "Your Maxio SaaSOptics API token.", "format": "password", "example": "your_maxio_saasoptics_api_token" }, "subdomain": { "title": "", "type": "string", "description": "Your Maxio SaaSOptics subdomain.", "example": "your_maxio_saasoptics_subdomain" } }, "description": "" } } }, "maxio_saasoptics_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/maxio_saasoptics_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "medallia_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Medallia Client ID", "format": "password", "example": "my_client_id" }, "client_name": { "title": "", "type": "string", "description": "Medallia company name", "format": "password", "example": "companyName" }, "client_secret": { "title": "", "type": "string", "description": "Medallia Client Secret key", "format": "password", "example": "my_client_secret" }, "domain_type": { "title": "", "type": "string", "description": "Domain type of your Medallia URL", "example": "eu" }, "subdomain": { "title": "", "type": "string", "description": "Medallia subdomain", "example": "subdomain" } }, "description": "" } } }, "medallia_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Medallia access token that contains all the information necessary for the API resources to fetch your data.", "example": "my_access_token" } }, "description": "" } } }, "medallia_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/medallia_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/medallia_auth_V1" } ] }, "medallia_agile_research_config_V1": { "properties": { "config": { "type": "object", "properties": { "region": { "type": "object", "description": "Your Medallia Agile region.", "enum": [ "eu", "eu2", "ca", "us", "ap" ] }, "x_key": { "title": "", "type": "string", "description": "Your Medallia Agile Research key.", "format": "password", "example": "your_medallia_agile_research_key" }, "x_master_key": { "title": "", "type": "string", "description": "Your Medallia Agile Research master key.", "format": "password", "example": "your_medallia_agile_research_master_key" } }, "description": "" } } }, "medallia_agile_research_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/medallia_agile_research_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "megaphone_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Megaphone API token.", "format": "password", "example": "your_meltwater_api_token" }, "organization_id": { "title": "", "type": "string", "description": "Your Megaphone organization ID.", "example": "your_megaphone_organization_id" } }, "description": "" } } }, "megaphone_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/megaphone_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "mention_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "mention_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "mention_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mention_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/mention_auth_V1" } ] }, "microsoft_dynamics_365_fno_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_method": { "title": "", "type": "object", "description": "Authentication Method", "example": "CONNECTION_STRING | SERVICE_PRINCIPAL_SECRET", "enum": [ "CONNECTION_STRING", "SERVICE_PRINCIPAL_SECRET" ] }, "connection_string": { "title": "", "type": "string", "description": "The blob storage container's connection string.", "format": "password", "example": "BlobEndpoint=https://abc123.blob.core.windows.net/;TableEndpoint=https://abc123.table.core.windows.net/;SharedAccessSignature=xxxxxxxxx" }, "container_name": { "title": "", "type": "string", "description": "The name of the blob container.", "example": "container_name" }, "source_file_type": { "title": "", "type": "object", "description": "The file type of the source files. Supported file types are `CSV` and `PARQUET`.", "example": "PARQUET | CSV", "enum": [ "PARQUET", "CSV" ] }, "storage_account_name": { "title": "", "type": "string", "description": "The name of the Azure Storage account.", "example": "storage_account_name" }, "sync_all_versions": { "title": "", "type": "boolean", "description": "Specify if all versions of the records should be synced. If set to `true`, all versions of the records will be synced. If set to `false`, only the latest version of the records will be synced.", "example": true } }, "description": "" } } }, "microsoft_dynamics_365_fno_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Microsoft client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Microsoft client application.", "example": "my_client_secret" }, "tenant_id": { "title": "", "type": "string", "description": "`Tenant ID` of your Microsoft client application.", "example": "41db1ebd-41a6-4dda-8029-5dd8f227d843" } }, "description": "" } } }, "microsoft_dynamics_365_fno_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/microsoft_dynamics_365_fno_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/microsoft_dynamics_365_fno_auth_V1" } ] }, "microsoft_entra_id_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Microsoft Entra ID Client ID.", "example": "your_microsoft_entra_id_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Microsoft Entra ID Client Secret.", "format": "password", "example": "your_microsoft_entra_id_client_secret" }, "tenant": { "title": "", "type": "string", "description": "Your Microsoft Entra ID Tenant.", "example": "your_microsoft_entra_id_tenant" } }, "description": "" } } }, "microsoft_entra_id_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/microsoft_entra_id_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "microsoft_lists_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_method": { "title": "", "type": "object", "description": "Authentication Method", "example": "AUTHORIZATION_CODE", "enum": [ "SERVICE_PRINCIPAL_SECRET", "MANAGED_IDENTITY_USER", "SERVICE_PRINCIPAL_CERTIFICATE", "MANAGED_IDENTITY_SYSTEM", "AUTHORIZATION_CODE" ] }, "site_id": { "title": "", "type": "string", "description": "The Site ID of the SharePoint site from which you want to sync your lists. The Site ID is the `id` field in the [Graph API](https://docs.microsoft.com/en-us/graph/api/site-search?view=graph-rest-1.0&tabs=http) response for sites.", "example": "target_site_id" }, "site_name": { "title": "", "type": "string", "description": "The Name of the SharePoint site. The Site Name is the `name` field in the Graph API response for sites.", "example": "target_site_name" } }, "description": "" } } }, "microsoft_lists_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Microsoft client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Microsoft client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived Refresh token carries the information necessary to get a new access token for API resources.", "example": "my_refresh_token" }, "tenant_id": { "title": "", "type": "string", "description": "`Tenant ID` of your Microsoft client application.", "example": "41db1ebd-41a6-4dda-8029-5dd8f227d843" } }, "description": "" } } }, "microsoft_lists_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/microsoft_lists_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/microsoft_lists_auth_V1" } ] }, "microsoft_power_bi_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Microsoft Power BI client ID.", "example": "your_microsoft_power_bi_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Microsoft Power BI client secret.", "format": "password", "example": "your_microsoft_power_bi_client_secret" }, "tenant": { "title": "", "type": "string", "description": "Your Microsoft Power BI tenant.", "example": "your_microsoft_power_bi_tenant" } }, "description": "" } } }, "microsoft_power_bi_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/microsoft_power_bi_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "microsoft_teams_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Microsoft Teams client ID.", "example": "your_microsoft_teams_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Microsoft Teams client secret.", "format": "password", "example": "your_microsoft_teams_client_secret" }, "tenant_id": { "title": "", "type": "string", "description": "Your Microsoft Teams tenant ID.", "example": "your_microsoft_teams_tenant_id" } }, "description": "" } } }, "microsoft_teams_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/microsoft_teams_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "missive_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Missive API token.", "format": "password", "example": "your_missive_api_token" } }, "description": "" } } }, "missive_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/missive_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "mixmax_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Mixmax API token.", "format": "password", "example": "your_mixmax_api_token" } }, "description": "" } } }, "mixmax_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mixmax_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "mixpanel_config_V1": { "properties": { "config": { "type": "object", "properties": { "backward_sync_limit_date": { "title": "", "type": "string", "description": "Date from which data needs to be synced.", "example": "string" }, "historical_sync_time_frame": { "type": "object", "description": "Should sync all data or adhere to `backward_sync_limit_date`", "enum": [ "ALL_TIME", "DATE_LIMIT" ] }, "project_id": { "title": "", "type": "string", "description": "Project ID", "example": "string" }, "region": { "type": "object", "description": "Data Region", "enum": [ "{\"defaultUrl\":\"mixpanel.com\",\"exportUrl\":\"data.mixpanel.com\"}", "{\"defaultUrl\":\"eu.mixpanel.com\",\"exportUrl\":\"data-eu.mixpanel.com\"}" ] }, "service_account_secret": { "title": "", "type": "string", "description": "Service Account Secret", "format": "password", "example": "string" }, "service_account_username": { "title": "", "type": "string", "description": "Service Account Username", "example": "string" } }, "description": "" } } }, "mixpanel_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mixpanel_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "mode_config_V1": { "properties": { "config": { "type": "object", "properties": { "secret": { "title": "", "type": "string", "description": "Your Mode Secret.", "format": "password", "example": "your_mode_secret" }, "token": { "title": "", "type": "string", "description": "Your Mode Token.", "format": "password", "example": "your_mode_token" }, "workspace": { "title": "", "type": "string", "description": "Your Mode Workspace.", "example": "your_mode_workspace" } }, "description": "" } } }, "mode_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mode_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "mollie_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Mollie API key.", "format": "password", "example": "your_api_key" } }, "description": "" } } }, "mollie_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mollie_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "moloco_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Moloco api_key", "format": "password", "example": "your_moloco_api_key" } }, "description": "" } } }, "moloco_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/moloco_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "monday_config_V1": { "properties": { "config": { "type": "object", "properties": { "personal_api_token": { "title": "", "type": "string", "description": "Your Monday.com Personal API Token.", "format": "password", "example": "your_monday_personal_api_token" } }, "description": "" } } }, "monday_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/monday_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "mongo_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS", "example": true }, "binary_representation": { "title": "", "type": "object", "description": "How binary data is represented in the database. Possible values: 'Base64' (default), 'Uuid'.", "example": "Base64 | Uuid", "enum": [ "Base64", "Uuid" ] }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "hosts": { "title": "", "type": "array", "description": "A list of host addresses of the primary node and all replicas. Each list item is either: a DB instance host/IP address with a port number, or SRV host record.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "packed_mode_tables": { "title": "", "type": "array", "description": "List of tables to be synced in packed mode; format:`.
`(case-sensitive).", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "packing_mode": { "title": "", "type": "object", "description": "Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: `UseUnpackedModeOnly`.", "example": "UsePackedModeOnly | UseUnpackedModeOnly", "enum": [ "UsePackedModeOnly", "UseUnpackedModeOnly" ] }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "mongo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mongo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" } ] }, "mongo_sharded_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "binary_representation": { "title": "", "type": "object", "description": "How binary data is represented in the database. Possible values: 'Base64' (default), 'Uuid'.", "example": "Base64 | Uuid", "enum": [ "Base64", "Uuid" ] }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "hosts": { "title": "", "type": "array", "description": "A list of host addresses of the primary node and all replicas. Each list item is either: a DB instance host/IP address with a port number, or SRV host record.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "packed_mode_tables": { "title": "", "type": "array", "description": "List of tables to be synced in packed mode; format:`.
`(case-sensitive).", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "packing_mode": { "title": "", "type": "object", "description": "Whether to sync all tables in unpacked mode only, all tables in packed mode only, or specific tables in packed mode. Default value: `UseUnpackedModeOnly`.", "example": "UsePackedModeOnly | UseUnpackedModeOnly", "enum": [ "UsePackedModeOnly", "UseUnpackedModeOnly" ] }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "mongo_sharded_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mongo_sharded_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" } ] }, "mountain_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your MNTN API key.", "format": "password", "example": "your_mntn_reporting_api_key" } }, "description": "" } } }, "mountain_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mountain_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "mux_config_V1": { "properties": { "config": { "type": "object", "properties": { "token_id": { "title": "", "type": "string", "description": "Your Mux token ID", "format": "password", "example": "your_mux_token_id" }, "token_secret_key": { "title": "", "type": "string", "description": "Your Mux token secret key", "format": "password", "example": "your_mux_token_secret_key" } }, "description": "" } } }, "mux_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mux_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "myosh_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your myosh API key.", "format": "password", "example": "your_myosh_api_key" }, "password": { "title": "", "type": "string", "description": "Your myosh password.", "format": "password", "example": "your_myosh_password" }, "server_variable": { "title": "", "type": "string", "description": "Your myosh server variable.", "example": "your_myosh_server_variable" }, "sub_domain": { "type": "object", "description": "Your myosh subdomain.", "enum": [ "oteapi", "api", "testapi" ] }, "username": { "title": "", "type": "string", "description": "Your myosh username.", "example": "your_myosh_username" } }, "description": "" } } }, "myosh_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/myosh_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "mysql_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Database authentication method", "example": "PASSWORD", "enum": [ "ENTRA_ID", "PASSWORD", "CLIENT_CERTIFICATE", "AWS_IAM" ] }, "client_private_key": { "title": "", "type": "string", "description": "Client Private Key in .pem format.", "format": "password", "example": "string" }, "client_public_certificate": { "title": "", "type": "string", "description": "Client Certificate in .pem format.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "mysqldb" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "mysqlinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 3306 }, "replica_id": { "title": "", "type": "integer", "description": "Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.", "format": "int32", "example": 4573961 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method to detect new or changed rows.
Supported values:
`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified.
`TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.", "example": "BINLOG | TELEPORT", "enum": [ "BINLOG", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "mysql_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "mysql_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mysql_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/mysql_esm_keys_config_V1" } ] }, "mysql_azure_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Database authentication method", "example": "PASSWORD", "enum": [ "ENTRA_ID", "PASSWORD", "CLIENT_CERTIFICATE", "AWS_IAM" ] }, "client_private_key": { "title": "", "type": "string", "description": "Client Private Key in .pem format.", "format": "password", "example": "string" }, "client_public_certificate": { "title": "", "type": "string", "description": "Client Certificate in .pem format.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "mysqldb" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "mysqlinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 3306 }, "replica_id": { "title": "", "type": "integer", "description": "Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.", "format": "int32", "example": 4573961 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method to detect new or changed rows.
Supported values:
`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified.
`TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.", "example": "BINLOG | TELEPORT", "enum": [ "BINLOG", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "mysql_azure_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "mysql_azure_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mysql_azure_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/mysql_azure_esm_keys_config_V1" } ] }, "mysql_rds_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Database authentication method", "example": "PASSWORD | AWS_IAM", "enum": [ "PASSWORD", "AWS_IAM" ] }, "aws_region_code": { "title": "", "type": "object", "description": "The AWS region code for your RDS instance. Required if the authentication method is `AWS_IAM`.", "example": "us-east-1", "enum": [ "me-central-1", "aws-cn-global", "us-isof-south-1", "ap-east-2", "us-west-1", "us-west-2", "af-south-1", "ap-northeast-3", "ap-northeast-2", "ap-northeast-1", "me-south-1", "sa-east-1", "cn-north-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ap-southeast-4", "ap-southeast-5", "us-east-1", "us-east-2", "ap-southeast-7", "aws-iso-e-global", "cn-northwest-1", "ap-south-2", "ap-south-1", "eu-south-1", "eu-south-2", "us-gov-east-1", "il-central-1", "ca-central-1", "mx-central-1", "eu-central-1", "eusc-de-east-1", "us-iso-west-1", "eu-central-2", "eu-isoe-west-1", "aws-global", "eu-north-1", "eu-west-3", "eu-west-2", "eu-west-1", "aws-iso-global", "ap-east-1", "ca-west-1", "us-gov-west-1", "us-iso-east-1", "aws-iso-b-global", "aws-iso-f-global", "aws-us-gov-global", "us-isob-east-1", "us-isof-east-1" ] }, "client_private_key": { "title": "", "type": "string", "description": "Client Private Key in .pem format.", "format": "password", "example": "string" }, "client_public_certificate": { "title": "", "type": "string", "description": "Client Certificate in .pem format.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "mysqldb" }, "database_endpoint": { "title": "", "type": "string", "description": "The RDS database endpoint. Required if the connection type is `PrivateLink` and the authentication method is `AWS_IAM`, where `host` is set to the PrivateLink DNS address instead of the actual database endpoint.", "example": "mysqlinstance.mycompany.com" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address. When the connection type is `PrivateLink` and the authentication method is `AWS_IAM`, set this to the PrivateLink DNS address and use `databaseEndpoint` for the actual RDS endpoint.", "example": "mysqlinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 3306 }, "replica_id": { "title": "", "type": "integer", "description": "Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.", "format": "int32", "example": 4573961 }, "role_arn": { "title": "", "type": "string", "description": "The ARN of the IAM role with RDS permissions. Required if the authentication method is `AWS_IAM` in the SaaS Deployment model.", "format": "password", "example": "arn" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method to detect new or changed rows.
Supported values:
`BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified.
`TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.", "example": "BINLOG | TELEPORT", "enum": [ "BINLOG", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "mysql_rds_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "mysql_rds_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/mysql_rds_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/mysql_rds_esm_keys_config_V1" } ] }, "namely_config_V1": { "properties": { "config": { "type": "object", "properties": { "sub_domain": { "title": "", "type": "string", "description": "Your Namely subdomain.", "example": "your_namely_subdomain" } }, "description": "" } } }, "namely_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "namely_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/namely_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/namely_auth_V1" } ] }, "national_heavy_vehicle_regulator_config_V1": { "properties": { "config": { "type": "object", "properties": { "hostname": { "type": "object", "description": "Your National Heavy Vehicle Regulator hostname.", "enum": [ "api-mobile.nhvr.gov.au", "api-public.nhvr.gov.au" ] }, "subscription_key": { "title": "", "type": "string", "description": "Your NHVR Portal API subscription key.", "format": "password", "example": "your_nhvr_portal_api_subscription_key" } }, "description": "" } } }, "national_heavy_vehicle_regulator_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/national_heavy_vehicle_regulator_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "navan_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Navan client ID.", "example": "your_navan_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Navan client secret.", "format": "password", "example": "your_navan_client_secret" }, "url": { "type": "object", "description": "Your Navan url.", "enum": [ "{\"header\":\"US\",\"host\":\"https:\\/\\/api.tripactions.com\"}", "{\"header\":\"EU\",\"host\":\"https:\\/\\/app-fra.tripactions.com\"}" ] } }, "description": "" } } }, "navan_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/navan_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "netsuite_suiteanalytics_config_V1": { "properties": { "config": { "type": "object", "properties": { "account": { "title": "", "type": "string", "description": "The NetSuite Account ID.", "example": "netsuite_account_id" }, "certificate_id": { "title": "", "type": "string", "description": "Certificate Id", "format": "password", "example": "certificate_id" }, "consumer_key": { "title": "", "type": "string", "description": "Consumer Key", "format": "password", "example": "netsuite_consumer_key" }, "consumer_secret": { "title": "", "type": "string", "description": "Consumer Secret", "format": "password", "example": "netsuite_consumer_secret" }, "datasource": { "title": "", "type": "object", "description": "The NetSuite data source value: `NetSuite.com`.", "example": "NetSuite2.com", "enum": [ "NetSuite2.com", "NetSuite.com" ] }, "email": { "title": "", "type": "string", "description": "The NetSuite user's email address.", "example": "netsuite_email" }, "host": { "title": "", "type": "string", "description": "The NetSuite service host address.", "example": "netsuite_service_host" }, "password": { "title": "", "type": "string", "description": "The NetSuite user's password.", "format": "password", "example": "netsuite_password" }, "port": { "title": "", "type": "integer", "description": "The NetSuite service host port.", "format": "int32" }, "private_key": { "title": "", "type": "string", "description": "Private Key", "format": "password", "example": "private_key" }, "role": { "title": "", "type": "string", "description": "The NetSuite Role ID for connection.", "example": "netsuite_role_id" }, "should_sync_reimport_tables": { "title": "", "type": "boolean", "description": "Re-sync re-import tables during every sync", "example": true }, "token_key": { "title": "", "type": "string", "description": "Token ID", "format": "password", "example": "netsuite_token_key" }, "token_secret": { "title": "", "type": "string", "description": "Token Secret", "format": "password", "example": "netsuite_token_secret" } }, "description": "" } } }, "netsuite_suiteanalytics_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/netsuite_suiteanalytics_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "nice_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_key_id": { "title": "", "type": "string", "description": "Your NICE access key ID.", "example": "your_nice_access_key_id" }, "access_key_secret": { "title": "", "type": "string", "description": "Your NICE access key secret.", "format": "password", "example": "your_nice_access_key_secret" }, "base_url": { "title": "", "type": "string", "description": "Your NICE base URL.", "example": "your_nice_base_url" }, "client_id": { "title": "", "type": "string", "description": "Your NICE client ID.", "example": "your_nice_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your NICE client secret.", "format": "password", "example": "your_nice_client_secret" } }, "description": "" } } }, "nice_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/nice_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "notion_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "notion_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/notion_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "nylas_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Nylas access_token.", "format": "password", "example": "your_nylas_access_token" }, "sub_domain": { "type": "object", "description": "Your Nylas subdomain.", "enum": [ "ireland.api", "api" ] } }, "description": "" } } }, "nylas_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/nylas_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "odoo_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Odoo API key.", "format": "password", "example": "your_odoo_api_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your Odoo subdomain.", "format": "password", "example": "your_odoo_subdomain" } }, "description": "" } } }, "odoo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/odoo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "odoo_synconics_config_V1": { "properties": { "config": { "type": "object", "properties": { "consumer_key": { "title": "", "type": "string", "description": "Consumer key of the OAuth application that you want the connection to use for authentication.", "example": "string" }, "consumer_secret": { "title": "", "type": "string", "description": "Consumer secret of the OAuth application that you want the connection to use for authentication.", "format": "password", "example": "string" }, "sub_domain": { "title": "", "type": "string", "description": "Your Odoo subdomain.", "example": "string" } }, "description": "" } } }, "odoo_synconics_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "odoo_synconics_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/odoo_synconics_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/odoo_synconics_auth_V1" } ] }, "okendo_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Okendo API key.", "format": "password", "example": "string" }, "user_id": { "title": "", "type": "string", "description": "Your Okendo user ID.", "example": "string" } }, "description": "" } } }, "okendo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/okendo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "okta_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Okta API token.", "format": "password", "example": "your_okta_api_token" }, "domain": { "type": "object", "description": "Your Okta domain.", "enum": [ "", ".okta.com", ".okta-emea.com", ".oktapreview.com" ] }, "sub_domain": { "title": "", "type": "string", "description": "Your Okta subdomain.", "example": "yourSubDomain" } }, "description": "" } } }, "okta_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/okta_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ometria_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Ometria API Key.", "format": "password", "example": "your_ometria_api_key" } }, "description": "" } } }, "ometria_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ometria_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "on24_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your ON24 client ID.", "example": "your_on24_client_id" }, "region": { "type": "object", "description": "Your ON24 region.", "enum": [ "api.eu", "api" ] }, "token_key": { "title": "", "type": "string", "description": "Your ON24 token key.", "format": "password", "example": "your_on24_token_key" }, "token_secret": { "title": "", "type": "string", "description": "Your ON24 token secret.", "format": "password", "example": "your_on24_token_secret" } }, "description": "" } } }, "on24_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/on24_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "oncehub_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your OnceHub API key.", "format": "password", "example": "your_oncehub_api_key" } }, "description": "" } } }, "oncehub_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/oncehub_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "one_drive_config_V1": { "properties": { "config": { "type": "object", "properties": { "folder_path": { "title": "", "type": "string", "description": "Your OneDrive folder URL", "example": "target_folder_path" } }, "description": "" } } }, "one_drive_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Microsoft OneDrive client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Microsoft OneDrive client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` carries the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "one_drive_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/one_drive_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/one_drive_auth_V1" } ] }, "onetrust_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_integration_type": { "type": "object", "description": "Your OneTrust API integration type.", "enum": [ "consentmanager/v1/datasubjects/profiles", "/cmp/v1/webscans", "/assessment/v2/assessments" ] }, "client_id": { "title": "", "type": "string", "description": "Your OneTrust client ID.", "example": "onetrust_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your OneTrust client secret.", "format": "password", "example": "onetrust_client_secret" }, "sub_domain": { "title": "", "type": "string", "description": "Your OneTrust subdomain.", "example": "your_onetrust_subdomain" } }, "description": "" } } }, "onetrust_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/onetrust_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "open_data_dc_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "open_data_dc_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/open_data_dc_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "open_exchange_rates_config_V1": { "properties": { "config": { "type": "object", "properties": { "app_id": { "title": "", "type": "string", "description": "Your Open Exchange Rates App Id.", "format": "password", "example": "your_app_id" }, "base_currency": { "type": "object", "description": "Your Open Exchange Rates Base Currency.", "enum": [ "FJD", "MXN", "STD", "SCR", "CDF", "BBD", "HNL", "UGX", "ZAR", "STN", "CUC", "STR", "BSD", "SDG", "IQD", "CUP", "GMD", "TWD", "RSD", "MYR", "FKP", "XOF", "BTC", "UYU", "CVE", "OMR", "KES", "SEK", "BTN", "GNF", "MZN", "BTS", "SVC", "ARS", "PPC", "QAR", "IRR", "XPD", "THB", "UZS", "XPF", "VEF_BLKMKT", "BDT", "XPM", "LYD", "KWD", "XPT", "RUB", "ISK", "NMC", "MKD", "VEF_DICOM", "DZD", "PAB", "SGD", "JEP", "KGS", "XAF", "XAG", "CHF", "HRK", "DJF", "DOGE", "TZS", "VND", "AUD", "KHR", "IDR", "KYD", "XRP", "Gold (troy ounce)", "BWP", "SHP", "TJS", "AED", "RWF", "DKK", "BGN", "MMK", "NOK", "SYP", "LKR", "CZK", "XCD", "HTG", "BHD", "VEF_DIPRO", "KZT", "SZL", "YER", "AFN", "AWG", "NPR", "MNT", "GBP", "BYN", "HUF", "BYR", "BIF", "XDR", "BZD", "MOP", "NAD", "PEN", "WST", "TMT", "CLF", "GTQ", "CLP", "TND", "SLL", "DOP", "KMF", "EAC", "GEL", "MAD", "TOP", "FTC", "AZN", "PGK", "FCT", "CNH", "UAH", "ERN", "VTC", "MRO", "CNY", "MRU", "BMD", "PHP", "PYG", "JMD", "COP", "USD", "GGP", "ETB", "SOS", "VUV", "LAK", "ETH", "LD", "BND", "ZMK", "NVC", "LRD", "ALL", "MTL", "VES", "ZMW", "DASH", "ILS", "GHS", "GYD", "KPW", "BOB", "MDL", "AMD", "TRY", "LBP", "JOD", "HKD", "EUR", "LSL", "CAD", "EEK", "MUR", "IMP", "GIP", "RON", "NGN", "CRC", "PKR", "ANG", "LTC", "SRD", "SAR", "TTD", "MVR", "NXT", "INR", "KRW", "JPY", "AOA", "PLN", "SBD", "MWK", "MGA", "BAM", "EGP", "SSP", "NIO", "NZD", "XMR", "BRL" ] } }, "description": "" } } }, "open_exchange_rates_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/open_exchange_rates_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "openai_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your OpenAI Platform Admin API key.", "format": "password", "example": "your_openai_platform_admin_api_key" }, "api_key_2": { "title": "", "type": "string", "description": "The API key for the OpenAI Platform project whose data you want to sync.", "format": "password", "example": "your_openai_platform_project_api_key" }, "api_key_3": { "title": "", "type": "string", "description": "Your ChatGPT Admin key for syncing Codex Enterprise Analytics API and Compliance Platform data.", "format": "password", "example": "your_chatgpt_admin_key" }, "organization_id": { "title": "", "type": "string", "description": "The ID of the OpenAI API Platform organization whose organization-level Compliance Platform data you want to sync.", "example": "your_openai_platform_organization_id" }, "workspace_id": { "title": "", "type": "string", "description": "The ID of the ChatGPT Enterprise or Edu workspace whose data you want to sync.", "example": "your_workspace_id" } }, "description": "" } } }, "openai_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/openai_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "openai_compliance_platform_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your OpenAI Compliance Platform API key.", "format": "password", "example": "your_openai_compliance_platform_api_key" }, "organization_id": { "title": "", "type": "string", "description": "Your OpenAI Compliance Platform organization ID.", "example": "your_openai_compliance_platform_organization_id" }, "workspace_id": { "title": "", "type": "string", "description": "Your OpenAI Compliance Platform workspace ID.", "example": "your_openai_compliance_platform_workspace_id" } }, "description": "" } } }, "openai_compliance_platform_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/openai_compliance_platform_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "opendistro_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Default value: true. Set to false if TLS is not required when using an SSH tunnel.", "example": true }, "authentication_method": { "title": "", "type": "object", "description": "The authentication method used to connect to your cluster.", "example": "BASICAUTH | APIKEY", "enum": [ "BASICAUTH", "APIKEY" ] }, "capture_deletes": { "title": "", "type": "boolean", "description": "Whether to capture hard deletes, meaning source documents removed from the index. Set to false to skip hard-delete detection, which may improve connector performance for sources that do not hard-delete documents. This does not affect source-level soft-delete fields; those fields sync as ordinary document updates. If you re-enable delete capture later, resync the affected tables to rebuild an accurate delete baseline. Default value: true.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | SshTunnel", "enum": [ "Directly", "SshTunnel" ] }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "opensearchinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 443 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect using an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect using an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect using an SSH tunnel.", "example": "tunnel_user" }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "user" } }, "description": "" } } }, "opendistro_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "opendistro_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/opendistro_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/opendistro_esm_keys_config_V1" } ] }, "opensearch_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Default value: true. Set to false if TLS is not required when using an SSH tunnel.", "example": true }, "authentication_method": { "title": "", "type": "object", "description": "The authentication method used to connect to your cluster.", "example": "BASICAUTH | APIKEY", "enum": [ "BASICAUTH", "APIKEY" ] }, "capture_deletes": { "title": "", "type": "boolean", "description": "Whether to capture hard deletes, meaning source documents removed from the index. Set to false to skip hard-delete detection, which may improve connector performance for sources that do not hard-delete documents. This does not affect source-level soft-delete fields; those fields sync as ordinary document updates. If you re-enable delete capture later, resync the affected tables to rebuild an accurate delete baseline. Default value: true.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | SshTunnel", "enum": [ "Directly", "SshTunnel" ] }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "opensearchinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 443 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect using an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect using an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect using an SSH tunnel.", "example": "tunnel_user" }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "user" } }, "description": "" } } }, "opensearch_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "opensearch_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/opensearch_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/opensearch_esm_keys_config_V1" } ] }, "optimizely_config_V1": { "properties": { "config": { "type": "object", "properties": { "enriched_export": { "title": "", "type": "string", "description": "Enriched Events S3 bucket", "example": "string" }, "packing_mode": { "title": "", "type": "object", "description": "Packing mode for conversion and decision tables.", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] } }, "description": "" } } }, "optimizely_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Optimizely client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Optimizely client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "optimizely_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/optimizely_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/optimizely_auth_V1" } ] }, "oracle_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "asm_staging_directory": { "title": "", "type": "string", "description": "ASM staging directory path. Required when the ASM option is enabled.", "example": "string" }, "cdb_database": { "title": "", "type": "string", "description": "Optional: CDB database name for TDE-encrypted containerized databases.", "example": "string" }, "cdb_password": { "title": "", "type": "string", "description": "Optional: Password for the CDB user.", "format": "password", "example": "string" }, "cdb_user": { "title": "", "type": "string", "description": "Optional: CDB user for TDE-encrypted containerized databases.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "oracledb" }, "enable_asm": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using ASM.", "example": true }, "enable_symbolic_links": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using symbolic links.", "example": true }, "enable_tde_encryption": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using TDE encryption.", "example": true }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "oracleinstance.mycompany.com" }, "local_wallet_host": { "title": "", "type": "string", "description": "Optional: The host for the local Oracle Wallet.", "example": "string" }, "local_wallet_user": { "title": "", "type": "string", "description": "Optional: The user for the local Oracle Wallet.", "example": "string" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "pdb_name": { "title": "", "type": "string", "description": "Optional: Required only for containerized database.", "example": "string" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 1521 }, "symbolic_links_mapping": { "title": "", "type": "array", "description": "Mapping of symbolic links to actual file paths. Required when symbolic links are enabled.", "items": { "type": "object", "properties": {}, "description": "" } }, "tde_wallet_password": { "title": "", "type": "string", "description": "TDE wallet password. Required for password based wallet.", "format": "password", "example": "tde_wallet_password" }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method used to detect new or changed rows. Supported values: - `BINARY_LOG_READER` - Fivetran reads Oracle redo logs to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.", "example": "BINARY_LOG_READER | LOGMINER | TELEPORT", "enum": [ "BINARY_LOG_READER", "LOGMINER", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "oracle_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "oracle_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/oracle_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/oracle_esm_keys_config_V1" } ] }, "oracle_business_intelligence_publisher_config_V1": { "properties": { "config": { "type": "object", "properties": { "data_model_path_alias_list": { "title": "", "type": "array", "description": "Data Model Paths (Optional)", "items": { "title": "", "type": "object", "properties": { "alias": { "title": "", "type": "string", "description": "Schema name", "example": "sample_schema" }, "path": { "title": "", "type": "string", "description": "Path", "example": "/Custom/data_models" } }, "description": "Data Model Paths (Optional)" } }, "folder_path": { "title": "", "type": "string", "description": "The folder path to save data models and reports.", "example": "/Custom/test_folder" }, "password": { "title": "", "type": "string", "description": "The Oracle Business Intelligence user password.", "format": "password", "example": "test_password" }, "server_url": { "title": "", "type": "string", "description": "The Oracle Business Intelligence Instance URL.", "example": "https://:" }, "username": { "title": "", "type": "string", "description": "The Oracle Business Intelligence username.", "example": "test_username" } }, "description": "" } } }, "oracle_business_intelligence_publisher_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/oracle_business_intelligence_publisher_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" } ] }, "oracle_ebs_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "asm_staging_directory": { "title": "", "type": "string", "description": "ASM staging directory path. Required when the ASM option is enabled.", "example": "string" }, "cdb_database": { "title": "", "type": "string", "description": "Optional: CDB database name for TDE-encrypted containerized databases.", "example": "string" }, "cdb_password": { "title": "", "type": "string", "description": "Optional: Password for the CDB user.", "format": "password", "example": "string" }, "cdb_user": { "title": "", "type": "string", "description": "Optional: CDB user for TDE-encrypted containerized databases.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "oracledb" }, "enable_asm": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using ASM.", "example": true }, "enable_symbolic_links": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using symbolic links.", "example": true }, "enable_tde_encryption": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using TDE encryption.", "example": true }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "oracleinstance.mycompany.com" }, "local_wallet_host": { "title": "", "type": "string", "description": "Optional: The host for the local Oracle Wallet.", "example": "string" }, "local_wallet_user": { "title": "", "type": "string", "description": "Optional: The user for the local Oracle Wallet.", "example": "string" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "pdb_name": { "title": "", "type": "string", "description": "Optional: Required only for containerized database.", "example": "string" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 1521 }, "symbolic_links_mapping": { "title": "", "type": "array", "description": "Mapping of symbolic links to actual file paths. Required when symbolic links are enabled.", "items": { "type": "object", "properties": {}, "description": "" } }, "tde_wallet_password": { "title": "", "type": "string", "description": "TDE wallet password. Required for password based wallet.", "format": "password", "example": "tde_wallet_password" }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method used to detect new or changed rows. Supported values: - `BINARY_LOG_READER` - Fivetran reads Oracle redo logs to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.", "example": "BINARY_LOG_READER | LOGMINER", "enum": [ "BINARY_LOG_READER", "LOGMINER" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "oracle_ebs_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "oracle_ebs_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/oracle_ebs_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/oracle_ebs_esm_keys_config_V1" } ] }, "oracle_fusion_cloud_apps_crm_config_V1": { "properties": { "config": { "type": "object", "properties": { "authentication_method": { "title": "", "type": "object", "description": "The Oracle Fusion Cloud authentication method.", "example": "JWT | BASIC", "enum": [ "JWT", "BASIC" ] }, "delete_capture_frequency": { "title": "", "type": "object", "description": "Use this option to configure how often the connection captures deletes.", "example": "EVERY_WEEK | EVERY_SYNC | NEVER | EVERY_DAY", "enum": [ "EVERY_WEEK", "EVERY_SYNC", "NEVER", "EVERY_DAY" ] }, "effective_date_disabled": { "title": "", "type": "boolean", "description": "Select this option to extract all historical records without applying a date filter. Console allows setting this option for all datastores in the connector.", "example": true }, "issuer": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud issuer name.", "example": "test_issuer" }, "partial_resync_lookback_unit": { "title": "", "type": "object", "description": "The unit (Hours or Days) for partialResyncLookbackValue.", "example": "HOURS | DAYS", "enum": [ "HOURS", "DAYS" ] }, "partial_resync_lookback_value": { "title": "", "type": "integer", "description": "The size of the partial resync lookback window, in the unit specified by partialResyncLookbackUnit. The value must be between 24 hours and 30 days.", "format": "int32", "example": 24 }, "password": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud user password.", "format": "password", "example": "test_password" }, "perform_partial_resync": { "title": "", "type": "boolean", "description": "Once per day, re-sync data for incremental tables to catch late-arriving or backdated records that the incremental filter may miss, extending the lookback window by partialResyncLookbackValue/partialResyncLookbackUnit. Disabling this may reduce sync duration but can cause some updates to be missed.", "example": true }, "private_key": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud private key.", "format": "password", "example": "test_private_key" }, "public_key": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud public key.", "format": "password", "example": "test_public_key" }, "server_url": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud Instance URL.", "example": "https://:" }, "username": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud username.", "example": "test_username" } }, "description": "" } } }, "oracle_fusion_cloud_apps_crm_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the Oracle Fusion Cloud user password.", "example": "PASSWORD_KEY" }, "username": { "title": "", "type": "string", "description": "ESM key for the Oracle Fusion Cloud username.", "example": "USERNAME_KEY" } }, "description": "" } } }, "oracle_fusion_cloud_apps_crm_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/oracle_fusion_cloud_apps_crm_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/oracle_fusion_cloud_apps_crm_esm_keys_config_V1" } ] }, "oracle_fusion_cloud_apps_fscm_config_V1": { "properties": { "config": { "type": "object", "properties": { "authentication_method": { "title": "", "type": "object", "description": "The Oracle Fusion Cloud authentication method.", "example": "JWT | BASIC", "enum": [ "JWT", "BASIC" ] }, "delete_capture_frequency": { "title": "", "type": "object", "description": "Use this option to configure how often the connection captures deletes.", "example": "EVERY_WEEK | EVERY_SYNC | NEVER | EVERY_DAY", "enum": [ "EVERY_WEEK", "EVERY_SYNC", "NEVER", "EVERY_DAY" ] }, "effective_date_disabled": { "title": "", "type": "boolean", "description": "Select this option to extract all historical records without applying a date filter. Console allows setting this option for all datastores in the connector.", "example": true }, "issuer": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud issuer name.", "example": "test_issuer" }, "partial_resync_lookback_unit": { "title": "", "type": "object", "description": "The unit (Hours or Days) for partialResyncLookbackValue.", "example": "HOURS | DAYS", "enum": [ "HOURS", "DAYS" ] }, "partial_resync_lookback_value": { "title": "", "type": "integer", "description": "The size of the partial resync lookback window, in the unit specified by partialResyncLookbackUnit. The value must be between 24 hours and 30 days.", "format": "int32", "example": 24 }, "password": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud user password.", "format": "password", "example": "test_password" }, "perform_partial_resync": { "title": "", "type": "boolean", "description": "Once per day, re-sync data for incremental tables to catch late-arriving or backdated records that the incremental filter may miss, extending the lookback window by partialResyncLookbackValue/partialResyncLookbackUnit. Disabling this may reduce sync duration but can cause some updates to be missed.", "example": true }, "private_key": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud private key.", "format": "password", "example": "test_private_key" }, "public_key": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud public key.", "format": "password", "example": "test_public_key" }, "server_url": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud Instance URL.", "example": "https://:" }, "username": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud username.", "example": "test_username" } }, "description": "" } } }, "oracle_fusion_cloud_apps_fscm_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the Oracle Fusion Cloud user password.", "example": "PASSWORD_KEY" }, "username": { "title": "", "type": "string", "description": "ESM key for the Oracle Fusion Cloud username.", "example": "USERNAME_KEY" } }, "description": "" } } }, "oracle_fusion_cloud_apps_fscm_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/oracle_fusion_cloud_apps_fscm_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/oracle_fusion_cloud_apps_fscm_esm_keys_config_V1" } ] }, "oracle_fusion_cloud_apps_hcm_config_V1": { "properties": { "config": { "type": "object", "properties": { "authentication_method": { "title": "", "type": "object", "description": "The Oracle Fusion Cloud authentication method.", "example": "JWT | BASIC", "enum": [ "JWT", "BASIC" ] }, "delete_capture_frequency": { "title": "", "type": "object", "description": "Use this option to configure how often the connection captures deletes.", "example": "EVERY_WEEK | EVERY_SYNC | NEVER | EVERY_DAY", "enum": [ "EVERY_WEEK", "EVERY_SYNC", "NEVER", "EVERY_DAY" ] }, "effective_date_disabled": { "title": "", "type": "boolean", "description": "Select this option to extract all historical records without applying a date filter. Console allows setting this option for all datastores in the connector.", "example": true }, "issuer": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud issuer name.", "example": "test_issuer" }, "partial_resync_lookback_unit": { "title": "", "type": "object", "description": "The unit (Hours or Days) for partialResyncLookbackValue.", "example": "HOURS | DAYS", "enum": [ "HOURS", "DAYS" ] }, "partial_resync_lookback_value": { "title": "", "type": "integer", "description": "The size of the partial resync lookback window, in the unit specified by partialResyncLookbackUnit. The value must be between 24 hours and 30 days.", "format": "int32", "example": 24 }, "password": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud user password.", "format": "password", "example": "test_password" }, "perform_partial_resync": { "title": "", "type": "boolean", "description": "Once per day, re-sync data for incremental tables to catch late-arriving or backdated records that the incremental filter may miss, extending the lookback window by partialResyncLookbackValue/partialResyncLookbackUnit. Disabling this may reduce sync duration but can cause some updates to be missed.", "example": true }, "private_key": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud private key.", "format": "password", "example": "test_private_key" }, "public_key": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud public key.", "format": "password", "example": "test_public_key" }, "server_url": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud Instance URL.", "example": "https://:" }, "username": { "title": "", "type": "string", "description": "The Oracle Fusion Cloud username.", "example": "test_username" } }, "description": "" } } }, "oracle_fusion_cloud_apps_hcm_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the Oracle Fusion Cloud user password.", "example": "PASSWORD_KEY" }, "username": { "title": "", "type": "string", "description": "ESM key for the Oracle Fusion Cloud username.", "example": "USERNAME_KEY" } }, "description": "" } } }, "oracle_fusion_cloud_apps_hcm_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/oracle_fusion_cloud_apps_hcm_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/oracle_fusion_cloud_apps_hcm_esm_keys_config_V1" } ] }, "oracle_fusion_field_service_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Oracle Fusion Field Service client ID.", "example": "your_oracle_fusion_field_service_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Oracle Fusion Field Service client secret.", "format": "password", "example": "your_oracle_fusion_field_service_client_secret" }, "root_resource_id": { "title": "", "type": "string", "description": "Your Oracle Fusion Field Service rootresourceId.", "example": "your_oracle_fusion_field_service_root_resource_id" }, "sub_domain": { "title": "", "type": "string", "description": "Your Oracle Fusion Field Service subDomain.", "example": "your_oracle_fusion_field_service_sub_domain" } }, "description": "" } } }, "oracle_fusion_field_service_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/oracle_fusion_field_service_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "oracle_hva_config_V1": { "properties": { "config": { "type": "object", "properties": { "agent_host": { "title": "", "type": "string", "description": "The host of the agent. This is the same as database host, since the agent must be installed in the same machine as source database.", "example": "host.com" }, "agent_ora_home": { "title": "", "type": "string", "description": "The home directory of the Oracle database.", "example": "/opt/oracle/product/19c/dbhome_1" }, "agent_password": { "title": "", "type": "string", "description": "The agent user's password. It should have a minimum length of 10 characters.", "format": "password", "example": "agent_password" }, "agent_port": { "title": "", "type": "integer", "description": "The port number of the agent.", "format": "int32", "example": 4343 }, "agent_public_cert": { "title": "", "type": "string", "description": "The agent public certificate.", "example": "CERTIFICATE" }, "agent_user": { "title": "", "type": "string", "description": "The agent's user.", "example": "hvr" }, "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "archive_log_format": { "title": "", "type": "string", "description": "Archive log format.", "example": "arc_EXAMPLE_%s_%t_%r_%z.log" }, "archive_log_path": { "title": "", "type": "string", "description": "Archive log path.", "example": "/opt/fivetran/EXAMPLE_archivelog" }, "asm_option": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using ASM on a non-RAC instance.", "example": true }, "asm_oracle_home": { "title": "", "type": "string", "description": "ASM Oracle Home path.", "example": "/asm/oracle/home" }, "asm_password": { "title": "", "type": "string", "description": "ASM password. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.", "format": "password", "example": "asm_password" }, "asm_tns": { "title": "", "type": "string", "description": "ASM TNS.", "example": "localhost:1521/ASM_TNS" }, "asm_user": { "title": "", "type": "string", "description": "ASM user. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.", "example": "asm_user" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "oracledb" }, "direct_capture_method": { "title": "", "type": "object", "description": "Possible values:`DIRECT`, `BFILE`, `ASM`, `ARCHIVE_ONLY`", "example": "DIRECT", "enum": [ "ARCHIVE_ONLY", "ASM", "BFILE", "DIRECT" ] }, "enable_archive_log_only": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using archive log only mode.", "example": true }, "enable_tde_encryption": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using TDE encryption.", "example": true }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "host.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "pdb_name": { "title": "", "type": "string", "description": "(Multi-tenant databases only) The database's PDB name. Omit this parameter for single-tenant databases.", "example": "pdb_name" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 1521 }, "tde_wallet_password": { "title": "", "type": "string", "description": "TDE wallet password. Required for password based wallet.", "format": "password", "example": "tde_wallet_password" }, "tns": { "title": "", "type": "string", "description": "Single-tenant database: The database's SID.
Multi-tenant database: The database's TNS.", "example": "localhost:1521/TNS" }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.", "example": "DIRECT_CAPTURE", "enum": [ "BINARY_LOG_READER", "XSTREAM_OUT", "LOGMINER", "TELEPORT", "DIRECT_CAPTURE", "BFILE_REMOTE_CAPTURE" ] }, "use_oracle_rac": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using a RAC instance.", "example": true }, "use_pdb_only": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` to connect directly to a single PDB. When `true`, set `database` to the PDB name and omit the `pdbName` field. Use only for Direct or Archive Log Only capture. Not supported with TDE, ASM, or RAC.", "example": true }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "oracle_hva_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "oracle_hva_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/oracle_hva_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/oracle_hva_esm_keys_config_V1" } ] }, "oracle_moat_analytics_config_V1": { "properties": { "config": { "type": "object", "properties": { "brand_id": { "title": "", "type": "string", "description": "Your Oracle Moat Analytics Brand ID.", "example": "your_oracle_moat_analytics_brand_id" }, "token": { "title": "", "type": "string", "description": "Your Oracle Moat Analytics Token.", "format": "password", "example": "your_oracle_moat_analytics_token" } }, "description": "" } } }, "oracle_moat_analytics_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/oracle_moat_analytics_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "oracle_netsuite_openair_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your NetSuite SuiteProjects Pro client ID.", "example": "your_netsuite_suiteprojects_pro_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your NetSuite SuiteProjects Pro client secret.", "format": "password", "example": "your_netsuite_suiteprojects_pro_client_secret" }, "company_id": { "title": "", "type": "string", "description": "Your NetSuite SuiteProjects Pro company ID.", "example": "your_netsuite_suiteprojects_pro_company_id" }, "environment": { "type": "object", "description": "Your NetSuite SuiteProjects Pro environment.", "enum": [ "sandbox.netsuitesuiteprojectspro.com", "netsuitesuiteprojectspro.com" ] } }, "description": "" } } }, "oracle_netsuite_openair_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "oracle_netsuite_openair_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/oracle_netsuite_openair_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/oracle_netsuite_openair_auth_V1" } ] }, "oracle_rac_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "asm_staging_directory": { "title": "", "type": "string", "description": "ASM staging directory path. Required when the ASM option is enabled.", "example": "string" }, "cdb_database": { "title": "", "type": "string", "description": "Optional: CDB database name for TDE-encrypted containerized databases.", "example": "string" }, "cdb_password": { "title": "", "type": "string", "description": "Optional: Password for the CDB user.", "format": "password", "example": "string" }, "cdb_user": { "title": "", "type": "string", "description": "Optional: CDB user for TDE-encrypted containerized databases.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "oracledb" }, "enable_asm": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using ASM.", "example": true }, "enable_symbolic_links": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using symbolic links.", "example": true }, "enable_tde_encryption": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using TDE encryption.", "example": true }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "oracleinstance.mycompany.com" }, "local_wallet_host": { "title": "", "type": "string", "description": "Optional: The host for the local Oracle Wallet.", "example": "string" }, "local_wallet_user": { "title": "", "type": "string", "description": "Optional: The user for the local Oracle Wallet.", "example": "string" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "pdb_name": { "title": "", "type": "string", "description": "Optional: Required only for containerized database.", "example": "string" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 1521 }, "symbolic_links_mapping": { "title": "", "type": "array", "description": "Mapping of symbolic links to actual file paths. Required when symbolic links are enabled.", "items": { "type": "object", "properties": {}, "description": "" } }, "tde_wallet_password": { "title": "", "type": "string", "description": "TDE wallet password. Required for password based wallet.", "format": "password", "example": "tde_wallet_password" }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method used to detect new or changed rows. Supported values: - `BINARY_LOG_READER` - Fivetran reads Oracle redo logs to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.", "example": "BINARY_LOG_READER | LOGMINER | TELEPORT", "enum": [ "BINARY_LOG_READER", "LOGMINER", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "oracle_rac_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "oracle_rac_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/oracle_rac_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/oracle_rac_esm_keys_config_V1" } ] }, "oracle_rds_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "oracledb" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "oracleinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "pdb_name": { "title": "", "type": "string", "description": "Optional: Required only for containerized database.", "example": "string" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 1521 }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method used to detect new or changed rows. Supported values: - `BINARY_LOG_READER` - Fivetran reads Oracle redo logs to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes. - `XSTREAM_OUT` - Fivetran uses Oracle XStream Out to stream changes from the database.", "example": "BINARY_LOG_READER | LOGMINER | TELEPORT", "enum": [ "BINARY_LOG_READER", "LOGMINER", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "oracle_rds_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "oracle_rds_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/oracle_rds_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/oracle_rds_esm_keys_config_V1" } ] }, "oracle_sap_hva_config_V1": { "properties": { "config": { "type": "object", "properties": { "agent_host": { "title": "", "type": "string", "description": "The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.", "example": "host.com" }, "agent_ora_home": { "title": "", "type": "string", "description": "The home directory of the Oracle database.", "example": "/opt/oracle/product/19c/dbhome_1" }, "agent_password": { "title": "", "type": "string", "description": "The agent user's password. It must have a minimum length of 10 characters.", "format": "password", "example": "agent_password" }, "agent_port": { "title": "", "type": "integer", "description": "The port number of the agent.", "format": "int32", "example": 4343 }, "agent_public_cert": { "title": "", "type": "string", "description": "The agent public certificate.", "example": "CERTIFICATE" }, "agent_user": { "title": "", "type": "string", "description": "The agent's user.", "example": "hvr" }, "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "archive_log_format": { "title": "", "type": "string", "description": "Archive log format.", "example": "arc_EXAMPLE_%s_%t_%r_%z.log" }, "archive_log_path": { "title": "", "type": "string", "description": "Archive log path.", "example": "/opt/fivetran/EXAMPLE_archivelog" }, "asm_option": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you are using ASM on a non-RAC instance.", "example": true }, "asm_oracle_home": { "title": "", "type": "string", "description": "The Oracle ASM home directory.", "example": "/asm/oracle/home" }, "asm_password": { "title": "", "type": "string", "description": "The ASM user's password. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.", "format": "password", "example": "asm_password" }, "asm_tns": { "title": "", "type": "string", "description": "ASM TNS.", "example": "localhost:1521/ASM_TNS" }, "asm_user": { "title": "", "type": "string", "description": "The ASM user. Mandatory if `use_oracle_rac` or `asm_option` is set to `true`.", "example": "asm_user" }, "connection_type": { "title": "", "type": "object", "description": "Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "oracledb" }, "direct_capture_method": { "title": "", "type": "object", "description": "Possible values:`DIRECT`, `BFILE`, `ASM`, `ARCHIVE_ONLY`", "example": "ARCHIVE_ONLY | ASM | BFILE | DIRECT", "enum": [ "ARCHIVE_ONLY", "ASM", "BFILE", "DIRECT" ] }, "enable_archive_log_only": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using archive log only mode.", "example": true }, "enable_tde_encryption": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using TDE encryption.", "example": true }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "host.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "pdb_name": { "title": "", "type": "string", "description": "(Multi-tenant databases only) The database's PDB name. Exclude this parameter for single-tenant databases.", "example": "pdb_name" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 1521 }, "sap_user": { "title": "", "type": "string", "description": "The Oracle schema name where the SAP tables reside.", "example": "sap_test_user" }, "tde_wallet_password": { "title": "", "type": "string", "description": "TDE wallet password. Required for password based wallet.", "format": "password", "example": "tde_wallet_password" }, "tns": { "title": "", "type": "string", "description": "Single-tenant database: The database SID.
Multi-tenant database: The database TNS.", "example": "localhost:1521/TNS" }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method used to detect new or changed rows. Supported values: - `LOGMINER` - Fivetran uses LogMiner, a utility that is part of Oracle Database, to detect modified rows in the source tables. - `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.", "example": "TELEPORT", "enum": [ "BINARY_LOG_READER", "XSTREAM_OUT", "LOGMINER", "TELEPORT", "DIRECT_CAPTURE", "BFILE_REMOTE_CAPTURE" ] }, "use_oracle_rac": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using a RAC instance.", "example": true }, "user": { "title": "", "type": "string", "description": "The username.", "example": "test_user" } }, "description": "" } } }, "oracle_sap_hva_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the username.", "example": "USER_KEY" } }, "description": "" } } }, "oracle_sap_hva_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/oracle_sap_hva_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/oracle_sap_hva_esm_keys_config_V1" } ] }, "oracle_sap_hva_netweaver_config_V1": { "properties": { "config": { "type": "object", "properties": { "agent_host": { "title": "", "type": "string", "description": "The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database.", "example": "host.com" }, "agent_password": { "title": "", "type": "string", "description": "The agent user's password. It must have a minimum length of 10 characters.", "format": "password", "example": "agent_password" }, "agent_port": { "title": "", "type": "integer", "description": "The port number of the agent.", "format": "int32", "example": 4343 }, "agent_public_cert": { "title": "", "type": "string", "description": "The agent public certificate.", "example": "CERTIFICATE" }, "agent_user": { "title": "", "type": "string", "description": "The agent's user.", "example": "hvr" }, "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS.", "example": true }, "archive_log_format": { "title": "", "type": "string", "description": "Archive log format.", "example": "arc_EXAMPLE_%s_%t_%r_%z.log" }, "archive_log_path": { "title": "", "type": "string", "description": "Archive log path.", "example": "/opt/fivetran/EXAMPLE_archivelog" }, "client_id": { "title": "", "type": "string", "description": "Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.", "example": "800" }, "connection_type": { "title": "", "type": "object", "description": "Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "enable_archive_log_only": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using archive log only mode.", "example": true }, "enable_tde_encryption": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using TDE encryption.", "example": true }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "host.com" }, "instance_number": { "title": "", "type": "string", "description": "Two-digit number (00-97) of the SAP instance within its host.", "example": "00" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "rfc_library_path": { "title": "", "type": "string", "description": "Directory path containing the SAP NetWeaver RFC SDK library files.", "example": "/opt/nwlibs" }, "tde_wallet_password": { "title": "", "type": "string", "description": "TDE wallet password. Required for password based wallet.", "format": "password", "example": "tde_wallet_password" }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "user": { "title": "", "type": "string", "description": "The username.", "example": "test_user" } }, "description": "" } } }, "oracle_sap_hva_netweaver_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the username.", "example": "USER_KEY" } }, "description": "" } } }, "oracle_sap_hva_netweaver_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/oracle_sap_hva_netweaver_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/oracle_sap_hva_netweaver_esm_keys_config_V1" } ] }, "orbit_config_V1": { "properties": { "config": { "type": "object", "properties": { "bearer_token": { "title": "", "type": "string", "description": "Your Orbit API Token.", "format": "password", "example": "your_orbit_api_token" } }, "description": "" } } }, "orbit_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/orbit_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ordergroove_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Ordergroove API key.", "format": "password", "example": "string" }, "environment": { "type": "object", "description": "Your Ordergroove environment.", "enum": [ "staging.restapi", "restapi" ] } }, "description": "" } } }, "ordergroove_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ordergroove_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ordway_config_V1": { "properties": { "config": { "type": "object", "properties": { "account": { "type": "object", "description": "Your Ordway account type.", "enum": [ "https://api.ordwaylabs.com", "https://eu-sandbox-api.ordwaylabs.com", "https://api.sandbox.ordwaylabs.com", "https://eu-api.ordwaylabs.com" ] }, "api_key": { "title": "", "type": "string", "description": "Your Ordway API key.", "format": "password", "example": "your_ordway_api_key" }, "api_token": { "title": "", "type": "string", "description": "Your Ordway API token.", "format": "password", "example": "your_ordway_api_token" }, "company": { "title": "", "type": "string", "description": "Your Ordway company name.", "example": "your_ordway_company_name" }, "email_id": { "title": "", "type": "string", "description": "Your Ordway user email ID.", "example": "your_ordway_email_id" }, "webhook_name": { "title": "", "type": "string", "description": "Your Ordway Webhook name.", "example": "your_ordway_webhook_name" } }, "description": "" } } }, "ordway_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ordway_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ortto_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Ortto API key.", "format": "password", "example": "your_ortto_api_key" }, "base_url": { "type": "object", "description": "Your Ortto base URL. Possible values: `api`, `api.au`, `api.eu`.", "enum": [ "api.eu", "api.au", "api" ] } }, "description": "" } } }, "ortto_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ortto_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "outbrain_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "The Outbrain user's password.", "format": "password", "example": "outbrain_password" }, "pull_archived_campaigns": { "title": "", "type": "boolean", "description": "Include or ignore results from archived campaigns", "example": true }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created.
NOTE: The more months of reporting data you sync, the longer your initial sync will take.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] }, "user": { "title": "", "type": "string", "description": "The username or email of the Outbrain user.", "example": "outbrain_user" } }, "description": "" } } }, "outbrain_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/outbrain_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "outreach_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "outreach_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Outreach client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Outreach client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "outreach_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/outreach_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/outreach_auth_V1" } ] }, "packiyo_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Packiyo API token.", "format": "password", "example": "string" }, "subdomain": { "title": "", "type": "string", "description": "Your Packiyo subdomain.", "example": "string" } }, "description": "" } } }, "packiyo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/packiyo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "paddle_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Paddle API key.", "format": "password", "example": "your_paddle_api_key" }, "environment": { "type": "object", "description": "Your Paddle environment.", "enum": [ "api", "sandbox-api" ] } }, "description": "" } } }, "paddle_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/paddle_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "pagerduty_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your PagerDuty API key.", "format": "password", "example": "your_pagerduty_api_key" } }, "description": "" } } }, "pagerduty_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/pagerduty_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "pandadoc_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your PandaDoc API key.", "format": "password", "example": "your_pandadoc_api_key" } }, "description": "" } } }, "pandadoc_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/pandadoc_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "papershift_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Papershift API Key", "format": "password", "example": "your_papershift_api_key" } }, "description": "" } } }, "papershift_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/papershift_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "parcellab_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_id": { "title": "", "type": "string", "description": "Your parcelLab account ID.", "example": "your_parcellab_account_id" }, "api_key": { "title": "", "type": "string", "description": "Your parcelLab API token.", "format": "password", "example": "your_parcellab_api_token" } }, "description": "" } } }, "parcellab_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/parcellab_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "pardot_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_version": { "title": "", "type": "object", "description": "API Version", "example": "V3 | V4", "enum": [ "V3", "V4" ] }, "auth_type": { "title": "", "type": "object", "description": "Authenticate using OAuth, HTTP Basic, or External Client App", "example": "ECA | BASIC | OAUTH", "enum": [ "ECA", "BASIC", "OAUTH" ] }, "business_unit_id": { "title": "", "type": "string", "description": "Business Unit ID", "example": "pardot_business_unit_id" }, "email": { "title": "", "type": "string", "description": "The email of the Pardot user.", "example": "pardot_user_email" }, "historical_sync_limit_date": { "title": "Historical sync limit date", "type": "string", "description": "The start date (YYYY-MM-DD) from which to sync historical data.", "example": "2006-01-01" }, "historical_sync_limit_time_frame": { "title": "Historical sync time frame", "type": "object", "description": "The options for time range for which historical data should be synced. Default value: `All Time`.", "example": "ALL_TIME | DATE_LIMIT", "enum": [ "ALL_TIME", "DATE_LIMIT" ] }, "is_external_activities_endpoint_selected": { "title": "", "type": "boolean", "description": "Whether the `EXTERNAL_ACTIVITY` table must be synced or not.", "example": true }, "limit_for_api_calls_to_external_activities_endpoint": { "title": "", "type": "integer", "description": "API limit for the external activities endpoint.", "format": "int32", "example": 150000 }, "my_domain_url": { "title": "", "type": "string", "description": "Your Salesforce domain URL", "example": "https://mycompany.my.salesforce.com" }, "password": { "title": "", "type": "string", "description": "The Pardot user's password.", "format": "password", "example": "pardot_password" }, "rest_api_limit": { "title": "", "type": "integer", "description": "The number of API calls that the connector should not exceed in a day. Default REST API call limit per day: 150,000.", "format": "int32", "example": 150000 }, "salesforce_security_token": { "title": "", "type": "string", "description": "The Pardot user's Salesforce SSO Account Security Token.", "format": "password", "example": "pardot_salesforce_security_token" }, "time_zone": { "title": "", "type": "object", "description": "The time zone configured in your Pardot instance. An empty value defaults to `UTC+00:00`.", "example": "GMT+05:30", "enum": [ "GMT+00:00", "GMT+02:00", "GMT-09:30", "GMT+04:00", "GMT+06:00", "GMT+08:45", "GMT+03:30", "GMT+08:00", "GMT+05:30", "GMT-12:00", "GMT-10:00", "GMT+13:00", "GMT-04:00", "GMT+10:30", "GMT-03:30", "GMT+09:00", "GMT+11:00", "GMT+13:45", "GMT-08:00", "GMT-06:00", "GMT-02:00", "GMT+01:00", "GMT+05:00", "GMT+03:00", "GMT+05:45", "GMT+04:30", "GMT+07:00", "GMT+06:30", "GMT-11:00", "GMT-02:30", "GMT+09:30", "GMT+10:00", "GMT+12:45", "GMT+14:00", "GMT+12:00", "GMT-09:00", "GMT-01:00", "GMT-07:00", "GMT-05:00", "GMT-03:00" ] }, "user_key": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "pardot_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Pardot client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Pardot client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "pardot_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/pardot_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/pardot_auth_V1" } ] }, "pardot_sandbox_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_version": { "title": "", "type": "object", "description": "API Version", "example": "V3 | V4", "enum": [ "V3", "V4" ] }, "auth_type": { "title": "", "type": "object", "description": "Authenticate using OAuth, HTTP Basic, or External Client App", "example": "ECA | BASIC | OAUTH", "enum": [ "ECA", "BASIC", "OAUTH" ] }, "business_unit_id": { "title": "", "type": "string", "description": "Business Unit ID", "example": "pardot_business_unit_id" }, "email": { "title": "", "type": "string", "description": "The email of the Pardot user.", "example": "pardot_user_email" }, "historical_sync_limit_date": { "title": "Historical sync limit date", "type": "string", "description": "The start date (YYYY-MM-DD) from which to sync historical data.", "example": "2006-01-01" }, "historical_sync_limit_time_frame": { "title": "Historical sync time frame", "type": "object", "description": "The options for time range for which historical data should be synced. Default value: `All Time`.", "example": "ALL_TIME | DATE_LIMIT", "enum": [ "ALL_TIME", "DATE_LIMIT" ] }, "is_external_activities_endpoint_selected": { "title": "", "type": "boolean", "description": "Whether the `EXTERNAL_ACTIVITY` table must be synced or not.", "example": true }, "limit_for_api_calls_to_external_activities_endpoint": { "title": "", "type": "integer", "description": "API limit for the external activities endpoint.", "format": "int32", "example": 150000 }, "my_domain_url": { "title": "", "type": "string", "description": "Your Salesforce domain URL", "example": "https://mycompany.my.salesforce.com" }, "password": { "title": "", "type": "string", "description": "The Pardot user's password.", "format": "password", "example": "pardot_password" }, "rest_api_limit": { "title": "", "type": "integer", "description": "The number of API calls that the connector should not exceed in a day. Default REST API call limit per day: 150,000.", "format": "int32", "example": 150000 }, "salesforce_security_token": { "title": "", "type": "string", "description": "The Pardot user's Salesforce SSO Account Security Token.", "format": "password", "example": "pardot_salesforce_security_token" }, "time_zone": { "title": "", "type": "object", "description": "The time zone configured in your Pardot instance. An empty value defaults to `UTC+00:00`.", "example": "GMT+05:30", "enum": [ "GMT+00:00", "GMT+02:00", "GMT-09:30", "GMT+04:00", "GMT+06:00", "GMT+08:45", "GMT+03:30", "GMT+08:00", "GMT+05:30", "GMT-12:00", "GMT-10:00", "GMT+13:00", "GMT-04:00", "GMT+10:30", "GMT-03:30", "GMT+09:00", "GMT+11:00", "GMT+13:45", "GMT-08:00", "GMT-06:00", "GMT-02:00", "GMT+01:00", "GMT+05:00", "GMT+03:00", "GMT+05:45", "GMT+04:30", "GMT+07:00", "GMT+06:30", "GMT-11:00", "GMT-02:30", "GMT+09:30", "GMT+10:00", "GMT+12:45", "GMT+14:00", "GMT+12:00", "GMT-09:00", "GMT-01:00", "GMT-07:00", "GMT-05:00", "GMT-03:00" ] }, "user_key": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "pardot_sandbox_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Pardot client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Pardot client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "pardot_sandbox_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/pardot_sandbox_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/pardot_sandbox_auth_V1" } ] }, "partnerize_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Partnerize user API key.", "format": "password", "example": "your_partnerize_user_api_key" }, "application_key": { "title": "", "type": "string", "description": "Your Partnerize user application key.", "example": "your_partnerize_user_application_key" } }, "description": "" } } }, "partnerize_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/partnerize_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "partnerstack_vendor_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Your PartnerStack Vendor Public key.", "example": "your_partnerstack_vendor_public_key" }, "secret_key": { "title": "", "type": "string", "description": "Your PartnerStack Vendor Secret key.", "format": "password", "example": "your_partnerstack_vendor_secret_key" } }, "description": "" } } }, "partnerstack_vendor_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/partnerstack_vendor_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "paychex_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Paychex client ID.", "format": "password", "example": "your_paychex_api_key" }, "client_secret": { "title": "", "type": "string", "description": "Your Paychex client secret.", "format": "password", "example": "your_paychex_api_secret" } }, "description": "" } } }, "paychex_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/paychex_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "paylocity_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Paylocity client ID.", "example": "your_paylocity_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Paylocity client secret.", "format": "password", "example": "your_paylocity_client_secret" }, "company_id": { "title": "", "type": "string", "description": "Your Paylocity company ID.", "example": "your_paylocity_company_id" }, "sub_domain": { "title": "", "type": "string", "description": "Your Paylocity subdomain.", "example": "your_paylocity_sub_domain" } }, "description": "" } } }, "paylocity_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/paylocity_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "paypal_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your PayPal client application.", "example": "my_client_id" }, "secret_key": { "title": "", "type": "string", "description": "`Secret Key` of your PayPal client application.", "format": "password", "example": "my_secret_key" } }, "description": "" } } }, "paypal_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/paypal_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "paypal_sandbox_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Client ID of your PayPal client application.", "example": "my_client_id" }, "secret_key": { "title": "", "type": "string", "description": "Secret key of your PayPal client application.", "format": "password", "example": "my_secret_key" } }, "description": "" } } }, "paypal_sandbox_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/paypal_sandbox_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "pendo_config_V1": { "properties": { "config": { "type": "object", "properties": { "app_ids": { "title": "", "type": "array", "description": "Specific App IDs to sync. Must be populated if `sync_mode` is set to `SpecificAppIds`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "aws_credentials": { "title": "", "type": "object", "properties": { "bucket_name": { "title": "", "type": "string", "description": "AWS bucket name", "example": "string" }, "home_folder": { "title": "", "type": "string", "description": "AWS home folder", "example": "string" }, "s3_role_arn": { "title": "", "type": "string", "description": "AWS s3 Role Arn", "format": "password", "example": "string" } }, "description": "Configuration for AWS S3 Storage" }, "azure_credentials": { "title": "", "type": "object", "properties": { "connection_string": { "title": "", "type": "string", "description": "Azure connection string", "format": "password", "example": "string" }, "container_name": { "title": "", "type": "string", "description": "Azure container name", "example": "string" }, "home_folder": { "title": "", "type": "string", "description": "Azure home folder", "example": "string" } }, "description": "Configuration for Azure Blob Storage" }, "backward_sync_limit_date": { "title": "", "type": "string", "description": "The start date (YYYY-MM-DD) from which to sync historical data.", "example": "2000-12-15" }, "export_storage_type": { "title": "", "type": "object", "description": "Denotes which storage option is chosen", "example": "AZURE | GCS | AWS_S3", "enum": [ "AZURE", "GCS", "AWS_S3" ] }, "gcs_credentials": { "title": "", "type": "object", "properties": { "bucket_name": { "title": "", "type": "string", "description": "GCS bucket name", "example": "string" }, "home_folder": { "title": "", "type": "string", "description": "GCS home folder", "example": "string" } }, "description": "Configuration for GCS Bucket" }, "historical_sync_time_frame": { "title": "", "type": "object", "description": "The time range for which historical data should be synced. Default value: `All Time`.", "example": "ALL_TIME | DATE_LIMIT", "enum": [ "ALL_TIME", "DATE_LIMIT" ] }, "integration_key": { "title": "", "type": "string", "description": "The integration key of the Pendo account.", "format": "password", "example": "pendo_integration_key" }, "region": { "title": "", "type": "object", "description": "The Pendo account region.", "example": "EU | US1 | AU | JPN | US", "enum": [ "EU", "US1", "AU", "JPN", "US" ] }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all App IDs or specific App IDs. Default value: `AllAppIds`.", "example": "AllAppIds | SpecificAppIds", "enum": [ "AllAppIds", "SpecificAppIds" ] }, "use_data_sync": { "title": "", "type": "boolean", "description": "Toggle field to determine whether connector is syncing from API or from Data Sync", "example": true } }, "description": "" } } }, "pendo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/pendo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "pennylane_config_V1": { "properties": { "config": { "type": "object", "properties": { "company_api_token": { "title": "", "type": "string", "description": "Your Pennylane company API token", "format": "password", "example": "your_pennylane_company_api_token" } }, "description": "" } } }, "pennylane_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/pennylane_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "peopleforce_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your PeopleForce API key.", "format": "password", "example": "your_peopleforce_api_key" } }, "description": "" } } }, "peopleforce_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/peopleforce_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "persona_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Persona API key.", "format": "password", "example": "your_persona_api_key" } }, "description": "" } } }, "persona_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/persona_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "personio_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Personio Client ID.", "example": "your_personio_clientid" }, "client_secret": { "title": "", "type": "string", "description": "Your Personio secret.", "format": "password", "example": "your_personio_client_secret" } }, "description": "" } } }, "personio_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/personio_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "phoenix_ads_config_V1": { "properties": { "config": { "type": "object", "properties": { "agent_id": { "title": "", "type": "string", "description": "Your Phoenix Ads Agent ID.", "example": "your_phoenix_ads_agent_id" }, "secret_key": { "title": "", "type": "string", "description": "Your Phoenix Ads Secret key.", "format": "password", "example": "your_phoenix_ads_secret_key" } }, "description": "" } } }, "phoenix_ads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/phoenix_ads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "picqer_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Picqer API key.", "format": "password", "example": "your_picqer_api_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your Picqer subdomain.", "example": "your_picqer_subdomain" } }, "description": "" } } }, "picqer_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/picqer_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "pigment_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Pigment API key.", "format": "password", "example": "string" }, "list_id": { "title": "", "type": "string", "description": "Your Pigment list ID.", "example": "string" }, "metric_id": { "title": "", "type": "string", "description": "Your Pigment metric ID.", "example": "string" }, "table_id": { "title": "", "type": "string", "description": "Your Pigment table ID.", "example": "string" }, "view_id": { "title": "", "type": "string", "description": "Your Pigment view ID.", "example": "string" } }, "description": "" } } }, "pigment_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/pigment_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "pingdom_config_V1": { "properties": { "config": { "type": "object", "properties": { "username": { "title": "", "type": "string", "description": "Your Pingdom Username.", "format": "password", "example": "your_pingdom_username" } }, "description": "" } } }, "pingdom_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/pingdom_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "pinpoint_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Pinpoint API key.", "format": "password", "example": "your_pinpoint_api_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your Pinpoint sub domain name.", "example": "your_pinpoint_subdomain" } }, "description": "" } } }, "pinpoint_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/pinpoint_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "pinterest_ads_config_V1": { "properties": { "config": { "type": "object", "properties": { "advertisers": { "title": "", "type": "array", "description": "Specific Advertisers to sync. Must be populated if `sync_mode` is set to `SpecificAdvertisers`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "click_attribution_window": { "title": "", "type": "object", "description": "The number of days to use as the conversion attribution window for a 'click' action.", "example": "ZERO | THIRTY | SIXTY | FOURTEEN | ONE | SEVEN", "enum": [ "ZERO", "THIRTY", "SIXTY", "FOURTEEN", "ONE", "SEVEN" ] }, "conversion_report_time": { "title": "", "type": "object", "description": "The date that the user interacted with the ad OR completed a conversion event.", "example": "CONVERSION_EVENT | AD_EVENT", "enum": [ "CONVERSION_EVENT", "AD_EVENT" ] }, "custom_reports": { "title": "", "type": "array", "description": "Custom reports to sync. Each entry creates a destination table with the specified metrics and breakdown level.", "items": { "title": "", "type": "object", "properties": { "click_attribution_window": { "title": "", "type": "object", "description": "Overrides the connector-level click attribution window for this report.", "example": "ZERO | THIRTY | SIXTY | FOURTEEN | ONE | SEVEN", "enum": [ "ZERO", "THIRTY", "SIXTY", "FOURTEEN", "ONE", "SEVEN" ] }, "conversion_report_time": { "title": "", "type": "object", "description": "Overrides the connector-level conversion report time for this report.", "example": "CONVERSION_EVENT | AD_EVENT", "enum": [ "CONVERSION_EVENT", "AD_EVENT" ] }, "granularity": { "title": "", "type": "object", "description": "Time granularity for the report: DAY, HOUR, WEEK, MONTH, or TOTAL.", "example": "TOTAL | MONTH | HOUR | WEEK | DAY", "enum": [ "TOTAL", "MONTH", "HOUR", "WEEK", "DAY" ] }, "metrics": { "title": "", "type": "array", "description": "List of metrics to include in the report.", "example": "OUTBOUND_CLICK_1", "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_type": { "title": "", "type": "object", "description": "The breakdown level for the report (e.g. ADVERTISER, CAMPAIGN, AD_GROUP, PIN_PROMOTION, KEYWORD, PRODUCT_GROUP, ADVERTISER_TARGETING, CAMPAIGN_TARGETING, AD_GROUP_TARGETING, PIN_PROMOTION_TARGETING, PRODUCT_GROUP_TARGETING, PRODUCT_ITEM_TARGETING).", "example": "CAMPAIGN", "enum": [ "PRODUCT_GROUP", "PIN_PROMOTION", "PRODUCT_GROUP_TARGETING", "ADVERTISER_TARGETING", "KEYWORD", "AD_GROUP_TARGETING", "PRODUCT_ITEM_TARGETING", "AD_GROUP", "ADVERTISER", "CAMPAIGN", "PIN_PROMOTION_TARGETING", "CAMPAIGN_TARGETING" ] }, "table_name": { "title": "", "type": "string", "description": "Destination table name for this custom report.", "example": "my_campaign_report" }, "targeting_type": { "title": "", "type": "object", "description": "The single targeting type to report on. Required for HOUR granularity on targeting breakdown levels and for the PRODUCT_ITEM_TARGETING level at any granularity; ignored otherwise. PRODUCT_ITEM_TARGETING supports only MEDIA_TYPE, APPTYPE, PLACEMENT, AGE_BUCKET, and GENDER.", "example": "LOCATION | AUDIENCE_MULTIPLIER | TARGETED_INTEREST | AUDIENCE_INCLUDE | AGE_BUCKET | AGE_BUCKET_AND_GENDER | KEYWORD | REGION | CREATIVE_ENHANCEMENTS | GEO | PINNER_INTEREST | PLACEMENT | COUNTRY | MEDIA_TYPE | GENDER | LOCAL_ADS_STORE_CODE | APPTYPE", "enum": [ "LOCATION", "AUDIENCE_MULTIPLIER", "TARGETED_INTEREST", "AUDIENCE_INCLUDE", "AGE_BUCKET", "AGE_BUCKET_AND_GENDER", "KEYWORD", "REGION", "CREATIVE_ENHANCEMENTS", "GEO", "PINNER_INTEREST", "PLACEMENT", "COUNTRY", "MEDIA_TYPE", "GENDER", "LOCAL_ADS_STORE_CODE", "APPTYPE" ] }, "view_attribution_window": { "title": "", "type": "object", "description": "Overrides the connector-level view attribution window for this report.", "example": "ZERO | THIRTY | SIXTY | FOURTEEN | ONE | SEVEN", "enum": [ "ZERO", "THIRTY", "SIXTY", "FOURTEEN", "ONE", "SEVEN" ] } }, "description": "Custom reports to sync. Each entry creates a destination table with the specified metrics and breakdown level." } }, "refresh_token_expires_at": { "title": "", "type": "string", "description": "The expiration date of the refresh token. Unix timestamp in seconds", "format": "date-time", "example": "1717858800" }, "report_granularity": { "title": "", "type": "object", "description": "Granularity at which reports will be ", "example": "HOUR | DAY", "enum": [ "HOUR", "DAY" ] }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all advertisers or specific advertisers.", "example": "SpecificAdvertisers | AllAdvertisers", "enum": [ "SpecificAdvertisers", "AllAdvertisers" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] }, "view_attribution_window": { "title": "", "type": "object", "description": "The number of days to use as the conversion attribution window for a 'view' action.", "example": "ZERO | THIRTY | SIXTY | FOURTEEN | ONE | SEVEN", "enum": [ "ZERO", "THIRTY", "SIXTY", "FOURTEEN", "ONE", "SEVEN" ] } }, "description": "" } } }, "pinterest_ads_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Pinterest client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Pinterest client application.", "example": "my_client_secret" } }, "description": "Your application client access fields." }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "pinterest_ads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/pinterest_ads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/pinterest_ads_auth_V1" } ] }, "pinterest_organic_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "pinterest_organic_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Pinterest access token.", "format": "password", "example": "your_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "Your Pinterest client access." }, "refresh_token": { "title": "", "type": "string", "description": "Your Pinterest refresh token.", "format": "password", "example": "your_refresh_token" } }, "description": "" } } }, "pinterest_organic_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/pinterest_organic_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/pinterest_organic_auth_V1" } ] }, "pipe17_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "The Pipe17 API key.", "format": "password", "example": "your_pipe17_api_key" } }, "description": "" } } }, "pipe17_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/pipe17_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "pipedrive_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "(Optional)Your Pipedrive personal API token", "format": "password", "example": "api_token" }, "domain": { "title": "", "type": "string", "description": "Your Pipedrive domain.", "example": "domain" } }, "description": "" } } }, "pipedrive_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Pipedrive client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Pipedrive client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "pipedrive_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/pipedrive_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/pipedrive_auth_V1" } ] }, "pivotal_tracker_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Pivotal Tracker API token.", "format": "password", "example": "your_api_token" } }, "description": "" } } }, "pivotal_tracker_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/pivotal_tracker_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "piwik_pro_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Piwik PRO client ID.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Your Piwik PRO client secret.", "format": "password", "example": "string" }, "sub_domain": { "title": "", "type": "string", "description": "Your Piwik PRO subdomain.", "example": "string" } }, "description": "" } } }, "piwik_pro_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/piwik_pro_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "placerai_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Placer.ai API key.", "format": "password", "example": "string" } }, "description": "" } } }, "placerai_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/placerai_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "planetscale_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "planetscale_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/planetscale_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "planful_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_id": { "title": "", "type": "string", "description": "Your Planful access ID.", "example": "your_planful_access_id" }, "access_key": { "title": "", "type": "string", "description": "Your Planful access key.", "format": "password", "example": "your_planful_access_key" }, "email_id": { "title": "", "type": "string", "description": "Your Planful email ID.", "example": "your_planful_email_id" }, "tenant_app_url": { "title": "", "type": "string", "description": "Your Planful tenant app URL.", "example": "your_planful_tenant_app_url" } }, "description": "" } } }, "planful_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/planful_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "planhat_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Planhat access token.", "format": "password", "example": "string" } }, "description": "" } } }, "planhat_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/planhat_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "playvox_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Playvox API Key.", "format": "password", "example": "your_playvox_api_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your Playvox Subdomain.", "example": "your_playvox_subdomain" }, "user_id": { "title": "", "type": "string", "description": "Your Playvox User ID.", "example": "your_playvox_user_id" } }, "description": "" } } }, "playvox_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/playvox_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "playvox_workforce_management_config_V1": { "properties": { "config": { "type": "object", "properties": { "identifier": { "title": "", "type": "string", "description": "Your Playvox Workforce Management client identifier.", "example": "string" }, "region_url": { "title": "", "type": "string", "description": "Your Playvox Workforce Management region URL.", "example": "string" }, "secret": { "title": "", "type": "string", "description": "Your Playvox Workforce Management client secret.", "format": "password", "example": "string" }, "tenant_url": { "title": "", "type": "string", "description": "Your Playvox Workforce Management tenant URL.", "example": "string" } }, "description": "" } } }, "playvox_workforce_management_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/playvox_workforce_management_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "podio_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Podio client ID.", "example": "your_podio_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Podio client secret.", "format": "password", "example": "your_podio_client_secret" }, "password": { "title": "", "type": "string", "description": "Your Podio account password.", "format": "password", "example": "your_podio_password" }, "username": { "title": "", "type": "string", "description": "Your Podio account username.", "example": "your_podio_username" } }, "description": "" } } }, "podio_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/podio_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "poplar_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Poplar access token.", "format": "password", "example": "your_poplar_access_token" } }, "description": "" } } }, "poplar_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/poplar_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "postgres_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Database authentication method. Supported values: `PASSWORD`, `ENTRA_ID`, `CLIENT_CERTIFICATE`.", "example": "ENTRA_ID | PASSWORD | CLIENT_CERTIFICATE", "enum": [ "ENTRA_ID", "PASSWORD", "CLIENT_CERTIFICATE" ] }, "client_private_key": { "title": "", "type": "string", "description": "Client Private Key in .pem format.", "format": "password", "example": "string" }, "client_public_certificate": { "title": "", "type": "string", "description": "Client Certificate in .pem format.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "postgres" }, "delete_capture_enabled": { "title": "", "type": "boolean", "description": "", "example": true }, "entra_app_id": { "title": "", "type": "string", "description": "Registered Application ID (for Entra ID authentication).", "example": "string" }, "entra_tenant_id": { "title": "", "type": "string", "description": "Azure Tenant ID (for Entra ID authentication).", "example": "string" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "postgresinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "For password authentication, enter the user's password.
For Entra ID authentication, enter the client secret value.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 5432 }, "publication_name": { "title": "", "type": "string", "description": "Publication name. Specify only for `\"updated_method\": \"WAL_PGOUTPUT\"`.", "example": "string" }, "replication_slot": { "title": "", "type": "string", "description": "Replication slot name. Specify only for `\"updated_method\": \"WAL_PGOUTPUT\"`.", "example": "test_replication_slot" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method to detect new or changed rows.
Specify only for `\"service\": \"postgres\"` or `\"service\": \"postgres_rds\"`.
Supported values:
`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot.This is more efficient than the query-based method, but requires more setup and monitoring.
`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns", "example": "QUERY_BASED | WAL_PGOUTPUT", "enum": [ "QUERY_BASED", "WAL_PGOUTPUT" ] }, "user": { "title": "", "type": "string", "description": "For password authentication, enter the user name.
For Entra ID authentication, enter the registered app display name.", "example": "test_user" } }, "description": "" } } }, "postgres_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password or client secret value.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name or app display name.", "example": "USER_KEY" } }, "description": "" } } }, "postgres_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/postgres_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/postgres_esm_keys_config_V1" } ] }, "postgres_rds_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS through Tunnel", "example": true }, "auth_method": { "title": "", "type": "object", "description": "Database authentication method", "example": "PASSWORD", "enum": [ "ENTRA_ID", "PASSWORD", "CLIENT_CERTIFICATE", "AWS_IAM" ] }, "client_private_key": { "title": "", "type": "string", "description": "Client Private Key in .pem format.", "format": "password", "example": "string" }, "client_public_certificate": { "title": "", "type": "string", "description": "Client Certificate in .pem format.", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "postgres" }, "delete_capture_enabled": { "title": "", "type": "boolean", "description": "", "example": true }, "entra_app_id": { "title": "", "type": "string", "description": "Registered Application ID (for Entra ID authentication).", "example": "string" }, "entra_tenant_id": { "title": "", "type": "string", "description": "Azure Tenant ID (for Entra ID authentication).", "example": "string" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "postgresinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 5432 }, "publication_name": { "title": "", "type": "string", "description": "Publication name. Specify only for `\"updated_method\": \"WAL_PGOUTPUT\"`.", "example": "string" }, "replication_slot": { "title": "", "type": "string", "description": "Replication slot name. Specify only for `\"updated_method\": \"WAL_PGOUTPUT\"`.", "example": "test_replication_slot" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "The method to detect new or changed rows.
Specify only for `\"service\": \"postgres\"` or `\"service\": \"postgres_rds\"`.
Supported values:
`WAL_PGOUTPUT` - logical replication of the WAL using the pgoutput plugin. This method replicates new, changed, and deleted rows by tailing the write-ahead log (WAL) using a logical slot. This is more efficient than the query-based method, but requires more setup and monitoring.
`QUERY_BASED` - this method replicates new, changed and deleted rows via the `xmin` and `ctid` system columns", "example": "QUERY_BASED | WAL_PGOUTPUT", "enum": [ "QUERY_BASED", "WAL_PGOUTPUT" ] }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "test_user" } }, "description": "" } } }, "postgres_rds_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "postgres_rds_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/postgres_rds_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/postgres_rds_esm_keys_config_V1" } ] }, "posthog_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your PostHog API key.", "format": "password", "example": "your_posthog_api_key" }, "sub_domain": { "type": "object", "description": "Your PostHog data region (`app` or `eu`).", "enum": [ "app", "eu" ] } }, "description": "" } } }, "posthog_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/posthog_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "postmark_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Postmark account API token.", "format": "password", "example": "your_postmark_account_api_token" } }, "description": "" } } }, "postmark_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/postmark_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "power_reviews_enterprise_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your PowerReviews Enterprise Client ID.", "example": "your_power_reviews_enterprise_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your PowerReviews Enterprise Client Secret.", "format": "password", "example": "your_power_reviews_enterprise_client_secret" } }, "description": "" } } }, "power_reviews_enterprise_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/power_reviews_enterprise_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "prisma_cloud_config_V1": { "properties": { "config": { "type": "object", "properties": { "base_url": { "type": "object", "description": "Your Prisma Cloud admin console URL.", "enum": [ "https://api.gov.prismacloud.io", "https://api.id.prismacloud.io", "https://api4.prismacloud.io", "https://api.jp.prismacloud.io", "https://api3.prismacloud.io", "https://api.uk.prismacloud.io", "https://api.ind.prismacloud.io", "https://api2.eu.prismacloud.io", "https://api.eu.prismacloud.io", "https://api.sg.prismacloud.io", "https://api.prismacloud.io", "https://api.prismacloud.cn", "https://api.anz.prismacloud.io", "https://api.ca.prismacloud.io", "https://api.fr.prismacloud.io", "https://api2.prismacloud.io" ] }, "client_id": { "title": "", "type": "string", "description": "Your Prisma Cloud access key ID.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Your Prisma Cloud secret access Key.", "format": "password", "example": "string" }, "console_url": { "title": "", "type": "string", "description": "Your Prisma Cloud console URL.", "example": "string" } }, "description": "" } } }, "prisma_cloud_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/prisma_cloud_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "prive_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Prive API key.", "format": "password", "example": "your_prive_api_key" } }, "description": "" } } }, "prive_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/prive_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "procore_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Procore client ID.", "example": "your_procore_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Procore client secret.", "format": "password", "example": "your_procore_client_secret" }, "environment": { "type": "object", "description": "Your Procore account environment.", "enum": [ "sandbox", "api", "api-monthly" ] } }, "description": "" } } }, "procore_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/procore_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "productboard_config_V1": { "properties": { "config": { "type": "object", "properties": { "bearer_token": { "title": "", "type": "string", "description": "Your Productboard API key.", "format": "password", "example": "your_productboard_api_key" } }, "description": "" } } }, "productboard_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/productboard_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "productive_config_V1": { "properties": { "config": { "type": "object", "properties": { "organization_id": { "title": "", "type": "string", "description": "Your Productive Organization ID.", "example": "string" }, "personal_access_token": { "title": "", "type": "string", "description": "Your Productive personal access token.", "format": "password", "example": "your_productive_api_token" } }, "description": "" } } }, "productive_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/productive_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "profound_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Profound API key.", "format": "password", "example": "your_profound_api_key" } }, "description": "" } } }, "profound_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/profound_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "proofpoint_security_awareness_config_V1": { "properties": { "config": { "type": "object", "properties": { "region": { "type": "object", "description": "Your Proofpoint Security Awareness Region.", "enum": [ "results.ap.securityeducation.com", "results.us.securityeducation.com", "results.eu.securityeducation.com" ] }, "token_key": { "title": "", "type": "string", "description": "Your Proofpoint Security Awareness Token Key.", "format": "password", "example": "your_proofpoint_security_awareness_token_key" } }, "description": "" } } }, "proofpoint_security_awareness_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/proofpoint_security_awareness_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "prosperstack_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your ProsperStack API key.", "format": "password", "example": "your_prosperstack_api_key" } }, "description": "" } } }, "prosperstack_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/prosperstack_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "purple_dot_config_V1": { "properties": { "config": { "type": "object", "properties": { "private_access_token": { "title": "", "type": "string", "description": "Your PurpleDot Private access token.", "format": "password", "example": "your_purple_dot_private_access_token" } }, "description": "" } } }, "purple_dot_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/purple_dot_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "pylon_support_platform_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Pylon Support Platform API token.", "format": "password", "example": "your_pylon_support_platform_api_token" }, "region": { "type": "object", "description": "The region of your Pylon Support Platform account. If your account is in the EU (tokens generated at app.eu.usepylon.com), provide `api.eu`. Otherwise provide `api`.", "enum": [ "api.eu", "api" ] } }, "description": "" } } }, "pylon_support_platform_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/pylon_support_platform_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "qmatic_data_connect_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your Qmatic Data Connect password.", "format": "password", "example": "your_qmatic_data_connect_password" }, "subdomain": { "title": "", "type": "string", "description": "Your Qmatic Data Connect subdomain.", "example": "your_qmatic_data_connect_subdomain" }, "username": { "title": "", "type": "string", "description": "Your Qmatic Data Connect username.", "example": "your_qmatic_data_connect_username" } }, "description": "" } } }, "qmatic_data_connect_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/qmatic_data_connect_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "qualaroo_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Qualaroo API Key.", "example": "your_qualaroo_api_key" }, "api_secret": { "title": "", "type": "string", "description": "Your Qualaroo API Secret.", "format": "password", "example": "your_qualaroo_api_secret" }, "survey_ids": { "title": "", "type": "string", "description": "Array of Qualaroo Survey IDs.", "example": "string" } }, "description": "" } } }, "qualaroo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/qualaroo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "qualtrics_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_requests_per_minute": { "title": "", "type": "integer", "description": "Allowed number of API requests to Qualtrics per minute, the default value is 2000. Maximum allowed number is 3000 because brands may make up to 3000 API requests per minute across all of its API calls.", "format": "int32", "example": 1500 }, "api_token": { "title": "", "type": "string", "description": "API token of the Qualtrics account.", "format": "password", "example": "string" }, "auth_type": { "title": "", "type": "object", "description": "Type of authentication being used by connector", "example": "STANDARD | ADVANCED", "enum": [ "STANDARD", "ADVANCED" ] }, "certificate": { "title": "", "type": "string", "description": "Your Client Certificate", "format": "password", "example": "---" }, "data_center": { "title": "", "type": "string", "description": "Data center ID of the Qualtrics account. Can be found in the URL before `qualtrics.com`. (For example, if your URL is `youraccount.ca1.qualtrics.com`, then the data center is `ca1`.)", "example": "data_center" }, "directories": { "title": "", "type": "array", "description": "Set of directories to be synced when syncMode is CUSTOM", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "directory_sync_mode": { "title": "", "type": "object", "description": "Sync mode to be used for fetching select directories. The Allowed Values are ALL and CUSTOM. If CUSTOM add the directories to be synced in the `directories` field.", "example": "ALL | CUSTOM", "enum": [ "ALL", "CUSTOM" ] }, "distribution_incremental_fetch_window_days": { "title": "", "type": "integer", "description": "Can be used to set the distributions fetch window for incremental sync. Fetch window cannot be lesser than 60 days.", "format": "int32", "example": 0 }, "pass_phrase": { "title": "", "type": "string", "description": "Pass Phrase", "format": "password", "example": "---" }, "private_key": { "title": "", "type": "string", "description": "Your private key", "format": "password", "example": "---" } }, "description": "" } } }, "qualtrics_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Qualtrics client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Qualtrics client application.", "example": "my_client_secret" } }, "description": "Your application client access fields." }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "qualtrics_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/qualtrics_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/qualtrics_auth_V1" } ] }, "quickbooks_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Client ID of your QuickBooks client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Client Secret of your QuickBooks client application.", "format": "password", "example": "my_client_secret" } }, "description": "" } } }, "quickbooks_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your QuickBooks client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your QuickBooks client application.", "example": "my_client_secret" } }, "description": "" }, "realm_id": { "title": "", "type": "string", "description": "`Realm ID` of your QuickBooks application.", "example": "my_realm_id" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "quickbooks_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/quickbooks_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/quickbooks_auth_V1" } ] }, "quora_ads_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Quora Ads client ID.", "example": "your_quora_ads_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Quora Ads client secret.", "format": "password", "example": "your_quora_ads_client_secret" } }, "description": "" } } }, "quora_ads_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "quora_ads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/quora_ads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/quora_ads_auth_V1" } ] }, "quorum_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Quorum API key.", "format": "password", "example": "your_quorum_api_key" }, "username": { "title": "", "type": "string", "description": "Your Quorum username .", "example": "your_quorum_username" } }, "description": "" } } }, "quorum_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/quorum_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "rakutenadvertising_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Rakuten Advertising API token.", "format": "password", "example": "your_rakutenadvertising_api_token" }, "report_keys": { "title": "", "type": "string", "description": "Your Rakuten Advertising report keys.", "example": "your_rakutenadvertising_report_keys" } }, "description": "" } } }, "rakutenadvertising_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/rakutenadvertising_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ramp_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "ramp_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Ramp access token.", "format": "password", "example": "ramp_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "Your Ramp refresh token.", "format": "password", "example": "ramp_refresh_token" } }, "description": "" } } }, "ramp_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ramp_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/ramp_auth_V1" } ] }, "rarible_config_V1": { "properties": { "config": { "type": "object", "properties": { "blockchain": { "type": "object", "description": "Your Rarible Blockchain.", "enum": [ "POLYGON", "ETHEREUM", "SOLANA", "IMMUTABLEX", "TEZOS", "FLOW" ] }, "collection_address": { "title": "", "type": "string", "description": "Your Rarible Collection Address.", "example": "your_rarible_collection_address" } }, "description": "" } } }, "rarible_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/rarible_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "rebound_returns_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your ReBound Returns API key.", "format": "password", "example": "your_rebound_returns_api_key" }, "login": { "title": "", "type": "string", "description": "Your ReBound Returns login.", "example": "your_rebound_returns_login" } }, "description": "" } } }, "rebound_returns_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/rebound_returns_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "recharge_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "The Recharge API token.", "format": "password", "example": "recharge_token" } }, "description": "" } } }, "recharge_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/recharge_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "recurly_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "The Recurly API key.", "format": "password", "example": "recurly_api_key" }, "region": { "type": "object", "description": "Your Recurly region.", "enum": [ "v3.eu", "v3" ] }, "sub_domain": { "title": "", "type": "string", "description": "Your company's Recurly subdomain.", "example": "recurly_subdomain" } }, "description": "" } } }, "recurly_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/recurly_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "reddit_ads_config_V1": { "properties": { "config": { "type": "object", "properties": { "business_accounts": { "title": "", "type": "array", "description": "Specific Accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "custom_reports": { "title": "", "type": "array", "description": "The list of custom report configurations. Each report corresponds to a table within the schema to which connector will sync the data.", "items": { "title": "", "type": "object", "properties": { "breakdowns": { "title": "", "type": "array", "description": "Breakdowns are now used instead of level and segmentation. They provide a filter for report data.", "example": "KEYWORD", "items": { "title": "", "type": "object", "description": "", "example": "CAMPAIGN_ID | AD_ID | OS_TYPE | KEYWORD | INTEREST | REGION | AD_ACCOUNT_ID | PLACEMENT | COMMUNITY | COUNTRY | DMA | GENDER | AD_GROUP_ID | GALLERY_ITEM_ID", "enum": [ "CAMPAIGN_ID", "AD_ID", "OS_TYPE", "KEYWORD", "INTEREST", "REGION", "AD_ACCOUNT_ID", "PLACEMENT", "COMMUNITY", "COUNTRY", "DMA", "GENDER", "AD_GROUP_ID", "GALLERY_ITEM_ID" ] } }, "conversions_report_included": { "title": "", "type": "boolean", "description": "The boolean value specifying whether to enable or disable event conversions data synchronisation. Default value: `false`", "example": true }, "custom_events_included": { "title": "", "type": "boolean", "description": "The boolean value specifying whether the custom events are included in event conversions report. Default value: `false`", "example": true }, "event_names": { "title": "", "type": "array", "description": "The list of events the conversion data will be synchronised for", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "level": { "title": "", "type": "object", "description": "Level of custom report.", "example": "CAMPAIGN", "enum": [ "ACCOUNT", "AD", "POST", "AD_GROUP", "NONE", "CAMPAIGN" ] }, "report_fields": { "title": "", "type": "array", "description": "The list of fields included in custom report", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_name": { "title": "", "type": "string", "description": "The table name within the schema to which connector syncs the data of the specific report.", "example": "test_report_name" }, "segmentation": { "title": "", "type": "object", "description": "Level of custom report.", "example": "COMMUNITY", "enum": [ "PLACEMENT", "COUNTRY", "METRO", "COMMUNITY", "NONE", "INTEREST" ] }, "time_zone": { "title": "", "type": "string", "description": "The specific time zone to sync report data if `useAccountTimeZone` set to `false`.", "example": "GMT" }, "time_zone_mode": { "title": "", "type": "object", "description": "When this parameter is set to `ACCOUNT`, connector will use account related time zone to sync report data. Default value: `ACCOUNT`. Possible values: `ACCOUNT`, `USER`", "example": "USER", "enum": [ "ACCOUNT", "USER" ] } }, "description": "The list of custom report configurations. Each report corresponds to a table within the schema to which connector will sync the data." } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all accounts or specific accounts.", "example": "AllAccounts | SpecificAccounts", "enum": [ "AllAccounts", "SpecificAccounts" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "reddit_ads_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Reddit Ads client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Reddit Ads client application.", "example": "my_client_secret" } }, "description": "Your application client access fields" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "reddit_ads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/reddit_ads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/reddit_ads_auth_V1" } ] }, "referralhero_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Referralhero API token.", "format": "password", "example": "your_referralhero_api_token" } }, "description": "" } } }, "referralhero_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/referralhero_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "refiner_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Refiner API key.", "format": "password", "example": "your_refiner_api_key" } }, "description": "" } } }, "refiner_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/refiner_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "reltio_config_V1": { "properties": { "config": { "type": "object", "properties": { "max_api_requests_per_day": { "title": "", "type": "integer", "description": "Maximum API requests per day", "format": "int32", "example": 1000000 }, "tenant_configs": { "title": "", "type": "array", "description": "* tenant(s)", "items": { "title": "", "type": "object", "properties": { "subdomain": { "title": "", "type": "string", "description": "Your Reltio subdomain.", "example": "your_reltio_subdomain" }, "tenant_id": { "title": "", "type": "string", "description": "Your Reltio tenant ID.", "example": "your_reltio_tenant_id" } }, "description": "* tenant(s)" } } }, "description": "" } } }, "reltio_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/reltio_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "replyio_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Reply API key.", "format": "password", "example": "your_replyio_api_key" } }, "description": "" } } }, "replyio_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/replyio_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "resource_management_by_smartsheet_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Resource Management by Smartsheet API token.", "format": "password", "example": "your_resource_management_by_smartsheet_api_token" } }, "description": "" } } }, "resource_management_by_smartsheet_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/resource_management_by_smartsheet_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "retailnext_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_key": { "title": "", "type": "string", "description": "Your RetailNext access key.", "format": "password", "example": "your_access_key" }, "secret_key": { "title": "", "type": "string", "description": "Your RetailNext secret key.", "format": "password", "example": "your_secret_key" }, "subscription": { "title": "", "type": "string", "description": "Your RetailNext subscription.", "example": "your_subscription" } }, "description": "" } } }, "retailnext_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/retailnext_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "retently_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Retently API token.", "format": "password", "example": "your_retently_api_token" } }, "description": "" } } }, "retently_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/retently_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "revel_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key_api_secret": { "title": "", "type": "string", "description": "Your Revel Systems API Key and API Secret.", "format": "password", "example": "your_revel_systems_api_key_api_secret" }, "sub_domain": { "title": "", "type": "string", "description": "Your Revel Systems subDomain.", "example": "your_revel_systems_sub_domain" } }, "description": "" } } }, "revel_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/revel_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "revenuecat_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your RevenueCat API key.", "format": "password", "example": "your_revenuecat_api_key" } }, "description": "" } } }, "revenuecat_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/revenuecat_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "reviewsai_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your REVIEWS.ai API token.", "format": "password", "example": "your_reviewsai_api_token" } }, "description": "" } } }, "reviewsai_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/reviewsai_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "reviewsio_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your REVIEWS.io API key.", "format": "password", "example": "your_reviewsio_api_key" }, "store_id": { "title": "", "type": "string", "description": "Your REVIEWS.io store ID", "example": "your_reviewsio_store_id" } }, "description": "" } } }, "reviewsio_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/reviewsio_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "revops_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your RevOps bearer token.", "format": "password", "example": "string" } }, "description": "" } } }, "revops_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/revops_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "revx_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your RevX Password.", "format": "password", "example": "your_revx_password_hash" }, "username": { "title": "", "type": "string", "description": "Your RevX Username.", "example": "your_revx_username" } }, "description": "" } } }, "revx_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/revx_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ricochet360_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Ricochet360 API key.", "format": "password", "example": "your_ricochet360_api_key" } }, "description": "" } } }, "ricochet360_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ricochet360_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ringcentral_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "ringcentral_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The long-lived `Access token` carries the information necessary to access API resources.", "example": "my_access_token" } }, "description": "" } } }, "ringcentral_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ringcentral_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/ringcentral_auth_V1" } ] }, "ringover_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Ringover API key.", "format": "password", "example": "your_ringover_api_key" }, "region": { "type": "object", "description": "Your Ringover region.", "enum": [ "-api-us", "-api" ] } }, "description": "" } } }, "ringover_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ringover_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "rippling_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Rippling API token.", "format": "password", "example": "your_rippling_api_token" } }, "description": "" } } }, "rippling_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/rippling_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "rithum_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "rithum_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "rithum_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/rithum_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/rithum_auth_V1" } ] }, "rivo_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Rivo API key.", "format": "password", "example": "your_rivo_api_key" } }, "description": "" } } }, "rivo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/rivo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "rocketlane_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Rocketlane API key.", "format": "password", "example": "your_rocketlane_api_key" }, "sub_domain": { "type": "object", "description": "Your Rocketlane API server region.", "enum": [ "api.eu.rocketlane.com", "api.rocketlane.com" ] } }, "description": "" } } }, "rocketlane_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/rocketlane_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "rokt_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_id": { "title": "", "type": "string", "description": "Your Rokt account ID.", "example": "your_rokt_account_id" }, "app_id": { "title": "", "type": "string", "description": "Your Rokt app ID.", "example": "your_rokt_app_id" }, "app_secret": { "title": "", "type": "string", "description": "Your Rokt app secret.", "format": "password", "example": "your_rokt_app_secret" }, "currency": { "type": "object", "description": "Your Rokt currency.", "enum": [ "AUD", "SGD", "KRW", "JPY", "EUR", "GBP", "USD", "CAD", "NZD", "CNY" ] }, "historical_sync_time_frame": { "type": "object", "description": "Your Rokt historical sync time frame.", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] }, "timezone": { "type": "object", "description": "Your Rokt timezone.", "enum": [ "Australia/Sydney", "America/Chicago", "Pacific/Honolulu" ] } }, "description": "" } } }, "rokt_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/rokt_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "rollbar_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_access_token": { "title": "", "type": "string", "description": "Your Rollbar account access token.", "format": "password", "example": "your_rollbar_account_access_token" }, "project_access_token": { "title": "", "type": "string", "description": "Your Rollbar project access token.", "format": "password", "example": "your_rollbar_project_access_token" } }, "description": "" } } }, "rollbar_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/rollbar_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "rootly_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Rootly API key.", "format": "password", "example": "your_rootly_api_key" } }, "description": "" } } }, "rootly_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/rootly_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "rtb_house_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your RTB House password.", "format": "password", "example": "your_rtb_house_password" }, "username": { "title": "", "type": "string", "description": "Your RTB House username.", "example": "your_rtb_house_username" } }, "description": "" } } }, "rtb_house_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/rtb_house_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ruddr_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Ruddr API key.", "format": "password", "example": "string" } }, "description": "" } } }, "ruddr_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ruddr_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "rundeck_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Rundeck API token.", "format": "password", "example": "your_rundeck_api_token" }, "sub_domain": { "title": "", "type": "string", "description": "Your Rundeck subdomain.", "example": "your_rundeck_subdomain" } }, "description": "" } } }, "rundeck_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/rundeck_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "s3_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_key_id": { "title": "", "type": "string", "description": "Access Key ID", "example": "access_key_id_value" }, "access_key_secret": { "title": "", "type": "string", "description": "Access Key Secret", "format": "password", "example": "access_key_secret_value" }, "append_file_option": { "title": "", "type": "object", "description": "If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.", "example": "upsert_file_with_primary_keys | upsert_file | append_file", "enum": [ "upsert_file_with_primary_keys", "upsert_file", "append_file" ] }, "auth_type": { "title": "", "type": "object", "description": "Access approach", "example": "IAM_ROLE | PUBLIC_BUCKET | ACCESS_KEY", "enum": [ "IAM_ROLE", "PUBLIC_BUCKET", "ACCESS_KEY" ] }, "bucket": { "title": "", "type": "string", "description": "The S3 bucket name. Required for connector creation.", "example": "bucket_name" }, "compression": { "title": "", "type": "object", "description": "The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.", "example": "zip | gz | tar_gz | tar | infer | gzip | uncompressed | bz2 | tar_bz2", "enum": [ "zip", "gz", "tar_gz", "tar", "infer", "gzip", "uncompressed", "bz2", "tar_bz2" ] }, "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "delimiter": { "title": "", "type": "string", "description": "You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.", "example": "," }, "empty_header": { "title": "", "type": "boolean", "description": "If your CSVs are headerless, set this is as `true`. When `true`, we will generate generic column names following the convention of `column_0`, `column_1`, ... `column_n` to map the rows. Default value: `false`.", "example": true }, "escape_char": { "title": "", "type": "string", "description": "If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.", "example": "string" }, "extraction_pattern": { "title": "", "type": "string", "description": "Required when `file_mapping_method` = `EXTRACT_TABLES`. A regular expression with a named capture group `(?
...)` to extract table names from file paths.", "example": "(?
\\w+)/.*" }, "file_mapping_method": { "title": "", "type": "object", "description": "The method used to map files to destination tables. Use `DEFINE_PER_TABLE` to manually configure each table with its own file pattern, or `EXTRACT_TABLES` to automatically discover tables based on a single extraction pattern.", "example": "EXTRACT_TABLES | DEFINE_PER_TABLE", "enum": [ "EXTRACT_TABLES", "DEFINE_PER_TABLE" ] }, "file_type": { "title": "", "type": "object", "description": "If your files are saved with improper extensions, you can force them to be synced as the selected file type.", "example": "tsv | xml | csv | spreadsheet | json | jsonl | avro | parquet", "enum": [ "tsv", "xml", "csv", "spreadsheet", "json", "jsonl", "avro", "parquet" ] }, "files": { "title": "", "type": "array", "description": "Required when `file_mapping_method` = `DEFINE_PER_TABLE`. Mapped file name patterns to a destination table.", "items": { "title": "", "type": "object", "properties": { "archive_pattern": { "title": "", "type": "string", "description": "All Files inside of compressed archives with filenames matching this regular expression will be synced.", "example": "string" }, "file_pattern": { "title": "", "type": "string", "description": "All files in your search path matching this regular expression will be synced per table.", "example": "string" }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "table_name": { "title": "", "type": "string", "description": "All files matching the above pattern will be synced to this table.", "example": "string" } }, "description": "Required when `file_mapping_method` = `DEFINE_PER_TABLE`. Mapped file name patterns to a destination table." } }, "is_private_link_required": { "title": "", "type": "boolean", "description": "Set to `true` if you want to connect to S3 bucket over PrivateLink. Default value: `false`.", "example": true }, "is_public": { "title": "", "type": "boolean", "description": "Whether you are syncing from a public bucket. Default value: `false`.", "example": true }, "json_delivery_mode": { "title": "", "type": "object", "description": "Control how your JSON data is delivered into your destination", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "line_separator": { "title": "", "type": "string", "description": "You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.", "example": ";" }, "list_strategy": { "title": "", "type": "object", "description": "The listing strategy you want to use. Default value: `complete_listing`.", "example": "complete_listing | time_based_pattern_listing", "enum": [ "complete_listing", "time_based_pattern_listing" ] }, "non_standard_escape_char": { "title": "", "type": "boolean", "description": "Use this if your CSV generator uses non-standard ways of escaping characters. Default value: `false`.", "example": true }, "null_sequence": { "title": "", "type": "string", "description": "If your CSVs use a special value indicating null, you can specify it here.", "example": "string" }, "on_error": { "title": "", "type": "object", "description": "If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as `fail` unless you are certain that you have undesirable, malformed data.", "example": "fail | skip", "enum": [ "fail", "skip" ] }, "pgp_pass_phrase": { "title": "", "type": "string", "description": "The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.", "format": "password", "example": "" }, "pgp_secret_key": { "title": "", "type": "string", "description": "The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.", "format": "password", "example": "" }, "prefix": { "title": "", "type": "string", "description": "The connection will look for files in this folder path. Choose the lowest common folder in a folder hierarchy that includes all the files you want to sync. This defines a specific location where Fivetran scans for files and helps ensure optimal performance.", "example": "files/exports" }, "quote_char": { "title": "", "type": "string", "description": "You can specify the enclosing character used in your CSVs here. Fivetran will consider \" as the quote character if this field is empty and quote_character_enabled is set to true.", "example": "\\" }, "quote_character_enabled": { "title": "", "type": "boolean", "description": "If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered \" as quote character.", "example": true }, "role_arn": { "title": "", "type": "string", "description": "The Role ARN required for authentication. Required for connector creation when syncing using private bucket.", "format": "password", "example": "arn::your_role_arn" }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "signer_public_key": { "title": "", "type": "string", "description": "The contents of the signer's public key file. This is optional — if you don't provide the key, we decrypt the files without verifying their signatures.", "example": "" }, "skip_after": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination.", "format": "int32", "example": 0 }, "skip_before": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified before syncing data.", "format": "int32", "example": 0 }, "sync_inconsistent_rows": { "title": "", "type": "boolean", "description": "When enabled, Fivetran syncs rows with fewer or more columns than the header row. For rows with fewer columns, Fivetran adds NULL values for the missing columns. For rows with extra columns, Fivetran names them `column_`. When disabled, Fivetran handles inconsistent rows according to your error-handling settings.", "example": true }, "use_pgp_encryption_options": { "title": "", "type": "boolean", "description": "Set to `true` if files are encrypted using PGP in the S3 bucket. Default value: `false`.", "example": true } }, "description": "" } } }, "s3_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "access_key_id": { "title": "", "type": "string", "description": "ESM key for access Key ID", "example": "ACCESS_KEY_ID_KEY" }, "access_key_secret": { "title": "", "type": "string", "description": "ESM key for access Key Secret", "example": "ACCESS_KEY_SECRET_KEY" } }, "description": "" } } }, "s3_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/s3_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table_group" }, { "$ref": "#/components/schemas/s3_esm_keys_config_V1" } ] }, "s3_compatible_storage_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_key_id": { "title": "", "type": "string", "description": "Access Key ID", "example": "access_key_id_value" }, "access_key_secret": { "title": "", "type": "string", "description": "Access Key Secret", "format": "password", "example": "access_key_secret_value" }, "append_file_option": { "title": "", "type": "object", "description": "If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.", "example": "upsert_file_with_primary_keys | upsert_file | append_file", "enum": [ "upsert_file_with_primary_keys", "upsert_file", "append_file" ] }, "auth_type": { "title": "", "type": "object", "description": "Access approach", "example": "PUBLIC_BUCKET | ACCESS_KEY", "enum": [ "PUBLIC_BUCKET", "ACCESS_KEY" ] }, "bucket": { "title": "", "type": "string", "description": "The S3-Compatible Storage bucket name. Required for connector creation.", "example": "bucket_name" }, "compression": { "title": "", "type": "object", "description": "The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.", "example": "zip | gz | tar_gz | tar | infer | gzip | uncompressed | bz2 | tar_bz2", "enum": [ "zip", "gz", "tar_gz", "tar", "infer", "gzip", "uncompressed", "bz2", "tar_bz2" ] }, "delimiter": { "title": "", "type": "string", "description": "You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.", "example": "," }, "empty_header": { "title": "", "type": "boolean", "description": "If your CSVs are headerless, set this is as `true`. When `true`, we will generate generic column names following the convention of `column_0`, `column_1`, ... `column_n` to map the rows. Default value: `false`.", "example": true }, "endpoint_url": { "title": "", "type": "string", "description": "S3-Compatible Storage Endpoint URL.", "example": "endpoint_url_value" }, "escape_char": { "title": "", "type": "string", "description": "If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.", "example": "string" }, "file_type": { "title": "", "type": "object", "description": "If your files are saved with improper extensions, you can force them to be synced as the selected file type.", "example": "tsv | xml | csv | spreadsheet | json | jsonl | avro | parquet", "enum": [ "tsv", "xml", "csv", "spreadsheet", "json", "jsonl", "avro", "parquet" ] }, "files": { "title": "", "type": "array", "description": "Mapped file name patterns to a destination table.", "items": { "title": "", "type": "object", "properties": { "archive_pattern": { "title": "", "type": "string", "description": "All Files inside of compressed archives with filenames matching this regular expression will be synced.", "example": "string" }, "file_pattern": { "title": "", "type": "string", "description": "All files in your search path matching this regular expression will be synced per table.", "example": "string" }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "table_name": { "title": "", "type": "string", "description": "All files matching the above pattern will be synced to this table.", "example": "string" } }, "description": "Mapped file name patterns to a destination table." } }, "json_delivery_mode": { "title": "", "type": "object", "description": "Control how your JSON data is delivered into your destination", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "line_separator": { "title": "", "type": "string", "description": "You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.", "example": ";" }, "list_strategy": { "title": "", "type": "object", "description": "The listing strategy you want to use. Default value: `complete_listing`.", "example": "complete_listing | time_based_pattern_listing", "enum": [ "complete_listing", "time_based_pattern_listing" ] }, "null_sequence": { "title": "", "type": "string", "description": "If your CSVs use a special value indicating null, you can specify it here.", "example": "string" }, "on_error": { "title": "", "type": "object", "description": "If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as `fail` unless you are certain that you have undesirable, malformed data.", "example": "fail | skip", "enum": [ "fail", "skip" ] }, "pgp_pass_phrase": { "title": "", "type": "string", "description": "The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.", "format": "password", "example": "" }, "pgp_secret_key": { "title": "", "type": "string", "description": "The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.", "format": "password", "example": "" }, "prefix": { "title": "", "type": "string", "description": "The connection will look for files in this folder path. Choose the lowest common folder in a folder hierarchy that includes all the files you want to sync. This defines a specific location where Fivetran scans for files and helps ensure optimal performance.", "example": "files/exports" }, "quote_char": { "title": "", "type": "string", "description": "You can specify the enclosing character used in your CSVs here. Fivetran will consider \" as the quote character if this field is empty and quote_character_enabled is set to true.", "example": "\\" }, "quote_character_enabled": { "title": "", "type": "boolean", "description": "If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered \" as quote character.", "example": true }, "selected_range": { "title": "", "type": "string", "description": "", "example": "string" }, "signer_public_key": { "title": "", "type": "string", "description": "The contents of the signer's public key file. This is optional — if you don't provide the key, we decrypt the files without verifying their signatures.", "example": "" }, "skip_after": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified at the end to avoid introducing aberrant data into your destination.", "format": "int32", "example": 0 }, "skip_before": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified before syncing data.", "format": "int32", "example": 0 }, "sync_inconsistent_rows": { "title": "", "type": "boolean", "description": "When enabled, Fivetran syncs rows with fewer or more columns than the header row. For rows with fewer columns, Fivetran adds NULL values for the missing columns. For rows with extra columns, Fivetran names them `column_`. When disabled, Fivetran handles inconsistent rows according to your error-handling settings.", "example": true }, "use_pgp_encryption_options": { "title": "", "type": "boolean", "description": "Set to `true` if files are encrypted using PGP in the S3-Compatible Storage bucket. Default value: `false`.", "example": true } }, "description": "" } } }, "s3_compatible_storage_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "access_key_id": { "title": "", "type": "string", "description": "ESM key for access Key ID", "example": "ACCESS_KEY_ID_KEY" }, "access_key_secret": { "title": "", "type": "string", "description": "ESM key for access Key Secret", "example": "ACCESS_KEY_SECRET_KEY" } }, "description": "" } } }, "s3_compatible_storage_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/s3_compatible_storage_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table_group" }, { "$ref": "#/components/schemas/s3_compatible_storage_esm_keys_config_V1" } ] }, "safebase_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your SafeBase API key.", "format": "password", "example": "your_safebase_api_key" } }, "description": "" } } }, "safebase_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/safebase_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "safetyculture_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your SafetyCulture API token.", "format": "password", "example": "your_safetyculture_api_token" } }, "description": "" } } }, "safetyculture_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/safetyculture_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sage_hr_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Sage HR API key.", "format": "password", "example": "your_sage_hr_api_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your Sage HR subdomain.", "example": "your_sage_hr_sub_domain" } }, "description": "" } } }, "sage_hr_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sage_hr_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sage_intacct_config_V1": { "properties": { "config": { "type": "object", "properties": { "company_id": { "title": "", "type": "string", "description": "Company ID", "example": "your_intacct_company_id" }, "historical_sync_limit": { "title": "", "type": "string", "description": "Historical Sync Limit for the Sync", "example": "1970-01-01" }, "login_password": { "title": "", "type": "string", "description": "The login password. It is a part of the login credentials.", "format": "password", "example": "xxxxxxxxxx" }, "look_back_window_for_gl_batch_endpoint": { "title": "", "type": "integer", "description": "Lookback window for GL Batch endpoint lookback sync", "format": "int32", "example": 365 }, "sender_id": { "title": "", "type": "string", "description": "Your Sender ID", "example": "your_intacct_sender_id" }, "sender_password": { "title": "", "type": "string", "description": "Your Sender Password", "format": "password", "example": "your_intacct_sender_password" }, "user_id": { "title": "", "type": "string", "description": "User ID", "example": "your_intacct_user_id" } }, "description": "" } } }, "sage_intacct_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sage_intacct_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sailthru_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "The Sailthru API key.", "example": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }, "api_secret": { "title": "", "type": "string", "description": "The Sailthru API secret.", "format": "password", "example": "your_api_secret" }, "campaign_query_lookback_window_in_days": { "title": "", "type": "integer", "description": "The number of days to look back for campaign query data during incremental syncs. Valid range: 2-90. Default: 60.", "format": "int32", "example": 60 }, "historical_sync_limit": { "title": "", "type": "object", "description": "The time range for which historical data should be synced. Default value: `All Time`.", "example": "ALL_TIME | DATE_LIMIT", "enum": [ "ALL_TIME", "DATE_LIMIT" ] }, "historical_sync_limit_date": { "title": "", "type": "string", "description": "The start date (YYYY-MM-DD) from which to sync historical data.", "example": "2008-03-25" }, "is_sailthru_connect_enabled": { "title": "", "type": "boolean", "description": "Enable this if you want to sync Sailthru Connect", "example": true }, "packing_mode": { "title": "", "type": "object", "description": "Packing mode for LIST_STATE and USER tables.", "example": "UNPACKED | PACKED", "enum": [ "UNPACKED", "PACKED" ] }, "s3bucket": { "title": "", "type": "string", "description": "Name of the bucket configured to receive sailthru connect data.", "example": "string" }, "s3path": { "title": "", "type": "string", "description": "Copy and use this to configure Sailthru Connect in your sailthru account.", "example": "string" }, "s3role_arn": { "title": "", "type": "string", "description": "Role ARN of the IAM role created for Fivetran.", "format": "password", "example": "string" }, "use_customer_s3_bucket": { "title": "", "type": "boolean", "description": "Enable this if you want to sync Sailthru Connect using your own\" S3 bucket.", "example": true } }, "description": "" } } }, "sailthru_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sailthru_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "salesforce_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_usage_limit": { "title": "", "type": "integer", "description": "(Optional) The percentage of your Salesforce [daily API limit](https://developer.salesforce.com/docs/atlas.en-us.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm) that Fivetran should consume. Value must be between 50 and 90 (default value = `90`)", "format": "int32", "example": 75 }, "authentication_method": { "title": "", "type": "object", "description": "(Optional) Authentication type (default value = `STANDARD`)", "example": "STANDARD | ADVANCED", "enum": [ "STANDARD", "ADVANCED" ] }, "base_url": { "title": "", "type": "string", "description": "(Optional) The custom Salesforce domain. Make sure that the `base_url` starts with `https://`.", "example": "https://base_url.salesforce.com" }, "certificate": { "title": "", "type": "string", "description": "Provide content of the `.pem` certificate (only when authentication_method = `ADVANCED`).", "format": "password", "example": "---" }, "private_key": { "title": "", "type": "string", "description": "Provide content of the `.key` private key (only when authentication_method = `ADVANCED`).", "format": "password", "example": "---" }, "sync_formula_fields": { "title": "", "type": "boolean", "description": "Enable this option to sync formula fields directly (default value = `false`)", "example": true }, "update_infrequent_objects_in_every_sync": { "title": "", "type": "boolean", "description": "Enable this option to sync infrequently updated tables during every sync (default value = `false`)", "example": true } }, "description": "" } } }, "salesforce_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Salesforce client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Salesforce client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "salesforce_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/salesforce_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/salesforce_auth_V1" } ] }, "salesforce_commerce_cloud_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "The Salesforce Commerce Cloud Client ID.", "example": "your_client_id" }, "client_secret": { "title": "", "type": "string", "description": "The Salesforce Commerce Cloud Client secret.", "format": "password", "example": "your_api_secret" }, "customer_list_id": { "title": "", "type": "string", "description": "The parameter to retrieve customer details.", "example": "your_customer_list_id" }, "include_ocapi_endpoints": { "title": "", "type": "boolean", "description": "Whether to sync data through OCAPI endpoints.", "example": true }, "ocapi_client_id": { "title": "", "type": "string", "description": "The Salesforce Commerce Cloud OCAPI Client ID.", "example": "string" }, "ocapi_client_secret": { "title": "", "type": "string", "description": "The Salesforce Commerce Cloud OCAPI Client secret.", "format": "password", "example": "string" }, "ocapi_custom_object_types": { "title": "", "type": "string", "description": "The Salesforce Commerce Cloud OCAPI custom object types.", "example": "string" }, "ocapi_hostname": { "title": "", "type": "string", "description": "The Salesforce Commerce Cloud OCAPI hostname.", "example": "string" }, "organization_id": { "title": "", "type": "string", "description": "The organization ID from Salesforce Commerce Cloud account.", "example": "organization_id" }, "short_code": { "title": "", "type": "string", "description": "The Salesforce eight-character string assigned to a realm for routing purposes.", "format": "password", "example": "your_short_code" }, "site_id": { "title": "", "type": "string", "description": "The name of the site from which you want to sync data.", "example": "your_site_id" } }, "description": "" } } }, "salesforce_commerce_cloud_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "ocapi_access_token": { "title": "", "type": "string", "description": "", "example": "string" }, "ocapi_refresh_token": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "salesforce_commerce_cloud_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/salesforce_commerce_cloud_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/salesforce_commerce_cloud_auth_V1" } ] }, "salesforce_marketing_cloud_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "The Salesforce Marketing Cloud client ID.", "example": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }, "client_secret": { "title": "", "type": "string", "description": "The Salesforce Marketing Cloud client secret.", "format": "password", "example": "your_api_secret" }, "event_extract_mode": { "title": "", "type": "object", "description": "Event sync method. This is how Fivetran gets data for the event objects, can be selected only during the connector creation. TRACKING_EXTRACT - Salesforce exports a file, which we download and extract event data from. This is the faster for large volumes, and requires SFTP. SOAP - We sync data using the SOAP API event object endpoints. This syncs the latest events faster, but is slow for large volumes.", "example": "TRACKING_EXTRACT | SOAP", "enum": [ "TRACKING_EXTRACT", "SOAP" ] }, "historical_sync_limit": { "title": "", "type": "object", "description": "The time range for which historical data should be synced. Default value: `All Time`.", "example": "ALL_TIME | DATE_LIMIT", "enum": [ "ALL_TIME", "DATE_LIMIT" ] }, "historical_sync_limit_date": { "title": "", "type": "string", "description": "The start date (YYYY-MM-DD) from which to sync historical data.", "example": "2000-12-15" }, "instance": { "title": "", "type": "object", "description": "The Salesforce Marketing Cloud instance ID", "example": "string", "enum": [ "s4", "s5", "s11", "s6", "s10", "s7", "s8", "s12", "s1", "s51", "s50" ] }, "is_new_package": { "title": "", "type": "boolean", "description": "Indicates that that your installed package uses OAuth 2.0. Default value: `false`", "example": true }, "is_sftp_creds_available": { "title": "", "type": "boolean", "description": "Provide SFTP credentials", "example": true }, "selected_event_types": { "title": "", "type": "array", "description": "Select the event types to be synced.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "sftp_host": { "title": "", "type": "string", "description": "Host", "example": "string" }, "sftp_is_key_pair": { "title": "", "type": "boolean", "description": "Set this field if you use a key pair for logging into your SFTP server. Don't set it if you use a username and password", "example": true }, "sftp_password": { "title": "", "type": "string", "description": "Password", "format": "password", "example": "string" }, "sftp_port": { "title": "", "type": "integer", "description": "Port", "format": "int32", "example": 0 }, "sftp_user": { "title": "", "type": "string", "description": "User", "example": "string" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "sync_mode": { "title": "", "type": "object", "description": "Filter event types.", "example": "SelectedEvents | AllEvents", "enum": [ "SelectedEvents", "AllEvents" ] } }, "description": "" } } }, "salesforce_marketing_cloud_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/salesforce_marketing_cloud_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "salesforce_sandbox_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_usage_limit": { "title": "", "type": "integer", "description": "(Optional) The percentage of your Salesforce [daily API limit](https://developer.salesforce.com/docs/atlas.en-us.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm) that Fivetran should consume. Value must be between 50 and 90 (default value = `90`)", "format": "int32", "example": 75 }, "authentication_method": { "title": "", "type": "object", "description": "(Optional) Authentication type (default value = `STANDARD`)", "example": "STANDARD | ADVANCED", "enum": [ "STANDARD", "ADVANCED" ] }, "base_url": { "title": "", "type": "string", "description": "(Optional) The custom Salesforce domain. Make sure that the `base_url` starts with `https://`.", "example": "https://base_url.salesforce.com" }, "certificate": { "title": "", "type": "string", "description": "Provide content of the `.pem` certificate (only when authentication_method = `ADVANCED`).", "format": "password", "example": "---" }, "private_key": { "title": "", "type": "string", "description": "Provide content of the `.key` private key (only when authentication_method = `ADVANCED`).", "format": "password", "example": "---" }, "sync_formula_fields": { "title": "", "type": "boolean", "description": "Enable this option to sync formula fields directly (default value = `false`)", "example": true }, "update_infrequent_objects_in_every_sync": { "title": "", "type": "boolean", "description": "Enable this option to sync infrequently updated tables during every sync (default value = `false`)", "example": true } }, "description": "" } } }, "salesforce_sandbox_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Salesforce client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Salesforce client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "salesforce_sandbox_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/salesforce_sandbox_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/salesforce_sandbox_auth_V1" } ] }, "salesloft_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Salesloft client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Salesloft client application.", "format": "password", "example": "my_client_secret" } }, "description": "" } } }, "salesloft_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "salesloft_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/salesloft_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/salesloft_auth_V1" } ] }, "salsify_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Salsify API Key.", "format": "password", "example": "your_salsify_api_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your Salsify Organization ID.", "example": "your_salsify_organization_id" } }, "description": "" } } }, "salsify_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/salsify_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "samsara_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Samsara API token.", "format": "password", "example": "your_samsara_api_token" }, "app_id": { "title": "", "type": "string", "description": "App ID for your OAuth 2.0 app.", "example": "your_oauth_app_id" }, "app_secret": { "title": "", "type": "string", "description": "App secret for your OAuth 2.0 app.", "format": "password", "example": "your_oauth_app_secret" }, "auth_type": { "type": "object", "description": "The authentication method you want to use for your connection.", "enum": [ "access_token", "oauth_2" ] }, "region": { "type": "object", "description": "The region of your Samsara account. For instance, if your region is `EUROPE`, provide `eu.samsara` in the `Region` field. If your region is not in Europe, provide `samsara`.", "enum": [ "eu.samsara", "samsara" ] } }, "description": "" } } }, "samsara_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/samsara_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sana_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Sana client ID.", "example": "sana_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Sana client secret.", "format": "password", "example": "sana_client_secret" }, "subdomain": { "title": "", "type": "string", "description": "Your Sana subdomain.", "example": "sana_subdomain" } }, "description": "" } } }, "sana_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sana_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sap_business_by_design_config_V1": { "properties": { "config": { "type": "object", "properties": { "instance_url": { "title": "", "type": "string", "description": "The SAP Business ByDesign instance URL.", "example": "your_sap_business_bydesign_instance_url" }, "password": { "title": "", "type": "string", "description": "The SAP Business ByDesign password.", "format": "password", "example": "your_sap_business_bydesign_password" }, "username": { "title": "", "type": "string", "description": "The SAP Business ByDesign username.", "example": "your_sap_business_bydesign_username" } }, "description": "" } } }, "sap_business_by_design_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sap_business_by_design_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sap_hana_db_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "", "example": true }, "client": { "title": "", "type": "string", "description": "", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "", "example": "PrivateLink | SshTunnel | ProxyAgent", "enum": [ "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "convert_dats_type_to_date": { "title": "", "type": "boolean", "description": "", "example": true }, "database": { "title": "", "type": "string", "description": "", "example": "string" }, "group": { "title": "Logon Group", "type": "string", "description": "SAP Logon Group name for load balancing", "example": "string" }, "hana_db_port": { "title": "HANA DB Port", "type": "integer", "description": "Port number of the SAP HANA database", "format": "int32", "example": 30215 }, "host": { "title": "", "type": "string", "description": "", "example": "string" }, "ms_host": { "title": "Message Server Host", "type": "string", "description": "SAP Message Server host name", "example": "string" }, "ms_serv": { "title": "Message Server Port", "type": "string", "description": "SAP Message Server service port number", "example": "string" }, "password": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "port": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 }, "r3_name": { "title": "System ID", "type": "string", "description": "SAP System ID (SID)", "example": "string" }, "sap_hana_connection_mode": { "title": "SAP HANA Connection Mode", "type": "object", "description": "Connection mode for SAP HANA database (DIRECT or NETWEAVER)", "example": "NETWEAVER | DIRECT", "enum": [ "NETWEAVER", "DIRECT" ] }, "sap_router": { "title": "SAP Router", "type": "string", "description": "SAP Router connection string (format: /H/hostname/S/port)", "example": "/H/hostname/S/3299" }, "schema_name": { "title": "schemaName", "type": "string", "description": "SAP schema name", "example": "SAPHANADB" }, "snc_certificate_source": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "snc_mode": { "title": "", "type": "object", "description": "", "example": "SncUserPass | NoSnc | SncCertificate", "enum": [ "SncUserPass", "NoSnc", "SncCertificate" ] }, "snc_source_name": { "title": "", "type": "string", "description": "", "example": "string" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "sysnr": { "title": "", "type": "string", "description": "", "example": "string" }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "string" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 0 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "string" }, "use_message_server": { "title": "Use Message Server", "type": "boolean", "description": "Enable connection via SAP Message Server for load balancing", "example": true }, "use_sap_router": { "title": "Use SAP Router", "type": "boolean", "description": "Enable connection via SAP Router", "example": true }, "user": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "sap_hana_db_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "", "example": "USER_KEY" } }, "description": "" } } }, "sap_hana_db_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sap_hana_db_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/sap_hana_db_esm_keys_config_V1" } ] }, "sap_odata_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Possible values: `Directly`, `ProxyAgent`, `PrivateLink`.", "example": "Directly | PrivateLink | ProxyAgent", "enum": [ "Directly", "PrivateLink", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "", "example": "string" }, "host": { "title": "", "type": "string", "description": "The hostname or IP address of the SAP OData service.", "example": "34.34.34.34" }, "password": { "title": "", "type": "string", "description": "The password for your SAP system.", "format": "password", "example": "string" }, "port": { "title": "", "type": "integer", "description": "The port number of the SAP OData service.", "format": "int32", "example": 44300 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "string" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 0 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "string" }, "user": { "title": "", "type": "string", "description": "The username for your SAP system.", "example": "string" } }, "description": "" } } }, "sap_odata_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the password for your SAP system.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the username for your SAP system.", "example": "USER_KEY" } }, "description": "" } } }, "sap_odata_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sap_odata_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/sap_odata_esm_keys_config_V1" } ] }, "sap_oracle_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS for connections through the tunnel.", "example": true }, "asm_staging_directory": { "title": "", "type": "string", "description": "ASM staging directory path. Required when the ASM option is enabled.", "example": "string" }, "cdb_database": { "title": "", "type": "string", "description": "Optional: CDB database name for TDE-encrypted containerized databases.", "example": "string" }, "cdb_password": { "title": "", "type": "string", "description": "Optional: Password for the CDB user.", "format": "password", "example": "string" }, "cdb_user": { "title": "", "type": "string", "description": "Optional: CDB user for TDE-encrypted containerized databases.", "example": "string" }, "client": { "title": "", "type": "string", "description": "The SAP NetWeaver client. Required when `sapConnectionMode` is `NETWEAVER`.", "example": "100" }, "connection_type": { "title": "", "type": "object", "description": "Possible values:`Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used if this parameter is omitted and any of these parameters is provided: `tunnel_host`, `tunnel_port`, or `tunnel_user`. If the parameter is omitted and none of those tunnel parameters are specified, `Directly` is used.", "example": "PrivateLink | SshTunnel | ProxyAgent", "enum": [ "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "convert_dats_type_to_date": { "title": "", "type": "boolean", "description": "(Immutable) Whether SAP DATS columns are coerced to LocalDate on newly added tables. When false, DATS columns stay String. Cannot be changed after Save & Test. Default value: `true`.", "example": true }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "string" }, "enable_archive_log_only_mode": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` to capture changes exclusively from archived redo logs, without reading from the online redo log.", "example": true }, "enable_asm": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using ASM.", "example": true }, "enable_symbolic_links": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if you're using symbolic links.", "example": true }, "enable_tde_encryption": { "title": "", "type": "boolean", "description": "Default value: `false`. Set to `true` if Transparent Data Encryption (TDE) is enabled.", "example": true }, "host": { "title": "", "type": "string", "description": "Database instance host name or IP address.", "example": "string" }, "local_wallet_host": { "title": "", "type": "string", "description": "Optional: The host for the local Oracle Wallet.", "example": "string" }, "local_wallet_user": { "title": "", "type": "string", "description": "Optional: The user for the local Oracle Wallet.", "example": "string" }, "oracle2_update_method": { "title": "", "type": "object", "description": "The update method for Oracle. Supported values: `BINARY_LOG_READER`. Default value: `BINARY_LOG_READER`.", "example": "BINARY_LOG_READER", "enum": [ "BINARY_LOG_READER", "XSTREAM_OUT", "TELEPORT" ] }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "string" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 0 }, "sap_connection_mode": { "title": "", "type": "object", "description": "The SAP Oracle connection mode. Supported values: `DIRECT`, `NETWEAVER`. Default value: `DIRECT`.", "example": "NETWEAVER | DIRECT", "enum": [ "NETWEAVER", "DIRECT" ] }, "sap_schema": { "title": "", "type": "string", "description": "The SAP schema name.", "example": "string" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "symbolic_links_mapping": { "title": "", "type": "array", "description": "Mapping of symbolic links to actual file paths. Required when symbolic links are enabled.", "items": { "type": "object", "properties": {}, "description": "" } }, "sysnr": { "title": "", "type": "string", "description": "The SAP NetWeaver system number. Required when `sapConnectionMode` is `NETWEAVER`.", "example": "00" }, "tde_wallet_password": { "title": "", "type": "string", "description": "The TDE wallet password. Required for password-based wallets.", "format": "password", "example": "tde_wallet_password" }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host. Specify only when connecting via an SSH tunnel (do not use a load balancer).", "example": "string" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port. Specify only when connecting via an SSH tunnel.", "format": "int32", "example": 0 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user. Specify only when connecting via an SSH tunnel.", "example": "string" }, "user": { "title": "", "type": "string", "description": "The user name.", "example": "string" } }, "description": "" } } }, "sap_oracle_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name.", "example": "USER_KEY" } }, "description": "" } } }, "sap_oracle_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sap_oracle_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/sap_oracle_esm_keys_config_V1" } ] }, "sap_success_factors_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your SAP SuccessFactors Client ID.", "example": "sap_success_factors_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your SAP SuccessFactors Client Secret that you generated through SAML Assertion.", "format": "password", "example": "sap_success_factors_client_secret" }, "company_id": { "title": "", "type": "string", "description": "Your SAP SuccessFactors Company ID.", "example": "sap_success_factors_company_id" }, "sub_domain": { "title": "", "type": "string", "description": "Your SAP SuccessFactors Subdomain.", "example": "http://your.sub.domain" } }, "description": "" } } }, "sap_success_factors_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sap_success_factors_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "scorm_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your Scorm Secret Key.", "format": "password", "example": "your_scorm_secret_key" }, "username": { "title": "", "type": "string", "description": "Your Scorm App ID.", "example": "your_scorm_app_id" } }, "description": "" } } }, "scorm_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/scorm_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "security_journey_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Security Journey API key.", "format": "password", "example": "your_security_journey_api_key" } }, "description": "" } } }, "security_journey_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/security_journey_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "segment_config_V1": { "properties": { "config": { "type": "object", "properties": { "bucket": { "title": "", "type": "string", "description": "The name of the Segment bucket. Must be populated if `sync_type` is set to `S3`.", "example": "bucket" }, "prefix": { "title": "", "type": "string", "description": "Folder path to the Segment files within the bucket. Must be populated if `sync_type` is set to `S3`.", "example": "prefix" }, "role_arn": { "title": "", "type": "string", "description": "The Role ARN required for authentication. Must be populated if `sync_type` is set to `S3`.", "format": "password", "example": "role_arn" }, "sync_type": { "title": "", "type": "object", "description": "The Segment connector sync type.", "example": "S3 | Webhook", "enum": [ "S3", "Webhook" ] } }, "description": "" } } }, "segment_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/segment_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sendgrid_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "The SendGrid API key.", "format": "password", "example": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } }, "description": "" } } }, "sendgrid_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sendgrid_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sentry_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Sentry auth token.", "format": "password", "example": "your_sentry_auth_token" }, "organization_id": { "title": "", "type": "string", "description": "Your Sentry organization ID.", "example": "your_sentry_organization_id" }, "project_ids": { "title": "", "type": "string", "description": "Your Sentry project IDs.", "example": "your_sentry_project_ids" } }, "description": "" } } }, "sentry_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sentry_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "servicenow_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "ServiceNow Client ID.", "example": "client_id" }, "client_secret": { "title": "", "type": "string", "description": "ServiceNow Client Secret.", "format": "password", "example": "client_secret" }, "include_inherited_columns": { "title": "", "type": "boolean", "description": "(Immutable) Include inherited columns.", "example": true }, "instance": { "title": "", "type": "string", "description": "ServiceNow Instance ID.", "example": "instance_id" }, "password": { "title": "", "type": "string", "description": "Your account password.", "format": "password", "example": "password" }, "rollback_window": { "title": "", "type": "integer", "description": "Set a rollback window between 0 and 7 days. The default is 0 days.", "format": "int32", "example": 0 }, "username": { "title": "", "type": "string", "description": "Your ServiceNow User ID (username).", "example": "username" } }, "description": "" } } }, "servicenow_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/servicenow_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "servicetitan_config_V1": { "properties": { "config": { "type": "object", "properties": { "app_key": { "title": "", "type": "string", "description": "Your ServiceTitan app key.", "format": "password", "example": "your_servicetitan_app_key" }, "client_id": { "title": "", "type": "string", "description": "Your ServiceTitan client ID.", "example": "your_servicetitan_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your ServiceTitan secret key.", "format": "password", "example": "your_servicetitan_client_secret" }, "environment": { "type": "object", "description": "Your ServiceTitan environment.", "enum": [ "-integration.", "." ] }, "tenant_id": { "title": "", "type": "string", "description": "Your ServiceTitan tenant ID.", "example": "your_servicetitan_tenant_id" } }, "description": "" } } }, "servicetitan_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/servicetitan_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "servicetrade_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your ServiceTrade password.", "format": "password", "example": "your_servicetrade_password" }, "username": { "title": "", "type": "string", "description": "Your ServiceTrade username.", "example": "your_servicetrade_username" } }, "description": "" } } }, "servicetrade_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/servicetrade_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sevdesk_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your sevdesk API token.", "format": "password", "example": "your_sevdesk_api_token" }, "base_url": { "title": "", "type": "string", "description": "The base URL for the sevdesk API, without the protocol prefix.", "example": "your_sevdesk_base_url" } }, "description": "" } } }, "sevdesk_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sevdesk_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sftp_config_V1": { "properties": { "config": { "type": "object", "properties": { "append_file_option": { "title": "", "type": "object", "description": "If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.", "example": "upsert_file_with_primary_keys | upsert_file | append_file", "enum": [ "upsert_file_with_primary_keys", "upsert_file", "append_file" ] }, "auth_method": { "title": "", "type": "object", "description": "The authentication method to use. Supported values: `PASSWORD`, `FIVETRAN_MANAGED_KEYPAIR`, `CUSTOMER_SUPPLIED_KEYPAIR`.", "example": "PASSWORD | CUSTOMER_SUPPLIED_KEYPAIR | FIVETRAN_MANAGED_KEYPAIR", "enum": [ "PASSWORD", "CUSTOMER_SUPPLIED_KEYPAIR", "FIVETRAN_MANAGED_KEYPAIR" ] }, "compression": { "title": "", "type": "object", "description": "The secrets that should be passed to the function at runtime.", "example": "zip | gz | tar_gz | tar | infer | gzip | uncompressed | bz2 | tar_bz2", "enum": [ "zip", "gz", "tar_gz", "tar", "infer", "gzip", "uncompressed", "bz2", "tar_bz2" ] }, "connection_method": { "title": "", "type": "object", "description": "The connection method used to connect to SFTP Server.", "example": "SSH_TUNNEL | PROXY_AGENT | DIRECT", "enum": [ "SSH_TUNNEL", "PROXY_AGENT", "DIRECT" ] }, "delimiter": { "title": "", "type": "string", "description": "You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.", "example": "string" }, "empty_header": { "title": "", "type": "boolean", "description": "Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.", "example": true }, "escape_char": { "title": "", "type": "string", "description": "If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.", "example": "string" }, "extraction_pattern": { "title": "", "type": "string", "description": "Required when `file_mapping_method` = `EXTRACT_TABLES`. A regular expression with a named capture group `(?
...)` to extract table names from file paths.", "example": "(?
\\w+)/.*" }, "file_handling": { "title": "", "type": "object", "description": "Files will be processed and synced according to the selected file handling option. Supported values:
`structured`- (Default) Extract structured data into destination tables for analysis. Commonly used.
`unstructured`- Replicate files in their original format. Best for PDFs, images, and other unstructured content. Learn more about unstructured file replication in our [documentation.](/docs/using-fivetran/features/unstructured-file-replication).", "example": "structured", "enum": [ "unstructured", "structured" ] }, "file_mapping_method": { "title": "", "type": "object", "description": "The method used to map files to destination tables. Use `DEFINE_PER_TABLE` to manually configure each table with its own file pattern, or `EXTRACT_TABLES` to automatically discover tables based on a single extraction pattern.", "example": "EXTRACT_TABLES | DEFINE_PER_TABLE", "enum": [ "EXTRACT_TABLES", "DEFINE_PER_TABLE" ] }, "file_type": { "title": "", "type": "object", "description": "If your files are saved with improper extensions, you can force them to by synced as the selected file type.", "example": "tsv | xml | csv | spreadsheet | json | jsonl | avro | parquet", "enum": [ "tsv", "xml", "csv", "spreadsheet", "json", "jsonl", "avro", "parquet" ] }, "files": { "title": "", "type": "array", "description": "Required when `file_mapping_method` = `DEFINE_PER_TABLE`. Mapped file name patterns to a destination table.", "items": { "title": "", "type": "object", "properties": { "archive_pattern": { "title": "", "type": "string", "description": "All Files inside of compressed archives with filenames matching this regular expression will be synced.", "example": "string" }, "file_pattern": { "title": "", "type": "string", "description": "All files in your search path matching this regular expression will be synced per table.", "example": "string" }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "table_name": { "title": "", "type": "string", "description": "All files matching the above pattern will be synced to this table.", "example": "string" } }, "description": "Required when `file_mapping_method` = `DEFINE_PER_TABLE`. Mapped file name patterns to a destination table." } }, "host": { "title": "", "type": "string", "description": "SFTP host address.", "example": "sftp.company.com" }, "is_keypair": { "title": "", "type": "boolean", "description": "Whether to use a key pair for authentication. When `true`, do not use `password`.", "example": true }, "is_single_table_mode": { "title": "", "type": "boolean", "description": "Allows the creation of connector using the specified Sync strategy.", "example": true }, "json_delivery_mode": { "title": "", "type": "object", "description": "Control how your JSON data is delivered into your destination", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "line_separator": { "title": "", "type": "string", "description": "You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.", "example": ";" }, "null_sequence": { "title": "", "type": "string", "description": "If your CSVs use a special value indicating null, you can specify it here.", "example": "string" }, "on_error": { "title": "", "type": "object", "description": "If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.", "example": "fail | skip", "enum": [ "fail", "skip" ] }, "password": { "title": "", "type": "string", "description": "SFTP password.", "format": "password", "example": "password" }, "pgp_pass_phrase": { "title": "", "type": "string", "description": "The PGP passphrase used to create the key. Must be populated if `use_pgp_encryption_options` is set to `true`.", "format": "password", "example": "" }, "pgp_secret_key": { "title": "", "type": "string", "description": "The contents of your PGP secret key file. Must be populated if `use_pgp_encryption_options` is set to `true`.", "format": "password", "example": "" }, "port": { "title": "", "type": "integer", "description": "SFTP port.", "format": "int32", "example": 22 }, "prefix": { "title": "", "type": "string", "description": "The connection will look for files in this folder path. Choose the lowest common folder in a folder hierarchy that includes all the files you want to sync. This defines a specific location where Fivetran scans for files and helps ensure optimal performance.", "example": "files/exports" }, "quote_char": { "title": "", "type": "string", "description": "You can specify the enclosing character used in your CSVs here. Fivetran will consider \" as the quote character if this field is empty and quote_character_enabled is set to true.", "example": "string" }, "quote_character_enabled": { "title": "", "type": "boolean", "description": "If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered \" as quote character.", "example": true }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "signer_public_key": { "title": "", "type": "string", "description": "The contents of the signer's public key file. This is optional — if you don't provide the key, we decrypt the files without verifying their signatures.", "example": "" }, "skip_after": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.", "format": "int32", "example": 0 }, "skip_before": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified before syncing data.", "format": "int32", "example": 0 }, "ssh_private_key": { "title": "", "type": "string", "description": "The contents of the SSH private key file. Required when `auth_method` is `CUSTOMER_SUPPLIED_KEYPAIR`.", "format": "password", "example": "string" }, "ssh_private_key_passphrase": { "title": "", "type": "string", "description": "The passphrase for the SSH private key. Required when `auth_method` is `CUSTOMER_SUPPLIED_KEYPAIR` and the private key is passphrase-protected.", "format": "password", "example": "string" }, "sync_inconsistent_rows": { "title": "", "type": "boolean", "description": "When enabled, Fivetran syncs rows with fewer or more columns than the header row. For rows with fewer columns, Fivetran adds NULL values for the missing columns. For rows with extra columns, Fivetran names them `column_`. When disabled, Fivetran handles inconsistent rows according to your error-handling settings.", "example": true }, "sync_nested_files": { "title": "", "type": "boolean", "description": "Optional. Set to true to sync files from nested folders within the specified folder.", "example": true }, "tunnel_host": { "title": "", "type": "string", "description": "Tunnel host address, specify only to connect via SSH tunnel.", "example": "string" }, "tunnel_port": { "title": "", "type": "integer", "description": "Tunnel port, specify only to connect via SSH tunnel.", "format": "int32", "example": 0 }, "tunnel_user": { "title": "", "type": "string", "description": "Tunnel user, specify only to connect via SSH tunnel.", "example": "string" }, "use_pgp_encryption_options": { "title": "", "type": "boolean", "description": "Set to `true` if files present in SFTP server are encrypted using PGP. Default value: `false`.", "example": true }, "user": { "title": "", "type": "string", "description": "SFTP user.", "example": "user_name" } }, "description": "" } } }, "sftp_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for sFTP password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for sFTP user.", "example": "USER_KEY" } }, "description": "" } } }, "sftp_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sftp_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table_group" }, { "$ref": "#/components/schemas/sftp_esm_keys_config_V1" } ] }, "share_point_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_type": { "title": "", "type": "object", "description": "Access Type", "example": "CUSTOM_APP | SPECIFIC_SITES | CLIENT_CERTIFICATE | ALL_SITES", "enum": [ "CUSTOM_APP", "SPECIFIC_SITES", "CLIENT_CERTIFICATE", "ALL_SITES" ] }, "append_file_option": { "title": "", "type": "object", "description": "If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.", "example": "upsert_file_with_primary_keys | upsert_file | append_file", "enum": [ "upsert_file_with_primary_keys", "upsert_file", "append_file" ] }, "client_certificate": { "title": "", "type": "string", "description": "`Client Certificate` of your Microsoft client application.", "format": "password", "example": "client_certificate" }, "client_certificate_private_key": { "title": "", "type": "string", "description": "`Certificate Private Key` of your Microsoft client application.", "format": "password", "example": "certificate_private_key" }, "client_certificate_private_key_passphrase": { "title": "", "type": "string", "description": "`Certificate Private Key Passphrase` of your Microsoft client application.", "format": "password", "example": "certificate_private_key_passphrase" }, "compression": { "title": "", "type": "object", "description": "The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format.", "example": "zip | gz | tar_gz | tar | infer | gzip | uncompressed | bz2 | tar_bz2", "enum": [ "zip", "gz", "tar_gz", "tar", "infer", "gzip", "uncompressed", "bz2", "tar_bz2" ] }, "delimiter": { "title": "", "type": "string", "description": "You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.", "example": "|" }, "empty_header": { "title": "", "type": "boolean", "description": "Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.", "example": true }, "escape_char": { "title": "", "type": "string", "description": "If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.", "example": "escape_char" }, "extraction_pattern": { "title": "", "type": "string", "description": "Required when `file_mapping_method` = `EXTRACT_TABLES`. A regular expression with a named capture group `(?
...)` to extract table names from file paths.", "example": "(?
\\w+)/.*" }, "file_handling": { "title": "", "type": "object", "description": "Files will be processed and synced according to the selected file handling option. Supported values:
`structured`- (Default) Extract structured data into destination tables for analysis. Commonly used.
`unstructured`- Replicate files in their original format. Best for PDFs, images, and other unstructured content. Learn more about unstructured file replication in our [documentation.](/docs/using-fivetran/features/unstructured-file-replication).", "example": "structured", "enum": [ "unstructured", "structured" ] }, "file_mapping_method": { "title": "", "type": "object", "description": "The method used to map files to destination tables. Use `DEFINE_PER_TABLE` to manually configure each table with its own file pattern, or `EXTRACT_TABLES` to automatically discover tables based on a single extraction pattern.", "example": "EXTRACT_TABLES | DEFINE_PER_TABLE", "enum": [ "EXTRACT_TABLES", "DEFINE_PER_TABLE" ] }, "file_type": { "title": "", "type": "object", "description": "If your files are saved with improper extensions, you can force them to be synced as the selected file type.", "example": "tsv | xml | csv | spreadsheet | json | jsonl | avro | parquet", "enum": [ "tsv", "xml", "csv", "spreadsheet", "json", "jsonl", "avro", "parquet" ] }, "files": { "title": "", "type": "array", "description": "Mapped file name patterns to a destination table.", "items": { "title": "", "type": "object", "properties": { "archive_pattern": { "title": "", "type": "string", "description": "All Files inside of compressed archives with filenames matching this regular expression will be synced.", "example": "string" }, "file_pattern": { "title": "", "type": "string", "description": "All files in your search path matching this regular expression will be synced per table.", "example": "string" }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "table_name": { "title": "", "type": "string", "description": "All files matching the above pattern will be synced to this table.", "example": "string" } }, "description": "Mapped file name patterns to a destination table." } }, "is_single_table_mode": { "title": "", "type": "boolean", "description": "Allows the creation of connector using Merge Mode strategy.", "example": true }, "json_delivery_mode": { "title": "", "type": "object", "description": "Control how your JSON data is delivered into your destination", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] }, "line_separator": { "title": "", "type": "string", "description": "You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.", "example": ";" }, "null_sequence": { "title": "", "type": "string", "description": "If your CSVs use a special value indicating null, you can specify it here.", "example": "string" }, "on_error": { "title": "", "type": "object", "description": "If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data.", "example": "fail | skip", "enum": [ "fail", "skip" ] }, "prefix": { "title": "", "type": "string", "description": "The connection will look for files in the folder of the URL you provide. Choose the lowest common folder in a folder hierarchy that includes all the files you want to sync. This defines a specific location where Fivetran scans for files and helps ensure optimal performance.", "example": "folder_link_url" }, "quote_char": { "title": "", "type": "string", "description": "You can specify the enclosing character used in your CSVs here. Fivetran will consider \" as the quote character if this field is empty and quote_character_enabled is set to true.", "example": "string" }, "quote_character_enabled": { "title": "", "type": "boolean", "description": "If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered \" as quote character.", "example": true }, "selected_range": { "title": "", "type": "string", "description": "Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `''!` format.", "example": "'Sheet1'!A1" }, "share_url": { "title": "", "type": "string", "description": "Your SharePoint folder URL. You can find the folder URL by following the steps mentioned [here](/docs/connectors/files/share-point/setup-guide).", "example": "target_share_url" }, "skip_after": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.", "format": "int32", "example": 0 }, "skip_before": { "title": "", "type": "integer", "description": "We will skip over the number of lines specified before syncing data.", "format": "int32", "example": 0 }, "sync_inconsistent_rows": { "title": "", "type": "boolean", "description": "When enabled, Fivetran syncs rows with fewer or more columns than the header row. For rows with fewer columns, Fivetran adds NULL values for the missing columns. For rows with extra columns, Fivetran names them `column_`. When disabled, Fivetran handles inconsistent rows according to your error-handling settings.", "example": true }, "sync_nested_files": { "title": "", "type": "boolean", "description": "Optional. Set to true to sync files from nested folders within the specified folder.", "example": true }, "sync_permissions": { "title": "", "type": "boolean", "description": "Optional. Set to true to sync per-user file access permissions to control visibility in downstream applications.", "example": true } }, "description": "" } } }, "share_point_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Microsoft client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Microsoft client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived Refresh token carries the information necessary to get a new access token for API resources.", "example": "my_refresh_token" }, "tenant_id": { "title": "", "type": "string", "description": "`Tenant ID` of your Microsoft client application.", "example": "my_tenand_id" } }, "description": "" } } }, "share_point_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/share_point_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table_group" }, { "$ref": "#/components/schemas/share_point_auth_V1" } ] }, "shareasale_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_secret": { "title": "", "type": "string", "description": "Your ShareASale API secret.", "format": "password", "example": "string" }, "merchant_id": { "title": "", "type": "string", "description": "Your ShareASale merchant ID.", "example": "string" }, "token": { "title": "", "type": "string", "description": "Your ShareASale token.", "format": "password", "example": "string" } }, "description": "" } } }, "shareasale_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/shareasale_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sharetribe_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Sharetribe client ID.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Your Sharetribe client secret.", "format": "password", "example": "string" } }, "description": "" } } }, "sharetribe_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sharetribe_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "shiphero_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your ShipHero password.", "format": "password", "example": "your_shiphero_password" }, "username": { "title": "", "type": "string", "description": "Your ShipHero username.", "example": "your_shiphero_username" } }, "description": "" } } }, "shiphero_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/shiphero_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "shipmonk_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your ShipMonk API key.", "format": "password", "example": "your_shipmonk_api_key" } }, "description": "" } } }, "shipmonk_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/shipmonk_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "shipnetwork_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_user_identifier": { "title": "", "type": "string", "description": "Your ShipNetwork API user identifier.", "format": "password", "example": "your_shipnetwork_api_user_identifier" }, "api_user_secret": { "title": "", "type": "string", "description": "Your ShipNetwork API user secret.", "format": "password", "example": "your_shipnetwork_api_user_secret" }, "client_id": { "title": "", "type": "string", "description": "Your ShipNetwork client ID.", "example": "your_shipnetwork_client_id" } }, "description": "" } } }, "shipnetwork_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/shipnetwork_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "shipstation_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your ShipStation password.", "format": "password", "example": "your_shipstation_password" }, "username": { "title": "", "type": "string", "description": "Your ShipStation username.", "format": "password", "example": "your_shipstation_username" }, "v2_api_key": { "title": "", "type": "string", "description": "Your ShipStation V2 API key.", "format": "password", "example": "your_shipstation_v2_api_key" } }, "description": "" } } }, "shipstation_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/shipstation_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "shopify_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_access_token": { "title": "", "type": "string", "description": "API access token of your custom or public app.", "format": "password", "example": "string" }, "app_url": { "title": "", "type": "string", "description": "App store url of your app", "example": "string" }, "backward_sync_limit": { "title": "", "type": "string", "description": "Limit of the Historical Sync Time for selected tables", "example": "string" }, "client_id": { "title": "", "type": "string", "description": "Client ID of your app", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Client secret of your app", "format": "password", "example": "string" }, "historical_sync_time_frame": { "title": "", "type": "object", "description": "Used to configure Historical sync timeframe for selected tables", "example": "ALL_TIME | DATE_LIMIT", "enum": [ "ALL_TIME", "DATE_LIMIT" ] }, "is_graphql_enabled": { "title": "", "type": "boolean", "description": "Set to `true` to sync your data using the Shopify GraphQL Admin API schema instead of the legacy schema. This cannot be changed after the connection is set up.", "example": true }, "shop": { "title": "", "type": "string", "description": "The Shopify shop name. Can be found in the URL before **.myshopify.com**.", "example": "my_shop" } }, "description": "" } } }, "shopify_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The Shopify access token.", "example": "my_access_token" } }, "description": "" } } }, "shopify_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/shopify_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/shopify_auth_V1" } ] }, "shopware_config_V1": { "properties": { "config": { "type": "object", "properties": { "domain": { "title": "", "type": "string", "description": "Your Shopware domain.", "example": "your_shopware_domain" }, "password": { "title": "", "type": "string", "description": "Your Shopware password.", "format": "password", "example": "your_shopware_password" }, "username": { "title": "", "type": "string", "description": "Your Shopware username.", "example": "your_shopware_username" } }, "description": "" } } }, "shopware_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/shopware_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "shortcut_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Shortcut API token.", "format": "password", "example": "string" } }, "description": "" } } }, "shortcut_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/shortcut_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "shortio_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Short.io API key.", "format": "password", "example": "your_shortio_api_key" } }, "description": "" } } }, "shortio_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/shortio_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "showpad_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Showpad client ID.", "example": "your_showpad_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Showpad client secret.", "format": "password", "example": "your_showpad_client_secret" }, "subdomain": { "title": "", "type": "string", "description": "Your Showpad subdomain.", "example": "your_showpad_subdomain" } }, "description": "" } } }, "showpad_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "showpad_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/showpad_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/showpad_auth_V1" } ] }, "siemens_building_x_openness_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Siemens Building X Openness client ID.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Your Siemens Building X Openness client secret.", "format": "password", "example": "string" } }, "description": "" } } }, "siemens_building_x_openness_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/siemens_building_x_openness_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sigma_computing_source_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_server": { "type": "object", "description": "Your Sigma Computing api server.", "enum": [ "api.us-a.aws", "api.uk.aws", "api.uk.azure", "api.ca.aws", "api.ca.azure", "api", "api.eu.aws", "api.au.aws", "aws-api", "api.us.azure", "api.eu.azure" ] }, "client_id": { "title": "", "type": "string", "description": "Your Sigma Computing client ID.", "example": "your_sigma_computing_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Sigma Computing client secret.", "format": "password", "example": "your_sigma_computing_client_secret" }, "environment": { "type": "object", "description": "Your Sigma Computing environment.", "enum": [ "sigmacomputing.com", "staging.sigmacomputing.io" ] } }, "description": "" } } }, "sigma_computing_source_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sigma_computing_source_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "simplecast_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Simplecast API token.", "format": "password", "example": "your_simplecast_api_token" } }, "description": "" } } }, "simplecast_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/simplecast_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "simplesat_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_key": { "title": "", "type": "string", "description": "Your Simplesat account key.", "format": "password", "example": "your_simplesat_account_key" } }, "description": "" } } }, "simplesat_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/simplesat_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "singlestore_source_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "singlestore_source_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/singlestore_source_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sistrix_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your SISTRIX API key.", "format": "password", "example": "your_sistrix_api_key" }, "country": { "type": "object", "description": "Your SISTRIX country code.", "enum": [ "de", "pt", "dk", "hr", "ua", "hu", "uk", "id", "ie", "us", "eg", "ae", "in", "mt", "za", "it", "mx", "my", "es", "ve", "ar", "at", "au", "vn", "ng", "ro", "nl", "no", "be", "fi", "ru", "bg", "jp", "fr", "nz", "br", "se", "sg", "si", "sk", "ca", "ch", "cl", "gr", "co", "th", "pe", "cy", "cz", "ph", "pk", "pl", "tr" ] }, "domain": { "title": "", "type": "string", "description": "Your SISTRIX domain.", "example": "your_domain" } }, "description": "" } } }, "sistrix_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sistrix_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "skilljar_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Skilljar API key.", "format": "password", "example": "your_skilljar_api_key" } }, "description": "" } } }, "skilljar_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/skilljar_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "skillstx_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your SkillsTX client ID.", "example": "your_skillstx_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your SkillsTX client secret.", "format": "password", "example": "your_skillstx_client_secret" }, "subdomain": { "title": "", "type": "string", "description": "Your SkillsTX subdomain.", "example": "your_skillstx_subdomain" } }, "description": "" } } }, "skillstx_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/skillstx_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "skimlinks_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Skimlinks client ID.", "example": "your_skimlinks_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Skimlinks client secret.", "format": "password", "example": "your_skimlinks_client_secret" }, "historical_sync_time_frame": { "type": "object", "description": "Your Skimlinks Historical sync time frame.", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] }, "publisher_id": { "title": "", "type": "string", "description": "Your Skimlinks publisher ID.", "example": "your_skimlinks_publisher_id" } }, "description": "" } } }, "skimlinks_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/skimlinks_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "skuvault_config_V1": { "properties": { "config": { "type": "object", "properties": { "email": { "title": "", "type": "string", "description": "Your SkuVault email.", "example": "your_skuvault_email" }, "password": { "title": "", "type": "string", "description": "Your SkuVault password.", "format": "password", "example": "your_skuvault_password" } }, "description": "" } } }, "skuvault_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/skuvault_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "slab_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Slab API key.", "format": "password", "example": "your_slab_access_token" } }, "description": "" } } }, "slab_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/slab_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "slack_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "slack_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/slack_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "slack_admin_data_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Slack admin client ID.", "example": "your_slack_admin_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Slack admin client secret.", "format": "password", "example": "your_slack_admin_client_secret" } }, "description": "" } } }, "slack_admin_data_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/slack_admin_data_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "slack_app_config_V1": { "properties": { "config": { "type": "object", "properties": { "app_level": { "type": "object", "description": "Your Slack app level.", "enum": [ "users:read,bookmarks:read,channels:history,channels:read,dnd:read,emoji:read,groups:history,groups:read,im:history,im:read,mpim:history,mpim:read,pins:read,reactions:read,reminders:read,usergroups:read,files:read,users.profile:read,users:read.email,remote_files:read,pins:read,team.billing:read,team.preferences:read", "users:read,bookmarks:read,channels:history,channels:read,dnd:read,emoji:read,groups:history,groups:read,im:history,im:read,mpim:history,mpim:read,pins:read,reactions:read,reminders:read,usergroups:read,files:read,users.profile:read,users:read.email,remote_files:read,pins:read,team.billing:read,team.preferences:read,auditlogs:read" ] }, "client_id": { "title": "", "type": "string", "description": "Your Slack app Client ID.", "example": "your_slack_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Slack app Client Secret.", "format": "password", "example": "your_slack_client_secret" } }, "description": "" } } }, "slack_app_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/slack_app_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "smadex_config_V1": { "properties": { "config": { "type": "object", "properties": { "email": { "title": "", "type": "string", "description": "Your Smadex account's email ID.", "example": "your_smadex_email" }, "password": { "title": "", "type": "string", "description": "Your Smadex Password.", "format": "password", "example": "your_smadex_password" } }, "description": "" } } }, "smadex_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/smadex_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "smarthr_config_V1": { "properties": { "config": { "type": "object", "properties": { "bearer_token": { "title": "", "type": "string", "description": "Your SmartHR access token.", "format": "password", "example": "string" }, "environment": { "type": "object", "description": "Your SmartHR environment.", "enum": [ "daruma.space", "smarthr.jp" ] }, "subdomain": { "title": "", "type": "string", "description": "Your SmartHR subdomain.", "example": "string" } }, "description": "" } } }, "smarthr_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/smarthr_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "smartrecruiters_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your SmartRecruiters client ID.", "example": "smartrecruiters_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your SmartRecruiters client secret.", "format": "password", "example": "smartrecruiters_client_secret" } }, "description": "" } } }, "smartrecruiters_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/smartrecruiters_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "smartsheet_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "API token generated from your Smartsheet account.", "format": "password", "example": "string" }, "auth_mode": { "title": "", "type": "object", "description": "Authorization type.", "example": "OAuth2 | APIToken", "enum": [ "OAuth2", "APIToken" ] }, "region": { "title": "", "type": "object", "description": "The Smartsheet data region for your account. Can be COM, EU, or AU.", "example": "COM | EU | AU", "enum": [ "COM", "EU", "AU" ] } }, "description": "" } } }, "smartsheet_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "example": "string" }, "realm_id": { "title": "", "type": "string", "description": "", "example": "string" }, "refresh_token": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "smartsheet_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/smartsheet_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/smartsheet_auth_V1" } ] }, "smartwaiver_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Smartwaiver API key.", "format": "password", "example": "your_smartwaiver_api_key" } }, "description": "" } } }, "smartwaiver_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/smartwaiver_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "snapchat_ads_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_sync_mode": { "title": "", "type": "object", "description": "Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.", "example": "AllAccounts | SpecificAccounts", "enum": [ "AllAccounts", "SpecificAccounts" ] }, "accounts": { "title": "", "type": "array", "description": "Specific accounts IDs to sync. Must be populated if `accountSyncMode` is set to `SpecificAccounts`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "custom_reports": { "title": "", "type": "array", "description": "[Custom reports for Snapchat Ads connector](/docs/connectors/applications/snapchat-ads/custom-reports).", "items": { "title": "", "type": "object", "properties": { "action_report_time": { "title": "", "type": "object", "description": "[Determines if reports will be based on impression or conversion time](/docs/connectors/applications/snapchat-ads/custom-reports)", "example": "impression | conversion", "enum": [ "impression", "conversion" ] }, "add_metric_variants": { "title": "", "type": "boolean", "description": "Add fields for separate \\\"swipe-up\\\" and \\\"view\\\" variants of selected metrics", "example": true }, "base_metrics_fields": { "title": "", "type": "array", "description": "[List of Core, Additional and Conversion Metrics Stats Fields](/docs/connectors/applications/snapchat-ads/custom-reports#basemetricsfields).", "example": [ "quartile_2 | quartile_3 | quartile_1 | conversion_searches_value | play_time_millis | conversion_login | avg_screen_time_millis | conversion_page_views | saves | video_views | conversion_list_view | conversion_add_billing_value | conversion_reserve_value | conversion_share | conversion_reserve | conversion_purchases_value | attachment_total_view_time_millis | conversion_add_to_wishlist | avg_position_screen_time_millis | conversion_visit_value | story_completes | conversion_complete_tutorial_value | conversion_start_trial | conversion_start_trial_value | uniques | conversion_subscribe | conversion_save | conversion_add_cart_value | conversion_level_completes | screen_time_millis | total_reach | conversion_invite | total_installs | conversion_achievement_unlocked_value | custom_event_1_value | view_completion | position_impressions | shares | video_views_time_based | conversion_complete_tutorial | conversion_login_value | ios_installs | conversion_subscribe_value | conversion_save_value | native_leads | conversion_rate | avg_view_time_millis | conversion_ad_view | attachment_avg_view_time_millis | earned_impressions | custom_event_1 | impressions | position_screen_time_millis | custom_event_2 | conversion_visit | conversion_spend_credits_value | conversion_add_billing | paid_impressions | conversion_purchases | android_installs | swipes | conversion_start_checkout | conversion_view_content_value | conversion_achievement_unlocked | position_swipe_up_percent | conversion_rate_value | frequency | custom_event_3 | custom_event_4 | custom_event_5 | earned_reach | conversion_start_checkout_value | swipe_up_percent | conversion_spend_credits | profile_clicks | conversion_level_completes_value | conversion_sign_ups | custom_event_5_value | story_opens | conversion_page_views_value | video_views_15s | conversion_add_to_wishlist_value | custom_event_2_value | conversion_ad_click_value | attachment_uniques | attachment_video_views | conversion_list_view_value | conversion_ad_view_value | conversion_sign_ups_value | total_impressions | conversion_app_opens_value | attachment_quartile_1 | landing_page_views | conversion_app_opens | conversion_invite_value | attachment_quartile_3 | spend | attachment_quartile_2 | custom_event_4_value | conversion_add_cart | conversion_searches | attachment_view_completion | view_time_millis | attachment_frequency | conversion_view_content | conversion_share_value | custom_event_3_value | conversion_ad_click" ], "items": { "title": "", "type": "object", "description": "", "example": "quartile_2 | quartile_3 | quartile_1 | conversion_searches_value | play_time_millis | conversion_login | avg_screen_time_millis | conversion_page_views | saves | video_views | conversion_list_view | conversion_add_billing_value | conversion_reserve_value | conversion_share | conversion_reserve | conversion_purchases_value | attachment_total_view_time_millis | conversion_add_to_wishlist | avg_position_screen_time_millis | conversion_visit_value | story_completes | conversion_complete_tutorial_value | conversion_start_trial | conversion_start_trial_value | uniques | conversion_subscribe | conversion_save | conversion_add_cart_value | conversion_level_completes | screen_time_millis | total_reach | conversion_invite | total_installs | conversion_achievement_unlocked_value | custom_event_1_value | view_completion | position_impressions | shares | video_views_time_based | conversion_complete_tutorial | conversion_login_value | ios_installs | conversion_subscribe_value | conversion_save_value | native_leads | conversion_rate | avg_view_time_millis | conversion_ad_view | attachment_avg_view_time_millis | earned_impressions | custom_event_1 | impressions | position_screen_time_millis | custom_event_2 | conversion_visit | conversion_spend_credits_value | conversion_add_billing | paid_impressions | conversion_purchases | android_installs | swipes | conversion_start_checkout | conversion_view_content_value | conversion_achievement_unlocked | position_swipe_up_percent | conversion_rate_value | frequency | custom_event_3 | custom_event_4 | custom_event_5 | earned_reach | conversion_start_checkout_value | swipe_up_percent | conversion_spend_credits | profile_clicks | conversion_level_completes_value | conversion_sign_ups | custom_event_5_value | story_opens | conversion_page_views_value | video_views_15s | conversion_add_to_wishlist_value | custom_event_2_value | conversion_ad_click_value | attachment_uniques | attachment_video_views | conversion_list_view_value | conversion_ad_view_value | conversion_sign_ups_value | total_impressions | conversion_app_opens_value | attachment_quartile_1 | landing_page_views | conversion_app_opens | conversion_invite_value | attachment_quartile_3 | spend | attachment_quartile_2 | custom_event_4_value | conversion_add_cart | conversion_searches | attachment_view_completion | view_time_millis | attachment_frequency | conversion_view_content | conversion_share_value | custom_event_3_value | conversion_ad_click", "enum": [ "quartile_2", "quartile_3", "quartile_1", "conversion_searches_value", "play_time_millis", "conversion_login", "avg_screen_time_millis", "conversion_page_views", "saves", "video_views", "conversion_list_view", "conversion_add_billing_value", "conversion_reserve_value", "conversion_share", "conversion_reserve", "conversion_purchases_value", "attachment_total_view_time_millis", "conversion_add_to_wishlist", "avg_position_screen_time_millis", "conversion_visit_value", "story_completes", "conversion_complete_tutorial_value", "conversion_start_trial", "conversion_start_trial_value", "uniques", "conversion_subscribe", "conversion_save", "conversion_add_cart_value", "conversion_level_completes", "screen_time_millis", "total_reach", "conversion_invite", "total_installs", "conversion_achievement_unlocked_value", "custom_event_1_value", "view_completion", "position_impressions", "shares", "video_views_time_based", "conversion_complete_tutorial", "conversion_login_value", "ios_installs", "conversion_subscribe_value", "conversion_save_value", "native_leads", "conversion_rate", "avg_view_time_millis", "conversion_ad_view", "attachment_avg_view_time_millis", "earned_impressions", "custom_event_1", "impressions", "position_screen_time_millis", "custom_event_2", "conversion_visit", "conversion_spend_credits_value", "conversion_add_billing", "paid_impressions", "conversion_purchases", "android_installs", "swipes", "conversion_start_checkout", "conversion_view_content_value", "conversion_achievement_unlocked", "position_swipe_up_percent", "conversion_rate_value", "frequency", "custom_event_3", "custom_event_4", "custom_event_5", "earned_reach", "conversion_start_checkout_value", "swipe_up_percent", "conversion_spend_credits", "profile_clicks", "conversion_level_completes_value", "conversion_sign_ups", "custom_event_5_value", "story_opens", "conversion_page_views_value", "video_views_15s", "conversion_add_to_wishlist_value", "custom_event_2_value", "conversion_ad_click_value", "attachment_uniques", "attachment_video_views", "conversion_list_view_value", "conversion_ad_view_value", "conversion_sign_ups_value", "total_impressions", "conversion_app_opens_value", "attachment_quartile_1", "landing_page_views", "conversion_app_opens", "conversion_invite_value", "attachment_quartile_3", "spend", "attachment_quartile_2", "custom_event_4_value", "conversion_add_cart", "conversion_searches", "attachment_view_completion", "view_time_millis", "attachment_frequency", "conversion_view_content", "conversion_share_value", "custom_event_3_value", "conversion_ad_click" ] } }, "breakdown": { "title": "", "type": "object", "description": "[Sets Breakdown on custom report](/docs/connectors/applications/snapchat-ads/custom-reports#breakdown).", "example": "AD | AD_SQUAD | CAMPAIGN", "enum": [ "AD", "AD_SQUAD", "CAMPAIGN" ] }, "breakout": { "title": "", "type": "object", "description": "[Sets Breakout on custom report](/docs/connectors/applications/snapchat-ads/custom-reports#breakout).", "example": "app | offline | total | total_on_platform | web | total_off_platform", "enum": [ "app", "offline", "total", "total_on_platform", "web", "total_off_platform" ] }, "dimension": { "title": "", "type": "object", "description": "[Sets Dimension on custom report](/docs/connectors/applications/snapchat-ads/custom-reports#dimension).", "example": "COUNTRY | DEVICE_OS | COUNTRY_OS | DMA | DEVICE_MAKE | DEMOGRAPHIC | REGION | INTEREST", "enum": [ "COUNTRY", "DEVICE_OS", "COUNTRY_OS", "DMA", "DEVICE_MAKE", "DEMOGRAPHIC", "REGION", "INTEREST" ] }, "granularity": { "title": "", "type": "object", "description": "[Sets Granularity on custom report](/docs/connectors/applications/snapchat-ads/custom-reports#granularity).", "example": "HOUR | DAY", "enum": [ "HOUR", "DAY" ] }, "report_name": { "title": "", "type": "string", "description": "Custom report name (must be unique)", "example": "some_report_name" }, "sk_ad_metrics_fields": { "title": "", "type": "array", "description": "[List of SKAd Metrics fields in custom report](/docs/connectors/applications/snapchat-ads/custom-reports#skadmetricsfields).", "example": [ "custom_event_2_sk_ad_network_view | conversion_invite_sk_ad_network_total | custom_event_4_sk_ad_network | conversion_list_view_sk_ad_network_view | conversion_share_sk_ad_network_total | conversion_ad_click_sk_ad_network | conversion_save_sk_ad_network_view | conversion_sign_ups_sk_ad_network_total | conversion_start_trial_sk_ad_network_total | conversion_start_trial_sk_ad_network | conversion_purchases_sk_ad_network_view | conversion_subscribe_sk_ad_network_view | conversion_level_completes_sk_ad_network_view | conversion_spend_credits_sk_ad_network_view | conversion_level_completes_sk_ad_network | conversion_add_billing_sk_ad_network_view | unknown_sk_ad_network_view | conversion_ad_view_sk_ad_network | custom_event_5_sk_ad_network_total | conversion_rate_sk_ad_network_view | conversion_view_content_sk_ad_network | conversion_login_sk_ad_network_total | conversion_reserve_sk_ad_network_view | conversion_app_opens_sk_ad_network_total | conversion_spend_credits_sk_ad_network | conversion_achievement_unlocked_sk_ad_network_total | conversion_reserve_sk_ad_network_total | conversion_complete_tutorial_sk_ad_network | conversion_ad_click_sk_ad_network_total | conversion_add_cart_sk_ad_network | conversion_ios_installs_sk_ad_network | conversion_assist_install_sk_ad_network_view | conversion_view_content_sk_ad_network_total | conversion_add_to_wishlist_sk_ad_network_view | conversion_start_trial_sk_ad_network_view | conversion_add_billing_sk_ad_network | conversion_list_view_sk_ad_network | conversion_subscribe_sk_ad_network_total | conversion_null_sk_ad_network | conversion_total_installs_sk_ad_network | conversion_sign_ups_sk_ad_network | conversion_list_view_sk_ad_network_total | conversion_app_opens_sk_ad_network | conversion_sign_ups_sk_ad_network_view | conversion_achievement_unlocked_sk_ad_network | unknown_sk_ad_network | conversion_page_views_sk_ad_network_total | conversion_ad_view_sk_ad_network_view | custom_event_4_sk_ad_network_view | conversion_searches_sk_ad_network_total | conversion_add_to_wishlist_sk_ad_network | conversion_searches_sk_ad_network_view | conversion_ad_view_sk_ad_network_total | conversion_ios_installs_sk_ad_network_view | custom_event_3_sk_ad_network | conversion_save_sk_ad_network_total | conversion_save_sk_ad_network | conversion_add_billing_sk_ad_network_total | conversion_null_sk_ad_network_total | custom_event_5_sk_ad_network | conversion_reserve_sk_ad_network | conversion_page_views_sk_ad_network | conversion_level_completes_sk_ad_network_total | custom_event_1_sk_ad_network_total | conversion_add_to_wishlist_sk_ad_network_total | conversion_rate_sk_ad_network_total | conversion_start_checkout_sk_ad_network_view | conversion_app_opens_sk_ad_network_view | conversion_spend_credits_sk_ad_network_total | conversion_purchases_sk_ad_network | conversion_share_sk_ad_network_view | custom_event_3_sk_ad_network_total | conversion_ios_installs_sk_ad_network_total | conversion_rate_sk_ad_network | custom_event_1_sk_ad_network_view | custom_event_3_sk_ad_network_view | conversion_add_cart_sk_ad_network_view | conversion_page_views_sk_ad_network_view | conversion_purchases_sk_ad_network_total | custom_event_1_sk_ad_network | conversion_complete_tutorial_sk_ad_network_total | custom_event_4_sk_ad_network_total | conversion_add_cart_sk_ad_network_total | conversion_subscribe_sk_ad_network | conversion_start_checkout_sk_ad_network_total | custom_event_5_sk_ad_network_view | conversion_total_installs_sk_ad_network_view | custom_event_2_sk_ad_network_total | conversion_view_content_sk_ad_network_view | conversion_login_sk_ad_network | conversion_login_sk_ad_network_view | conversion_start_checkout_sk_ad_network | conversion_assist_install_sk_ad_network_total | conversion_achievement_unlocked_sk_ad_network_view | conversion_searches_sk_ad_network | conversion_share_sk_ad_network | conversion_ad_click_sk_ad_network_view | conversion_total_installs_sk_ad_network_total | conversion_assist_install_sk_ad_network | unknown_sk_ad_network_total | conversion_invite_sk_ad_network | conversion_null_sk_ad_network_view | conversion_complete_tutorial_sk_ad_network_view | conversion_invite_sk_ad_network_view | custom_event_2_sk_ad_network" ], "items": { "title": "", "type": "object", "description": "", "example": "custom_event_2_sk_ad_network_view | conversion_invite_sk_ad_network_total | custom_event_4_sk_ad_network | conversion_list_view_sk_ad_network_view | conversion_share_sk_ad_network_total | conversion_ad_click_sk_ad_network | conversion_save_sk_ad_network_view | conversion_sign_ups_sk_ad_network_total | conversion_start_trial_sk_ad_network_total | conversion_start_trial_sk_ad_network | conversion_purchases_sk_ad_network_view | conversion_subscribe_sk_ad_network_view | conversion_level_completes_sk_ad_network_view | conversion_spend_credits_sk_ad_network_view | conversion_level_completes_sk_ad_network | conversion_add_billing_sk_ad_network_view | unknown_sk_ad_network_view | conversion_ad_view_sk_ad_network | custom_event_5_sk_ad_network_total | conversion_rate_sk_ad_network_view | conversion_view_content_sk_ad_network | conversion_login_sk_ad_network_total | conversion_reserve_sk_ad_network_view | conversion_app_opens_sk_ad_network_total | conversion_spend_credits_sk_ad_network | conversion_achievement_unlocked_sk_ad_network_total | conversion_reserve_sk_ad_network_total | conversion_complete_tutorial_sk_ad_network | conversion_ad_click_sk_ad_network_total | conversion_add_cart_sk_ad_network | conversion_ios_installs_sk_ad_network | conversion_assist_install_sk_ad_network_view | conversion_view_content_sk_ad_network_total | conversion_add_to_wishlist_sk_ad_network_view | conversion_start_trial_sk_ad_network_view | conversion_add_billing_sk_ad_network | conversion_list_view_sk_ad_network | conversion_subscribe_sk_ad_network_total | conversion_null_sk_ad_network | conversion_total_installs_sk_ad_network | conversion_sign_ups_sk_ad_network | conversion_list_view_sk_ad_network_total | conversion_app_opens_sk_ad_network | conversion_sign_ups_sk_ad_network_view | conversion_achievement_unlocked_sk_ad_network | unknown_sk_ad_network | conversion_page_views_sk_ad_network_total | conversion_ad_view_sk_ad_network_view | custom_event_4_sk_ad_network_view | conversion_searches_sk_ad_network_total | conversion_add_to_wishlist_sk_ad_network | conversion_searches_sk_ad_network_view | conversion_ad_view_sk_ad_network_total | conversion_ios_installs_sk_ad_network_view | custom_event_3_sk_ad_network | conversion_save_sk_ad_network_total | conversion_save_sk_ad_network | conversion_add_billing_sk_ad_network_total | conversion_null_sk_ad_network_total | custom_event_5_sk_ad_network | conversion_reserve_sk_ad_network | conversion_page_views_sk_ad_network | conversion_level_completes_sk_ad_network_total | custom_event_1_sk_ad_network_total | conversion_add_to_wishlist_sk_ad_network_total | conversion_rate_sk_ad_network_total | conversion_start_checkout_sk_ad_network_view | conversion_app_opens_sk_ad_network_view | conversion_spend_credits_sk_ad_network_total | conversion_purchases_sk_ad_network | conversion_share_sk_ad_network_view | custom_event_3_sk_ad_network_total | conversion_ios_installs_sk_ad_network_total | conversion_rate_sk_ad_network | custom_event_1_sk_ad_network_view | custom_event_3_sk_ad_network_view | conversion_add_cart_sk_ad_network_view | conversion_page_views_sk_ad_network_view | conversion_purchases_sk_ad_network_total | custom_event_1_sk_ad_network | conversion_complete_tutorial_sk_ad_network_total | custom_event_4_sk_ad_network_total | conversion_add_cart_sk_ad_network_total | conversion_subscribe_sk_ad_network | conversion_start_checkout_sk_ad_network_total | custom_event_5_sk_ad_network_view | conversion_total_installs_sk_ad_network_view | custom_event_2_sk_ad_network_total | conversion_view_content_sk_ad_network_view | conversion_login_sk_ad_network | conversion_login_sk_ad_network_view | conversion_start_checkout_sk_ad_network | conversion_assist_install_sk_ad_network_total | conversion_achievement_unlocked_sk_ad_network_view | conversion_searches_sk_ad_network | conversion_share_sk_ad_network | conversion_ad_click_sk_ad_network_view | conversion_total_installs_sk_ad_network_total | conversion_assist_install_sk_ad_network | unknown_sk_ad_network_total | conversion_invite_sk_ad_network | conversion_null_sk_ad_network_view | conversion_complete_tutorial_sk_ad_network_view | conversion_invite_sk_ad_network_view | custom_event_2_sk_ad_network", "enum": [ "custom_event_2_sk_ad_network_view", "conversion_invite_sk_ad_network_total", "custom_event_4_sk_ad_network", "conversion_list_view_sk_ad_network_view", "conversion_share_sk_ad_network_total", "conversion_ad_click_sk_ad_network", "conversion_save_sk_ad_network_view", "conversion_sign_ups_sk_ad_network_total", "conversion_start_trial_sk_ad_network_total", "conversion_start_trial_sk_ad_network", "conversion_purchases_sk_ad_network_view", "conversion_subscribe_sk_ad_network_view", "conversion_level_completes_sk_ad_network_view", "conversion_spend_credits_sk_ad_network_view", "conversion_level_completes_sk_ad_network", "conversion_add_billing_sk_ad_network_view", "unknown_sk_ad_network_view", "conversion_ad_view_sk_ad_network", "custom_event_5_sk_ad_network_total", "conversion_rate_sk_ad_network_view", "conversion_view_content_sk_ad_network", "conversion_login_sk_ad_network_total", "conversion_reserve_sk_ad_network_view", "conversion_app_opens_sk_ad_network_total", "conversion_spend_credits_sk_ad_network", "conversion_achievement_unlocked_sk_ad_network_total", "conversion_reserve_sk_ad_network_total", "conversion_complete_tutorial_sk_ad_network", "conversion_ad_click_sk_ad_network_total", "conversion_add_cart_sk_ad_network", "conversion_ios_installs_sk_ad_network", "conversion_assist_install_sk_ad_network_view", "conversion_view_content_sk_ad_network_total", "conversion_add_to_wishlist_sk_ad_network_view", "conversion_start_trial_sk_ad_network_view", "conversion_add_billing_sk_ad_network", "conversion_list_view_sk_ad_network", "conversion_subscribe_sk_ad_network_total", "conversion_null_sk_ad_network", "conversion_total_installs_sk_ad_network", "conversion_sign_ups_sk_ad_network", "conversion_list_view_sk_ad_network_total", "conversion_app_opens_sk_ad_network", "conversion_sign_ups_sk_ad_network_view", "conversion_achievement_unlocked_sk_ad_network", "unknown_sk_ad_network", "conversion_page_views_sk_ad_network_total", "conversion_ad_view_sk_ad_network_view", "custom_event_4_sk_ad_network_view", "conversion_searches_sk_ad_network_total", "conversion_add_to_wishlist_sk_ad_network", "conversion_searches_sk_ad_network_view", "conversion_ad_view_sk_ad_network_total", "conversion_ios_installs_sk_ad_network_view", "custom_event_3_sk_ad_network", "conversion_save_sk_ad_network_total", "conversion_save_sk_ad_network", "conversion_add_billing_sk_ad_network_total", "conversion_null_sk_ad_network_total", "custom_event_5_sk_ad_network", "conversion_reserve_sk_ad_network", "conversion_page_views_sk_ad_network", "conversion_level_completes_sk_ad_network_total", "custom_event_1_sk_ad_network_total", "conversion_add_to_wishlist_sk_ad_network_total", "conversion_rate_sk_ad_network_total", "conversion_start_checkout_sk_ad_network_view", "conversion_app_opens_sk_ad_network_view", "conversion_spend_credits_sk_ad_network_total", "conversion_purchases_sk_ad_network", "conversion_share_sk_ad_network_view", "custom_event_3_sk_ad_network_total", "conversion_ios_installs_sk_ad_network_total", "conversion_rate_sk_ad_network", "custom_event_1_sk_ad_network_view", "custom_event_3_sk_ad_network_view", "conversion_add_cart_sk_ad_network_view", "conversion_page_views_sk_ad_network_view", "conversion_purchases_sk_ad_network_total", "custom_event_1_sk_ad_network", "conversion_complete_tutorial_sk_ad_network_total", "custom_event_4_sk_ad_network_total", "conversion_add_cart_sk_ad_network_total", "conversion_subscribe_sk_ad_network", "conversion_start_checkout_sk_ad_network_total", "custom_event_5_sk_ad_network_view", "conversion_total_installs_sk_ad_network_view", "custom_event_2_sk_ad_network_total", "conversion_view_content_sk_ad_network_view", "conversion_login_sk_ad_network", "conversion_login_sk_ad_network_view", "conversion_start_checkout_sk_ad_network", "conversion_assist_install_sk_ad_network_total", "conversion_achievement_unlocked_sk_ad_network_view", "conversion_searches_sk_ad_network", "conversion_share_sk_ad_network", "conversion_ad_click_sk_ad_network_view", "conversion_total_installs_sk_ad_network_total", "conversion_assist_install_sk_ad_network", "unknown_sk_ad_network_total", "conversion_invite_sk_ad_network", "conversion_null_sk_ad_network_view", "conversion_complete_tutorial_sk_ad_network_view", "conversion_invite_sk_ad_network_view", "custom_event_2_sk_ad_network" ] } } }, "description": "[Custom reports for Snapchat Ads connector](/docs/connectors/applications/snapchat-ads/custom-reports)." } }, "organizations": { "title": "", "type": "array", "description": "Specific organizations IDs to sync. Must be populated if `syncMode` is set to `SpecificOrganizations`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "swipe_attribution_window": { "title": "", "type": "object", "description": "The time period to attribute conversions based on swipes. Default value: `DAY_28`", "example": "DAY_1 | DAY_7 | DAY_28", "enum": [ "DAY_1", "DAY_7", "DAY_28" ] }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all organizations or specific organizations. Default value: `AllOrganizations`.", "example": "SpecificOrganizations", "enum": [ "SpecificOrganizations", "AllOrganizations" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] }, "view_attribution_window": { "title": "", "type": "object", "description": "The time period to attribute conversions based on views. Default value: `DAY_1`", "example": "DAY_1 | HOUR_6 | HOUR_3 | HOUR_1 | DAY_7 | NONE | DAY_28", "enum": [ "DAY_1", "HOUR_6", "HOUR_3", "HOUR_1", "DAY_7", "NONE", "DAY_28" ] } }, "description": "" } } }, "snapchat_ads_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Snapchat Ads client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Snapchat Ads client application.", "example": "my_client_secret" } }, "description": "Your application client access fields." }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "snapchat_ads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/snapchat_ads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/snapchat_ads_auth_V1" } ] }, "snowflake_db_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth": { "title": "", "type": "object", "description": "Password-based or key-based authentication type", "example": "PASSWORD | KEY_PAIR", "enum": [ "PASSWORD", "KEY_PAIR" ] }, "connection_type": { "title": "", "type": "object", "description": "Directly or Private Link", "example": "Directly | PrivateLink", "enum": [ "Directly", "PrivateLink" ] }, "database": { "title": "", "type": "string", "description": "The database name: Snowflake", "example": "database" }, "host": { "title": "", "type": "string", "description": "Host name", "example": "host" }, "is_private_key_encrypted": { "title": "", "type": "boolean", "description": "Indicates that a private key is encrypted. The default value: `false`. The field can be specified if authentication type is `KEY_PAIR`.", "example": true }, "passphrase": { "title": "", "type": "string", "description": "In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is `KEY_PAIR`.", "format": "password", "example": "passphrase" }, "password": { "title": "", "type": "string", "description": "The Snowflake user's password.", "format": "password", "example": "password" }, "port": { "title": "", "type": "integer", "description": "The Snowflake optional port number.", "format": "int32", "example": 443 }, "private_key": { "title": "", "type": "string", "description": "Private access key. The field should be specified if authentication type is `KEY_PAIR`.", "format": "password", "example": "privateKey" }, "role": { "title": "", "type": "string", "description": "Snowflake Connector role name", "example": "role" }, "use_workspace": { "title": "", "type": "boolean", "description": "Choose a database and schema to create temporary tables for syncs.", "example": true }, "user": { "title": "", "type": "string", "description": "The Snowflake username.", "example": "user" }, "workspace_name": { "title": "", "type": "string", "description": "The name of the database where the temporary tables will be created.", "example": "string" }, "workspace_schema": { "title": "", "type": "string", "description": "The name of the schema that belongs to the workspace database where the temporary tables will be created.", "example": "string" } }, "description": "" } } }, "snowflake_db_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/snowflake_db_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" } ] }, "snowplow_config_V1": { "properties": { "config": { "type": "object", "properties": { "config_repository_url": { "title": "", "type": "string", "description": "Public repository URL containing JSON configuration files.", "example": "configRepositoryURL" }, "enable_enrichments": { "title": "", "type": "boolean", "description": "Enable Enrichments", "example": true } }, "description": "" } } }, "snowplow_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/snowplow_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "snyk_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Snyk API token.", "format": "password", "example": "your_snyk_api_token" }, "region": { "type": "object", "description": "Your Snyk region.", "enum": [ "", ".au", ".us", ".eu" ] } }, "description": "" } } }, "snyk_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/snyk_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "solarwinds_service_desk_config_V1": { "properties": { "config": { "type": "object", "properties": { "domain": { "type": "object", "description": "Your SolarWinds Service Desk domain.", "enum": [ "https://api.samanage.com", "https://apieu.samanage.com" ] }, "token": { "title": "", "type": "string", "description": "Your SolarWinds Service Desk token.", "format": "password", "example": "your_solarwinds_service_desk_token" } }, "description": "" } } }, "solarwinds_service_desk_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/solarwinds_service_desk_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sonarqube_config_V1": { "properties": { "config": { "type": "object", "properties": { "subdomain": { "title": "", "type": "string", "description": "Your Sonarqube subdomain.", "example": "your_sonarqube_subdomain" }, "user_token": { "title": "", "type": "string", "description": "Your Sonarqube user token.", "format": "password", "example": "your_sonarqube_user_token" } }, "description": "" } } }, "sonarqube_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sonarqube_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sparkpost_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your SparkPost API key.", "format": "password", "example": "your_sparkpost_api_key" }, "host_url": { "title": "", "type": "string", "description": "Your SparkPost host URL.", "example": "your_sparkpost_host_url" } }, "description": "" } } }, "sparkpost_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sparkpost_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "splash_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Splash client ID.", "example": "your_splash_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Splash client secret.", "format": "password", "example": "your_splash_client_secret" }, "password": { "title": "", "type": "string", "description": "Your Splash password.", "format": "password", "example": "your_splash_password" }, "username": { "title": "", "type": "string", "description": "Your Splash username.", "example": "your_splash_username" } }, "description": "" } } }, "splash_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/splash_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "splitio_config_V1": { "properties": { "config": { "type": "object", "properties": { "admin_api_key": { "title": "", "type": "string", "description": "Your Split admin api key.", "format": "password", "example": "your_split_admin_api_key" } }, "description": "" } } }, "splitio_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/splitio_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "splunk_config_V1": { "properties": { "config": { "type": "object", "properties": { "host": { "title": "", "type": "string", "description": "The Splunk service host address.", "example": "host" }, "password": { "title": "", "type": "string", "description": "The Splunk user's password.", "format": "password", "example": "password" }, "port": { "title": "", "type": "integer", "description": "The Splunk service host port.", "format": "int32", "example": 8089 }, "rollback_window": { "title": "", "type": "integer", "description": "Set a rollback window between 0 and 7 days. The default is 2 days.", "format": "int32", "example": 2 }, "user": { "title": "", "type": "string", "description": "The Splunk username.", "example": "user" } }, "description": "" } } }, "splunk_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/splunk_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "spotify_ads_config_V1": { "properties": { "config": { "type": "object", "properties": { "accounts": { "title": "", "type": "array", "description": "The list of Ad Account IDs to sync. Must be populated if `sync_mode` is set to `SPECIFIC_ACCOUNTS`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_list": { "title": "", "type": "array", "description": "The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.", "items": { "title": "", "type": "object", "properties": { "dimension": { "title": "", "type": "object", "description": "The dimension (entity_type) to sync.", "example": "AD_ACCOUNT | AD | AD_SET | CAMPAIGN", "enum": [ "AD_ACCOUNT", "AD", "AD_SET", "CAMPAIGN" ] }, "fields": { "title": "", "type": "array", "description": "A list of the fields (metrics) to sync.", "example": [ "CTR | SKIPS | VIDEO_VIEWS | COMPLETES | STREAMS_PER_USER | E_CPCL | SPEND | THIRD_QUARTILES | CLICKS | NEW_LISTENER_CONVERSION_RATE | FREQUENCY | OFF_SPOTIFY_IMPRESSIONS | VIDEO_EXPAND_RATE | NEW_LISTENERS | PAID_LISTENS | IMPRESSIONS | CONVERSION_RATE | FIRST_QUARTILES | STREAMED_IMPRESSIONS | PAID_LISTENS_FREQUENCY | STREAMS_PER_NEW_LISTENER | PAID_LISTENS_REACH | LISTENERS | REACH | STARTS | NEW_LISTENER_STREAMS | STREAMS | VIDEO_EXPANDS | INTENT_RATE | MIDPOINTS | E_CPM" ], "items": { "title": "", "type": "object", "description": "", "example": "CTR | SKIPS | VIDEO_VIEWS | COMPLETES | STREAMS_PER_USER | E_CPCL | SPEND | THIRD_QUARTILES | CLICKS | NEW_LISTENER_CONVERSION_RATE | FREQUENCY | OFF_SPOTIFY_IMPRESSIONS | VIDEO_EXPAND_RATE | NEW_LISTENERS | PAID_LISTENS | IMPRESSIONS | CONVERSION_RATE | FIRST_QUARTILES | STREAMED_IMPRESSIONS | PAID_LISTENS_FREQUENCY | STREAMS_PER_NEW_LISTENER | PAID_LISTENS_REACH | LISTENERS | REACH | STARTS | NEW_LISTENER_STREAMS | STREAMS | VIDEO_EXPANDS | INTENT_RATE | MIDPOINTS | E_CPM", "enum": [ "CTR", "SKIPS", "VIDEO_VIEWS", "COMPLETES", "STREAMS_PER_USER", "E_CPCL", "SPEND", "THIRD_QUARTILES", "CLICKS", "NEW_LISTENER_CONVERSION_RATE", "FREQUENCY", "OFF_SPOTIFY_IMPRESSIONS", "VIDEO_EXPAND_RATE", "NEW_LISTENERS", "PAID_LISTENS", "IMPRESSIONS", "CONVERSION_RATE", "FIRST_QUARTILES", "STREAMED_IMPRESSIONS", "PAID_LISTENS_FREQUENCY", "STREAMS_PER_NEW_LISTENER", "PAID_LISTENS_REACH", "LISTENERS", "REACH", "STARTS", "NEW_LISTENER_STREAMS", "STREAMS", "VIDEO_EXPANDS", "INTENT_RATE", "MIDPOINTS", "E_CPM" ] } }, "granularity": { "title": "", "type": "object", "description": "The report granularity.", "example": "HOUR | DAY", "enum": [ "HOUR", "DAY" ] }, "table": { "title": "", "type": "string", "description": "The table name within the schema to which connector will sync the data of the specific report.", "example": "table_2" } }, "description": "The list of reports. Each report corresponds to a table within the schema to which connector will sync the data." } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all ad accounts or specific ad accounts.", "example": "ALL_ACCOUNTS | SPECIFIC_ACCOUNTS", "enum": [ "ALL_ACCOUNTS", "SPECIFIC_ACCOUNTS" ] }, "timeframe_months": { "title": "", "type": "object", "description": "The number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `SIX`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "spotify_ads_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Ad Studio application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Ad Studio application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "spotify_ads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/spotify_ads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/spotify_ads_auth_V1" } ] }, "sprout_config_V1": { "properties": { "config": { "type": "object", "properties": { "bearer_token": { "title": "", "type": "string", "description": "Your Sprout Social API Access Token.", "format": "password", "example": "your_sprout_bearer_token" } }, "description": "" } } }, "sprout_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sprout_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sql_server_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS.", "example": true }, "backup_log_format": { "title": "", "type": "string", "description": "Filename pattern for transaction log backup files.", "example": "The format backup_%d_%Y%M%D_%h%m%s.log translates to backup__YYYYMMDD_HHMMSS.log" }, "backup_log_path": { "title": "", "type": "string", "description": "Full path to the local directory containing transaction log backup files. Required if `backup_storage_type` is `ALTERNATE_LOCATION`", "example": "C:\\BackupLogs" }, "backup_storage_type": { "title": "", "type": "object", "description": "Location of transaction log backup files when using BACKUP binary log type. Possible values: `\"AZURE\"`, `\"ALTERNATE_LOCATION\"`, `\"AWS\"`, `\"GCS\"`, `\"MSDB\"`.", "example": "MSDB | AZURE | ALTERNATE_LOCATION | GCS | AWS", "enum": [ "MSDB", "AZURE", "ALTERNATE_LOCATION", "GCS", "AWS" ] }, "binary_log_truncater": { "title": "", "type": "object", "description": "Determine who is responsible for truncating the online transaction log. Possible values: `\"FIVETRAN\"`, `\"USER_MANAGED\"`, `\"SQL_SERVER_AGENT\"`. Default value is `\"FIVETRAN\"`.", "example": "FIVETRAN | USER_MANAGED | SQL_SERVER_AGENT", "enum": [ "FIVETRAN", "USER_MANAGED", "SQL_SERVER_AGENT" ] }, "binary_log_type": { "title": "", "type": "object", "description": "Source of transaction log data when using Binary Log Reader. Possible values: `\"ONLINE\"`, `\"BACKUP\"`. Default value is `\"ONLINE\"`.", "example": "BACKUP | ONLINE", "enum": [ "BACKUP", "ONLINE" ] }, "bucket": { "title": "", "type": "string", "description": "The name of the S3 bucket.", "example": "bucket_name" }, "connection_string": { "title": "", "type": "string", "description": "The Azure Blob Storage container connection string.", "format": "password", "example": "BlobEndpoint=https://abc123.blob.core.windows.net/;TableEndpoint=https://abc123.table.core.windows.net/;SharedAccessSignature=xxxxxxxxx" }, "connection_type": { "title": "", "type": "object", "description": "Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "container_name": { "title": "", "type": "string", "description": "The name of the Azure Blob Storage container.", "format": "password", "example": "container_name" }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "sqldb" }, "ekm_key_identifiers": { "title": "", "type": "array", "description": "The list of Azure Key Vault key identifiers used for TDE. Each identifier should be in the format `https://.vault.azure.net/keys/` or `https://.vault.azure.net/keys//`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "external_id": { "title": "", "type": "string", "description": "The external ID to be used when assuming the IAM role.", "example": "external_id" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "sqlinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 1433 }, "role_arn": { "title": "", "type": "string", "description": "The ARN of the IAM role that has access to the S3 bucket.", "format": "password", "example": "arn:aws:iam::123456789012:role/rolename" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tde_certificate_backup": { "title": "", "type": "string", "description": "Certificate file used to protect a database encryption key. Used when decrypting backup logs.", "format": "password", "example": "string" }, "tde_certificate_path": { "title": "", "type": "string", "description": "Certificate file path used to protect a database encryption key. Used when decrypting online logs", "format": "password", "example": "c:\\certificates\\tde_cert.cer" }, "tde_password": { "title": "", "type": "string", "description": "Password of the TDE private key", "format": "password", "example": "string" }, "tde_private_key_backup": { "title": "", "type": "string", "description": "Private key file associated with the TDE certificate. Used when decrypting backup logs.", "format": "password", "example": "string" }, "tde_private_key_path": { "title": "", "type": "string", "description": "Private key file path associated with the TDE certificate. Used when decrypting online logs.", "format": "password", "example": "c:\\certificates\\tde_cert.pvk" }, "tde_setting": { "title": "", "type": "object", "description": "Transparent Data Encryption (TDE) setting. Possible values: `\"OFF\"`, `\"CERTIFICATE\"`. Default value is `\"OFF\"`.", "example": "CERTIFICATE | OFF", "enum": [ "CERTIFICATE", "OFF" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "(Optional) The incremental update method the connector will use. The possible values are `\"TELEPORT\"` or `\"NATIVE_UPDATE\"`. The type defaults to `\"NATIVE_UPDATE\"` if the value is set to `null` or not specified.", "example": "BINARY_LOG_READER | NATIVE_UPDATE | TELEPORT", "enum": [ "BINARY_LOG_READER", "NATIVE_UPDATE", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name. For Azure Databases, the format must be `user@domain`.", "example": "test_user" }, "windows_auth_client_certificate": { "title": "", "type": "string", "description": "Fivetran client certificate to add to the Windows Auth server's trusted clients.", "format": "password", "example": "string" }, "windows_auth_grpc_host": { "title": "", "type": "string", "description": "Hostname of the Windows Auth gRPC server.", "example": "windows-auth.example.com" }, "windows_auth_grpc_port": { "title": "", "type": "integer", "description": "Port of the Windows Auth gRPC server.", "format": "int32", "example": 443 }, "windows_auth_server_certificate": { "title": "", "type": "string", "description": "PEM certificate of the Windows Auth gRPC server used to verify the server identity.", "format": "password", "example": "string" } }, "description": "" } } }, "sql_server_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name", "example": "USER_KEY" } }, "description": "" } } }, "sql_server_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sql_server_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/sql_server_esm_keys_config_V1" } ] }, "sql_server_hva_config_V1": { "properties": { "config": { "type": "object", "properties": { "agent_host": { "title": "", "type": "string", "description": "The host address of the machine running the agent. Often the same as the DB host.", "example": "host.com" }, "agent_password": { "title": "", "type": "string", "description": "The password for the agent user.", "format": "password", "example": "agent_password" }, "agent_port": { "title": "", "type": "integer", "description": "The port that the agent has open for Fivetran's connection. Default value is 4343.", "format": "int32", "example": 4343 }, "agent_public_cert": { "title": "", "type": "string", "description": "The public certificate generated by the agent.", "example": "CERTIFICATE" }, "agent_user": { "title": "", "type": "string", "description": "The agent's username.", "example": "hvr" }, "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS.", "example": true }, "archive_log_format": { "title": "", "type": "string", "description": "Format for archive log file names", "example": "string" }, "archive_log_path": { "title": "", "type": "string", "description": "Directory where archive logs are located", "example": "string" }, "auth_method": { "title": "", "type": "object", "description": "Authentication Method", "example": "WindowsAuth | Password", "enum": [ "WindowsAuth", "Password" ] }, "blr_windows_auth_server_certificate": { "title": "", "type": "string", "description": "(Optional) PEM certificate of the Windows Auth gRPC server used to verify the server's identity. Only needed to migrate this connector to the Windows Auth Server.", "format": "password", "example": "string" }, "blr_windows_auth_server_grpc_port": { "title": "", "type": "integer", "description": "(Optional) Port of the Windows Auth gRPC server. Only needed to migrate this connector to the Windows Auth Server.", "format": "int32", "example": 443 }, "connection_type": { "title": "", "type": "object", "description": "Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "oracledb" }, "enable_archive_log_only": { "title": "", "type": "boolean", "description": "Use archive log only mode", "example": true }, "enable_tde": { "title": "", "type": "boolean", "description": "Using Transparent Data Encryption (TDE)", "example": true }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "host.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 1433 }, "sap_schema": { "title": "", "type": "string", "description": "SAP Schema Name. Required only for High-Volume Agent SAP ECC connector.", "example": "string" }, "server_name": { "title": "", "type": "string", "description": "Server name. Used when authenticating with Windows Authentication.", "example": "string" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tde_certificate": { "title": "", "type": "string", "description": "Certificate used to protect a database encryption key", "format": "password", "example": "string" }, "tde_certificate_name": { "title": "", "type": "string", "description": "Name of the Certificate used to protect a database encryption key", "example": "string" }, "tde_password": { "title": "", "type": "string", "description": "Password of the TDE private key", "format": "password", "example": "string" }, "tde_private_key": { "title": "", "type": "string", "description": "Private key associated with the TDE certificate", "format": "password", "example": "string" }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "(Optional) The incremental update method the connector will use. The possible values are `\"TELEPORT\"` or `\"NATIVE_UPDATE\"`. The type defaults to `\"NATIVE_UPDATE\"` if the value is set to `null` or not specified.", "example": "DIRECT", "enum": [ "DIRECT" ] }, "user": { "title": "", "type": "string", "description": "The user name. For Azure Databases, the format must be `user@domain`.", "example": "test_user" } }, "description": "" } } }, "sql_server_hva_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sql_server_hva_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" } ] }, "sql_server_rds_config_V1": { "properties": { "config": { "type": "object", "properties": { "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS.", "example": true }, "connection_type": { "title": "", "type": "object", "description": "Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "sqldb" }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "sqlinstance.mycompany.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 1433 }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "(Optional) The incremental update method the connector will use. The possible values are `\"TELEPORT\"` or `\"NATIVE_UPDATE\"`. The type defaults to `\"NATIVE_UPDATE\"` if the value is set to `null` or not specified.", "example": "NATIVE_UPDATE | TELEPORT", "enum": [ "NATIVE_UPDATE", "TELEPORT" ] }, "user": { "title": "", "type": "string", "description": "The user name. For Azure Databases, the format must be `user@domain`.", "example": "test_user" } }, "description": "" } } }, "sql_server_rds_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for the user's password.", "example": "PASSWORD_KEY" }, "user": { "title": "", "type": "string", "description": "ESM key for the user name", "example": "USER_KEY" } }, "description": "" } } }, "sql_server_rds_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sql_server_rds_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" }, { "$ref": "#/components/schemas/sql_server_rds_esm_keys_config_V1" } ] }, "sql_server_sap_ecc_hva_config_V1": { "properties": { "config": { "type": "object", "properties": { "agent_host": { "title": "", "type": "string", "description": "The host address of the machine running the agent. Often the same as the DB host.", "example": "host.com" }, "agent_password": { "title": "", "type": "string", "description": "The password for the agent user.", "format": "password", "example": "agent_password" }, "agent_port": { "title": "", "type": "integer", "description": "The port that the agent has open for Fivetran's connection. Default value is 4343.", "format": "int32", "example": 4343 }, "agent_public_cert": { "title": "", "type": "string", "description": "The public certificate generated by the agent.", "example": "CERTIFICATE" }, "agent_user": { "title": "", "type": "string", "description": "The agent's username.", "example": "hvr" }, "always_encrypted": { "title": "", "type": "boolean", "description": "Require TLS.", "example": true }, "archive_log_format": { "title": "", "type": "string", "description": "Format for archive log file names", "example": "string" }, "archive_log_path": { "title": "", "type": "string", "description": "Directory where archive logs are located", "example": "string" }, "auth_method": { "title": "", "type": "object", "description": "Authentication Method", "example": "WindowsAuth | Password", "enum": [ "WindowsAuth", "Password" ] }, "blr_windows_auth_server_certificate": { "title": "", "type": "string", "description": "(Optional) PEM certificate of the Windows Auth gRPC server used to verify the server's identity. Only needed to migrate this connector to the Windows Auth Server.", "format": "password", "example": "string" }, "blr_windows_auth_server_grpc_port": { "title": "", "type": "integer", "description": "(Optional) Port of the Windows Auth gRPC server. Only needed to migrate this connector to the Windows Auth Server.", "format": "int32", "example": 443 }, "connection_type": { "title": "", "type": "object", "description": "Possible values: `Directly`, `PrivateLink`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "database": { "title": "", "type": "string", "description": "The database name.", "example": "oracledb" }, "enable_archive_log_only": { "title": "", "type": "boolean", "description": "Use archive log only mode", "example": true }, "enable_tde": { "title": "", "type": "boolean", "description": "Using Transparent Data Encryption (TDE)", "example": true }, "host": { "title": "", "type": "string", "description": "DB instance host or IP address.", "example": "host.com" }, "password": { "title": "", "type": "string", "description": "The user's password.", "format": "password", "example": "test_password" }, "port": { "title": "", "type": "integer", "description": "The port number.", "format": "int32", "example": 1433 }, "sap_schema": { "title": "", "type": "string", "description": "SAP Schema Name.", "example": "string" }, "server_name": { "title": "", "type": "string", "description": "Server name. Used when authenticating with Windows Authentication.", "example": "string" }, "ssh_algorithm": { "title": "", "type": "object", "description": "SSH Key Type", "example": "RSA | ECDSA", "enum": [ "RSA", "ECDSA" ] }, "tde_certificate": { "title": "", "type": "string", "description": "Certificate used to protect a database encryption key", "format": "password", "example": "string" }, "tde_certificate_name": { "title": "", "type": "string", "description": "Name of the Certificate used to protect a database encryption key", "example": "string" }, "tde_password": { "title": "", "type": "string", "description": "Password of the TDE private key", "format": "password", "example": "string" }, "tde_private_key": { "title": "", "type": "string", "description": "Private key associated with the TDE certificate", "format": "password", "example": "string" }, "tunnel_host": { "title": "", "type": "string", "description": "SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).", "example": "XXX.XXX.XXX.XXX" }, "tunnel_port": { "title": "", "type": "integer", "description": "SSH port, specify only to connect via an SSH tunnel.", "format": "int32", "example": 22 }, "tunnel_user": { "title": "", "type": "string", "description": "SSH user, specify only to connect via an SSH tunnel.", "example": "fivetran" }, "update_method": { "title": "", "type": "object", "description": "(Optional) The incremental update method the connector will use. The possible values are `\"TELEPORT\"` or `\"NATIVE_UPDATE\"`. The type defaults to `\"NATIVE_UPDATE\"` if the value is set to `null` or not specified.", "example": "DIRECT", "enum": [ "DIRECT" ] }, "user": { "title": "", "type": "string", "description": "The user name. For Azure Databases, the format must be `user@domain`.", "example": "test_user" } }, "description": "" } } }, "sql_server_sap_ecc_hva_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sql_server_sap_ecc_hva_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_prefix" } ] }, "square_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_access_token": { "title": "", "type": "string", "description": "The Square API access token of your application.", "format": "password", "example": "accessToken" }, "client_id": { "title": "", "type": "string", "description": "The Application ID of your organization.", "example": "clientId" }, "client_secret": { "title": "", "type": "string", "description": "The Application Secret of your organization.", "format": "password", "example": "clientSecret" } }, "description": "" } } }, "square_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/square_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "squarespace_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Squarespace API key.", "format": "password", "example": "your_squarespace_api_key" } }, "description": "" } } }, "squarespace_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/squarespace_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "stackadapt_graphql_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your StackAdapt API key.", "format": "password", "example": "your_stackadapt_api_key" }, "environment": { "type": "object", "description": "Your StackAdapt environment.", "enum": [ "api.stackadapt.com", "sandbox.stackadapt.com/public" ] } }, "description": "" } } }, "stackadapt_graphql_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/stackadapt_graphql_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "standard_metrics_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Standard Metrics Client ID.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Your Standard Metrics Client secret.", "format": "password", "example": "string" } }, "description": "" } } }, "standard_metrics_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/standard_metrics_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "starrez_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your StarRez API password", "format": "password", "example": "string" }, "sub_domain": { "title": "", "type": "string", "description": "Your StarRez subdomain", "example": "string" }, "username": { "title": "", "type": "string", "description": "Your StarRez API username", "example": "string" } }, "description": "" } } }, "starrez_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/starrez_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "statistics_netherlands_cbs_config_V1": { "properties": { "config": { "type": "object", "properties": { "identifier": { "title": "", "type": "string", "description": "Your Statistics Netherlands CBS catalog identifier.", "example": "string" } }, "description": "" } } }, "statistics_netherlands_cbs_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/statistics_netherlands_cbs_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "statsig_config_V1": { "properties": { "config": { "type": "object", "properties": { "secret_key": { "title": "", "type": "string", "description": "Your Statsig secret key.", "format": "password", "example": "your_statsig_secret_key" } }, "description": "" } } }, "statsig_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/statsig_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "statuspage_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Statuspage API Key.", "format": "password", "example": "your_statuspage_api_key" }, "organization": { "title": "", "type": "string", "description": "Your Statuspage Organization ID.", "example": "your_statuspage_organization" } }, "description": "" } } }, "statuspage_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/statuspage_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "stickyio_config_V1": { "properties": { "config": { "type": "object", "properties": { "base_url": { "title": "", "type": "string", "description": "Your sticky.io base URL .", "example": "your_stickyio_base_url" }, "password": { "title": "", "type": "string", "description": "Your sticky.io password.", "format": "password", "example": "your_stickyio_password" }, "username": { "title": "", "type": "string", "description": "Your sticky.io username .", "example": "your_stickyio_username" } }, "description": "" } } }, "stickyio_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/stickyio_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "stripe_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The Stripe API Restricted Key", "format": "password", "example": "restricted_key" }, "api_key": { "title": "", "type": "string", "description": "Restricted API key", "format": "password", "example": "string" }, "backward_sync_limit": { "title": "", "type": "string", "description": "Limit of the Historical Sync Time for selected tables", "example": "string" }, "historical_sync_time_frame": { "title": "", "type": "object", "description": "Used to configure Historical sync timeframe for selected tables", "example": "ALL_TIME | DATE_LIMIT", "enum": [ "ALL_TIME", "DATE_LIMIT" ] }, "invoice_weekly_resync": { "title": "", "type": "boolean", "description": "Resync the `INVOICE` table weekly to fetch the `hosted_invoice_url` and `invoice_pdf` column data. For more information, see [our documentation](/docs/connectors/applications/stripe#limitations).", "example": true }, "support_connected_accounts_sync": { "title": "", "type": "boolean", "description": "Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts.", "example": true } }, "description": "" } } }, "stripe_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/stripe_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "stripe_test_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The Stripe API Restricted Key", "format": "password", "example": "restricted_key" }, "api_key": { "title": "", "type": "string", "description": "Restricted API key", "format": "password", "example": "string" }, "backward_sync_limit": { "title": "", "type": "string", "description": "Limit of the Historical Sync Time for selected tables", "example": "string" }, "historical_sync_time_frame": { "title": "", "type": "object", "description": "Used to configure Historical sync timeframe for selected tables", "example": "ALL_TIME | DATE_LIMIT", "enum": [ "ALL_TIME", "DATE_LIMIT" ] }, "invoice_weekly_resync": { "title": "", "type": "boolean", "description": "Resync the `INVOICE` table weekly to fetch the `hosted_invoice_url` and `invoice_pdf` column data. For more information, see [our documentation](/docs/connectors/applications/stripe#limitations).", "example": true }, "support_connected_accounts_sync": { "title": "", "type": "boolean", "description": "Sync Connected Accounts. Connected Account Documentation - https://stripe.com/docs/api/connected_accounts.", "example": true } }, "description": "" } } }, "stripe_test_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/stripe_test_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "stylight_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your Stylight Password.", "format": "password", "example": "your_stylight_api_password" }, "username": { "title": "", "type": "string", "description": "Your Stylight Username.", "example": "your_stylight_api_username" } }, "description": "" } } }, "stylight_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/stylight_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "subscript_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Subscript API key.", "format": "password", "example": "your_subscript_api_key" } }, "description": "" } } }, "subscript_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/subscript_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "sugarcrm_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your SugarCRM client ID.", "example": "your_sugarcrm_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your SugarCRM client secret.", "format": "password", "example": "your_sugarcrm_client_secret" }, "password": { "title": "", "type": "string", "description": "Your SugarCRM password.", "format": "password", "example": "your_sugarcrm_password" }, "sub_domain": { "title": "", "type": "string", "description": "Your SugarCRM subdomain.", "example": "your_sugarcrm_sub_domain" }, "username": { "title": "", "type": "string", "description": "Your SugarCRM username.", "example": "your_sugarcrm_username" } }, "description": "" } } }, "sugarcrm_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/sugarcrm_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "survey_monkey_config_V1": { "properties": { "config": { "type": "object", "properties": { "eu_region": { "title": "", "type": "boolean", "description": "The SurveyMonkey account region. Specify `true`, if your account is hosted in the EU region. Default value is `false`.", "example": true } }, "description": "" } } }, "survey_monkey_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The long-lived `Access token` carries the information necessary to access API resources.", "example": "my_access_token" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your SurveyMonkey client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your SurveyMonkey client application.", "example": "my_client_secret" } }, "description": "" } }, "description": "" } } }, "survey_monkey_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/survey_monkey_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/survey_monkey_auth_V1" } ] }, "survicate_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Survicate API Key.", "format": "password", "example": "your_survicate_api_key" } }, "description": "" } } }, "survicate_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/survicate_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "swoogo_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Swoogo client Id.", "example": "your_swoogo_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Swoogo Client Secret.", "format": "password", "example": "your_swoogo_client_secret" } }, "description": "" } } }, "swoogo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/swoogo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "tableau_source_config_V1": { "properties": { "config": { "type": "object", "properties": { "pat_name": { "title": "", "type": "string", "description": "Your Tableau Source PAT Name.", "example": "your_tableau_source_personal_access_token_name" }, "pat_secret": { "title": "", "type": "string", "description": "Your Tableau Source PAT Secret.", "format": "password", "example": "your_tableau_source_personal_access_token_secret" }, "site_name": { "title": "", "type": "string", "description": "Your Tableau Source site name.", "example": "your_tableau_source_site_name" }, "sub_domain": { "title": "", "type": "string", "description": "Your Tableau Source subdomain.", "example": "your_tableau_source_sub_domain" } }, "description": "" } } }, "tableau_source_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/tableau_source_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "taboola_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_ids": { "title": "", "type": "array", "description": "Specific Account IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.", "example": "account_id1, account_id2", "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "client_id": { "title": "", "type": "string", "description": "The Taboola client ID.", "example": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }, "client_secret": { "title": "", "type": "string", "description": "The Taboola client secret.", "format": "password", "example": "your_api_secret" }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all accounts or specific accounts.", "example": "AllAccounts | SpecificAccounts", "enum": [ "AllAccounts", "SpecificAccounts" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once connection is created.
NOTE: The more months of reporting data you sync, the longer your initial sync will take.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "taboola_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/taboola_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "talkdesk_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_name": { "title": "", "type": "string", "description": "Your Talkdesk Account Name.", "example": "string" }, "client_id": { "title": "", "type": "string", "description": "The Client ID of your OAuth Client", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "The Client Secret of your OAuth Client", "format": "password", "example": "string" }, "region": { "type": "object", "description": "Your Talkdesk region (\".com\",\".eu\",\"ca.com\")", "enum": [ ".com", "ca.com", ".eu" ] } }, "description": "" } } }, "talkdesk_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/talkdesk_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "talkwalker_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Talkwalker access token.", "format": "password", "example": "your_talkwalker_access_token" } }, "description": "" } } }, "talkwalker_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/talkwalker_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "teads_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Teads API key.", "format": "password", "example": "your_teads_api_key" } }, "description": "" } } }, "teads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/teads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "teamtailor_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Teamtailor API key.", "format": "password", "example": "your_teamtailor_api_key" } }, "description": "" } } }, "teamtailor_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/teamtailor_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "teamwork_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your Teamwork password.", "format": "password", "example": "your_password" }, "site_address": { "title": "", "type": "string", "description": "Your Teamwork site address.", "example": "your_site_address" }, "username": { "title": "", "type": "string", "description": "Your Teamwork username.", "example": "your_username" } }, "description": "" } } }, "teamwork_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/teamwork_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "tempo_config_V1": { "properties": { "config": { "type": "object", "properties": { "sub_domain": { "title": "", "type": "string", "description": "Your Tempo subdomain.", "example": "your_tempo_organization_name" } }, "description": "" } } }, "tempo_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "tempo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/tempo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/tempo_auth_V1" } ] }, "testrail_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your TestRail API key.", "format": "password", "example": "your_testrail_api_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your TestRail subdomain.", "example": "your_testrail_subdomain" }, "username": { "title": "", "type": "string", "description": "Your TestRail username.", "example": "your_testrail_username" } }, "description": "" } } }, "testrail_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/testrail_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "textus_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your TextUs API token.", "format": "password", "example": "textus_api_token" } }, "description": "" } } }, "textus_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/textus_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "the_movie_database_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_read_access_token": { "title": "", "type": "string", "description": "Your The Movie Database API read access token.", "format": "password", "example": "your_the_movie_database_api_read_access_token" } }, "description": "" } } }, "the_movie_database_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/the_movie_database_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "the_trade_desk_config_V1": { "properties": { "config": { "type": "object", "properties": { "login": { "title": "", "type": "string", "description": "The Trade Desk email. It is a part of the login credentials.", "example": "test_login" }, "partners": { "title": "", "type": "array", "description": "Specific Partner IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "password": { "title": "", "type": "string", "description": "The Trade Desk password. It is a part of the login credentials.", "format": "password", "example": "xxxxxxxxxx" }, "report_templates": { "title": "", "type": "array", "description": "Report templates to sync.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all accounts or specific accounts.", "example": "AllAccounts | SpecificAccounts", "enum": [ "AllAccounts", "SpecificAccounts" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of data you'd like to include in your initial sync. Increasing this value does not automatically backfill older data for tables that have already synced; trigger a resync for those tables to apply the new time frame. Default value: `THREE`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "the_trade_desk_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/the_trade_desk_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "thinkific_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_key": { "title": "", "type": "string", "description": "Your Thinkific client key.", "format": "password", "example": "your_thinkific_client_key" }, "client_secret": { "title": "", "type": "string", "description": "Your Thinkific client secret.", "format": "password", "example": "your_thinkific_client_secret" }, "sub_domain": { "title": "", "type": "string", "description": "Your Thinkific subdomain.", "example": "your_thinkific_subdomain" } }, "description": "" } } }, "thinkific_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "thinkific_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/thinkific_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/thinkific_auth_V1" } ] }, "ticket_tailor_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Ticket Tailor API key.", "format": "password", "example": "your_ticket_tailor_api_key" } }, "description": "" } } }, "ticket_tailor_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ticket_tailor_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "tiktok_ads_config_V1": { "properties": { "config": { "type": "object", "properties": { "accounts": { "title": "", "type": "array", "description": "Specific accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "attribution_window_size": { "title": "", "type": "object", "description": "Rollback sync duration to capture conversions. Set this to your configured attribution window in TikTok Ads. The default value is 7 days.", "example": "TWENTY_EIGHT | FOURTEEN | ONE | SEVEN", "enum": [ "TWENTY_EIGHT", "FOURTEEN", "ONE", "SEVEN" ] }, "custom_reports": { "title": "", "type": "array", "description": "Title of Custom Report", "items": { "title": "", "type": "object", "properties": { "aggregate": { "title": "", "type": "string", "description": "Time aggregation of report", "example": "daily" }, "dimensions": { "title": "", "type": "array", "description": "Dimensions to synced", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "metrics": { "title": "", "type": "array", "description": "Metrics to be synced", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_type": { "title": "", "type": "string", "description": "Type of report to be generated", "example": "auction_basic_campaign_report" }, "table_name": { "title": "", "type": "string", "description": "Destination Table name of report", "example": "table_1" } }, "description": "Title of Custom Report" } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all advertiser accounts or specific accounts.", "example": "AllAccounts | SpecificAccounts", "enum": [ "AllAccounts", "SpecificAccounts" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "tiktok_ads_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The long-lived `Access token` carries the information necessary to access API resources.", "example": "my_access_token" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your TikTok Ads client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your TikTok Ads client application.", "example": "my_client_secret" } }, "description": "Your application client access fields" } }, "description": "" } } }, "tiktok_ads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/tiktok_ads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/tiktok_ads_auth_V1" } ] }, "tiktok_organic_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_environment": { "type": "object", "description": "Your TikTok Organic API environment.", "enum": [ "business-api.tiktok.com", "sandbox-ads.tiktok.com" ] }, "app_id": { "title": "", "type": "string", "description": "Your Tiktok Organic app ID.", "example": "your_tiktok_organic_app_id" }, "secret": { "title": "", "type": "string", "description": "The secret of the app registered in your TikTok developer account.", "format": "password", "example": "your_tiktok_organic_app_secret" } }, "description": "" } } }, "tiktok_organic_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/tiktok_organic_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "tiktok_organic_app_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_environment": { "type": "object", "description": "Your TikTok Organic API environment.", "enum": [ "business-api.tiktok.com", "sandbox-ads.tiktok.com" ] }, "business_category": { "type": "array", "description": "The TikTok business category whose data you want to sync.", "items": { "type": "object", "description": "The TikTok business category whose data you want to sync.", "enum": [ "CLOTHING_AND_ACCESSORIES", "FINANCE_AND_INVESTING", "HEALTH_AND_WELLNESS", "SHOPPING_AND_RETAIL", "BABY", "PROFESSIONAL_SERVICES", "GAMING", "PETS", "EDUCATION_AND_TRAINING", "PUBLIC_ADMINISTRATION", "PERSONAL_BLOG", "SPORTS_FITNESS_AND_OUTDOORS", "ELECTRONICS", "REAL_ESTATE", "TRAVEL_AND_TOURISM", "MACHINERY_AND_EQUIPMENT", "RESTAURANTS_AND_BARS", "ART_AND_CRAFTS", "HOME_FURNITURE_AND_APPLIANCES", "OTHERS", "BEAUTY", "SOFTWARE_AND_APPS", "FOOD_AND_BEVERAGE", "MEDIA_AND_ENTERTAINMENT", "AUTOMOTIVE_AND_TRANSPORTATION" ] } } }, "description": "" } } }, "tiktok_organic_app_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your TikTok Organic access token.", "format": "password", "example": "your_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "Your TikTok Organic client access." }, "realm_id": { "title": "", "type": "string", "description": "The TikTok account Open ID (open_id) returned during OAuth authorization. Required when creating the connector via REST API.", "example": "your_realm_id" }, "refresh_token": { "title": "", "type": "string", "description": "Your TikTok Organic refresh token.", "format": "password", "example": "your_refresh_token" } }, "description": "" } } }, "tiktok_organic_app_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/tiktok_organic_app_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/tiktok_organic_app_auth_V1" } ] }, "tiktok_shop_partner_center_config_V1": { "properties": { "config": { "type": "object", "properties": { "app_key": { "title": "", "type": "string", "description": "Your TikTok Shop Partner Center app key.", "example": "your_tiktok_shop_partner_center_app_key" }, "app_secret": { "title": "", "type": "string", "description": "Your TikTok Shop Partner Center app secret.", "format": "password", "example": "your_tiktok_shop_partner_center_app_secret" }, "authorization_url": { "title": "", "type": "string", "description": "Your TikTok Shop Partner Center authorization URL.", "example": "https://services.tiktokshops.us/open/authorize?service_id=7369437808455026474" }, "platform": { "type": "array", "description": "Your TikTok Shop Partner Center external order data.", "items": { "type": "object", "description": "Your TikTok Shop Partner Center external order data.", "enum": [ "SALESFORCE_COMMERCE_CLOUD", "AMAZON", "WAREHOUSE_MANAGEMENT_SYSTEM", "BIGCOMMERCE", "MAGENTO", "ORDER_MANAGEMENT_SYSTEM", "SHOPIFY", "WOOCOMMERCE", "CHANNEL_ADVISOR", "ERP_SYSTEM" ] } } }, "description": "" } } }, "tiktok_shop_partner_center_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/tiktok_shop_partner_center_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "tive_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Tive client ID.", "example": "your_tive_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Tive client secret.", "format": "password", "example": "your_tive_client_secret" } }, "description": "" } } }, "tive_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/tive_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "toggl_track_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Toggl Track API token", "format": "password", "example": "your_toggl_track_api_token" }, "custom_rate_limit": { "title": "", "type": "string", "description": "Your Toggl Track custom rate limit. Supports only numeric characters (0-9).", "example": "your_toggl_track_custom_rate_limit" }, "rate_limit_plan": { "type": "object", "description": "Your Toggl Track plan type.", "enum": [ "220", "", "27", "580" ] } }, "description": "" } } }, "toggl_track_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/toggl_track_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "totango_config_V1": { "properties": { "config": { "type": "object", "properties": { "personal_access_token": { "title": "", "type": "string", "description": "Your Totango personal access token.", "format": "password", "example": "your_totango_personal_access_token" }, "region": { "type": "object", "description": "Your Totango region.", "enum": [ "api-eu1", "api" ] } }, "description": "" } } }, "totango_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/totango_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "tracksuit_source_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "tracksuit_source_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/tracksuit_source_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "transcend_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Transcend API key.", "format": "password", "example": "your_transcend_api_key" }, "region": { "type": "object", "description": "Your Transcend region.", "enum": [ "api.us", "api" ] } }, "description": "" } } }, "transcend_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/transcend_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "trelica_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Trelica client ID.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Your Trelica client secret.", "format": "password", "example": "string" }, "environment": { "type": "object", "description": "Your Trelica environment.", "enum": [ "app", "eu" ] } }, "description": "" } } }, "trelica_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/trelica_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "trello_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your TRELLO api key.", "format": "password", "example": "your_trello_api_key" }, "api_token": { "title": "", "type": "string", "description": "Your TRELLO api token.", "format": "password", "example": "your_trello_api_token" } }, "description": "" } } }, "trello_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/trello_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "tremendous_config_V1": { "properties": { "config": { "type": "object", "properties": { "environment": { "type": "object", "description": "Your Tremendous environment.", "enum": [ "testflight", "api" ] } }, "description": "" } } }, "tremendous_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Tremendous access token.", "format": "password", "example": "string" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "Your Tremendous client access." }, "refresh_token": { "title": "", "type": "string", "description": "Your Tremendous refresh token.", "format": "password", "example": "string" } }, "description": "" } } }, "tremendous_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/tremendous_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/tremendous_auth_V1" } ] }, "triple_whale_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Triple Whale API key.", "format": "password", "example": "string" }, "shop_domain": { "title": "", "type": "string", "description": "Your Triple Whale shop domain.", "example": "string" } }, "description": "" } } }, "triple_whale_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/triple_whale_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "trisolute_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Trisolute API token.", "format": "password", "example": "your_trisolute_api_token" } }, "description": "" } } }, "trisolute_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/trisolute_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "trustpilot_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Trustpilot application API key.", "format": "password", "example": "your_trustpilot_api_key" }, "api_secret": { "title": "", "type": "string", "description": "Your Trustpilot application API secret.", "format": "password", "example": "your_trustpilot_api_secret" }, "domain_name": { "title": "", "type": "string", "description": "Your domain from which you want to sync data.", "example": "your_domain_name" } }, "description": "" } } }, "trustpilot_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/trustpilot_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "twilio_config_V1": { "properties": { "config": { "type": "object", "properties": { "accounts": { "title": "", "type": "array", "description": "Specific Accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "secret": { "title": "", "type": "string", "description": "The Twilio API secret", "format": "password", "example": "test_api_secret" }, "sid": { "title": "", "type": "string", "description": "The Twilio API key SID", "example": "test_api_sid" }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all accounts or specific accounts.", "example": "AllAccounts | SpecificAccounts", "enum": [ "AllAccounts", "SpecificAccounts" ] } }, "description": "" } } }, "twilio_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "secret": { "title": "", "type": "string", "description": "ESM key for the Twilio API secret", "example": "SECRET_KEY" }, "sid": { "title": "", "type": "string", "description": "ESM key for the Twilio API key SID", "example": "SID_KEY" } }, "description": "" } } }, "twilio_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/twilio_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/twilio_esm_keys_config_V1" } ] }, "twitter_config_V1": { "properties": { "config": { "type": "object", "properties": { "accounts": { "title": "", "type": "array", "description": "Specific accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.", "example": "AllAccounts | SpecificAccounts", "enum": [ "AllAccounts", "SpecificAccounts" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "twitter_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your X client application.", "example": "my_consumer_key" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your X client application.", "example": "my_consumer_secret" } }, "description": "Your application client access fields" }, "consumer_key": { "title": "", "type": "string", "description": "API Key of your app", "example": "string" }, "consumer_secret": { "title": "", "type": "string", "description": "API Secret of your app", "example": "string" }, "oauth_token": { "title": "", "type": "string", "description": "The X App access token.", "example": "x_access_token" }, "oauth_token_secret": { "title": "", "type": "string", "description": "The X App access token secret.", "example": "x_access_token_secret" } }, "description": "" } } }, "twitter_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/twitter_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/twitter_auth_V1" } ] }, "twitter_ads_config_V1": { "properties": { "config": { "type": "object", "properties": { "accounts": { "title": "", "type": "array", "description": "Specific Accounts to sync. Must be populated if `sync_mode` is set to `SpecificAccounts`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "is_custom_api_credentials": { "title": "", "type": "boolean", "description": "Custom API credentials", "example": true }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all accounts or specific accounts.", "example": "AllAccounts | SpecificAccounts", "enum": [ "AllAccounts", "SpecificAccounts" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Historical sync timeframe in months.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "twitter_ads_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your X Ads client application.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your X Ads client application.", "example": "string" } }, "description": "Your application client access fields." }, "consumer_key": { "title": "", "type": "string", "description": "The X App consumer key.", "example": "x_key" }, "consumer_secret": { "title": "", "type": "string", "description": "The X App consumer secret.", "example": "x_secret" }, "oauth_token": { "title": "", "type": "string", "description": "The X App access token.", "example": "x_access_token" }, "oauth_token_secret": { "title": "", "type": "string", "description": "The X App access token secret.", "example": "x_access_token_secret" } }, "description": "" } } }, "twitter_ads_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/twitter_ads_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/twitter_ads_auth_V1" } ] }, "tymeshift_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_plan": { "title": "", "type": "string", "description": "Your Tymeshift account plan.", "example": "your_tymeshift_account_plan" }, "client_id": { "title": "", "type": "string", "description": "Your Tymeshift email.", "example": "your_tymeshift_email" }, "client_secret": { "title": "", "type": "string", "description": "Your Tymeshift password.", "format": "password", "example": "your_tymeshift_password" }, "sub_domain": { "title": "", "type": "string", "description": "Your Tymeshift subdomain.", "example": "your_tymeshift_domain" } }, "description": "" } } }, "tymeshift_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/tymeshift_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "typeform_config_V1": { "properties": { "config": { "type": "object", "properties": { "data_region": { "title": "", "type": "object", "description": "The selected Typeform auth/data region. Empty for Standard/Global, `eu` for the New EU Data Center.", "example": "EU | US_DEFAULT | LEGACY_EU", "enum": [ "EU", "US_DEFAULT", "LEGACY_EU" ] } }, "description": "" } } }, "typeform_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The Typeform API access token.", "example": "my_access_token" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "The Typeform client ID.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "The Typeform client secret.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The Typeform API refresh token.", "example": "my_refresh_token" } }, "description": "" } } }, "typeform_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/typeform_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/typeform_auth_V1" } ] }, "udemy_business_config_V1": { "properties": { "config": { "type": "object", "properties": { "account_id": { "title": "", "type": "string", "description": "Your Udemy Business account ID.", "example": "udemy_business_account_id" }, "account_name": { "title": "", "type": "string", "description": "Your Udemy Business account name.", "example": "udemy_business_account_name" }, "client_id": { "title": "", "type": "string", "description": "Your Udemy Business client ID.", "example": "udemy_business_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Udemy Business client secret.", "format": "password", "example": "udemy_business_client_secret" } }, "description": "" } } }, "udemy_business_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/udemy_business_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ukg_pro_config_V1": { "properties": { "config": { "type": "object", "properties": { "customer_api_key": { "title": "", "type": "string", "description": "Your UKG Pro Customer API key.", "format": "password", "example": "your_ukg_pro_customer_api_key" }, "hostname": { "title": "", "type": "string", "description": "Your UKG Pro hostname.", "example": "your_ukg_pro_hostname" }, "password": { "title": "", "type": "string", "description": "Your UKG Pro password.", "format": "password", "example": "your_ukg_pro_password" }, "username": { "title": "", "type": "string", "description": "Your UKG Pro username.", "example": "your_ukg_pro_username" } }, "description": "" } } }, "ukg_pro_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ukg_pro_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "ukg_pro_workforce_management_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_environment": { "title": "", "type": "string", "description": "Your UKG Pro Workforce Management Auth base URL.", "example": "your_ukg_pro_workforce_management_auth_base_url" }, "auth_type": { "type": "object", "description": "The authentication method you want to use for your connection.", "enum": [ "client_credentials", "ropc" ] }, "client_id": { "title": "", "type": "string", "description": "Your UKG Pro Workforce Management client ID.", "example": "your_ukg_pro_workforce_management_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your UKG Pro Workforce Management client secret.", "format": "password", "example": "your_ukg_pro_workforce_management_client_secret" }, "host_name": { "title": "", "type": "string", "description": "Your UKG Pro Workforce Management hostname.", "example": "your_ukg_pro_workforce_management_host_name" }, "organization": { "title": "", "type": "string", "description": "Your UKG Pro Workforce Management Organization ID.", "example": "your_ukg_pro_workforce_management_organization_id" }, "password": { "title": "", "type": "string", "description": "Your UKG Pro Workforce Management password.", "format": "password", "example": "your_ukg_pro_workforce_management_password" }, "username": { "title": "", "type": "string", "description": "Your UKG Pro Workforce Management username.", "example": "your_ukg_pro_workforce_management_username" } }, "description": "" } } }, "ukg_pro_workforce_management_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/ukg_pro_workforce_management_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "unicommerce_config_V1": { "properties": { "config": { "type": "object", "properties": { "facility_codes": { "title": "", "type": "string", "description": "Your uniware facility codes.", "example": "string" }, "password": { "title": "", "type": "string", "description": "Your uniware login password.", "format": "password", "example": "uniware_password" }, "tenant": { "title": "", "type": "string", "description": "Your uniware tenant.", "example": "your_uniware_account_code" }, "username": { "title": "", "type": "string", "description": "Your uniware login username.", "example": "uniware_username" } }, "description": "" } } }, "unicommerce_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/unicommerce_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "upland_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Upland Software API key.", "format": "password", "example": "your_upland_api_key" }, "auth_type": { "type": "object", "description": "Authentication method you want to use for your connection.", "enum": [ "api_key", "basic" ] }, "company_key": { "title": "", "type": "string", "description": "Your Upland Software company key.", "format": "password", "example": "your_upland_company_key" }, "password": { "title": "", "type": "string", "description": "Your Upland Software password.", "format": "password", "example": "your_upland_password" }, "sub_domain": { "title": "", "type": "string", "description": "Your Upland Software subdomain.", "example": "your_upland_sub_domain" }, "username": { "title": "", "type": "string", "description": "Your Upland Software username.", "example": "your_upland_username" } }, "description": "" } } }, "upland_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/upland_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "uppromote_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your UpPromote API key.", "format": "password", "example": "your_uppromote_api_key" } }, "description": "" } } }, "uppromote_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/uppromote_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "uptempo_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your Uptempo password.", "format": "password", "example": "your_uptempo_password" }, "subdomain": { "type": "object", "description": "Your Uptempo subdomain.", "enum": [ "api-eu", "api-na" ] }, "username": { "title": "", "type": "string", "description": "Your Uptempo username.", "example": "your_uptempo_username" } }, "description": "" } } }, "uptempo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/uptempo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "uservoice_config_V1": { "properties": { "config": { "type": "object", "properties": { "domain": { "title": "", "type": "string", "description": "Domain of your UserVoice site. If it ends with \".uservoice.com\", you can specify just the subdomain (\"mydomain.uservoice.com\" → \"mydomain\")", "example": "uservoice_domain" }, "key": { "title": "", "type": "string", "description": "The UserVoice API key.", "format": "password", "example": "your_api_key" }, "secret": { "title": "", "type": "string", "description": "The UserVoice API secret.", "format": "password", "example": "your_api_secret" } }, "description": "" } } }, "uservoice_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/uservoice_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "validio_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_key_id": { "title": "", "type": "string", "description": "Your Validio access key ID.", "format": "password", "example": "your_validio_access_key_id" }, "secret_access_key": { "title": "", "type": "string", "description": "Your Validio secret access key.", "format": "password", "example": "your_validio_secret_access_key" }, "sub_domain": { "title": "", "type": "string", "description": "Your Validio subdomain.", "example": "your_validio_sub_domain" } }, "description": "" } } }, "validio_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/validio_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "veeqo_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Veeqo API key.", "format": "password", "example": "your_veeqo_api_key" } }, "description": "" } } }, "veeqo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/veeqo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "veeva_vault_config_V1": { "properties": { "config": { "type": "object", "properties": { "authentication_method": { "title": "", "type": "object", "description": "(Optional) Authentication type (default value is `Basic`)", "example": "Basic | OAuth2", "enum": [ "Basic", "OAuth2" ] }, "base_url": { "title": "", "type": "string", "description": "Base URL of your Veeva Vault instance", "example": "my-org.veevavault.com" }, "client_id": { "title": "", "type": "string", "description": "OAuth2 client ID (only when authentication_method is `OAuth2`)", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "OAuth2 client secret (only when authentication_method is `OAuth2`)", "format": "password", "example": "my_client_secret" }, "o_auth_service_token_url": { "title": "", "type": "string", "description": "OAuth2 authorization server token endpoint URL (only when authentication_method is `OAuth2`)", "example": "https://login.veevavault.com/auth/oauth/token/v1" }, "oidc_profile_id": { "title": "", "type": "string", "description": "OIDC profile ID configured in Veeva Vault (only when authentication_method is `OAuth2`)", "example": "my_oidc_profile_id" }, "password": { "title": "", "type": "string", "description": "Password (only when authentication_method is `Basic`)", "format": "password", "example": "password" }, "scope": { "title": "", "type": "string", "description": "OAuth2 scope (only when authentication_method is `OAuth2`)", "example": "openid" }, "username": { "title": "", "type": "string", "description": "Username (only when authentication_method is `Basic`)", "example": "username" }, "vault_dns": { "title": "", "type": "string", "description": "(Optional) Target Vault DNS if different from default (only when authentication_method is `OAuth2`)", "example": "my-vault.veevavault.com" } }, "description": "" } } }, "veeva_vault_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/veeva_vault_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "venminder_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Venminder API key.", "format": "password", "example": "your_venminder_api_key" }, "secret": { "title": "", "type": "string", "description": "Your Venminder secret.", "format": "password", "example": "your_venminder_secret" } }, "description": "" } } }, "venminder_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/venminder_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "vimeo_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Vimeo client ID.", "example": "your_vimeo_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Vimeo client secret.", "format": "password", "example": "your_vimeo_client_secret" }, "historical_sync_time_frame": { "type": "object", "description": "Your Vimeo Historical sync time frame.", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] }, "rate_limit_plan": { "type": "object", "description": "Your Vimeo rate limit plan.", "enum": [ "235", "115", "725", "480", "20" ] }, "user_id": { "title": "", "type": "string", "description": "Your Vimeo user ID.", "example": "your_vimeo_user_id" } }, "description": "" } } }, "vimeo_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "vimeo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/vimeo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/vimeo_auth_V1" } ] }, "visit_by_ges_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Visit by GES API key.", "format": "password", "example": "your_visit_by_ges_api_key" } }, "description": "" } } }, "visit_by_ges_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/visit_by_ges_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "visma_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Visma client ID.", "example": "your_visma_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Visma client secret.", "format": "password", "example": "your_visma_client_secret" }, "tenant_id": { "title": "", "type": "string", "description": "Your Visma tenant ID.", "example": "your_visma_tenant_id" } }, "description": "" } } }, "visma_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/visma_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "vitally_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Vitally API key.", "format": "password", "example": "your_vitally_api_key" }, "base_url": { "title": "", "type": "string", "description": "Your Vitally base URL.", "example": "your_vitally_base_url" } }, "description": "" } } }, "vitally_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/vitally_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "vonage_contact_center_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Vonage Contact Center client ID.", "example": "your_vonage_contact_center_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Vonage Contact Center client secret.", "format": "password", "example": "your_vonage_contact_center_client_secret" }, "region": { "type": "object", "description": "Your Vonage Contact Center region.", "enum": [ "emea", "nam", "apac" ] } }, "description": "" } } }, "vonage_contact_center_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/vonage_contact_center_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "vts_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your VTS API key.", "format": "password", "example": "your_vts_api_key" }, "environment": { "type": "object", "description": "Your VTS environment.", "enum": [ "sandbox.vts.com", "api.vts.com" ] }, "secret": { "title": "", "type": "string", "description": "Your VTS secret.", "format": "password", "example": "your_vts_secret" } }, "description": "" } } }, "vts_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/vts_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "vwo_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your VWO API token.", "format": "password", "example": "your_vwo_api_token" } }, "description": "" } } }, "vwo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/vwo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "walmart_dsp_config_V1": { "properties": { "config": { "type": "object", "properties": { "login": { "title": "", "type": "string", "description": "Walmart DSP email. It is a part of the login credentials.", "example": "test_login" }, "partners": { "title": "", "type": "array", "description": "Specific Partner IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "password": { "title": "", "type": "string", "description": "Walmart DSP password. It is a part of the login credentials.", "format": "password", "example": "xxxxxxxxxx" }, "report_templates": { "title": "", "type": "array", "description": "Report templates to sync.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all accounts or specific accounts.", "example": "AllAccounts | SpecificAccounts", "enum": [ "AllAccounts", "SpecificAccounts" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "walmart_dsp_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/walmart_dsp_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "walmart_marketplace_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Walmart Marketplace client ID.", "example": "your_walmart_marketplace_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Walmart Marketplace client secret.", "format": "password", "example": "your_walmart_marketplace_client_secret" }, "service_name": { "title": "", "type": "string", "description": "Your Walmart Marketplace service name.", "example": "your_walmart_marketplace_service_name" } }, "description": "" } } }, "walmart_marketplace_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/walmart_marketplace_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "web_scraper_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Web Scraper API token.", "format": "password", "example": "your_web_scraper_api_token" } }, "description": "" } } }, "web_scraper_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/web_scraper_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "webconnex_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Webconnex API key.", "format": "password", "example": "your_webconnex_api_key" }, "product": { "type": "object", "description": "Your Webconnex product.", "enum": [ "redpodium.com", "ticketspice.com", "givingfuel.com", "regfox.com" ] } }, "description": "" } } }, "webconnex_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/webconnex_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "webhooks_config_V1": { "properties": { "config": { "type": "object", "properties": { "algorithm": { "title": "", "type": "object", "description": "HMAC algorithm used for generating the HMAC signature. Supported algorithms INFER_FROM_HEADER, MD5, SHA_1, SHA_224, SHA_256, SHA_384, SHA_512. Default: SHA_256", "example": "SHA_512 | SHA_256 | SHA_224 | INFER_FROM_HEADER | SHA_1 | SHA_384 | MD5", "enum": [ "SHA_512", "SHA_256", "SHA_224", "INFER_FROM_HEADER", "SHA_1", "SHA_384", "MD5" ] }, "auth_header_key": { "title": "", "type": "string", "description": "Set if you use HMAC/token-based auth methods. This is used to retrieve a key in headers", "example": "string" }, "auth_method": { "title": "", "type": "object", "description": "The authentication mechanism you want to use", "example": "HMAC | TOKEN_BASED | NONE", "enum": [ "HMAC", "TOKEN_BASED", "NONE" ] }, "auth_secret": { "title": "", "type": "string", "description": "The secret you want to use for HMAC/token-based auth methods", "format": "password", "example": "My$ecret@12345678" }, "blob_sas_url": { "title": "", "type": "string", "description": "The blob SAS URL of your Azure container. Required if `bucket_service` is set to `AZURE`.", "format": "password", "example": "string" }, "bucket_service": { "title": "", "type": "object", "description": "Whether to store the events in Fivetran's container service or your S3 bucket. Default value: `Fivetran`.", "example": "S3 | AZURE | GCS | Fivetran", "enum": [ "S3", "AZURE", "GCS", "Fivetran" ] }, "gcs_bucket": { "title": "", "type": "string", "description": "The GCS bucket name. Required if `bucket_service` is set to `GCS`.", "example": "string" }, "s3_bucket": { "title": "", "type": "string", "description": "The S3 bucket name. Required if `bucket_service` is set to `S3`.", "example": "your_bucket_name" }, "s3_role_arn": { "title": "", "type": "string", "description": "The Role ARN required for authentication. Required if `bucket_service` is set to `S3`.", "format": "password", "example": "arn::your_role_arn" }, "signature_encoding": { "title": "", "type": "object", "description": "This is used in HMAC auth method to decode and verify the signature. Supported encodings BASE64 and HEXA_DECIMAL. Default: BASE64", "example": "BASE64 | HEXA_DECIMAL", "enum": [ "BASE64", "HEXA_DECIMAL" ] }, "sync_format": { "title": "", "type": "object", "description": "The webhooks sync format. Default value: `Unpacked`. Unpacked messages must be valid JSON.", "example": "Packed | Unpacked", "enum": [ "Packed", "Unpacked" ] } }, "description": "" } } }, "webhooks_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/webhooks_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "when_i_work_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your When I Work password.", "format": "password", "example": "when_i_work_password" }, "username": { "title": "", "type": "string", "description": "Your When I Work username.", "example": "when_i_work_username" } }, "description": "" } } }, "when_i_work_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/when_i_work_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "wherefour_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your Wherefour password.", "format": "password", "example": "wherefour_password" }, "username": { "title": "", "type": "string", "description": "Your Wherefour username.", "example": "wherefour_username" } }, "description": "" } } }, "wherefour_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/wherefour_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "wicked_reports_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Wicked Reports API key.", "format": "password", "example": "wicked_reports_api_key" } }, "description": "" } } }, "wicked_reports_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/wicked_reports_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "woocommerce_config_V1": { "properties": { "config": { "type": "object", "properties": { "consumer_key": { "title": "", "type": "string", "description": "Your WooCommerce Consumer key.", "example": "your_woocommerce_consumer_key" }, "consumer_secret": { "title": "", "type": "string", "description": "Your WooCommerce Consumer secret.", "format": "password", "example": "your_woocommerce_consumer_secret" }, "word_press_site_id_or_woocommerce_domain_name": { "title": "", "type": "string", "description": "The Site ID of your WordPress hosted WooCommerce instance or the subdomain of your self-hosted WooCommerce instance.", "example": "wordpress_site_id or http://your.sub.domain/" } }, "description": "" } } }, "woocommerce_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/woocommerce_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "wordpress_config_V1": { "properties": { "config": { "type": "object", "properties": { "sub_domain": { "title": "", "type": "string", "description": "Your WordPress subdomain.", "example": "your_wordpress_sub_domain" } }, "description": "" } } }, "wordpress_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "format": "password", "example": "string" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } } }, "description": "" } } }, "wordpress_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/wordpress_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" }, { "$ref": "#/components/schemas/wordpress_auth_V1" } ] }, "workable_config_V1": { "properties": { "config": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Workable Access Token.", "format": "password", "example": "your_workable_access_token" }, "sub_domain": { "title": "", "type": "string", "description": "Your Workable Subdomain.", "example": "your_workable_sub_domain" } }, "description": "" } } }, "workable_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/workable_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "workday_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_mode": { "title": "", "type": "object", "description": "Authentication Mode", "example": "BASIC | OAUTH", "enum": [ "BASIC", "OAUTH" ] }, "authorization_url": { "title": "", "type": "string", "description": "Authorization URL", "example": "string" }, "domain_host_name": { "title": "", "type": "string", "description": "Workday host name.", "example": "string" }, "password": { "title": "", "type": "string", "description": "Workday password.", "format": "password", "example": "workday_password" }, "reports": { "title": "", "type": "array", "description": "The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.", "items": { "title": "", "type": "object", "properties": { "dynamic_parameter_field": { "title": "", "type": "string", "description": "Dynamic parameter field name", "example": "string" }, "enable_dynamic_parameters": { "title": "", "type": "boolean", "description": "Select this option to enable dynamic report parameters.", "example": true }, "generate_fivetran_pk": { "title": "", "type": "boolean", "description": "Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.", "example": true }, "primary_keys": { "title": "", "type": "array", "description": "Primary Keys", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_format_type": { "title": "", "type": "object", "description": "This is to select report format from JSON and CSV. By default, report format is JSON.", "example": "csv | json", "enum": [ "csv", "json" ] }, "report_url": { "title": "", "type": "string", "description": "URL for a live custom report.", "example": "workday_report_url" }, "start_date": { "title": "", "type": "string", "description": "Start date", "example": "2024-01-01" }, "start_date_parameter_field": { "title": "", "type": "string", "description": "Start date parameter field name", "example": "string" }, "support_nested_columns": { "title": "", "type": "boolean", "description": "This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.", "example": true }, "sync_strategy": { "title": "", "type": "object", "description": "Dynamic report parameters sync strategy", "example": "FROM_START_DATE | FROM_LAST_SYNCED_DATE", "enum": [ "FROM_START_DATE", "FROM_LAST_SYNCED_DATE" ] }, "table": { "title": "", "type": "string", "description": "The table name within the schema to which connector will sync the data of the specific report.", "example": "table_name" } }, "description": "The list of reports. Each report corresponds to a table within the schema to which connector will sync the data." } }, "tenant": { "title": "", "type": "string", "description": "Workday tenant name", "example": "string" }, "user_name": { "title": "", "type": "string", "description": "Workday username.", "example": "workday_username" } }, "description": "" } } }, "workday_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Client ID", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Client Secret", "example": "string" }, "refresh_token": { "title": "", "type": "string", "description": "OAuth Refresh Token", "example": "string" } }, "description": "" } } }, "workday_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for workday password.", "example": "PASSWORD_KEY" }, "user_name": { "title": "", "type": "string", "description": "ESM key for workday username.", "example": "USER_NAME_KEY" } }, "description": "" } } }, "workday_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/workday_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table_group" }, { "$ref": "#/components/schemas/workday_auth_V1" }, { "$ref": "#/components/schemas/workday_esm_keys_config_V1" } ] }, "workday_adaptive_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_mode": { "title": "", "type": "object", "description": "Authentication mode: PASSWORD (username/password) or TOKEN (key-based authentication)", "example": "PASSWORD | TOKEN", "enum": [ "PASSWORD", "TOKEN" ] }, "client_id": { "title": "", "type": "string", "description": "Client ID for token authentication (required for TOKEN authentication)", "example": "string" }, "host": { "title": "", "type": "string", "description": "Workday Adaptive host URL, including the scheme, required for TOKEN authentication", "example": "https://impl-services1.wd12.myworkday.com" }, "instance_code": { "title": "", "type": "string", "description": "Instance code for Workday Adaptive Planning.", "example": "string" }, "isu": { "title": "", "type": "string", "description": "Integration System User (ISU) for token authentication (required for TOKEN authentication)", "example": "string" }, "login": { "title": "", "type": "string", "description": "User email address (required for PASSWORD authentication)", "example": "string" }, "password": { "title": "", "type": "string", "description": "User password (required for PASSWORD authentication)", "format": "password", "example": "string" }, "private_key": { "title": "", "type": "string", "description": "PEM-formatted PKCS#8 private key, including BEGIN/END PRIVATE KEY markers, for token authentication", "format": "password", "example": "string" }, "reports": { "title": "", "type": "array", "description": "Custom Report", "items": { "title": "", "type": "object", "properties": { "account_sync_mode": { "title": "", "type": "object", "description": "Account sync mode for the table. Options: `SYNC_ALL_ACCOUNTS` (sync all accounts) or `SELECT_SPECIFIC_ACCOUNTS` (sync selected accounts only).", "example": "SELECT_SPECIFIC_ACCOUNTS | SYNC_ALL_ACCOUNTS", "enum": [ "SELECT_SPECIFIC_ACCOUNTS", "SYNC_ALL_ACCOUNTS" ] }, "currency": { "title": "", "type": "string", "description": "List of currencies to sync for the table, if applicable.", "example": "string" }, "dimensions": { "title": "", "type": "array", "description": "List of dimensions to sync for the table, if applicable.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "include_zero_rows": { "title": "", "type": "boolean", "description": "Include zero rows in the table sync.", "example": true }, "level_sync_mode": { "title": "", "type": "object", "description": "Level sync mode for the table. Options: `SYNC_ALL_LEVELS` (sync all levels) or `SELECT_SPECIFIC_LEVELS` (sync selected levels only).", "example": "SELECT_SPECIFIC_LEVELS | SYNC_ALL_LEVELS", "enum": [ "SELECT_SPECIFIC_LEVELS", "SYNC_ALL_LEVELS" ] }, "selected_accounts": { "title": "", "type": "array", "description": "List of account IDs to sync when `accountSyncMode` is `SELECT_SPECIFIC_ACCOUNTS`. Each ID should be in the format: `,` (e.g., `1,false`).", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "selected_levels": { "title": "", "type": "array", "description": "List of level IDs to sync when `levelSyncMode` is `SELECT_SPECIFIC_LEVELS`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "sync_descendant_accounts": { "title": "", "type": "boolean", "description": "Flag to indicate if descendant accounts should be included for the selected accounts.", "example": true }, "sync_descendant_levels": { "title": "", "type": "boolean", "description": "Flag to indicate if descendant levels should be included for the selected levels.", "example": true }, "table": { "title": "", "type": "string", "description": "Table name to be synced.", "example": "string" }, "version_sync_strategy": { "title": "", "type": "object", "description": "Version sync strategy for the table, `SYNC_ALL_AND_NEW_VERSIONS` or `SYNC_SELECT_VERSIONS`.", "example": "SYNC_SELECT_VERSIONS | SYNC_ALL_AND_NEW_VERSIONS", "enum": [ "SYNC_SELECT_VERSIONS", "SYNC_ALL_AND_NEW_VERSIONS" ] }, "versions": { "title": "", "type": "array", "description": "List of versions to sync for the table, if versionSyncStrategy is `SYNC_SELECT_VERSIONS`.", "example": [ "string" ], "items": { "title": "", "type": "string", "description": "", "example": "string" } } }, "description": "Custom Report" } }, "tenant": { "title": "", "type": "string", "description": "Tenant identifier (required for TOKEN authentication)", "example": "string" } }, "description": "" } } }, "workday_adaptive_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/workday_adaptive_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "workday_financial_management_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_mode": { "title": "", "type": "object", "description": "Authentication Mode", "example": "BASIC | OAUTH", "enum": [ "BASIC", "OAUTH" ] }, "domain_host_name": { "title": "", "type": "string", "description": "Workday host name.", "example": "your_workday_hostname" }, "password": { "title": "", "type": "string", "description": "Workday password.", "format": "password", "example": "your_workday_password" }, "tenant": { "title": "", "type": "string", "description": "Workday tenant name", "example": "your_workday_tenant" }, "username": { "title": "", "type": "string", "description": "Workday username.", "example": "your_workday_username" } }, "description": "" } } }, "workday_financial_management_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "ID of your Workday Client App", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Secret of your Workday Client App", "example": "string" }, "refresh_token": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "workday_financial_management_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for workday password.", "example": "PASSWORD_KEY" }, "username": { "title": "", "type": "string", "description": "ESM key for workday username.", "example": "USERNAME_KEY" } }, "description": "" } } }, "workday_financial_management_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/workday_financial_management_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/workday_financial_management_auth_V1" }, { "$ref": "#/components/schemas/workday_financial_management_esm_keys_config_V1" } ] }, "workday_hcm_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_mode": { "title": "", "type": "object", "description": "Authentication Mode", "example": "BASIC | OAUTH", "enum": [ "BASIC", "OAUTH" ] }, "domain_host_name": { "title": "", "type": "string", "description": "Workday host name.", "example": "your_workday_host_name" }, "integration_system_id": { "title": "", "type": "string", "description": "Integration System ID", "example": "integration_system_id" }, "password": { "title": "", "type": "string", "description": "Workday password.", "format": "password", "example": "workday_password" }, "subscriber_id": { "title": "", "type": "string", "description": "WID of the Workday Integration Transaction Log Service subscriber. Used to scope the V2 optimised history transaction-log queries to a specific integration subscriber.", "example": "subscriber_id" }, "tenant": { "title": "", "type": "string", "description": "Workday tenant name", "example": "string" }, "username": { "title": "", "type": "string", "description": "Username of your Workday Integration System User account", "example": "workday_username" } }, "description": "" } } }, "workday_hcm_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "ID of your Workday Client App", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Secret of your Workday Client App", "example": "string" }, "refresh_token": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "workday_hcm_esm_keys_config_V1": { "properties": { "external_secrets_keys_config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "ESM key for workday password.", "example": "PASSWORD_KEY" }, "username": { "title": "", "type": "string", "description": "ESM key for username of your Workday Integration System User account", "example": "USERNAME_KEY" } }, "description": "" } } }, "workday_hcm_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/workday_hcm_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/workday_hcm_auth_V1" }, { "$ref": "#/components/schemas/workday_hcm_esm_keys_config_V1" } ] }, "workday_strategic_sourcing_config_V1": { "properties": { "config": { "type": "object", "properties": { "region": { "type": "object", "description": "Your Workday Strategic Sourcing Region.", "enum": [ "eu", "us", "ca" ] }, "x_api_key": { "title": "", "type": "string", "description": "Your Workday Strategic Sourcing X API key.", "format": "password", "example": "your_workday_strategic_sourcing_api_key" }, "x_user_email": { "title": "", "type": "string", "description": "Your Workday Strategic Sourcing X User Email.", "example": "your_workday_strategic_sourcing_user_email" }, "x_user_token": { "title": "", "type": "string", "description": "Your Workday Strategic Sourcing X User Token.", "format": "password", "example": "your_workday_strategic_sourcing_user_token" } }, "description": "" } } }, "workday_strategic_sourcing_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/workday_strategic_sourcing_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "workleap_officevibe_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Workleap Officevibe API key.", "format": "password", "example": "your_workleap_officevibe_api_key" } }, "description": "" } } }, "workleap_officevibe_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/workleap_officevibe_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema_table" } ] }, "workramp_config_V1": { "properties": { "config": { "type": "object", "properties": { "academy_id": { "title": "", "type": "string", "description": "Your WorkRamp academy ID.", "example": "your_workramp_academy_id" }, "access_token": { "title": "", "type": "string", "description": "Your WorkRamp access token.", "format": "password", "example": "your_workramp_access_token" } }, "description": "" } } }, "workramp_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/workramp_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "wrike_config_V1": { "properties": { "config": { "type": "object", "properties": { "plan": { "type": "object", "description": "Your Wrike Subscription Plan.", "enum": [ "{\"folder_project\":\"[customColumnIds,superParentIds,customItemTypeId,metadata,attachmentCount,customFields,space]\",\"folder_task\":\"[authorIds,hasAttachments,attachmentCount,parentIds,superParentIds,sharedIds,responsibleIds,description,briefDescription,followerIds,recurrent,superTaskIds,subTaskIds,dependencyIds,metadata,customFields,customItemTypeId,effortAllocation]\",\"space_task\":\"[authorIds,hasAttachments,attachmentCount,parentIds,superParentIds,sharedIds,responsibleIds,description,briefDescription,followerIds,recurrent,superTaskIds,subTaskIds,dependencyIds,metadata,customFields,customItemTypeId,effortAllocation]\"}", "{\"folder_project\":\"[customColumnIds,superParentIds,customItemTypeId,attachmentCount,space,customFields,metadata]\",\"folder_task\":\"[authorIds,hasAttachments,attachmentCount,parentIds,superParentIds,sharedIds,responsibleIds,description,briefDescription,followerIds,recurrent,superTaskIds,subTaskIds,dependencyIds,effortAllocation,customFields,customItemTypeId,metadata]\",\"space_task\":\"[authorIds,hasAttachments,attachmentCount,parentIds,superParentIds,sharedIds,responsibleIds,description,briefDescription,followerIds,recurrent,superTaskIds,subTaskIds,dependencyIds,effortAllocation,customFields,customItemTypeId,metadata]\"}", "{\"folder_project\":\"[customColumnIds,superParentIds,customItemTypeId,metadata,attachmentCount,space,customFields]\",\"folder_task\":\"[authorIds,hasAttachments,attachmentCount,parentIds,superParentIds,sharedIds,responsibleIds,description,briefDescription,followerIds,recurrent,superTaskIds,subTaskIds,dependencyIds,metadata,customFields,effortAllocation,customItemTypeId]\",\"space_task\":\"[authorIds,hasAttachments,attachmentCount,parentIds,superParentIds,sharedIds,responsibleIds,description,briefDescription,followerIds,recurrent,superTaskIds,subTaskIds,dependencyIds,metadata,customFields,effortAllocation,customItemTypeId]\"}", "{\"folder_project\":\"[customColumnIds,superParentIds,customItemTypeId,metadata,space,customFields,attachmentCount]\",\"folder_task\":\"[authorIds,hasAttachments,attachmentCount,parentIds,superParentIds,sharedIds,responsibleIds,description,briefDescription,followerIds,recurrent,superTaskIds,subTaskIds,dependencyIds,metadata,customItemTypeId,effortAllocation,customFields]\",\"space_task\":\"[authorIds,hasAttachments,attachmentCount,parentIds,superParentIds,sharedIds,responsibleIds,description,briefDescription,followerIds,recurrent,superTaskIds,subTaskIds,dependencyIds,metadata,customItemTypeId,effortAllocation,customFields]\"}", "{\"folder_project\":\"[customColumnIds,superParentIds,customItemTypeId,metadata,attachmentCount,space,customFields,contractType]\",\"folder_task\":\"[authorIds,hasAttachments,attachmentCount,parentIds,superParentIds,sharedIds,responsibleIds,responsiblePlaceholderIds,description,briefDescription,followerIds,recurrent,superTaskIds,subTaskIds,dependencyIds,metadata,customFields,effortAllocation,billingType,finance,customItemTypeId]\",\"space_task\":\"[authorIds,hasAttachments,attachmentCount,parentIds,superParentIds,sharedIds,responsibleIds,responsiblePlaceholderIds,description,briefDescription,followerIds,recurrent,superTaskIds,subTaskIds,dependencyIds,metadata,customFields,effortAllocation,billingType,customItemTypeId]\"}" ] }, "sub_domain": { "type": "object", "description": "Your Wrike Subdomain.", "enum": [ "app-us2.wrike.com", "www.wrike.com", "app-eu.wrike.com" ] } }, "description": "" } } }, "wrike_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "wrike_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/wrike_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/wrike_auth_V1" } ] }, "writesonic_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Writesonic API key.", "format": "password", "example": "your_writesonic_api_key" }, "project_website_url": { "title": "", "type": "string", "description": "Website URL of your Writesonic project.", "example": "your_writesonic_project_website_url" } }, "description": "" } } }, "writesonic_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/writesonic_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "xactly_config_V1": { "properties": { "config": { "type": "object", "properties": { "application_id": { "title": "", "type": "string", "description": "Your Xactly Application ID.", "example": "your_xactly_application_id" }, "connect_password": { "title": "", "type": "string", "description": "Your Xactly Connect password.", "format": "password", "example": "your_xactly_connect_password" }, "connect_username": { "title": "", "type": "string", "description": "Your Xactly Connect username.", "example": "your_xactly_connect_username" }, "consumer_name": { "title": "", "type": "string", "description": "Your Xactly Connect consumer name.", "example": "your_xactly_consumer_name" }, "environment": { "type": "object", "description": "Your Xactly environment.", "enum": [ "api", "api-sandbox", "api-implement" ] }, "environment_host": { "title": "", "type": "string", "description": "Your Xactly environment host.", "example": "your_xactly_environment_host" } }, "description": "" } } }, "xactly_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/xactly_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "xandr_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your Xandr password.", "format": "password", "example": "string" }, "username": { "title": "", "type": "string", "description": "Your Xandr username.", "example": "string" } }, "description": "" } } }, "xandr_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/xandr_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "xero_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "your clientId", "example": "xero_client_id" }, "client_secret": { "title": "", "type": "string", "description": "your clientSecret", "format": "password", "example": "xero_client_secret" }, "use_webhooks": { "title": "", "type": "boolean", "description": "Updates to few fields like sent_to_contact in Invoice table might be missed if you don't enable this.", "example": true }, "webhook_key": { "title": "", "type": "string", "description": "Webhook Key", "example": "string" } }, "description": "" } } }, "xero_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/xero_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "xray_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Xray Client ID.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Your Xray Client Secret.", "format": "password", "example": "string" }, "region": { "type": "object", "description": "Your Xray region.", "enum": [ "au.xray.cloud.getxray.app", "xray.cloud.getxray.app", "us.xray.cloud.getxray.app", "eu.xray.cloud.getxray.app" ] } }, "description": "" } } }, "xray_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/xray_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "xsolla_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Xsolla API key.", "format": "password", "example": "your_xsolla_api_key" }, "merchant_id": { "title": "", "type": "string", "description": "Your Xsolla Merchant ID.", "example": "your_xsolla_merchant_id" } }, "description": "" } } }, "xsolla_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/xsolla_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "yahoo_display_ads_on_yahoo_japan_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Yahoo Display Ads on Yahoo Japan client ID.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Your Yahoo Display Ads on Yahoo Japan client secret.", "format": "password", "example": "string" } }, "description": "" } } }, "yahoo_display_ads_on_yahoo_japan_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "yahoo_display_ads_on_yahoo_japan_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/yahoo_display_ads_on_yahoo_japan_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/yahoo_display_ads_on_yahoo_japan_auth_V1" } ] }, "yahoo_dsp_config_V1": { "properties": { "config": { "type": "object", "properties": { "advertisers_with_seat": { "title": "", "type": "array", "description": "Specific Advertisers to sync. Must be populated if `sync_mode_advertiser` is set to `SPECIFIC_ADVERTISERS`. Pay attention to the format: `AdvertiserId:SeatId`", "example": "[\"1234578:987\", \"19283411:999\"]", "items": { "title": "", "type": "string", "description": "", "example": "string" } }, "report_configs": { "title": "", "type": "array", "description": "Specify the reports you want to sync. This is optional.", "items": { "title": "", "type": "object", "properties": { "config_type": { "title": "", "type": "object", "description": "Set the value to `PREBUILT` if it's one of the preconfigured reports (see the `prebuilt_report_type` option). Otherwise, set to `CUSTOM`.", "example": "CUSTOM | PREBUILT", "enum": [ "CUSTOM", "PREBUILT" ] }, "currency": { "title": "", "type": "object", "description": "[Currency](https://developer.yahooinc.com/dsp/api/docs/reporting/payloadspec.html) used in a report. Default value: `USD`.", "example": "SEAT | USD | ADVERTISER | CAMPAIGN", "enum": [ "SEAT", "USD", "ADVERTISER", "CAMPAIGN" ] }, "dimensions": { "title": "", "type": "array", "description": "[Dimensions](https://developer.yahooinc.com/dsp/api/docs/reporting/dimensions.html) used in a report. Must be populated if `config_type` is set to `CUSTOM`. PUBLISHER, DESKTOP_OS_DEPRECATED, LINE_TYPE, GOAL_TYPE, BID_REQUEST_AD_SIZE, CHANNEL_TYPE, SITE_NAME, and SITE_GROUP_NAME are deprecated dimension, and shouldn't be used anymore", "example": [ "CONNECTION_TYPE | PACKAGE_END_DATE | PACKAGE_BUDGET_DISTRIBUTOR | LINE_DAILY_BUDGET_SCHEDULE | APP_NAME | CONTENT_CHANNEL | LINE_SCHEDULE_NAME | CAMPAIGN_DAILY_BUDGET_SCHEDULE | DYNAMIC_CREATIVE_VARIATION | PACKAGE_SCHEDULE_START_DATE | LINE_BILLING_METHOD | NATIVE_TYPE | DAYS_TO_CONVERSION | GOAL_TYPE | PACKAGE_TOTAL_BUDGET | NATIVE_SITE | CHANNEL_TYPE | PACKAGE_SCHEDULE_NAME | EXCHANGE | CAMPAIGN_SCHEDULE_NAME | ADVERTISER | FREQUENCY_BUCKET_30D | AD | CONNECTED_TV_MODEL | CAMPAIGN_END_DATE | REGION | SUBDOMAIN | LINE_END_DATE | DESKTOP_OS | LINE_BUDGET_PACING | DOMAIN | CAMPAIGN_TOTAL_BUDGET | LAYOUT | LINE_DAILY_BUDGET | LINE_SCHEDULE_END_DATE | BROWSER_TYPE | INVENTORY_AUCTION_TYPE | DEAL_TYPE | ADVERTISER_SUB_CATEGORY | BUCKETED_AGE | ADVERTISER_CATEGORY_ID | PACKAGE_DAILY_BUDGET_SCHEDULE | OTHER_COST_NAME | POSTAL_CODE | CONTENT_SHOW | SITE_GROUP_NAME | LINE_START_DATE | CAMPAIGN | CONTENT_GENRE | CAMPAIGN_START_DATE | LINE_GOAL_TYPE | CREATIVE_CUSTOM_ID | ISP | LINE_TYPE | CITY | CREATIVE_FORMAT | PACKAGE_DAILY_BUDGET | VIDEO_AD_PLACEMENT | CAMPAIGN_DAILY_BUDGET | LINE_TOTAL_BUDGET | PUBLISHER | CAMPAIGN_CURRENT_SCHEDULE_TOTAL_BUDGET | AUDIENCE_MEASUREMENT_COST_NAME | CREATIVE | PIXEL_PARAMETER | PACKAGE_CURRENT_SCHEDULE_TOTAL_BUDGET | CONTENT_TITLE | SEAT_ID | SITE_NAME | LINE_FLIGHT | INVENTORY_TYPE | COUNTRY | PACKAGE | ADVERTISER_GROUP | AD_SERVING_COST_NAME | DEMO_VENDOR | CAMPAIGN_SCHEDULE_END_DATE | MARKET_AREA | LINE_PACING_ACCELERATION | DEVICE_TYPE | MOBILE_MAKE | NATIVE_SITE_GROUP | DESKTOP_OS_DEPRECATED | FREQUENCY_BUCKET_7D | DEVICE_CATEGORY | VIDEO_CREATIVE_DURATION | CONNECTED_TV_DEVICE | DYNAMIC_CREATIVE_SET | DOT_RULE | CONNECTED_TV_MAKE | PACKAGE_BUDGET_SCHEDULE | PACKAGE_SCHEDULE_END_DATE | FREQUENCY_BUCKET_1D | LINE_CHANNEL_TYPE | WEATHER_CONDITION | LINE | EXCHANGE_DEAL_ID | GENDER | VIDEO_CONTENT_LENGTH | AGE | LINE_CURRENT_SCHEDULE_TOTAL_BUDGET | CONTENT_NETWORK | SUPPLY_GROUP | BID_REQUEST_DIMENSIONS | VIDEO_PLAYER_SIZE | TARGET_AUDIENCE_ID_GROUP_B | TARGET_AUDIENCE_ID_GROUP_A | MOBILE_OS | PIXEL | LINE_SCHEDULE_START_DATE | AD_POSITION | BID_REQUEST_AD_SIZE | ADS_TXT_DECLARATION | MOBILE_CARRIER | MOBILE_MODEL | PARENT_LINE" ], "items": { "title": "", "type": "object", "description": "", "example": "CONNECTION_TYPE | PACKAGE_END_DATE | PACKAGE_BUDGET_DISTRIBUTOR | LINE_DAILY_BUDGET_SCHEDULE | APP_NAME | CONTENT_CHANNEL | LINE_SCHEDULE_NAME | CAMPAIGN_DAILY_BUDGET_SCHEDULE | DYNAMIC_CREATIVE_VARIATION | PACKAGE_SCHEDULE_START_DATE | LINE_BILLING_METHOD | NATIVE_TYPE | DAYS_TO_CONVERSION | GOAL_TYPE | PACKAGE_TOTAL_BUDGET | NATIVE_SITE | CHANNEL_TYPE | PACKAGE_SCHEDULE_NAME | EXCHANGE | CAMPAIGN_SCHEDULE_NAME | ADVERTISER | FREQUENCY_BUCKET_30D | AD | CONNECTED_TV_MODEL | CAMPAIGN_END_DATE | REGION | SUBDOMAIN | LINE_END_DATE | DESKTOP_OS | LINE_BUDGET_PACING | DOMAIN | CAMPAIGN_TOTAL_BUDGET | LAYOUT | LINE_DAILY_BUDGET | LINE_SCHEDULE_END_DATE | BROWSER_TYPE | INVENTORY_AUCTION_TYPE | DEAL_TYPE | ADVERTISER_SUB_CATEGORY | BUCKETED_AGE | ADVERTISER_CATEGORY_ID | PACKAGE_DAILY_BUDGET_SCHEDULE | OTHER_COST_NAME | POSTAL_CODE | CONTENT_SHOW | SITE_GROUP_NAME | LINE_START_DATE | CAMPAIGN | CONTENT_GENRE | CAMPAIGN_START_DATE | LINE_GOAL_TYPE | CREATIVE_CUSTOM_ID | ISP | LINE_TYPE | CITY | CREATIVE_FORMAT | PACKAGE_DAILY_BUDGET | VIDEO_AD_PLACEMENT | CAMPAIGN_DAILY_BUDGET | LINE_TOTAL_BUDGET | PUBLISHER | CAMPAIGN_CURRENT_SCHEDULE_TOTAL_BUDGET | AUDIENCE_MEASUREMENT_COST_NAME | CREATIVE | PIXEL_PARAMETER | PACKAGE_CURRENT_SCHEDULE_TOTAL_BUDGET | CONTENT_TITLE | SEAT_ID | SITE_NAME | LINE_FLIGHT | INVENTORY_TYPE | COUNTRY | PACKAGE | ADVERTISER_GROUP | AD_SERVING_COST_NAME | DEMO_VENDOR | CAMPAIGN_SCHEDULE_END_DATE | MARKET_AREA | LINE_PACING_ACCELERATION | DEVICE_TYPE | MOBILE_MAKE | NATIVE_SITE_GROUP | DESKTOP_OS_DEPRECATED | FREQUENCY_BUCKET_7D | DEVICE_CATEGORY | VIDEO_CREATIVE_DURATION | CONNECTED_TV_DEVICE | DYNAMIC_CREATIVE_SET | DOT_RULE | CONNECTED_TV_MAKE | PACKAGE_BUDGET_SCHEDULE | PACKAGE_SCHEDULE_END_DATE | FREQUENCY_BUCKET_1D | LINE_CHANNEL_TYPE | WEATHER_CONDITION | LINE | EXCHANGE_DEAL_ID | GENDER | VIDEO_CONTENT_LENGTH | AGE | LINE_CURRENT_SCHEDULE_TOTAL_BUDGET | CONTENT_NETWORK | SUPPLY_GROUP | BID_REQUEST_DIMENSIONS | VIDEO_PLAYER_SIZE | TARGET_AUDIENCE_ID_GROUP_B | TARGET_AUDIENCE_ID_GROUP_A | MOBILE_OS | PIXEL | LINE_SCHEDULE_START_DATE | AD_POSITION | BID_REQUEST_AD_SIZE | ADS_TXT_DECLARATION | MOBILE_CARRIER | MOBILE_MODEL | PARENT_LINE", "enum": [ "CONNECTION_TYPE", "PACKAGE_END_DATE", "PACKAGE_BUDGET_DISTRIBUTOR", "LINE_DAILY_BUDGET_SCHEDULE", "APP_NAME", "CONTENT_CHANNEL", "LINE_SCHEDULE_NAME", "CAMPAIGN_DAILY_BUDGET_SCHEDULE", "DYNAMIC_CREATIVE_VARIATION", "PACKAGE_SCHEDULE_START_DATE", "LINE_BILLING_METHOD", "NATIVE_TYPE", "DAYS_TO_CONVERSION", "GOAL_TYPE", "PACKAGE_TOTAL_BUDGET", "NATIVE_SITE", "CHANNEL_TYPE", "PACKAGE_SCHEDULE_NAME", "EXCHANGE", "CAMPAIGN_SCHEDULE_NAME", "ADVERTISER", "FREQUENCY_BUCKET_30D", "AD", "CONNECTED_TV_MODEL", "CAMPAIGN_END_DATE", "REGION", "SUBDOMAIN", "LINE_END_DATE", "DESKTOP_OS", "LINE_BUDGET_PACING", "DOMAIN", "CAMPAIGN_TOTAL_BUDGET", "LAYOUT", "LINE_DAILY_BUDGET", "LINE_SCHEDULE_END_DATE", "BROWSER_TYPE", "INVENTORY_AUCTION_TYPE", "DEAL_TYPE", "ADVERTISER_SUB_CATEGORY", "BUCKETED_AGE", "ADVERTISER_CATEGORY_ID", "PACKAGE_DAILY_BUDGET_SCHEDULE", "OTHER_COST_NAME", "POSTAL_CODE", "CONTENT_SHOW", "SITE_GROUP_NAME", "LINE_START_DATE", "CAMPAIGN", "CONTENT_GENRE", "CAMPAIGN_START_DATE", "LINE_GOAL_TYPE", "CREATIVE_CUSTOM_ID", "ISP", "LINE_TYPE", "CITY", "CREATIVE_FORMAT", "PACKAGE_DAILY_BUDGET", "VIDEO_AD_PLACEMENT", "CAMPAIGN_DAILY_BUDGET", "LINE_TOTAL_BUDGET", "PUBLISHER", "CAMPAIGN_CURRENT_SCHEDULE_TOTAL_BUDGET", "AUDIENCE_MEASUREMENT_COST_NAME", "CREATIVE", "PIXEL_PARAMETER", "PACKAGE_CURRENT_SCHEDULE_TOTAL_BUDGET", "CONTENT_TITLE", "SEAT_ID", "SITE_NAME", "LINE_FLIGHT", "INVENTORY_TYPE", "COUNTRY", "PACKAGE", "ADVERTISER_GROUP", "AD_SERVING_COST_NAME", "DEMO_VENDOR", "CAMPAIGN_SCHEDULE_END_DATE", "MARKET_AREA", "LINE_PACING_ACCELERATION", "DEVICE_TYPE", "MOBILE_MAKE", "NATIVE_SITE_GROUP", "DESKTOP_OS_DEPRECATED", "FREQUENCY_BUCKET_7D", "DEVICE_CATEGORY", "VIDEO_CREATIVE_DURATION", "CONNECTED_TV_DEVICE", "DYNAMIC_CREATIVE_SET", "DOT_RULE", "CONNECTED_TV_MAKE", "PACKAGE_BUDGET_SCHEDULE", "PACKAGE_SCHEDULE_END_DATE", "FREQUENCY_BUCKET_1D", "LINE_CHANNEL_TYPE", "WEATHER_CONDITION", "LINE", "EXCHANGE_DEAL_ID", "GENDER", "VIDEO_CONTENT_LENGTH", "AGE", "LINE_CURRENT_SCHEDULE_TOTAL_BUDGET", "CONTENT_NETWORK", "SUPPLY_GROUP", "BID_REQUEST_DIMENSIONS", "VIDEO_PLAYER_SIZE", "TARGET_AUDIENCE_ID_GROUP_B", "TARGET_AUDIENCE_ID_GROUP_A", "MOBILE_OS", "PIXEL", "LINE_SCHEDULE_START_DATE", "AD_POSITION", "BID_REQUEST_AD_SIZE", "ADS_TXT_DECLARATION", "MOBILE_CARRIER", "MOBILE_MODEL", "PARENT_LINE" ] } }, "interval_type": { "title": "", "type": "object", "description": "The [granularity](https://developer.yahooinc.com/dsp/api/docs/reporting/range-examples.html#interval-type-id) of data in a report. Default value: `DAY`.", "example": "MONTH | HOUR | CUMULATIVE | WEEK | DAY", "enum": [ "MONTH", "HOUR", "CUMULATIVE", "WEEK", "DAY" ] }, "metrics": { "title": "", "type": "array", "description": "[Metrics](https://developer.yahooinc.com/dsp/api/docs/reporting/metrics.html) used in a report. Must be populated if `config_type` is set to `CUSTOM`. PUBLISHER_EARNINGS, PUBLISHER_EARNINGS_PERCENTAGE, INVENTORY_ECPM_DEPRECATED, SEAT_TECH_FEE, and SEAT_DATA_FEE are deprecated and shouldn't be used anymore", "example": [ "CTR | AD_SERVING_COST | IMPRESSION_DISTRIBUTION_NONMEASURABLE | BID_CPM_ADVERTISER_CURRENCY | SEAT_DATA_FEE | CLICK_THROUGH_CPA | AVAILABLE_BID_REQUESTS | COMPLETION_RATE_75 | ROAS | YAHOO_NON_MEASURABLE_IMPRESSIONS | BID_PRICE_WITHOUT_MULTIPLIER_ADVERTISER_CURRENCY | VIEW_THROUGH_CONVERSION_RATE | COMPLETION_RATE_100 | TOTAL_DATA_FEE | ADVERTISER_ECPM | YAHOO_VIEWABLE_IMPRESSIONS | VIEW_THROUGH_CONVERSION | NETWORK_ECPM | NETWORK_PROFIT_PERCENTAGE | VERY_FIRST_CONVERSION | AUDIENCE_IMPRESSIONS | MOAT_MEASURABLE_IMPRESSIONS | FILTERED_COMPANION_IMPRESSIONS | INVENTORY_COST | VERY_FIRST_CLICK_THROUGH_CONVERSION_VALUE | SEAT_MANAGEMENT_FEE | VCPM | MOAT_AVOC | ORDER_MANAGEMENT_FEE | DROP_RATE_AT_75 | DYNAMIC_CONVERSION_VALUE | COMPLETIONS_75 | ADVERTISER_SPENDING | CLICKS | UNIQUE_CLICK_THROUGH_CONVERTERS | CLICK_THROUGH_CONVERSION_VALUE | START_VIEWS | BID_PRICE_WITHOUT_MULTIPLIER_ORDER_CURRENCY | IMPRESSION_DISTRIBUTION_VIEWABLE | MOAT_AVFH | MAIL_AD_SAVES_RATE | YAHOO_MEASURABLE_IMPRESSIONS | AVERAGE_WIN_RATE | IMPRESSIONS | INVENTORY_ECPM_DEPRECATED | IMPRESSION_DISTRIBUTION_NONVIEWABLE | CONVERSION_VALUE | SEAT_TECH_FEE | MAIL_AD_OPENS | FILTERED_IMPRESSIONS | MAIL_AD_FORWARDS | TOTAL_VENDOR_FEE | OTHER_COST | MAIL_AD_FORM_SUBMITS | CPA | VIEWABIILITY_COST | CPC | MOAT_VIEWABLE_IMPRESSIONS | CNVR | MOAT_AVOC_RATE | ESTIMATED_NUMBER_OF_STORE_VISITS | YAHOO_VIEWABLE_RATE | TOTAL_VARIABLE_COST | NETWORK_PROFIT | BID_CPM_SEAT_CURRENCY | YAHOO_DATA_FEES | COMPLETIONS_50 | DROP_RATE_AT_50 | UNIQUE_CONVERTERS | COMPANION_CLICKS | UNIQUE_VIEW_THROUGH_CONVERTERS | COMPLETIONS_100 | CLICK_THROUGH_CONVERSION | ESTIMATED_UNIQUE_STORE_VISITORS | MOAT_MEASURABILITY_RATE | CONVERSION | AVERAGE_FREQUENCY_PER_HOUSEHOLD | THIRD_PARTY_DATA_FEES | COMPLETION_RATE_25 | ESTIMATED_STORE_VISIT_THROUGH_RATE_VTR | MAIL_AD_CLICK_OUTS_RATE | YAHOO_SEGMENT_FEE | THIRD_PARTY_SEGMENT_FEE | VIEW_THROUGH_CONVERSION_VALUE | VERY_FIRST_VIEW_THROUGH_CONVERSION | BID_CPM_ORDER_CURRENCY | YAHOO_MEASURABLE_RATE | BID_PRICE_WITHOUT_MULTIPLIER | VERY_FIRST_CLICK_THROUGH_CONVERSION | CPCV | BRAND_SAFETY_COST | UNIQUE_VIEWERS | COMPLETION_RATE_50 | SKIPPED_ADS | ESTIMATED_COST_PER_STORE_VISIT_CPSV | BID_CPM | MAIL_AD_CLICK_OUTS | PUBLISHER_EARNINGS | AVERAGE_FREQUENCY | MULTIPLIED_ECPM | DROP_RATE_AT_25 | MAIL_AD_FORWARD_RATE | NON_VIEWABLE_IMPRESSIONS | AVERAGE_IMPRESSION_MULTIPLIER | PUBLISHER_EARNINGS_PERCENTAGE | MAIL_AD_SUBMIT_RATE | FILTERED_COMPANION_CLICKS | AD_VERIFICATION_COST | MOAT_IMPRESSIONS_ANALYZED | COMPLETIONS_25 | CROSS_DEVICE_CONVERSIONS | PLATFORM_FEE | AUDIENCE_MEASUREMENT_COST | BID_RESPONSES | VIEW_THROUGH_CPA | COMPANION_IMPRESSIONS | ESTIMATED_BILLABLE_AMOUNT | INVENTORY_COST_PERCENTAGE | MAIL_AD_SAVES | VERY_FIRST_VIEW_THROUGH_CONVERSION_VALUE | BID_PRICE_WITHOUT_MULTIPLIER_SEAT_CURRENCY | DROP_RATE_AT_0 | AVERAGE_PEOPLE_FREQUENCY | CLICK_THROUGH_CONVERSION_RATE | MOAT_VIEWABLE_RATE | INVENTORY_ECPM | COST_PER_VALID_VIDEO_VIEW_CPV | FILTERED_CLICKS | QUALIFIED_BID_REQUESTS" ], "items": { "title": "", "type": "object", "description": "", "example": "CTR | AD_SERVING_COST | IMPRESSION_DISTRIBUTION_NONMEASURABLE | BID_CPM_ADVERTISER_CURRENCY | SEAT_DATA_FEE | CLICK_THROUGH_CPA | AVAILABLE_BID_REQUESTS | COMPLETION_RATE_75 | ROAS | YAHOO_NON_MEASURABLE_IMPRESSIONS | BID_PRICE_WITHOUT_MULTIPLIER_ADVERTISER_CURRENCY | VIEW_THROUGH_CONVERSION_RATE | COMPLETION_RATE_100 | TOTAL_DATA_FEE | ADVERTISER_ECPM | YAHOO_VIEWABLE_IMPRESSIONS | VIEW_THROUGH_CONVERSION | NETWORK_ECPM | NETWORK_PROFIT_PERCENTAGE | VERY_FIRST_CONVERSION | AUDIENCE_IMPRESSIONS | MOAT_MEASURABLE_IMPRESSIONS | FILTERED_COMPANION_IMPRESSIONS | INVENTORY_COST | VERY_FIRST_CLICK_THROUGH_CONVERSION_VALUE | SEAT_MANAGEMENT_FEE | VCPM | MOAT_AVOC | ORDER_MANAGEMENT_FEE | DROP_RATE_AT_75 | DYNAMIC_CONVERSION_VALUE | COMPLETIONS_75 | ADVERTISER_SPENDING | CLICKS | UNIQUE_CLICK_THROUGH_CONVERTERS | CLICK_THROUGH_CONVERSION_VALUE | START_VIEWS | BID_PRICE_WITHOUT_MULTIPLIER_ORDER_CURRENCY | IMPRESSION_DISTRIBUTION_VIEWABLE | MOAT_AVFH | MAIL_AD_SAVES_RATE | YAHOO_MEASURABLE_IMPRESSIONS | AVERAGE_WIN_RATE | IMPRESSIONS | INVENTORY_ECPM_DEPRECATED | IMPRESSION_DISTRIBUTION_NONVIEWABLE | CONVERSION_VALUE | SEAT_TECH_FEE | MAIL_AD_OPENS | FILTERED_IMPRESSIONS | MAIL_AD_FORWARDS | TOTAL_VENDOR_FEE | OTHER_COST | MAIL_AD_FORM_SUBMITS | CPA | VIEWABIILITY_COST | CPC | MOAT_VIEWABLE_IMPRESSIONS | CNVR | MOAT_AVOC_RATE | ESTIMATED_NUMBER_OF_STORE_VISITS | YAHOO_VIEWABLE_RATE | TOTAL_VARIABLE_COST | NETWORK_PROFIT | BID_CPM_SEAT_CURRENCY | YAHOO_DATA_FEES | COMPLETIONS_50 | DROP_RATE_AT_50 | UNIQUE_CONVERTERS | COMPANION_CLICKS | UNIQUE_VIEW_THROUGH_CONVERTERS | COMPLETIONS_100 | CLICK_THROUGH_CONVERSION | ESTIMATED_UNIQUE_STORE_VISITORS | MOAT_MEASURABILITY_RATE | CONVERSION | AVERAGE_FREQUENCY_PER_HOUSEHOLD | THIRD_PARTY_DATA_FEES | COMPLETION_RATE_25 | ESTIMATED_STORE_VISIT_THROUGH_RATE_VTR | MAIL_AD_CLICK_OUTS_RATE | YAHOO_SEGMENT_FEE | THIRD_PARTY_SEGMENT_FEE | VIEW_THROUGH_CONVERSION_VALUE | VERY_FIRST_VIEW_THROUGH_CONVERSION | BID_CPM_ORDER_CURRENCY | YAHOO_MEASURABLE_RATE | BID_PRICE_WITHOUT_MULTIPLIER | VERY_FIRST_CLICK_THROUGH_CONVERSION | CPCV | BRAND_SAFETY_COST | UNIQUE_VIEWERS | COMPLETION_RATE_50 | SKIPPED_ADS | ESTIMATED_COST_PER_STORE_VISIT_CPSV | BID_CPM | MAIL_AD_CLICK_OUTS | PUBLISHER_EARNINGS | AVERAGE_FREQUENCY | MULTIPLIED_ECPM | DROP_RATE_AT_25 | MAIL_AD_FORWARD_RATE | NON_VIEWABLE_IMPRESSIONS | AVERAGE_IMPRESSION_MULTIPLIER | PUBLISHER_EARNINGS_PERCENTAGE | MAIL_AD_SUBMIT_RATE | FILTERED_COMPANION_CLICKS | AD_VERIFICATION_COST | MOAT_IMPRESSIONS_ANALYZED | COMPLETIONS_25 | CROSS_DEVICE_CONVERSIONS | PLATFORM_FEE | AUDIENCE_MEASUREMENT_COST | BID_RESPONSES | VIEW_THROUGH_CPA | COMPANION_IMPRESSIONS | ESTIMATED_BILLABLE_AMOUNT | INVENTORY_COST_PERCENTAGE | MAIL_AD_SAVES | VERY_FIRST_VIEW_THROUGH_CONVERSION_VALUE | BID_PRICE_WITHOUT_MULTIPLIER_SEAT_CURRENCY | DROP_RATE_AT_0 | AVERAGE_PEOPLE_FREQUENCY | CLICK_THROUGH_CONVERSION_RATE | MOAT_VIEWABLE_RATE | INVENTORY_ECPM | COST_PER_VALID_VIDEO_VIEW_CPV | FILTERED_CLICKS | QUALIFIED_BID_REQUESTS", "enum": [ "CTR", "AD_SERVING_COST", "IMPRESSION_DISTRIBUTION_NONMEASURABLE", "BID_CPM_ADVERTISER_CURRENCY", "SEAT_DATA_FEE", "CLICK_THROUGH_CPA", "AVAILABLE_BID_REQUESTS", "COMPLETION_RATE_75", "ROAS", "YAHOO_NON_MEASURABLE_IMPRESSIONS", "BID_PRICE_WITHOUT_MULTIPLIER_ADVERTISER_CURRENCY", "VIEW_THROUGH_CONVERSION_RATE", "COMPLETION_RATE_100", "TOTAL_DATA_FEE", "ADVERTISER_ECPM", "YAHOO_VIEWABLE_IMPRESSIONS", "VIEW_THROUGH_CONVERSION", "NETWORK_ECPM", "NETWORK_PROFIT_PERCENTAGE", "VERY_FIRST_CONVERSION", "AUDIENCE_IMPRESSIONS", "MOAT_MEASURABLE_IMPRESSIONS", "FILTERED_COMPANION_IMPRESSIONS", "INVENTORY_COST", "VERY_FIRST_CLICK_THROUGH_CONVERSION_VALUE", "SEAT_MANAGEMENT_FEE", "VCPM", "MOAT_AVOC", "ORDER_MANAGEMENT_FEE", "DROP_RATE_AT_75", "DYNAMIC_CONVERSION_VALUE", "COMPLETIONS_75", "ADVERTISER_SPENDING", "CLICKS", "UNIQUE_CLICK_THROUGH_CONVERTERS", "CLICK_THROUGH_CONVERSION_VALUE", "START_VIEWS", "BID_PRICE_WITHOUT_MULTIPLIER_ORDER_CURRENCY", "IMPRESSION_DISTRIBUTION_VIEWABLE", "MOAT_AVFH", "MAIL_AD_SAVES_RATE", "YAHOO_MEASURABLE_IMPRESSIONS", "AVERAGE_WIN_RATE", "IMPRESSIONS", "INVENTORY_ECPM_DEPRECATED", "IMPRESSION_DISTRIBUTION_NONVIEWABLE", "CONVERSION_VALUE", "SEAT_TECH_FEE", "MAIL_AD_OPENS", "FILTERED_IMPRESSIONS", "MAIL_AD_FORWARDS", "TOTAL_VENDOR_FEE", "OTHER_COST", "MAIL_AD_FORM_SUBMITS", "CPA", "VIEWABIILITY_COST", "CPC", "MOAT_VIEWABLE_IMPRESSIONS", "CNVR", "MOAT_AVOC_RATE", "ESTIMATED_NUMBER_OF_STORE_VISITS", "YAHOO_VIEWABLE_RATE", "TOTAL_VARIABLE_COST", "NETWORK_PROFIT", "BID_CPM_SEAT_CURRENCY", "YAHOO_DATA_FEES", "COMPLETIONS_50", "DROP_RATE_AT_50", "UNIQUE_CONVERTERS", "COMPANION_CLICKS", "UNIQUE_VIEW_THROUGH_CONVERTERS", "COMPLETIONS_100", "CLICK_THROUGH_CONVERSION", "ESTIMATED_UNIQUE_STORE_VISITORS", "MOAT_MEASURABILITY_RATE", "CONVERSION", "AVERAGE_FREQUENCY_PER_HOUSEHOLD", "THIRD_PARTY_DATA_FEES", "COMPLETION_RATE_25", "ESTIMATED_STORE_VISIT_THROUGH_RATE_VTR", "MAIL_AD_CLICK_OUTS_RATE", "YAHOO_SEGMENT_FEE", "THIRD_PARTY_SEGMENT_FEE", "VIEW_THROUGH_CONVERSION_VALUE", "VERY_FIRST_VIEW_THROUGH_CONVERSION", "BID_CPM_ORDER_CURRENCY", "YAHOO_MEASURABLE_RATE", "BID_PRICE_WITHOUT_MULTIPLIER", "VERY_FIRST_CLICK_THROUGH_CONVERSION", "CPCV", "BRAND_SAFETY_COST", "UNIQUE_VIEWERS", "COMPLETION_RATE_50", "SKIPPED_ADS", "ESTIMATED_COST_PER_STORE_VISIT_CPSV", "BID_CPM", "MAIL_AD_CLICK_OUTS", "PUBLISHER_EARNINGS", "AVERAGE_FREQUENCY", "MULTIPLIED_ECPM", "DROP_RATE_AT_25", "MAIL_AD_FORWARD_RATE", "NON_VIEWABLE_IMPRESSIONS", "AVERAGE_IMPRESSION_MULTIPLIER", "PUBLISHER_EARNINGS_PERCENTAGE", "MAIL_AD_SUBMIT_RATE", "FILTERED_COMPANION_CLICKS", "AD_VERIFICATION_COST", "MOAT_IMPRESSIONS_ANALYZED", "COMPLETIONS_25", "CROSS_DEVICE_CONVERSIONS", "PLATFORM_FEE", "AUDIENCE_MEASUREMENT_COST", "BID_RESPONSES", "VIEW_THROUGH_CPA", "COMPANION_IMPRESSIONS", "ESTIMATED_BILLABLE_AMOUNT", "INVENTORY_COST_PERCENTAGE", "MAIL_AD_SAVES", "VERY_FIRST_VIEW_THROUGH_CONVERSION_VALUE", "BID_PRICE_WITHOUT_MULTIPLIER_SEAT_CURRENCY", "DROP_RATE_AT_0", "AVERAGE_PEOPLE_FREQUENCY", "CLICK_THROUGH_CONVERSION_RATE", "MOAT_VIEWABLE_RATE", "INVENTORY_ECPM", "COST_PER_VALID_VIDEO_VIEW_CPV", "FILTERED_CLICKS", "QUALIFIED_BID_REQUESTS" ] } }, "prebuilt_report_type": { "title": "", "type": "object", "description": "Specific report type to sync. Must be populated if `config_type` is set to `PREBUILT`.", "example": "REPORT_CONVERSIONS | REPORT_SITE_DOMAIN_PERFORMANCE | REPORT_BASIC | REPORT_AUDIENCE_SEGMENT | REPORT_CAMPAIGN_PERFORMANCE | REPORT_AD_PERFORMANCE | REPORT_LINE_PERFORMANCE | REPORT_DYNAMIC_PRODUCT_ADS", "enum": [ "REPORT_CONVERSIONS", "REPORT_SITE_DOMAIN_PERFORMANCE", "REPORT_BASIC", "REPORT_AUDIENCE_SEGMENT", "REPORT_CAMPAIGN_PERFORMANCE", "REPORT_AD_PERFORMANCE", "REPORT_LINE_PERFORMANCE", "REPORT_DYNAMIC_PRODUCT_ADS" ] }, "report_name": { "title": "", "type": "string", "description": "Table name in destination.", "example": "string" }, "time_zone": { "title": "", "type": "object", "description": "Specify the time zone to be used to request report data", "example": "ASIA_JAKARTA | AMERICA_NEW_YORK | ASIA_DUBAI | ASIA_KARACHI | AMERICA_HALIFAX | ASIA_JERUSALEM | AMERICA_MEXICO_CITY | EUROPE_PARIS | PACIFIC_AUCKLAND | AMERICA_SAO_PAULO | ASIA_SHANGHAI | AMERICA_LIMA | ETC_GMT | ASIA_DHAKA | AMERICA_ARGENTINA_BUENOS_AIRES | AMERICA_EL_SALVADOR | AMERICA_DENVER | AMERICA_SANTIAGO | ASIA_TOKYO | AUSTRALIA_PERTH | AMERICA_LOS_ANGELES | AUSTRALIA_SYDNEY | AMERICA_CHICAGO | EUROPE_LONDON | AMERICA_BOGOTA | AMERICA_PUERTO_RICO", "enum": [ "ASIA_JAKARTA", "AMERICA_NEW_YORK", "ASIA_DUBAI", "ASIA_KARACHI", "AMERICA_HALIFAX", "ASIA_JERUSALEM", "AMERICA_MEXICO_CITY", "EUROPE_PARIS", "PACIFIC_AUCKLAND", "AMERICA_SAO_PAULO", "ASIA_SHANGHAI", "AMERICA_LIMA", "ETC_GMT", "ASIA_DHAKA", "AMERICA_ARGENTINA_BUENOS_AIRES", "AMERICA_EL_SALVADOR", "AMERICA_DENVER", "AMERICA_SANTIAGO", "ASIA_TOKYO", "AUSTRALIA_PERTH", "AMERICA_LOS_ANGELES", "AUSTRALIA_SYDNEY", "AMERICA_CHICAGO", "EUROPE_LONDON", "AMERICA_BOGOTA", "AMERICA_PUERTO_RICO" ] }, "use_advertiser_timezone": { "title": "", "type": "boolean", "description": "Use advertiser timezone to request report data.", "example": true } }, "description": "Specify the reports you want to sync. This is optional." } }, "seats": { "title": "", "type": "array", "description": "Specific Seats to sync. Must be populated if `sync_mode_seat` is set to `SPECIFIC_SEATS`.", "example": [ 0 ], "items": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 } }, "sync_mode_advertiser": { "title": "", "type": "object", "description": "Whether to sync all advertisers or specific advertisers. Default value: `ALL_ADVERTISERS`.", "example": "SPECIFIC_ADVERTISERS | ALL_ADVERTISERS", "enum": [ "SPECIFIC_ADVERTISERS", "ALL_ADVERTISERS" ] }, "sync_mode_seat": { "title": "", "type": "object", "description": "Whether to sync all seats or specific seats. Default value: `ALL_SEATS`.", "example": "ALL_SEATS | SPECIFIC_SEATS", "enum": [ "ALL_SEATS", "SPECIFIC_SEATS" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months` worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `THREE`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "yahoo_dsp_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Yahoo DSP Client ID.", "example": "client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Yahoo DSP Client Secret.", "example": "client_secret" } }, "description": "" } } }, "yahoo_dsp_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/yahoo_dsp_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/yahoo_dsp_auth_V1" } ] }, "yahoo_gemini_config_V1": { "properties": { "config": { "type": "object", "properties": { "advertisers_id": { "title": "", "type": "array", "description": "Specific Advertiser IDs to sync. Must be populated if `syncMode` is set to `SpecificAccounts`.", "example": [ 0 ], "items": { "title": "", "type": "integer", "description": "", "format": "int32", "example": 0 } }, "sync_mode": { "title": "", "type": "object", "description": "Whether to sync all accounts or specific accounts. Default value: `SpecificAccounts`.", "example": "AllAccounts | SpecificAccounts", "enum": [ "AllAccounts", "SpecificAccounts" ] }, "timeframe_months": { "title": "", "type": "object", "description": "Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.", "example": "TWENTY_FOUR | SIX | ALL_TIME | TWELVE | THREE", "enum": [ "TWENTY_FOUR", "SIX", "ALL_TIME", "TWELVE", "THREE" ] } }, "description": "" } } }, "yahoo_gemini_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Yahoo Gemini client application.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Yahoo Gemini client application.", "example": "string" } }, "description": "Your application client access fields" } }, "description": "" } } }, "yahoo_gemini_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/yahoo_gemini_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/yahoo_gemini_auth_V1" } ] }, "yahoo_search_ads_yahoo_japan_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "yahoo_search_ads_yahoo_japan_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Yahoo Search Ads Access Token.", "format": "password", "example": "string" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } }, "refresh_token": { "title": "", "type": "string", "description": "Your Yahoo Search Ads Refresh Token.", "format": "password", "example": "string" } }, "description": "" } } }, "yahoo_search_ads_yahoo_japan_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/yahoo_search_ads_yahoo_japan_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/yahoo_search_ads_yahoo_japan_auth_V1" } ] }, "yext_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Yext API key.", "format": "password", "example": "your_yext_api_key" }, "subdomain": { "type": "object", "description": "Your Yext subdomain. ", "enum": [ "sbx-api.us", "api.us", "api.eu", "api", "sbx-api", "sbx-api.eu" ] } }, "description": "" } } }, "yext_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/yext_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "yotpo_config_V1": { "properties": { "config": { "type": "object", "properties": { "app_key": { "title": "", "type": "string", "description": "Your Yotpo app key.", "format": "password", "example": "string" } }, "description": "" } } }, "yotpo_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } } } }, "description": "" } } }, "yotpo_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/yotpo_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/yotpo_auth_V1" } ] }, "yougov_brandindex_config_V1": { "properties": { "config": { "type": "object", "properties": { "password": { "title": "", "type": "string", "description": "Your YouGov BrandIndex password.", "format": "password", "example": "your_yougov_brandindex_password" }, "username": { "title": "", "type": "string", "description": "Your YouGov BrandIndex username.", "example": "your_yougov_brandindex_username" } }, "description": "" } } }, "yougov_brandindex_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/yougov_brandindex_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "yougov_sport_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Yougov Sport API key.", "format": "password", "example": "your_yougov_sport_api_key" }, "client_id": { "title": "", "type": "string", "description": "Your Yougov Sport client ID.", "example": "string" }, "client_key": { "title": "", "type": "string", "description": "Your Yougov Sport client key.", "format": "password", "example": "your_yougov_sport_client_key" } }, "description": "" } } }, "yougov_sport_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/yougov_sport_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "younium_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_environment": { "type": "object", "description": "Your Younium auth environment. Use this parameter only if you want the connection to authenticate using OAuth 2.0.", "enum": [ "younium-identity-server-sandbox.azurewebsites.net", "younium-identity-server.azurewebsites.net" ] }, "auth_type": { "type": "object", "description": "The authentication method you want to use for your connection.", "enum": [ "jwt_auth", "oauth2" ] }, "client_id": { "title": "", "type": "string", "description": "Client ID of the personal access token you want to use to generate the JWT token. Use this parameter only if you want the connection to authenticate using a JWT token.", "example": "your_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Secret key of the personal access token you want to use to generate the JWT token. Use this parameter only if you want the connection to authenticate using a JWT token.", "format": "password", "example": "your_secret_key" }, "environment": { "type": "object", "description": "Your Younium API environment. Use this parameter only if you want the connection to authenticate using OAuth 2.0.", "enum": [ "apisanbox", "api.us", "api.sandbox.us", "api" ] }, "jwt_environment": { "type": "object", "description": "Your Younium API environment. Use this parameter only if you want the connection to authenticate using a JWT token.", "enum": [ "api.us", "api.sandbox.us", "api.sandbox", "api" ] }, "legal_entity_id": { "title": "", "type": "string", "description": "Your Younium legal entity ID.", "example": "your_younium_legal_entity_id" }, "password": { "title": "", "type": "string", "description": "Your Younium password. Use this parameter only if you want the connection to authenticate using OAuth 2.0.", "format": "password", "example": "your_younium_password" }, "username": { "title": "", "type": "string", "description": "Your Younium username. Use this parameter only if you want the connection to authenticate using OAuth 2.0.", "example": "your_younium_username" } }, "description": "" } } }, "younium_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/younium_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "youtube_analytics_config_V1": { "properties": { "config": { "type": "object", "properties": { "content_owner_id": { "title": "", "type": "string", "description": "Used only for Content Owner reports. The ID of the content owner for whom the API request is being made.", "example": "content_owner_id" }, "report_type": { "title": "", "type": "string", "description": "The name of report of which connector will sync the data.", "example": "string" } }, "description": "" } } }, "youtube_analytics_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Youtube client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Youtube client application.", "example": "my_client_secret" } }, "description": "External client credentials to access the connector source." }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token` along with the `client_id` and `client_secret` parameters carry the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "youtube_analytics_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/youtube_analytics_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/youtube_analytics_auth_V1" } ] }, "zendesk_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Deprecated: Use Confidential OAuth client authentication instead. Zendesk API tokens are auto-generated passwords in the Support admin interface.", "format": "password", "example": "api_token" }, "api_usage": { "title": "", "type": "number", "description": "Maximum Zendesk Api Usage allowed", "example": 50 }, "backward_sync_limit": { "title": "", "type": "string", "description": "Date Limit of the Historical Sync Time for selected tables. The format should be YYYY-MM-DD.", "example": "2023-01-11" }, "domain": { "title": "", "type": "string", "description": "Zendesk domain.", "example": "domain" }, "email": { "title": "", "type": "string", "description": "Zendesk email.", "example": "email" }, "historical_sync_time_frame": { "title": "", "type": "object", "description": "Used to configure Historical sync timeframe for selected tables.", "example": "ALL_TIME | DATE_LIMIT", "enum": [ "ALL_TIME", "DATE_LIMIT" ] } }, "description": "" } } }, "zendesk_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The long-lived `Access token` carries the information necessary to access API resources.", "example": "my_access_token" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Identifier` of your Zendesk Confidential OAuth client app.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Zendesk Confidential OAuth client app.", "example": "my_client_secret" } }, "description": "Confidential OAuth client credentials for your application." } }, "description": "" } } }, "zendesk_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zendesk_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/zendesk_auth_V1" } ] }, "zendesk_chat_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Zendesk client ID.", "example": "test_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Zendesk client secret.", "format": "password", "example": "test_client_secret" }, "subdomain": { "title": "", "type": "string", "description": "Your Zendesk domain.", "example": "zendesk_domain" } }, "description": "" } } }, "zendesk_chat_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The long-lived `Access token` carries the information necessary to access API resources.", "format": "password", "example": "my_access_token" } }, "description": "" } } }, "zendesk_chat_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zendesk_chat_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/zendesk_chat_auth_V1" } ] }, "zendesk_sell_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "zendesk_sell_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "The long-lived `Access token` carries the information necessary to access API resources.", "example": "my_access_token" } }, "description": "" } } }, "zendesk_sell_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zendesk_sell_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/zendesk_sell_auth_V1" } ] }, "zendesk_sunshine_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Zendesk API tokens are auto-generated passwords in the Support admin interface.", "format": "password", "example": "api_token" }, "domain": { "title": "", "type": "string", "description": "Zendesk domain.", "example": "domain" }, "email": { "title": "", "type": "string", "description": "Zendesk email.", "example": "email" } }, "description": "" } } }, "zendesk_sunshine_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zendesk_sunshine_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "zendesk_workforce_management_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_token": { "title": "", "type": "string", "description": "Your Zendesk Workforce Management API token.", "format": "password", "example": "your_zendesk_workforce_management_api_token" }, "email_id": { "title": "", "type": "string", "description": "Email ID associated with the Zendesk Workforce Management account you want Fivetran to use to access your data.", "example": "your_zendesk_workforce_management_email_id" }, "subdomain": { "title": "", "type": "string", "description": "Your Zendesk Workforce Management subdomain.", "example": "your_zendesk_workforce_management_subdomain" } }, "description": "" } } }, "zendesk_workforce_management_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zendesk_workforce_management_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "zenefits_config_V1": { "properties": { "config": { "type": "object", "properties": { "bearer_token": { "title": "", "type": "string", "description": "Your Zenefits bearer token.", "format": "password", "example": "your_zenefits_bearer_token" } }, "description": "" } } }, "zenefits_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zenefits_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "zingtree_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Zingtree API key.", "format": "password", "example": "your_zingtree_api_key" } }, "description": "" } } }, "zingtree_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zingtree_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "zip_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_key": { "title": "", "type": "string", "description": "Your Zip API key.", "format": "password", "example": "your_zip_api_key" }, "environment": { "title": "", "type": "string", "description": "Your Zip environment.", "example": "your_zip_environment" } }, "description": "" } } }, "zip_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zip_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "zoho_books_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Zoho Books Client ID.", "example": "your_zoho_books_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Zoho Books Client Secret.", "format": "password", "example": "your_zoho_books_client_secret" }, "organization_id": { "title": "", "type": "string", "description": "Your Zoho Books Organization ID.", "example": "your_zoho_books_organization_id" }, "region": { "type": "object", "description": "Your Zoho Books application host region.", "enum": [ "com", "eu", "in", "jp", "com.au" ] } }, "description": "" } } }, "zoho_books_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "zoho_books_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zoho_books_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/zoho_books_auth_V1" } ] }, "zoho_campaigns_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Zoho Campaigns Client ID.", "example": "your_zoho_campaigns_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Zoho Campaigns Client Secret.", "format": "password", "example": "your_zoho_campaigns_client_secret" }, "region": { "type": "object", "description": "Your Zoho Campaigns application host region.", "enum": [ "com", "eu", "in", "jp", "com.cn", "com.au" ] } }, "description": "" } } }, "zoho_campaigns_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "zoho_campaigns_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zoho_campaigns_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/zoho_campaigns_auth_V1" } ] }, "zoho_crm_config_V1": { "properties": { "config": { "type": "object", "properties": { "data_center": { "title": "", "type": "object", "description": "Data Center, depending on the Domain name", "example": "data_center", "enum": [ "EU", "AU", "IN", "JP", "CN", "US", "CA" ] } }, "description": "" } } }, "zoho_crm_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "`Client ID` of your Zoho client application.", "example": "my_client_id" }, "client_secret": { "title": "", "type": "string", "description": "`Client Secret` of your Zoho client application.", "example": "my_client_secret" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "The long-lived `Refresh token`, along with the `client_id` and `client_secret` parameters, carries the information necessary to get a new access token for API resources.", "example": "my_refresh_token" } }, "description": "" } } }, "zoho_crm_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zoho_crm_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/zoho_crm_auth_V1" } ] }, "zoho_desk_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Zoho Desk Client Id.", "example": "your_zoho_desk_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Zoho Desk Client secret.", "format": "password", "example": "your_zoho_desk_client_secret" }, "region": { "type": "object", "description": "Your Zoho Desk domain.", "enum": [ "com", "eu", "in", "jp", "com.au" ] } }, "description": "" } } }, "zoho_desk_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "zoho_desk_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zoho_desk_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/zoho_desk_auth_V1" } ] }, "zoho_inventory_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Zoho Inventory client ID.", "example": "your_zoho_inventory_client_id" }, "client_secret": { "title": "", "type": "string", "description": "Your Zoho Inventory client secret.", "format": "password", "example": "your_zoho_inventory_client_secret" }, "organization_id": { "title": "", "type": "string", "description": "Your Zoho Inventory organization ID.", "example": "string" }, "region": { "type": "object", "description": "Your Zoho Inventory application host region.", "enum": [ "com", "eu", "in", "jp", "com.cn", "com.au" ] } }, "description": "" } } }, "zoho_inventory_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "zoho_inventory_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zoho_inventory_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/zoho_inventory_auth_V1" } ] }, "zoho_people_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "The client ID of the application that is registered in your Zoho People developer account for this connection.", "example": "your_application_client_id" }, "client_secret": { "title": "", "type": "string", "description": "The client secret of the application that is registered in your Zoho People developer account for this connection.", "format": "password", "example": "your_application_client_secret" }, "region": { "type": "object", "description": "The region where the application that is registered in your Zoho People developer account is hosted.", "enum": [ "com", "eu", "in", "jp", "com.cn", "com.au" ] } }, "description": "" } } }, "zoho_people_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "zoho_people_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zoho_people_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/zoho_people_auth_V1" } ] }, "zoho_recruit_config_V1": { "properties": { "config": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "Your Zoho Recruit client ID.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Your Zoho Recruit client secret.", "format": "password", "example": "string" }, "region": { "type": "object", "description": "Your Zoho Recruit region.", "enum": [ "com", "eu", "in", "com.cn", "jp", "com.au" ] } }, "description": "" } } }, "zoho_recruit_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" }, "client_access": { "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" }, "refresh_token": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "" } } }, "zoho_recruit_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zoho_recruit_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/zoho_recruit_auth_V1" } ] }, "zonka_feedback_config_V1": { "properties": { "config": { "type": "object", "properties": { "auth_token": { "title": "", "type": "string", "description": "Your Zonka Feedback auth token.", "format": "password", "example": "string" }, "data_center_id": { "type": "object", "description": "Your Zonka Feedback data center ID.", "enum": [ "us1", "au", "e", "in" ] } }, "description": "" } } }, "zonka_feedback_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zonka_feedback_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "zoom_config_V1": { "properties": { "config": { "type": "object", "description": "" } } }, "zoom_auth_V1": { "properties": { "auth": { "type": "object", "properties": { "access_token": { "title": "", "type": "string", "description": "Your Zoom Access token.", "format": "password", "example": "zoom_access_token" }, "client_access": { "title": "", "type": "object", "properties": { "client_id": { "title": "", "type": "string", "description": "", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "", "format": "password", "example": "string" } }, "description": "Your zoom client access" }, "refresh_token": { "title": "", "type": "string", "description": "Your Zoom Refresh token.", "format": "password", "example": "zoom_refresh_token" } }, "description": "" } } }, "zoom_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zoom_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" }, { "$ref": "#/components/schemas/zoom_auth_V1" } ] }, "zuora_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_role": { "title": "", "type": "string", "description": "The API role assigned to the integration user.", "example": "For example, Integration, Admin" }, "client_id": { "title": "", "type": "string", "description": "Zuora Client ID.", "example": "zuora_client_id" }, "client_name": { "title": "", "type": "string", "description": "The name of your organization as registered with Zuora Revenue.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Zuora Client Secret.", "format": "password", "example": "zuora_client_secret" }, "entity_id": { "title": "", "type": "string", "description": "If `is_multi_entity_feature_enabled` is `true`, then it's `EntityId`.", "example": "zuora_entity_id" }, "environment": { "title": "", "type": "string", "description": "Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.", "example": "string" }, "host_name": { "title": "", "type": "string", "description": "The domain or URL of your Zuora Revenue instance.", "example": "https://yourcompany.zuora.com" }, "is_multi_entity_feature_enabled": { "title": "", "type": "boolean", "description": "Set to `true` if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to `false`.", "example": true }, "password": { "title": "", "type": "string", "description": "The corresponding password for the API user.", "format": "password", "example": "string" }, "sync_mode": { "title": "", "type": "object", "description": "Select `Zuora Billing` to sync exclusively Zuora Billing related records. Choose `Zuora Revenue` for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for `Both`.", "example": "ZuoraBilling | ZuoraRevenue | Both", "enum": [ "ZuoraBilling", "ZuoraRevenue", "Both" ] }, "username": { "title": "", "type": "string", "description": "The API username with the necessary access permissions.", "example": "string" } }, "description": "" } } }, "zuora_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zuora_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "zuora_sandbox_config_V1": { "properties": { "config": { "type": "object", "properties": { "api_role": { "title": "", "type": "string", "description": "The API role assigned to the integration user.", "example": "For example, Integration, Admin" }, "client_id": { "title": "", "type": "string", "description": "Zuora Client ID.", "example": "zuora_client_id" }, "client_name": { "title": "", "type": "string", "description": "The name of your organization as registered with Zuora Revenue.", "example": "string" }, "client_secret": { "title": "", "type": "string", "description": "Zuora Client Secret.", "format": "password", "example": "zuora_client_secret" }, "entity_id": { "title": "", "type": "string", "description": "If `is_multi_entity_feature_enabled` is `true`, then it's `EntityId`.", "example": "zuora_entity_id" }, "environment": { "title": "", "type": "object", "description": "Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.", "example": "zuora_sandbox_environment", "enum": [ "Central Sandbox", "Sandbox" ] }, "host_name": { "title": "", "type": "string", "description": "The domain or URL of your Zuora Revenue instance.", "example": "https://yourcompany.zuora.com" }, "is_multi_entity_feature_enabled": { "title": "", "type": "boolean", "description": "Set to `true` if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to `false`.", "example": true }, "password": { "title": "", "type": "string", "description": "The corresponding password for the API user.", "format": "password", "example": "string" }, "sync_mode": { "title": "", "type": "object", "description": "Select `Zuora Billing` to sync exclusively Zuora Billing related records. Choose `Zuora Revenue` for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for `Both`.", "example": "ZuoraBilling | ZuoraRevenue | Both", "enum": [ "ZuoraBilling", "ZuoraRevenue", "Both" ] }, "username": { "title": "", "type": "string", "description": "The API username with the necessary access permissions.", "example": "string" } }, "description": "" } } }, "zuora_sandbox_NewConnectorRequestV1": { "allOf": [ { "$ref": "#/components/schemas/NewConnectorRequestV1" }, { "$ref": "#/components/schemas/zuora_sandbox_config_V1" }, { "$ref": "#/components/schemas/schema_format_schema" } ] }, "15five_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/15five_config_V1" } ] }, "360learning_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/360learning_config_V1" } ] }, "7shifts_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/7shifts_config_V1" } ] }, "absorb_lms_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/absorb_lms_config_V1" } ] }, "acculynx_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/acculynx_config_V1" } ] }, "activecampaign_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/activecampaign_config_V1" } ] }, "acumatica_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/acumatica_config_V1" } ] }, "ada_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ada_config_V1" } ] }, "adform_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/adform_config_V1" } ] }, "adjust_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/adjust_config_V1" } ] }, "adobe_analytics_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/adobe_analytics_config_V1" }, { "$ref": "#/components/schemas/adobe_analytics_esm_keys_config_V1" } ] }, "adobe_analytics_data_feed_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "abs_public_key": { "title": "", "type": "string", "description": "Azure Blob Storage public key", "example": "string" }, "sftp_public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "adobe_analytics_data_feed_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/adobe_analytics_data_feed_config_V1" }, { "$ref": "#/components/schemas/adobe_analytics_data_feed_readonly_config_V1" } ] }, "adobe_commerce_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/adobe_commerce_config_V1" } ] }, "adobe_workfront_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/adobe_workfront_config_V1" } ] }, "adp_workforce_now_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/adp_workforce_now_config_V1" } ] }, "adroll_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/adroll_config_V1" } ] }, "adyen_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/adyen_config_V1" } ] }, "affinity_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/affinity_config_V1" } ] }, "afterpay_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/afterpay_config_V1" } ] }, "aha_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/aha_config_V1" } ] }, "ai_generated_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ai_generated_config_V1" } ] }, "aircall_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/aircall_config_V1" } ] }, "airtable_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/airtable_config_V1" } ] }, "akamai_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/akamai_config_V1" } ] }, "akeneo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/akeneo_config_V1" } ] }, "alation_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/alation_config_V1" } ] }, "alchemer_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/alchemer_config_V1" } ] }, "algolia_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/algolia_config_V1" } ] }, "alida_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/alida_config_V1" } ] }, "amazon_ads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/amazon_ads_config_V1" } ] }, "amazon_attribution_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/amazon_attribution_config_V1" } ] }, "amazon_dsp_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/amazon_dsp_config_V1" } ] }, "amazon_selling_partner_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/amazon_selling_partner_config_V1" } ] }, "amplitude_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/amplitude_config_V1" } ] }, "amqp_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/amqp_config_V1" } ] }, "anaplan_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/anaplan_config_V1" } ] }, "anthropic_claude_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/anthropic_claude_config_V1" } ] }, "anvyl_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/anvyl_config_V1" } ] }, "apache_kafka_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/apache_kafka_config_V1" } ] }, "apollo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/apollo_config_V1" } ] }, "appcues_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/appcues_config_V1" } ] }, "appfigures_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/appfigures_config_V1" } ] }, "apple_search_ads_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "encoded_public_key": { "title": "", "type": "string", "description": "Use the public key to grant Fivetran access to Apple Search Ads api.", "example": "string" } }, "description": "" } } }, "apple_search_ads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/apple_search_ads_config_V1" }, { "$ref": "#/components/schemas/apple_search_ads_readonly_config_V1" } ] }, "applovin_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/applovin_config_V1" } ] }, "appsflyer_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "external_id": { "title": "", "type": "string", "description": "The external ID is a string that designates who can assume the role. For more information, click here", "example": "string" }, "webhook_endpoint": { "title": "", "type": "string", "description": "Webhook Url", "example": "string" } }, "description": "" } } }, "appsflyer_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/appsflyer_config_V1" }, { "$ref": "#/components/schemas/appsflyer_readonly_config_V1" } ] }, "asana_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/asana_config_V1" } ] }, "ascend_by_partnerize_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ascend_by_partnerize_config_V1" } ] }, "ashby_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ashby_config_V1" } ] }, "assembled_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/assembled_config_V1" } ] }, "asset_panda_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/asset_panda_config_V1" } ] }, "atlassian_compass_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/atlassian_compass_config_V1" } ] }, "atlassian_jira_align_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/atlassian_jira_align_config_V1" } ] }, "atlassian_ops_genie_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/atlassian_ops_genie_config_V1" } ] }, "attentive_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/attentive_config_V1" } ] }, "attio_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/attio_config_V1" } ] }, "aumni_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/aumni_config_V1" } ] }, "aura_from_unity_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/aura_from_unity_config_V1" } ] }, "aurora_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "external_id": { "title": "", "type": "string", "description": "Fivetran-generated External ID. Use it with the `role_arn` for authentication.", "example": "external_id" }, "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "aurora_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/aurora_config_V1" }, { "$ref": "#/components/schemas/aurora_readonly_config_V1" }, { "$ref": "#/components/schemas/aurora_esm_keys_config_V1" } ] }, "aurora_postgres_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "aurora_postgres_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/aurora_postgres_config_V1" }, { "$ref": "#/components/schemas/aurora_postgres_readonly_config_V1" }, { "$ref": "#/components/schemas/aurora_postgres_esm_keys_config_V1" } ] }, "auth0_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/auth0_config_V1" } ] }, "autodesk_bim_360_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/autodesk_bim_360_config_V1" } ] }, "avantlink_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/avantlink_config_V1" } ] }, "aveva_pi_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key.", "example": "string" } }, "description": "" } } }, "aveva_pi_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/aveva_pi_config_V1" }, { "$ref": "#/components/schemas/aveva_pi_readonly_config_V1" } ] }, "awin_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/awin_config_V1" } ] }, "aws_cloudtrail_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "external_id": { "title": "", "type": "string", "description": "This is the same as your `group_id`, used for authentication along with the `role_arn`.", "example": "1k56c2c4xlti6" } }, "description": "" } } }, "aws_cloudtrail_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/aws_cloudtrail_config_V1" }, { "$ref": "#/components/schemas/aws_cloudtrail_readonly_config_V1" } ] }, "aws_cost_report_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "external_id": { "title": "", "type": "string", "description": "The external ID is a string that designates who can assume the role. For more information, click here", "example": "string" } }, "description": "" } } }, "aws_cost_report_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/aws_cost_report_config_V1" }, { "$ref": "#/components/schemas/aws_cost_report_readonly_config_V1" }, { "$ref": "#/components/schemas/aws_cost_report_esm_keys_config_V1" } ] }, "aws_inventory_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/aws_inventory_config_V1" } ] }, "aws_lambda_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "external_id": { "title": "", "type": "string", "description": "The external ID is a string that designates who can assume the role.", "example": "group_id" } }, "description": "" } } }, "aws_lambda_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/aws_lambda_config_V1" }, { "$ref": "#/components/schemas/aws_lambda_readonly_config_V1" } ] }, "aws_msk_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "external_id": { "title": "", "type": "string", "description": "This is the same as your `group_id`. This is required when `sasl_mechanism` is set to `IAM`.", "example": "group_id" } }, "description": "" } } }, "aws_msk_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/aws_msk_config_V1" }, { "$ref": "#/components/schemas/aws_msk_readonly_config_V1" } ] }, "azure_blob_storage_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "connection_type": { "title": "", "type": "object", "description": "Connection method. Default value: `Directly`.", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "public_key": { "title": "", "type": "string", "description": "Public key generated by Fivetran to be copied into the host-machine's authorized keys file.", "example": "string" } }, "description": "" } } }, "azure_blob_storage_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/azure_blob_storage_config_V1" }, { "$ref": "#/components/schemas/azure_blob_storage_readonly_config_V1" } ] }, "azure_cosmos_for_mongo_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "azure_cosmos_for_mongo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/azure_cosmos_for_mongo_config_V1" }, { "$ref": "#/components/schemas/azure_cosmos_for_mongo_readonly_config_V1" } ] }, "azure_devops_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/azure_devops_config_V1" } ] }, "azure_event_hub_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/azure_event_hub_config_V1" } ] }, "azure_function_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "external_id": { "title": "", "type": "string", "description": "External ID.", "example": "string" } }, "description": "" } } }, "azure_function_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/azure_function_config_V1" }, { "$ref": "#/components/schemas/azure_function_readonly_config_V1" } ] }, "azure_postgres_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "azure_postgres_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/azure_postgres_config_V1" }, { "$ref": "#/components/schemas/azure_postgres_readonly_config_V1" }, { "$ref": "#/components/schemas/azure_postgres_esm_keys_config_V1" } ] }, "azure_service_bus_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public key generated by Fivetran to be copied into the host-machine's authorized keys file.", "example": "string" } }, "description": "" } } }, "azure_service_bus_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/azure_service_bus_config_V1" }, { "$ref": "#/components/schemas/azure_service_bus_readonly_config_V1" } ] }, "azure_sql_db_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key.", "example": "string" } }, "description": "" } } }, "azure_sql_db_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/azure_sql_db_config_V1" }, { "$ref": "#/components/schemas/azure_sql_db_readonly_config_V1" }, { "$ref": "#/components/schemas/azure_sql_db_esm_keys_config_V1" } ] }, "azure_sql_managed_db_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key.", "example": "string" } }, "description": "" } } }, "azure_sql_managed_db_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/azure_sql_managed_db_config_V1" }, { "$ref": "#/components/schemas/azure_sql_managed_db_readonly_config_V1" }, { "$ref": "#/components/schemas/azure_sql_managed_db_esm_keys_config_V1" } ] }, "backbone_plm_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/backbone_plm_config_V1" } ] }, "ballotready_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ballotready_config_V1" } ] }, "bamboohr_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/bamboohr_config_V1" } ] }, "bazaarvoice_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/bazaarvoice_config_V1" } ] }, "betterworks_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/betterworks_config_V1" } ] }, "big_commerce_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/big_commerce_config_V1" } ] }, "bigin_by_zoho_crm_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/bigin_by_zoho_crm_config_V1" } ] }, "bigmarker_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/bigmarker_config_V1" } ] }, "bigquery_db_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/bigquery_db_config_V1" } ] }, "billing_platform_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/billing_platform_config_V1" } ] }, "bing_webmaster_tools_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/bing_webmaster_tools_config_V1" } ] }, "bingads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/bingads_config_V1" } ] }, "birdeye_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/birdeye_config_V1" } ] }, "bitly_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/bitly_config_V1" } ] }, "bizzabo_app_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/bizzabo_app_config_V1" } ] }, "boostr_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/boostr_config_V1" } ] }, "box_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/box_config_V1" } ] }, "braintree_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/braintree_config_V1" } ] }, "braintree_sandbox_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/braintree_sandbox_config_V1" } ] }, "branch_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "webhook_url": { "title": "", "type": "string", "description": "Webhook URL", "example": "string" } }, "description": "" } } }, "branch_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/branch_config_V1" }, { "$ref": "#/components/schemas/branch_readonly_config_V1" } ] }, "brave_ads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/brave_ads_config_V1" } ] }, "braze_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "s3_export_external_id": { "title": "", "type": "string", "description": "This is the same as your `group_id`, used if `export_storage_type` is `AWS_S3`", "example": "_moonbeam" }, "s3external_id": { "title": "", "type": "string", "description": "This is the same as your `group_id`, used for authentication along with the `role_arn` required if `AWS_S3` is the `cloud_storage_type`", "example": "_moonbeam" } }, "description": "" } } }, "braze_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/braze_config_V1" }, { "$ref": "#/components/schemas/braze_readonly_config_V1" } ] }, "breathe_hr_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/breathe_hr_config_V1" } ] }, "brevo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/brevo_config_V1" } ] }, "brex_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/brex_config_V1" } ] }, "brightcove_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/brightcove_config_V1" } ] }, "brightflag_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/brightflag_config_V1" } ] }, "brightpearl_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/brightpearl_config_V1" } ] }, "brivo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/brivo_config_V1" } ] }, "buildium_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/buildium_config_V1" } ] }, "buildkite_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/buildkite_config_V1" } ] }, "business_central_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/business_central_config_V1" } ] }, "buzzsprout_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/buzzsprout_config_V1" } ] }, "bynder_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/bynder_config_V1" } ] }, "cabcharge_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/cabcharge_config_V1" } ] }, "calabrio_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/calabrio_config_V1" } ] }, "calcom_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/calcom_config_V1" } ] }, "calendly_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/calendly_config_V1" } ] }, "callrail_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/callrail_config_V1" } ] }, "campaignmonitor_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/campaignmonitor_config_V1" } ] }, "campfire_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/campfire_config_V1" } ] }, "canny_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/canny_config_V1" } ] }, "canvas_by_instructure_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/canvas_by_instructure_config_V1" } ] }, "canvas_data_2_by_instructure_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/canvas_data_2_by_instructure_config_V1" } ] }, "captivateiq_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/captivateiq_config_V1" } ] }, "care_quality_commission_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/care_quality_commission_config_V1" } ] }, "castor_edc_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/castor_edc_config_V1" } ] }, "centra_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/centra_config_V1" } ] }, "ceridian_dayforce_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ceridian_dayforce_config_V1" } ] }, "chameleon_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/chameleon_config_V1" } ] }, "chargebee_product_catalog_1_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/chargebee_product_catalog_1_config_V1" } ] }, "chargebee_product_catalog_2_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/chargebee_product_catalog_2_config_V1" } ] }, "chargedesk_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/chargedesk_config_V1" } ] }, "charthop_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/charthop_config_V1" } ] }, "chartmogul_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/chartmogul_config_V1" } ] }, "checkout_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/checkout_config_V1" } ] }, "checkr_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/checkr_config_V1" } ] }, "chorusai_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/chorusai_config_V1" } ] }, "churnkey_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/churnkey_config_V1" } ] }, "churnzero_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/churnzero_config_V1" } ] }, "cimis_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/cimis_config_V1" } ] }, "cin7_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/cin7_config_V1" } ] }, "cin7core_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/cin7core_config_V1" } ] }, "circle_community_platform_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/circle_community_platform_config_V1" } ] }, "circleci_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/circleci_config_V1" } ] }, "cj_commission_detail_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/cj_commission_detail_config_V1" } ] }, "clari_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/clari_config_V1" } ] }, "claude_compliance_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/claude_compliance_config_V1" } ] }, "clazar_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/clazar_config_V1" } ] }, "clickup_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/clickup_config_V1" } ] }, "clockify_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/clockify_config_V1" } ] }, "clockodo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/clockodo_config_V1" } ] }, "close_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/close_config_V1" } ] }, "cloudbeds_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/cloudbeds_config_V1" } ] }, "cloudflare_analytics_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/cloudflare_analytics_config_V1" } ] }, "cloudfront_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "external_id": { "title": "", "type": "string", "description": "This is the same as your `group_id`, used for authentication along with the `role_arn`.", "example": "group_id" } }, "description": "" } } }, "cloudfront_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/cloudfront_config_V1" }, { "$ref": "#/components/schemas/cloudfront_readonly_config_V1" } ] }, "cloudtalk_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/cloudtalk_config_V1" } ] }, "clubspeed_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/clubspeed_config_V1" } ] }, "coalesce_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/coalesce_config_V1" } ] }, "coassemble_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/coassemble_config_V1" } ] }, "cockroachdb_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "cockroachdb_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/cockroachdb_config_V1" }, { "$ref": "#/components/schemas/cockroachdb_readonly_config_V1" } ] }, "coda_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/coda_config_V1" } ] }, "codefresh_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/codefresh_config_V1" } ] }, "collibra_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/collibra_config_V1" } ] }, "column_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/column_config_V1" } ] }, "commercetools_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/commercetools_config_V1" } ] }, "compliance_checkpoint_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/compliance_checkpoint_config_V1" } ] }, "concord_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/concord_config_V1" } ] }, "concur_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/concur_config_V1" } ] }, "confluence_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/confluence_config_V1" } ] }, "confluent_cloud_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/confluent_cloud_config_V1" } ] }, "connector_sdk_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/connector_sdk_config_V1" } ] }, "consensus_demo_automation_platform_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/consensus_demo_automation_platform_config_V1" } ] }, "constant_contact_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/constant_contact_config_V1" } ] }, "contrast_security_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/contrast_security_config_V1" } ] }, "convex_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/convex_config_V1" } ] }, "copper_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/copper_config_V1" } ] }, "cornerstone_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/cornerstone_config_V1" } ] }, "cosmos_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/cosmos_config_V1" } ] }, "coupa_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/coupa_config_V1" }, { "$ref": "#/components/schemas/coupa_esm_keys_config_V1" } ] }, "credly_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/credly_config_V1" } ] }, "criteo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/criteo_config_V1" } ] }, "criteo_retail_media_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/criteo_retail_media_config_V1" } ] }, "crossbeam_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/crossbeam_config_V1" } ] }, "crowddev_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/crowddev_config_V1" } ] }, "crunchbase_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/crunchbase_config_V1" } ] }, "cube_software_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/cube_software_config_V1" } ] }, "culture_amp_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/culture_amp_config_V1" } ] }, "cursor_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/cursor_config_V1" } ] }, "customerio_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/customerio_config_V1" } ] }, "cvent_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/cvent_config_V1" } ] }, "d2l_brightspace_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/d2l_brightspace_config_V1" } ] }, "databricks_db_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/databricks_db_config_V1" } ] }, "datadog_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/datadog_config_V1" } ] }, "datastreamer_source_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/datastreamer_source_config_V1" } ] }, "db2i_hva_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "db2i_hva_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/db2i_hva_config_V1" }, { "$ref": "#/components/schemas/db2i_hva_readonly_config_V1" }, { "$ref": "#/components/schemas/db2i_hva_esm_keys_config_V1" } ] }, "db2i_sap_hva_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "db2i_sap_hva_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/db2i_sap_hva_config_V1" }, { "$ref": "#/components/schemas/db2i_sap_hva_readonly_config_V1" }, { "$ref": "#/components/schemas/db2i_sap_hva_esm_keys_config_V1" } ] }, "db2luw_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "db2luw_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/db2luw_config_V1" }, { "$ref": "#/components/schemas/db2luw_readonly_config_V1" } ] }, "db2z_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "db2z_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/db2z_config_V1" }, { "$ref": "#/components/schemas/db2z_readonly_config_V1" } ] }, "dbt_cloud_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/dbt_cloud_config_V1" } ] }, "dcl_logistics_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/dcl_logistics_config_V1" } ] }, "deel_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/deel_config_V1" } ] }, "deposco_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/deposco_config_V1" } ] }, "deputy_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/deputy_config_V1" } ] }, "destini_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/destini_config_V1" } ] }, "device_magic_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/device_magic_config_V1" } ] }, "dialpad_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/dialpad_config_V1" } ] }, "discourse_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/discourse_config_V1" } ] }, "dixa_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/dixa_config_V1" } ] }, "docebo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/docebo_config_V1" } ] }, "documentdb_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "documentdb_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/documentdb_config_V1" }, { "$ref": "#/components/schemas/documentdb_readonly_config_V1" } ] }, "donus_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/donus_config_V1" } ] }, "doorloop_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/doorloop_config_V1" } ] }, "double_click_campaign_manager_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/double_click_campaign_manager_config_V1" } ] }, "double_click_publishers_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/double_click_publishers_config_V1" } ] }, "drata_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/drata_config_V1" } ] }, "drift_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/drift_config_V1" } ] }, "drip_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/drip_config_V1" } ] }, "dropbox_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/dropbox_config_V1" } ] }, "dropbox_sign_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/dropbox_sign_config_V1" } ] }, "dsv_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/dsv_config_V1" } ] }, "duoplane_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/duoplane_config_V1" } ] }, "dutchie_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/dutchie_config_V1" } ] }, "dynamics_365_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "connecting_user": { "title": "", "type": "string", "description": "Full name of the connecting user, or service principal application", "example": "connecting_user" }, "connecting_user_email": { "title": "", "type": "string", "description": "Email ID of the connecting user", "example": "connecting_user_email" } }, "description": "" } } }, "dynamics_365_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/dynamics_365_config_V1" }, { "$ref": "#/components/schemas/dynamics_365_readonly_config_V1" } ] }, "dynamodb_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "external_id": { "title": "", "type": "string", "description": "This is the same as your `group_id`, used for authentication along with the `role_arn`.", "example": "external_id" } }, "description": "" } } }, "dynamodb_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/dynamodb_config_V1" }, { "$ref": "#/components/schemas/dynamodb_readonly_config_V1" } ] }, "easypost_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/easypost_config_V1" } ] }, "ebay_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ebay_config_V1" } ] }, "economic_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/economic_config_V1" } ] }, "elastic_cloud_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "elastic_cloud_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/elastic_cloud_config_V1" }, { "$ref": "#/components/schemas/elastic_cloud_readonly_config_V1" }, { "$ref": "#/components/schemas/elastic_cloud_esm_keys_config_V1" } ] }, "elastic_cloud_serverless_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "elastic_cloud_serverless_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/elastic_cloud_serverless_config_V1" }, { "$ref": "#/components/schemas/elastic_cloud_serverless_readonly_config_V1" }, { "$ref": "#/components/schemas/elastic_cloud_serverless_esm_keys_config_V1" } ] }, "electronic_tenant_solutions_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/electronic_tenant_solutions_config_V1" } ] }, "eloqua_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/eloqua_config_V1" } ] }, "email_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "email": { "title": "", "type": "string", "description": "Send your emails to this address.", "example": "string" } }, "description": "" } } }, "email_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/email_config_V1" }, { "$ref": "#/components/schemas/email_readonly_config_V1" } ] }, "employment_hero_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/employment_hero_config_V1" } ] }, "epic_clarity_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key.", "example": "string" } }, "description": "" } } }, "epic_clarity_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/epic_clarity_config_V1" }, { "$ref": "#/components/schemas/epic_clarity_readonly_config_V1" }, { "$ref": "#/components/schemas/epic_clarity_esm_keys_config_V1" } ] }, "es_self_hosted_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "es_self_hosted_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/es_self_hosted_config_V1" }, { "$ref": "#/components/schemas/es_self_hosted_readonly_config_V1" }, { "$ref": "#/components/schemas/es_self_hosted_esm_keys_config_V1" } ] }, "eventbrite_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/eventbrite_config_V1" } ] }, "eventsforce_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/eventsforce_config_V1" } ] }, "everflow_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/everflow_config_V1" } ] }, "everhour_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/everhour_config_V1" } ] }, "exact_online_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/exact_online_config_V1" } ] }, "expensein_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/expensein_config_V1" } ] }, "expensify_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/expensify_config_V1" } ] }, "ezofficeinventory_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ezofficeinventory_config_V1" } ] }, "facebook_ads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/facebook_ads_config_V1" }, { "$ref": "#/components/schemas/facebook_ads_esm_keys_config_V1" } ] }, "facebook_pages_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/facebook_pages_config_V1" } ] }, "factbird_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/factbird_config_V1" } ] }, "factorial_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/factorial_config_V1" } ] }, "fathom_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/fathom_config_V1" } ] }, "fillout_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/fillout_config_V1" } ] }, "firebase_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/firebase_config_V1" } ] }, "fireflies_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/fireflies_config_V1" } ] }, "firehydrant_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/firehydrant_config_V1" } ] }, "fivetran_log_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/fivetran_log_config_V1" } ] }, "flexport_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/flexport_config_V1" } ] }, "float_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/float_config_V1" } ] }, "flywheel_digital_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/flywheel_digital_config_V1" } ] }, "fone_dynamics_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/fone_dynamics_config_V1" } ] }, "forethought_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/forethought_config_V1" } ] }, "forj_community_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/forj_community_config_V1" } ] }, "formstack_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/formstack_config_V1" } ] }, "fortnox_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/fortnox_config_V1" } ] }, "fountain_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/fountain_config_V1" } ] }, "fourkites_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/fourkites_config_V1" } ] }, "freightview_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/freightview_config_V1" } ] }, "freshbooks_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/freshbooks_config_V1" } ] }, "freshchat_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/freshchat_config_V1" } ] }, "freshdesk_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/freshdesk_config_V1" } ] }, "freshdesk_contact_center_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/freshdesk_contact_center_config_V1" } ] }, "freshsales_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/freshsales_config_V1" } ] }, "freshservice_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/freshservice_config_V1" } ] }, "freshsuccess_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/freshsuccess_config_V1" } ] }, "freshteam_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/freshteam_config_V1" } ] }, "friendbuy_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/friendbuy_config_V1" } ] }, "front_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/front_config_V1" } ] }, "ftp_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ftp_config_V1" } ] }, "fulfil_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/fulfil_config_V1" } ] }, "fullstory_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/fullstory_config_V1" } ] }, "g2_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/g2_config_V1" } ] }, "gainsight_customer_success_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/gainsight_customer_success_config_V1" } ] }, "gainsight_product_experience_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/gainsight_product_experience_config_V1" } ] }, "gcs_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/gcs_config_V1" } ] }, "gem_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/gem_config_V1" } ] }, "genesys_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/genesys_config_V1" } ] }, "getfeedback_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/getfeedback_config_V1" } ] }, "github_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/github_config_V1" } ] }, "gitlab_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/gitlab_config_V1" } ] }, "gladly_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/gladly_config_V1" } ] }, "globalmeet_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/globalmeet_config_V1" } ] }, "gmail_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/gmail_config_V1" } ] }, "gocardless_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/gocardless_config_V1" } ] }, "gofundme_pro_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/gofundme_pro_config_V1" } ] }, "goldcast_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/goldcast_config_V1" } ] }, "gongio_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/gongio_config_V1" } ] }, "google_ads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_ads_config_V1" } ] }, "google_analytics_4_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_analytics_4_config_V1" } ] }, "google_analytics_4_export_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_analytics_4_export_config_V1" } ] }, "google_business_profile_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_business_profile_config_V1" } ] }, "google_calendar_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_calendar_config_V1" } ] }, "google_classroom_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_classroom_config_V1" } ] }, "google_cloud_function_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "service_account_email": { "title": "", "type": "string", "description": "Provide Invoker role to this service account.", "example": "string" } }, "description": "" } } }, "google_cloud_function_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_cloud_function_config_V1" }, { "$ref": "#/components/schemas/google_cloud_function_readonly_config_V1" } ] }, "google_cloud_mysql_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "google_cloud_mysql_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_cloud_mysql_config_V1" }, { "$ref": "#/components/schemas/google_cloud_mysql_readonly_config_V1" }, { "$ref": "#/components/schemas/google_cloud_mysql_esm_keys_config_V1" } ] }, "google_cloud_postgresql_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "google_cloud_postgresql_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_cloud_postgresql_config_V1" }, { "$ref": "#/components/schemas/google_cloud_postgresql_readonly_config_V1" }, { "$ref": "#/components/schemas/google_cloud_postgresql_esm_keys_config_V1" } ] }, "google_cloud_sqlserver_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key.", "example": "string" } }, "description": "" } } }, "google_cloud_sqlserver_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_cloud_sqlserver_config_V1" }, { "$ref": "#/components/schemas/google_cloud_sqlserver_readonly_config_V1" }, { "$ref": "#/components/schemas/google_cloud_sqlserver_esm_keys_config_V1" } ] }, "google_display_and_video_360_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_display_and_video_360_config_V1" } ] }, "google_drive_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "service_account": { "title": "", "type": "string", "description": "Share the folder with the email address", "example": "string" } }, "description": "" } } }, "google_drive_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_drive_config_V1" }, { "$ref": "#/components/schemas/google_drive_readonly_config_V1" } ] }, "google_play_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_play_config_V1" } ] }, "google_search_ads_360_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_search_ads_360_config_V1" } ] }, "google_search_console_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_search_console_config_V1" } ] }, "google_sheets_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_sheets_config_V1" } ] }, "google_tag_manager_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_tag_manager_config_V1" } ] }, "google_tasks_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/google_tasks_config_V1" } ] }, "gorgias_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/gorgias_config_V1" } ] }, "green_power_monitor_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/green_power_monitor_config_V1" } ] }, "greenhouse_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/greenhouse_config_V1" } ] }, "grepsr_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/grepsr_config_V1" } ] }, "grin_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/grin_config_V1" } ] }, "guidewire_cloud_data_access_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "external_id": { "title": "", "type": "string", "description": "Used for authentication along with the `role_arn`. If not provided, it uses connector's `group_id`. Use the [List All Groups endpoint](/docs/rest-api/groups#listallgroups) to find the `group_id`.", "example": "group_id" } }, "description": "" } } }, "guidewire_cloud_data_access_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/guidewire_cloud_data_access_config_V1" }, { "$ref": "#/components/schemas/guidewire_cloud_data_access_readonly_config_V1" }, { "$ref": "#/components/schemas/guidewire_cloud_data_access_esm_keys_config_V1" } ] }, "guru_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/guru_config_V1" } ] }, "h_level_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/h_level_config_V1" } ] }, "happyfox_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/happyfox_config_V1" } ] }, "harvest_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/harvest_config_V1" } ] }, "healthie_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/healthie_config_V1" } ] }, "heap_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/heap_config_V1" } ] }, "heartland_retail_pos_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/heartland_retail_pos_config_V1" } ] }, "helpdesk_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/helpdesk_config_V1" } ] }, "helpjuice_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/helpjuice_config_V1" } ] }, "helpscout_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/helpscout_config_V1" } ] }, "helpshift_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/helpshift_config_V1" } ] }, "heroku_kafka_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/heroku_kafka_config_V1" } ] }, "heroku_postgres_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "heroku_postgres_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/heroku_postgres_config_V1" }, { "$ref": "#/components/schemas/heroku_postgres_readonly_config_V1" }, { "$ref": "#/components/schemas/heroku_postgres_esm_keys_config_V1" } ] }, "hex_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/hex_config_V1" } ] }, "hibob_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/hibob_config_V1" } ] }, "higher_logic_vanilla_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/higher_logic_vanilla_config_V1" } ] }, "hilti_ontrack_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/hilti_ontrack_config_V1" } ] }, "hopin_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/hopin_config_V1" } ] }, "hubspot_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/hubspot_config_V1" } ] }, "ibacos_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ibacos_config_V1" } ] }, "ilevel_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ilevel_config_V1" } ] }, "impact_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/impact_config_V1" } ] }, "impact_partner_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/impact_partner_config_V1" } ] }, "incidentio_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/incidentio_config_V1" } ] }, "infobip_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/infobip_config_V1" } ] }, "insightly_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/insightly_config_V1" } ] }, "instagram_business_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/instagram_business_config_V1" } ] }, "integral_ad_science_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/integral_ad_science_config_V1" } ] }, "integrate_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/integrate_config_V1" } ] }, "intercom_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/intercom_config_V1" } ] }, "invoiced_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/invoiced_config_V1" } ] }, "ironclad_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ironclad_config_V1" } ] }, "ironclad_clickwrap_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ironclad_clickwrap_config_V1" } ] }, "ironsource_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ironsource_config_V1" } ] }, "iterable_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "endpoint": { "title": "", "type": "string", "description": "Register the following URL for webhooks on your Iterable dashboard.", "example": "string" }, "project_type": { "title": "", "type": "object", "description": "The type of Iterable project associated with the API key.", "example": "USER_ID_BASED_PROJECT | HYBRID_PROJECT | EMAIL_BASED_PROJECT", "enum": [ "USER_ID_BASED_PROJECT", "HYBRID_PROJECT", "EMAIL_BASED_PROJECT" ] }, "webhook_secret": { "title": "", "type": "string", "description": "The secret token used to authenticate incoming webhook events from Iterable. Only applicable when `webhook_auth_type` is `Basic` or `OAuth2`.", "format": "password", "example": "string" } }, "description": "" } } }, "iterable_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/iterable_config_V1" }, { "$ref": "#/components/schemas/iterable_readonly_config_V1" } ] }, "itunes_connect_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/itunes_connect_config_V1" } ] }, "ivanti_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ivanti_config_V1" } ] }, "jama_software_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/jama_software_config_V1" } ] }, "jamf_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/jamf_config_V1" } ] }, "jibble_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/jibble_config_V1" } ] }, "jira_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/jira_config_V1" }, { "$ref": "#/components/schemas/jira_esm_keys_config_V1" } ] }, "jobnimbus_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/jobnimbus_config_V1" } ] }, "jotform_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/jotform_config_V1" } ] }, "justcall_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/justcall_config_V1" } ] }, "kandji_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/kandji_config_V1" } ] }, "katana_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/katana_config_V1" } ] }, "kevel_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/kevel_config_V1" } ] }, "keypay_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/keypay_config_V1" } ] }, "khoros_care_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/khoros_care_config_V1" } ] }, "khoros_communities_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/khoros_communities_config_V1" } ] }, "khoros_marketing_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/khoros_marketing_config_V1" } ] }, "kinesis_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "external_id": { "title": "", "type": "string", "description": "The external ID is a string that designates who can assume the role. For more information, click here", "example": "string" } }, "description": "" } } }, "kinesis_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/kinesis_config_V1" }, { "$ref": "#/components/schemas/kinesis_readonly_config_V1" } ] }, "kisi_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/kisi_config_V1" } ] }, "kissmetrics_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/kissmetrics_config_V1" } ] }, "klarna_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/klarna_config_V1" } ] }, "klaviyo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/klaviyo_config_V1" } ] }, "konnect_insights_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/konnect_insights_config_V1" } ] }, "kustomer_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/kustomer_config_V1" } ] }, "kyriba_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/kyriba_config_V1" } ] }, "lattice_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/lattice_config_V1" } ] }, "launchdarkly_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/launchdarkly_config_V1" } ] }, "leap_crm_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/leap_crm_config_V1" } ] }, "leapsome_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/leapsome_config_V1" } ] }, "learn_amp_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/learn_amp_config_V1" } ] }, "learnupon_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/learnupon_config_V1" } ] }, "leave_dates_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/leave_dates_config_V1" } ] }, "lemlist_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/lemlist_config_V1" } ] }, "lessonly_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/lessonly_config_V1" } ] }, "lever_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/lever_config_V1" } ] }, "liftoff_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/liftoff_config_V1" } ] }, "light_speed_retail_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/light_speed_retail_config_V1" } ] }, "lightspeed_retail_xseries_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/lightspeed_retail_xseries_config_V1" } ] }, "line_ads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/line_ads_config_V1" } ] }, "linear_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/linear_config_V1" } ] }, "linkedin_ads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/linkedin_ads_config_V1" } ] }, "linkedin_company_pages_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/linkedin_company_pages_config_V1" } ] }, "linksquares_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/linksquares_config_V1" } ] }, "listen360_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/listen360_config_V1" } ] }, "livechat_partner_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/livechat_partner_config_V1" } ] }, "livestorm_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/livestorm_config_V1" } ] }, "lob_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/lob_config_V1" } ] }, "local_file_system_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/local_file_system_config_V1" } ] }, "looker_source_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/looker_source_config_V1" } ] }, "loop_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/loop_config_V1" } ] }, "loopio_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/loopio_config_V1" } ] }, "lucca_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/lucca_config_V1" } ] }, "luma_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/luma_config_V1" } ] }, "magento_mysql_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "magento_mysql_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/magento_mysql_config_V1" }, { "$ref": "#/components/schemas/magento_mysql_readonly_config_V1" }, { "$ref": "#/components/schemas/magento_mysql_esm_keys_config_V1" } ] }, "magento_mysql_rds_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "external_id": { "title": "", "type": "string", "description": "Fivetran-generated External ID. Use it with the `role_arn` for authentication.", "example": "external_id" }, "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "magento_mysql_rds_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/magento_mysql_rds_config_V1" }, { "$ref": "#/components/schemas/magento_mysql_rds_readonly_config_V1" }, { "$ref": "#/components/schemas/magento_mysql_rds_esm_keys_config_V1" } ] }, "mailchimp_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mailchimp_config_V1" } ] }, "maileon_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/maileon_config_V1" } ] }, "mailgun_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mailgun_config_V1" } ] }, "mailjet_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mailjet_config_V1" } ] }, "maintainx_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/maintainx_config_V1" } ] }, "malomo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/malomo_config_V1" } ] }, "mambu_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mambu_config_V1" } ] }, "mandrill_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mandrill_config_V1" } ] }, "maria_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "maria_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/maria_config_V1" }, { "$ref": "#/components/schemas/maria_readonly_config_V1" }, { "$ref": "#/components/schemas/maria_esm_keys_config_V1" } ] }, "maria_azure_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "maria_azure_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/maria_azure_config_V1" }, { "$ref": "#/components/schemas/maria_azure_readonly_config_V1" }, { "$ref": "#/components/schemas/maria_azure_esm_keys_config_V1" } ] }, "maria_rds_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "external_id": { "title": "", "type": "string", "description": "Fivetran-generated External ID. Use it with the `role_arn` for authentication.", "example": "external_id" }, "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "maria_rds_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/maria_rds_config_V1" }, { "$ref": "#/components/schemas/maria_rds_readonly_config_V1" }, { "$ref": "#/components/schemas/maria_rds_esm_keys_config_V1" } ] }, "marin_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/marin_config_V1" }, { "$ref": "#/components/schemas/marin_esm_keys_config_V1" } ] }, "marketo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/marketo_config_V1" } ] }, "matomo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/matomo_config_V1" } ] }, "mavenlink_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mavenlink_config_V1" } ] }, "maxio_chargify_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/maxio_chargify_config_V1" } ] }, "maxio_saasoptics_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/maxio_saasoptics_config_V1" } ] }, "medallia_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/medallia_config_V1" } ] }, "medallia_agile_research_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/medallia_agile_research_config_V1" } ] }, "megaphone_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/megaphone_config_V1" } ] }, "mention_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mention_config_V1" } ] }, "microsoft_dynamics_365_fno_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/microsoft_dynamics_365_fno_config_V1" } ] }, "microsoft_entra_id_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/microsoft_entra_id_config_V1" } ] }, "microsoft_lists_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/microsoft_lists_config_V1" } ] }, "microsoft_power_bi_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/microsoft_power_bi_config_V1" } ] }, "microsoft_teams_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/microsoft_teams_config_V1" } ] }, "missive_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/missive_config_V1" } ] }, "mixmax_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mixmax_config_V1" } ] }, "mixpanel_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mixpanel_config_V1" } ] }, "mode_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mode_config_V1" } ] }, "mollie_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mollie_config_V1" } ] }, "moloco_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/moloco_config_V1" } ] }, "monday_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/monday_config_V1" } ] }, "mongo_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "mongo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mongo_config_V1" }, { "$ref": "#/components/schemas/mongo_readonly_config_V1" } ] }, "mongo_sharded_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "mongo_sharded_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mongo_sharded_config_V1" }, { "$ref": "#/components/schemas/mongo_sharded_readonly_config_V1" } ] }, "mountain_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mountain_config_V1" } ] }, "mux_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mux_config_V1" } ] }, "myosh_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/myosh_config_V1" } ] }, "mysql_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "mysql_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mysql_config_V1" }, { "$ref": "#/components/schemas/mysql_readonly_config_V1" }, { "$ref": "#/components/schemas/mysql_esm_keys_config_V1" } ] }, "mysql_azure_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "mysql_azure_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mysql_azure_config_V1" }, { "$ref": "#/components/schemas/mysql_azure_readonly_config_V1" }, { "$ref": "#/components/schemas/mysql_azure_esm_keys_config_V1" } ] }, "mysql_rds_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "external_id": { "title": "", "type": "string", "description": "Fivetran-generated External ID. Use it with the `role_arn` for authentication.", "example": "external_id" }, "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "mysql_rds_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/mysql_rds_config_V1" }, { "$ref": "#/components/schemas/mysql_rds_readonly_config_V1" }, { "$ref": "#/components/schemas/mysql_rds_esm_keys_config_V1" } ] }, "namely_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/namely_config_V1" } ] }, "national_heavy_vehicle_regulator_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/national_heavy_vehicle_regulator_config_V1" } ] }, "navan_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/navan_config_V1" } ] }, "netsuite_suiteanalytics_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/netsuite_suiteanalytics_config_V1" } ] }, "nice_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/nice_config_V1" } ] }, "notion_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/notion_config_V1" } ] }, "nylas_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/nylas_config_V1" } ] }, "odoo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/odoo_config_V1" } ] }, "odoo_synconics_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/odoo_synconics_config_V1" } ] }, "okendo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/okendo_config_V1" } ] }, "okta_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/okta_config_V1" } ] }, "ometria_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ometria_config_V1" } ] }, "on24_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/on24_config_V1" } ] }, "oncehub_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/oncehub_config_V1" } ] }, "one_drive_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/one_drive_config_V1" } ] }, "onetrust_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/onetrust_config_V1" } ] }, "open_data_dc_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/open_data_dc_config_V1" } ] }, "open_exchange_rates_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/open_exchange_rates_config_V1" } ] }, "openai_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/openai_config_V1" } ] }, "openai_compliance_platform_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/openai_compliance_platform_config_V1" } ] }, "opendistro_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "opendistro_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/opendistro_config_V1" }, { "$ref": "#/components/schemas/opendistro_readonly_config_V1" }, { "$ref": "#/components/schemas/opendistro_esm_keys_config_V1" } ] }, "opensearch_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "opensearch_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/opensearch_config_V1" }, { "$ref": "#/components/schemas/opensearch_readonly_config_V1" }, { "$ref": "#/components/schemas/opensearch_esm_keys_config_V1" } ] }, "optimizely_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/optimizely_config_V1" } ] }, "oracle_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "oracle_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/oracle_config_V1" }, { "$ref": "#/components/schemas/oracle_readonly_config_V1" }, { "$ref": "#/components/schemas/oracle_esm_keys_config_V1" } ] }, "oracle_business_intelligence_publisher_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/oracle_business_intelligence_publisher_config_V1" } ] }, "oracle_ebs_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "oracle_ebs_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/oracle_ebs_config_V1" }, { "$ref": "#/components/schemas/oracle_ebs_readonly_config_V1" }, { "$ref": "#/components/schemas/oracle_ebs_esm_keys_config_V1" } ] }, "oracle_fusion_cloud_apps_crm_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/oracle_fusion_cloud_apps_crm_config_V1" }, { "$ref": "#/components/schemas/oracle_fusion_cloud_apps_crm_esm_keys_config_V1" } ] }, "oracle_fusion_cloud_apps_fscm_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/oracle_fusion_cloud_apps_fscm_config_V1" }, { "$ref": "#/components/schemas/oracle_fusion_cloud_apps_fscm_esm_keys_config_V1" } ] }, "oracle_fusion_cloud_apps_hcm_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/oracle_fusion_cloud_apps_hcm_config_V1" }, { "$ref": "#/components/schemas/oracle_fusion_cloud_apps_hcm_esm_keys_config_V1" } ] }, "oracle_fusion_field_service_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/oracle_fusion_field_service_config_V1" } ] }, "oracle_hva_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "oracle_hva_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/oracle_hva_config_V1" }, { "$ref": "#/components/schemas/oracle_hva_readonly_config_V1" }, { "$ref": "#/components/schemas/oracle_hva_esm_keys_config_V1" } ] }, "oracle_moat_analytics_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/oracle_moat_analytics_config_V1" } ] }, "oracle_netsuite_openair_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/oracle_netsuite_openair_config_V1" } ] }, "oracle_rac_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "oracle_rac_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/oracle_rac_config_V1" }, { "$ref": "#/components/schemas/oracle_rac_readonly_config_V1" }, { "$ref": "#/components/schemas/oracle_rac_esm_keys_config_V1" } ] }, "oracle_rds_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "oracle_rds_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/oracle_rds_config_V1" }, { "$ref": "#/components/schemas/oracle_rds_readonly_config_V1" }, { "$ref": "#/components/schemas/oracle_rds_esm_keys_config_V1" } ] }, "oracle_sap_hva_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "oracle_sap_hva_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/oracle_sap_hva_config_V1" }, { "$ref": "#/components/schemas/oracle_sap_hva_readonly_config_V1" }, { "$ref": "#/components/schemas/oracle_sap_hva_esm_keys_config_V1" } ] }, "oracle_sap_hva_netweaver_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/oracle_sap_hva_netweaver_config_V1" }, { "$ref": "#/components/schemas/oracle_sap_hva_netweaver_esm_keys_config_V1" } ] }, "orbit_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/orbit_config_V1" } ] }, "ordergroove_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ordergroove_config_V1" } ] }, "ordway_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ordway_config_V1" } ] }, "ortto_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ortto_config_V1" } ] }, "outbrain_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/outbrain_config_V1" } ] }, "outreach_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/outreach_config_V1" } ] }, "packiyo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/packiyo_config_V1" } ] }, "paddle_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/paddle_config_V1" } ] }, "pagerduty_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/pagerduty_config_V1" } ] }, "pandadoc_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/pandadoc_config_V1" } ] }, "papershift_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/papershift_config_V1" } ] }, "parcellab_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/parcellab_config_V1" } ] }, "pardot_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/pardot_config_V1" } ] }, "pardot_sandbox_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/pardot_sandbox_config_V1" } ] }, "partnerize_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/partnerize_config_V1" } ] }, "partnerstack_vendor_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/partnerstack_vendor_config_V1" } ] }, "paychex_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/paychex_config_V1" } ] }, "paylocity_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/paylocity_config_V1" } ] }, "paypal_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/paypal_config_V1" } ] }, "paypal_sandbox_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/paypal_sandbox_config_V1" } ] }, "pendo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/pendo_config_V1" } ] }, "pennylane_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/pennylane_config_V1" } ] }, "peopleforce_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/peopleforce_config_V1" } ] }, "persona_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/persona_config_V1" } ] }, "personio_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/personio_config_V1" } ] }, "phoenix_ads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/phoenix_ads_config_V1" } ] }, "picqer_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/picqer_config_V1" } ] }, "pigment_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/pigment_config_V1" } ] }, "pingdom_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/pingdom_config_V1" } ] }, "pinpoint_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/pinpoint_config_V1" } ] }, "pinterest_ads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/pinterest_ads_config_V1" } ] }, "pinterest_organic_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/pinterest_organic_config_V1" } ] }, "pipe17_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/pipe17_config_V1" } ] }, "pipedrive_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "webhook_url": { "title": "", "type": "string", "description": "The registered URL for webhooks in your Pipedrive dashboard.", "example": "string" } }, "description": "" } } }, "pipedrive_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/pipedrive_config_V1" }, { "$ref": "#/components/schemas/pipedrive_readonly_config_V1" } ] }, "pivotal_tracker_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/pivotal_tracker_config_V1" } ] }, "piwik_pro_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/piwik_pro_config_V1" } ] }, "placerai_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/placerai_config_V1" } ] }, "planetscale_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/planetscale_config_V1" } ] }, "planful_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/planful_config_V1" } ] }, "planhat_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/planhat_config_V1" } ] }, "playvox_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/playvox_config_V1" } ] }, "playvox_workforce_management_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/playvox_workforce_management_config_V1" } ] }, "podio_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/podio_config_V1" } ] }, "poplar_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/poplar_config_V1" } ] }, "postgres_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "postgres_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/postgres_config_V1" }, { "$ref": "#/components/schemas/postgres_readonly_config_V1" }, { "$ref": "#/components/schemas/postgres_esm_keys_config_V1" } ] }, "postgres_rds_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "postgres_rds_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/postgres_rds_config_V1" }, { "$ref": "#/components/schemas/postgres_rds_readonly_config_V1" }, { "$ref": "#/components/schemas/postgres_rds_esm_keys_config_V1" } ] }, "posthog_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/posthog_config_V1" } ] }, "postmark_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/postmark_config_V1" } ] }, "power_reviews_enterprise_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/power_reviews_enterprise_config_V1" } ] }, "prisma_cloud_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/prisma_cloud_config_V1" } ] }, "prive_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/prive_config_V1" } ] }, "procore_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/procore_config_V1" } ] }, "productboard_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/productboard_config_V1" } ] }, "productive_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/productive_config_V1" } ] }, "profound_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/profound_config_V1" } ] }, "proofpoint_security_awareness_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/proofpoint_security_awareness_config_V1" } ] }, "prosperstack_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/prosperstack_config_V1" } ] }, "purple_dot_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/purple_dot_config_V1" } ] }, "pylon_support_platform_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/pylon_support_platform_config_V1" } ] }, "qmatic_data_connect_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/qmatic_data_connect_config_V1" } ] }, "qualaroo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/qualaroo_config_V1" } ] }, "qualtrics_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/qualtrics_config_V1" } ] }, "quickbooks_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/quickbooks_config_V1" } ] }, "quora_ads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/quora_ads_config_V1" } ] }, "quorum_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/quorum_config_V1" } ] }, "rakutenadvertising_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/rakutenadvertising_config_V1" } ] }, "ramp_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ramp_config_V1" } ] }, "rarible_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/rarible_config_V1" } ] }, "rebound_returns_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/rebound_returns_config_V1" } ] }, "recharge_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/recharge_config_V1" } ] }, "recurly_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/recurly_config_V1" } ] }, "reddit_ads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/reddit_ads_config_V1" } ] }, "referralhero_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/referralhero_config_V1" } ] }, "refiner_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/refiner_config_V1" } ] }, "reltio_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/reltio_config_V1" } ] }, "replyio_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/replyio_config_V1" } ] }, "resource_management_by_smartsheet_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/resource_management_by_smartsheet_config_V1" } ] }, "retailnext_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/retailnext_config_V1" } ] }, "retently_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/retently_config_V1" } ] }, "revel_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/revel_config_V1" } ] }, "revenuecat_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/revenuecat_config_V1" } ] }, "reviewsai_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/reviewsai_config_V1" } ] }, "reviewsio_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/reviewsio_config_V1" } ] }, "revops_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/revops_config_V1" } ] }, "revx_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/revx_config_V1" } ] }, "ricochet360_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ricochet360_config_V1" } ] }, "ringcentral_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ringcentral_config_V1" } ] }, "ringover_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ringover_config_V1" } ] }, "rippling_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/rippling_config_V1" } ] }, "rithum_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/rithum_config_V1" } ] }, "rivo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/rivo_config_V1" } ] }, "rocketlane_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/rocketlane_config_V1" } ] }, "rokt_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/rokt_config_V1" } ] }, "rollbar_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/rollbar_config_V1" } ] }, "rootly_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/rootly_config_V1" } ] }, "rtb_house_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/rtb_house_config_V1" } ] }, "ruddr_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ruddr_config_V1" } ] }, "rundeck_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/rundeck_config_V1" } ] }, "s3_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "external_id": { "title": "", "type": "string", "description": "Used for authentication along with the `role_arn`. If not provided, it uses connector's `group_id`. Use the [List All Groups endpoint](/docs/rest-api/groups#listallgroups) to find the `group_id`.", "example": "group_id" } }, "description": "" } } }, "s3_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/s3_config_V1" }, { "$ref": "#/components/schemas/s3_readonly_config_V1" }, { "$ref": "#/components/schemas/s3_esm_keys_config_V1" } ] }, "s3_compatible_storage_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/s3_compatible_storage_config_V1" }, { "$ref": "#/components/schemas/s3_compatible_storage_esm_keys_config_V1" } ] }, "safebase_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/safebase_config_V1" } ] }, "safetyculture_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/safetyculture_config_V1" } ] }, "sage_hr_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sage_hr_config_V1" } ] }, "sage_intacct_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sage_intacct_config_V1" } ] }, "sailthru_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "s3external_id": { "title": "", "type": "string", "description": "The external ID is a string that designates who can assume the role.", "example": "string" } }, "description": "" } } }, "sailthru_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sailthru_config_V1" }, { "$ref": "#/components/schemas/sailthru_readonly_config_V1" } ] }, "salesforce_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "connecting_user": { "title": "", "type": "string", "description": "", "example": "string" }, "connecting_user_email": { "title": "", "type": "string", "description": "", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "organization_id": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "salesforce_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/salesforce_config_V1" }, { "$ref": "#/components/schemas/salesforce_readonly_config_V1" } ] }, "salesforce_commerce_cloud_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/salesforce_commerce_cloud_config_V1" } ] }, "salesforce_marketing_cloud_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "sftp_public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" }, "sub_domain": { "title": "", "type": "string", "description": "Your Salesforce Marketing Cloud subdomain.", "example": "http://your.sub.domain/" } }, "description": "" } } }, "salesforce_marketing_cloud_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/salesforce_marketing_cloud_config_V1" }, { "$ref": "#/components/schemas/salesforce_marketing_cloud_readonly_config_V1" } ] }, "salesforce_sandbox_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "connecting_user": { "title": "", "type": "string", "description": "", "example": "string" }, "connecting_user_email": { "title": "", "type": "string", "description": "", "example": "string" }, "connection_type": { "title": "", "type": "object", "description": "", "example": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enum": [ "Directly", "PrivateLink", "SshTunnel", "ProxyAgent" ] }, "organization_id": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "salesforce_sandbox_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/salesforce_sandbox_config_V1" }, { "$ref": "#/components/schemas/salesforce_sandbox_readonly_config_V1" } ] }, "salesloft_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/salesloft_config_V1" } ] }, "salsify_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/salsify_config_V1" } ] }, "samsara_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/samsara_config_V1" } ] }, "sana_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sana_config_V1" } ] }, "sap_business_by_design_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sap_business_by_design_config_V1" } ] }, "sap_hana_db_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "", "example": "string" }, "snc_fivetran_name": { "title": "", "type": "string", "description": "", "example": "string" } }, "description": "" } } }, "sap_hana_db_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sap_hana_db_config_V1" }, { "$ref": "#/components/schemas/sap_hana_db_readonly_config_V1" }, { "$ref": "#/components/schemas/sap_hana_db_esm_keys_config_V1" } ] }, "sap_odata_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key.", "example": "string" } }, "description": "" } } }, "sap_odata_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sap_odata_config_V1" }, { "$ref": "#/components/schemas/sap_odata_readonly_config_V1" }, { "$ref": "#/components/schemas/sap_odata_esm_keys_config_V1" } ] }, "sap_oracle_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "sap_oracle_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sap_oracle_config_V1" }, { "$ref": "#/components/schemas/sap_oracle_readonly_config_V1" }, { "$ref": "#/components/schemas/sap_oracle_esm_keys_config_V1" } ] }, "sap_success_factors_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sap_success_factors_config_V1" } ] }, "scorm_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/scorm_config_V1" } ] }, "security_journey_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/security_journey_config_V1" } ] }, "segment_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "external_id": { "title": "", "type": "string", "description": "The external ID is a string that designates who can assume the role. For more information, see Amazon's AWS Identity and Access Management User Guide.", "example": "string" }, "webhook_url": { "title": "", "type": "string", "description": "Webhook URL.", "example": "string" } }, "description": "" } } }, "segment_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/segment_config_V1" }, { "$ref": "#/components/schemas/segment_readonly_config_V1" } ] }, "sendgrid_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sendgrid_config_V1" } ] }, "sentry_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sentry_config_V1" } ] }, "servicenow_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/servicenow_config_V1" } ] }, "servicetitan_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/servicetitan_config_V1" } ] }, "servicetrade_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/servicetrade_config_V1" } ] }, "sevdesk_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sevdesk_config_V1" } ] }, "sftp_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key", "example": "string" } }, "description": "" } } }, "sftp_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sftp_config_V1" }, { "$ref": "#/components/schemas/sftp_readonly_config_V1" }, { "$ref": "#/components/schemas/sftp_esm_keys_config_V1" } ] }, "share_point_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/share_point_config_V1" } ] }, "shareasale_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/shareasale_config_V1" } ] }, "sharetribe_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sharetribe_config_V1" } ] }, "shiphero_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/shiphero_config_V1" } ] }, "shipmonk_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/shipmonk_config_V1" } ] }, "shipnetwork_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/shipnetwork_config_V1" } ] }, "shipstation_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/shipstation_config_V1" } ] }, "shopify_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/shopify_config_V1" } ] }, "shopware_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/shopware_config_V1" } ] }, "shortcut_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/shortcut_config_V1" } ] }, "shortio_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/shortio_config_V1" } ] }, "showpad_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/showpad_config_V1" } ] }, "siemens_building_x_openness_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/siemens_building_x_openness_config_V1" } ] }, "sigma_computing_source_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sigma_computing_source_config_V1" } ] }, "simplecast_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/simplecast_config_V1" } ] }, "simplesat_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/simplesat_config_V1" } ] }, "singlestore_source_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/singlestore_source_config_V1" } ] }, "sistrix_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sistrix_config_V1" } ] }, "skilljar_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/skilljar_config_V1" } ] }, "skillstx_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/skillstx_config_V1" } ] }, "skimlinks_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/skimlinks_config_V1" } ] }, "skuvault_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/skuvault_config_V1" } ] }, "slab_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/slab_config_V1" } ] }, "slack_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/slack_config_V1" } ] }, "slack_admin_data_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/slack_admin_data_config_V1" } ] }, "slack_app_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/slack_app_config_V1" } ] }, "smadex_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/smadex_config_V1" } ] }, "smarthr_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/smarthr_config_V1" } ] }, "smartrecruiters_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/smartrecruiters_config_V1" } ] }, "smartsheet_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/smartsheet_config_V1" } ] }, "smartwaiver_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/smartwaiver_config_V1" } ] }, "snapchat_ads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/snapchat_ads_config_V1" } ] }, "snowflake_db_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/snowflake_db_config_V1" } ] }, "snowplow_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "endpoint": { "title": "", "type": "string", "description": "Connection-specific collector endpoint. The collector endpoint will have the `webhooks.fivetran.com/snowplow/` format. You will need it to configure Snowplow to connect with Fivetran.", "example": "string" } }, "description": "" } } }, "snowplow_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/snowplow_config_V1" }, { "$ref": "#/components/schemas/snowplow_readonly_config_V1" } ] }, "snyk_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/snyk_config_V1" } ] }, "solarwinds_service_desk_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/solarwinds_service_desk_config_V1" } ] }, "sonarqube_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sonarqube_config_V1" } ] }, "sparkpost_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sparkpost_config_V1" } ] }, "splash_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/splash_config_V1" } ] }, "splitio_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/splitio_config_V1" } ] }, "splunk_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/splunk_config_V1" } ] }, "spotify_ads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/spotify_ads_config_V1" } ] }, "sprout_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sprout_config_V1" } ] }, "sql_server_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key.", "example": "string" } }, "description": "" } } }, "sql_server_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sql_server_config_V1" }, { "$ref": "#/components/schemas/sql_server_readonly_config_V1" }, { "$ref": "#/components/schemas/sql_server_esm_keys_config_V1" } ] }, "sql_server_hva_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key.", "example": "string" } }, "description": "" } } }, "sql_server_hva_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sql_server_hva_config_V1" }, { "$ref": "#/components/schemas/sql_server_hva_readonly_config_V1" } ] }, "sql_server_rds_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key.", "example": "string" } }, "description": "" } } }, "sql_server_rds_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sql_server_rds_config_V1" }, { "$ref": "#/components/schemas/sql_server_rds_readonly_config_V1" }, { "$ref": "#/components/schemas/sql_server_rds_esm_keys_config_V1" } ] }, "sql_server_sap_ecc_hva_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "public_key": { "title": "", "type": "string", "description": "Public Key.", "example": "string" } }, "description": "" } } }, "sql_server_sap_ecc_hva_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sql_server_sap_ecc_hva_config_V1" }, { "$ref": "#/components/schemas/sql_server_sap_ecc_hva_readonly_config_V1" } ] }, "square_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/square_config_V1" } ] }, "squarespace_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/squarespace_config_V1" } ] }, "stackadapt_graphql_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/stackadapt_graphql_config_V1" } ] }, "standard_metrics_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/standard_metrics_config_V1" } ] }, "starrez_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/starrez_config_V1" } ] }, "statistics_netherlands_cbs_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/statistics_netherlands_cbs_config_V1" } ] }, "statsig_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/statsig_config_V1" } ] }, "statuspage_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/statuspage_config_V1" } ] }, "stickyio_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/stickyio_config_V1" } ] }, "stripe_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/stripe_config_V1" } ] }, "stripe_test_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/stripe_test_config_V1" } ] }, "stylight_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/stylight_config_V1" } ] }, "subscript_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/subscript_config_V1" } ] }, "sugarcrm_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/sugarcrm_config_V1" } ] }, "survey_monkey_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/survey_monkey_config_V1" } ] }, "survicate_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/survicate_config_V1" } ] }, "swoogo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/swoogo_config_V1" } ] }, "tableau_source_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/tableau_source_config_V1" } ] }, "taboola_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/taboola_config_V1" } ] }, "talkdesk_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/talkdesk_config_V1" } ] }, "talkwalker_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/talkwalker_config_V1" } ] }, "teads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/teads_config_V1" } ] }, "teamtailor_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/teamtailor_config_V1" } ] }, "teamwork_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/teamwork_config_V1" } ] }, "tempo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/tempo_config_V1" } ] }, "testrail_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/testrail_config_V1" } ] }, "textus_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/textus_config_V1" } ] }, "the_movie_database_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/the_movie_database_config_V1" } ] }, "the_trade_desk_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/the_trade_desk_config_V1" } ] }, "thinkific_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/thinkific_config_V1" } ] }, "ticket_tailor_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ticket_tailor_config_V1" } ] }, "tiktok_ads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/tiktok_ads_config_V1" } ] }, "tiktok_organic_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/tiktok_organic_config_V1" } ] }, "tiktok_organic_app_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/tiktok_organic_app_config_V1" } ] }, "tiktok_shop_partner_center_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/tiktok_shop_partner_center_config_V1" } ] }, "tive_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/tive_config_V1" } ] }, "toggl_track_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/toggl_track_config_V1" } ] }, "totango_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/totango_config_V1" } ] }, "tracksuit_source_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/tracksuit_source_config_V1" } ] }, "transcend_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/transcend_config_V1" } ] }, "trelica_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/trelica_config_V1" } ] }, "trello_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/trello_config_V1" } ] }, "tremendous_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/tremendous_config_V1" } ] }, "triple_whale_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/triple_whale_config_V1" } ] }, "trisolute_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/trisolute_config_V1" } ] }, "trustpilot_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/trustpilot_config_V1" } ] }, "twilio_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/twilio_config_V1" }, { "$ref": "#/components/schemas/twilio_esm_keys_config_V1" } ] }, "twitter_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "consumer_key": { "title": "", "type": "string", "description": "API Key of your app", "format": "password", "example": "string" }, "consumer_secret": { "title": "", "type": "string", "description": "API Secret of your app", "format": "password", "example": "string" } }, "description": "" } } }, "twitter_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/twitter_config_V1" }, { "$ref": "#/components/schemas/twitter_readonly_config_V1" } ] }, "twitter_ads_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "consumer_key": { "title": "", "type": "string", "description": "The X App consumer key.", "example": "x_key" }, "consumer_secret": { "title": "", "type": "string", "description": "The X App consumer secret.", "format": "password", "example": "x_secret" } }, "description": "" } } }, "twitter_ads_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/twitter_ads_config_V1" }, { "$ref": "#/components/schemas/twitter_ads_readonly_config_V1" } ] }, "tymeshift_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/tymeshift_config_V1" } ] }, "typeform_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/typeform_config_V1" } ] }, "udemy_business_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/udemy_business_config_V1" } ] }, "ukg_pro_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ukg_pro_config_V1" } ] }, "ukg_pro_workforce_management_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/ukg_pro_workforce_management_config_V1" } ] }, "unicommerce_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/unicommerce_config_V1" } ] }, "upland_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/upland_config_V1" } ] }, "uppromote_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/uppromote_config_V1" } ] }, "uptempo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/uptempo_config_V1" } ] }, "uservoice_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/uservoice_config_V1" } ] }, "validio_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/validio_config_V1" } ] }, "veeqo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/veeqo_config_V1" } ] }, "veeva_vault_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/veeva_vault_config_V1" } ] }, "venminder_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/venminder_config_V1" } ] }, "vimeo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/vimeo_config_V1" } ] }, "visit_by_ges_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/visit_by_ges_config_V1" } ] }, "visma_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/visma_config_V1" } ] }, "vitally_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/vitally_config_V1" } ] }, "vonage_contact_center_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/vonage_contact_center_config_V1" } ] }, "vts_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/vts_config_V1" } ] }, "vwo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/vwo_config_V1" } ] }, "walmart_dsp_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/walmart_dsp_config_V1" } ] }, "walmart_marketplace_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/walmart_marketplace_config_V1" } ] }, "web_scraper_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/web_scraper_config_V1" } ] }, "webconnex_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/webconnex_config_V1" } ] }, "webhooks_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/webhooks_config_V1" } ] }, "when_i_work_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/when_i_work_config_V1" } ] }, "wherefour_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/wherefour_config_V1" } ] }, "wicked_reports_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/wicked_reports_config_V1" } ] }, "woocommerce_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/woocommerce_config_V1" } ] }, "wordpress_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/wordpress_config_V1" } ] }, "workable_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/workable_config_V1" } ] }, "workday_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/workday_config_V1" }, { "$ref": "#/components/schemas/workday_esm_keys_config_V1" } ] }, "workday_adaptive_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/workday_adaptive_config_V1" } ] }, "workday_financial_management_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/workday_financial_management_config_V1" }, { "$ref": "#/components/schemas/workday_financial_management_esm_keys_config_V1" } ] }, "workday_hcm_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/workday_hcm_config_V1" }, { "$ref": "#/components/schemas/workday_hcm_esm_keys_config_V1" } ] }, "workday_strategic_sourcing_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/workday_strategic_sourcing_config_V1" } ] }, "workleap_officevibe_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/workleap_officevibe_config_V1" } ] }, "workramp_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/workramp_config_V1" } ] }, "wrike_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/wrike_config_V1" } ] }, "writesonic_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/writesonic_config_V1" } ] }, "xactly_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/xactly_config_V1" } ] }, "xandr_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/xandr_config_V1" } ] }, "xero_readonly_config_V1": { "properties": { "config": { "type": "object", "properties": { "webhook_url": { "title": "", "type": "string", "description": "(ReadOnly) The Webhook URL generated by Fivetran. You can configure this in XERO.", "example": "string" } }, "description": "" } } }, "xero_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/xero_config_V1" }, { "$ref": "#/components/schemas/xero_readonly_config_V1" } ] }, "xray_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/xray_config_V1" } ] }, "xsolla_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/xsolla_config_V1" } ] }, "yahoo_display_ads_on_yahoo_japan_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/yahoo_display_ads_on_yahoo_japan_config_V1" } ] }, "yahoo_dsp_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/yahoo_dsp_config_V1" } ] }, "yahoo_gemini_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/yahoo_gemini_config_V1" } ] }, "yahoo_search_ads_yahoo_japan_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/yahoo_search_ads_yahoo_japan_config_V1" } ] }, "yext_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/yext_config_V1" } ] }, "yotpo_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/yotpo_config_V1" } ] }, "yougov_brandindex_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/yougov_brandindex_config_V1" } ] }, "yougov_sport_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/yougov_sport_config_V1" } ] }, "younium_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/younium_config_V1" } ] }, "youtube_analytics_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/youtube_analytics_config_V1" } ] }, "zendesk_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zendesk_config_V1" } ] }, "zendesk_chat_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zendesk_chat_config_V1" } ] }, "zendesk_sell_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zendesk_sell_config_V1" } ] }, "zendesk_sunshine_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zendesk_sunshine_config_V1" } ] }, "zendesk_workforce_management_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zendesk_workforce_management_config_V1" } ] }, "zenefits_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zenefits_config_V1" } ] }, "zingtree_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zingtree_config_V1" } ] }, "zip_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zip_config_V1" } ] }, "zoho_books_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zoho_books_config_V1" } ] }, "zoho_campaigns_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zoho_campaigns_config_V1" } ] }, "zoho_crm_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zoho_crm_config_V1" } ] }, "zoho_desk_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zoho_desk_config_V1" } ] }, "zoho_inventory_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zoho_inventory_config_V1" } ] }, "zoho_people_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zoho_people_config_V1" } ] }, "zoho_recruit_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zoho_recruit_config_V1" } ] }, "zonka_feedback_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zonka_feedback_config_V1" } ] }, "zoom_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zoom_config_V1" } ] }, "zuora_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zuora_config_V1" } ] }, "zuora_sandbox_ConnectorResponseV1": { "allOf": [ { "$ref": "#/components/schemas/ConnectorResponseV1" }, { "$ref": "#/components/schemas/zuora_sandbox_config_V1" } ] }, "DBT_CORE_new_transformation_config_V1": { "properties": { "transformation_config": { "required": [ "name", "project_id", "steps" ], "type": "object", "properties": { "project_id": { "type": "string", "description": "The unique identifier for the dbt project within the Fivetran system" }, "name": { "type": "string", "description": "The transformation name" }, "steps": { "type": "array", "description": "The list of transformation steps", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The step name" }, "command": { "type": "string", "description": "The dbt command in the transformation step" } }, "description": "" } } }, "description": "dbt Core transformation configuration object" } } }, "DBT_CORE_NewTransformationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewTransformationRequest" }, { "$ref": "#/components/schemas/DBT_CORE_new_transformation_config_V1" } ] }, "QUICKSTART_new_transformation_config_V1": { "properties": { "transformation_config": { "type": "object", "properties": { "package_name": { "type": "string", "description": "The Quickstart transformation package name" }, "connection_ids": { "type": "array", "description": "The list of connection IDs that the Quickstart transformation depends on when using the integrated schedule (`schedule_type: INTEGRATED`) or custom schedules (`schedule_type: TIME_OF_DAY` or `schedule_type: INTERVAL`) with smart syncing enabled (`smart_syncing: true`). This is also used to auto-detect `package_name` if it is not provided. This field should not be used for Transformations for dbt.", "items": { "type": "string", "description": "" } }, "excluded_models": { "type": "array", "description": "The list of excluded output model names", "items": { "type": "string", "description": "" } }, "configurable_variables": { "type": "object", "description": "The map of configurable variable values keyed by variable name." }, "group_id": { "type": "string", "description": "The destination group identifier to run the Quickstart transformation against. Required only when it differs from the connections' own group, for example, when the connections land data through Managed Data Lake Service (MDLS) and this group is linked to it. Defaults to the connections' own group." } }, "description": "Quickstart package transformation configuration object" } } }, "QUICKSTART_NewTransformationRequest": { "allOf": [ { "$ref": "#/components/schemas/NewTransformationRequest" }, { "$ref": "#/components/schemas/QUICKSTART_new_transformation_config_V1" } ] }, "DBT_CORE_update_transformation_config_V1": { "properties": { "transformation_config": { "type": "object", "properties": { "project_id": { "type": "string", "description": "The unique identifier for the dbt project within the Fivetran system" }, "name": { "type": "string", "description": "The transformation name" }, "steps": { "type": "array", "description": "The list of transformation steps", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The step name" }, "command": { "type": "string", "description": "The dbt command in the transformation step" } }, "description": "" } } }, "description": "dbt Core transformation configuration object" } } }, "DBT_CORE_UpdateTransformationRequest": { "allOf": [ { "$ref": "#/components/schemas/UpdateTransformationRequest" }, { "$ref": "#/components/schemas/DBT_CORE_update_transformation_config_V1" } ] }, "QUICKSTART_update_transformation_config_V1": { "properties": { "transformation_config": { "type": "object", "properties": { "excluded_models": { "type": "array", "description": "The list of excluded output model names", "items": { "type": "string", "description": "" } }, "configurable_variables": { "type": "object", "description": "The map of configurable variable values keyed by variable name." }, "group_id": { "type": "string", "description": "The destination group identifier to run the Quickstart transformation against. Required only when it differs from the connections' own group, for example, when the connections land data through Managed Data Lake Service (MDLS) and this group is linked to it. Defaults to the connections' own group." } }, "description": "Quickstart package transformation configuration object" } } }, "QUICKSTART_UpdateTransformationRequest": { "allOf": [ { "$ref": "#/components/schemas/UpdateTransformationRequest" }, { "$ref": "#/components/schemas/QUICKSTART_update_transformation_config_V1" } ] }, "DBT_CORE_transformation_config_response_V1": { "properties": { "transformation_config": { "type": "object", "properties": { "project_id": { "type": "string", "description": "The unique identifier for the dbt project within the Fivetran system" }, "name": { "type": "string", "description": "The transformation name" }, "steps": { "type": "array", "description": "The list of transformation steps", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The step name" }, "command": { "type": "string", "description": "The dbt command in the transformation step" } }, "description": "" } } }, "description": "dbt Core transformation configuration object" } } }, "DBT_CORE_TransformationResponse": { "allOf": [ { "$ref": "#/components/schemas/TransformationResponse" }, { "$ref": "#/components/schemas/DBT_CORE_transformation_config_response_V1" } ] }, "QUICKSTART_transformation_config_response_V1": { "properties": { "transformation_config": { "type": "object", "properties": { "package_name": { "type": "string", "description": "The Quickstart transformation package name" }, "connection_ids": { "type": "array", "description": "The list of connection IDs that the Quickstart transformation depends on when using the integrated schedule (`schedule_type: INTEGRATED`) or custom schedules (`schedule_type: TIME_OF_DAY` or `schedule_type: INTERVAL`) with smart syncing enabled (`smart_syncing: true`). This is also used to auto-detect `package_name` if it is not provided. This field should not be used for Transformations for dbt.", "items": { "type": "string", "description": "" } }, "excluded_models": { "type": "array", "description": "The list of excluded output model names", "items": { "type": "string", "description": "" } }, "upgrade_available": { "type": "boolean", "description": "The boolean flag indicating that a newer version is available for the transformation package" }, "configurable_variables": { "type": "object", "description": "The map of configurable variable values keyed by variable name." }, "group_id": { "type": "string", "description": "The destination group identifier to run the Quickstart transformation against. Required only when it differs from the connections' own group, for example, when the connections land data through Managed Data Lake Service (MDLS) and this group is linked to it. Defaults to the connections' own group." } }, "description": "Quickstart package transformation configuration object" } } }, "QUICKSTART_TransformationResponse": { "allOf": [ { "$ref": "#/components/schemas/TransformationResponse" }, { "$ref": "#/components/schemas/QUICKSTART_transformation_config_response_V1" } ] }, "DBT_CORE_new_transformation_project_config_V1": { "properties": { "project_config": { "required": [ "dbt_version", "default_schema", "git_remote_url" ], "type": "object", "properties": { "dbt_version": { "type": "string", "description": "The version of dbt that should run the project" }, "default_schema": { "type": "string", "description": "The default schema in the destination" }, "git_remote_url": { "type": "string", "description": "The Git remote URL of your dbt project" }, "folder_path": { "type": "string", "description": "The path to the folder in the Git repo where your dbt project is stored." }, "git_branch": { "type": "string", "description": "The Git branch of your dbt project." }, "threads": { "type": "integer", "description": "The number of threads dbt will use", "format": "int32" }, "target_name": { "type": "string", "description": "The default target name" }, "environment_vars": { "type": "array", "description": "The list of environment variables defined as key-value pairs in the raw string format using `=` as a separator. The variable names should have the `DBT_` prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: `[\"DBT_VARIABLE=variable_value\", \"DBT_VARIABLE_2=variable_value_2\"]`", "items": { "type": "string", "description": "" } } }, "description": "dbt Core project configuration object" } } }, "DBT_CORE_NewTransformationProjectRequest": { "allOf": [ { "$ref": "#/components/schemas/NewTransformationProjectRequest" }, { "$ref": "#/components/schemas/DBT_CORE_new_transformation_project_config_V1" } ] }, "DBT_CORE_update_transformation_project_config_V1": { "properties": { "project_config": { "type": "object", "properties": { "folder_path": { "type": "string", "description": "The path to the folder in the Git repo where your dbt project is stored." }, "git_branch": { "type": "string", "description": "The Git branch of your dbt project." }, "threads": { "type": "integer", "description": "The number of threads dbt will use", "format": "int32" }, "target_name": { "type": "string", "description": "The default target name" }, "environment_vars": { "type": "array", "description": "The list of environment variables defined as key-value pairs in the raw string format using `=` as a separator. The variable names should have the `DBT_` prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: `[\"DBT_VARIABLE=variable_value\", \"DBT_VARIABLE_2=variable_value_2\"]`", "items": { "type": "string", "description": "" } } }, "description": "dbt Core project configuration object" } } }, "DBT_CORE_UpdateTransformationProjectRequest": { "allOf": [ { "$ref": "#/components/schemas/UpdateTransformationProjectRequest" }, { "$ref": "#/components/schemas/DBT_CORE_update_transformation_project_config_V1" } ] }, "DBT_CORE_transformation_project_config_response_V1": { "properties": { "project_config": { "type": "object", "properties": { "dbt_version": { "type": "string", "description": "The version of dbt that should run the project" }, "default_schema": { "type": "string", "description": "The default schema in the destination" }, "git_remote_url": { "type": "string", "description": "The Git remote URL of your dbt project" }, "folder_path": { "type": "string", "description": "The path to the folder in the Git repo where your dbt project is stored." }, "git_branch": { "type": "string", "description": "The Git branch of your dbt project." }, "threads": { "type": "integer", "description": "The number of threads dbt will use", "format": "int32" }, "target_name": { "type": "string", "description": "The default target name" }, "environment_vars": { "type": "array", "description": "The list of environment variables defined as key-value pairs in the raw string format using `=` as a separator. The variable names should have the `DBT_` prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: `[\"DBT_VARIABLE=variable_value\", \"DBT_VARIABLE_2=variable_value_2\"]`", "items": { "type": "string", "description": "" } }, "public_key": { "type": "string", "description": "The public key used to grant Fivetran SSH access to the dbt project Git repository" } }, "description": "dbt Core project configuration object" } } }, "DBT_CORE_TransformationProjectDetailsResponse": { "allOf": [ { "$ref": "#/components/schemas/TransformationProjectDetailsResponse" }, { "$ref": "#/components/schemas/DBT_CORE_transformation_project_config_response_V1" } ] }, "databricks_aws_private_link_config_V1": { "properties": { "config": { "title": "databricks", "required": [ "connection_service_name" ], "type": "object", "properties": { "connection_service_name": { "type": "string", "description": "The name of your connection service.", "example": "com.amazonaws.vpce.us-east-1.vpce-svc-01234567890abcdef" } }, "description": "Databricks for AWS" } } }, "databricks_aws_PrivateLinkCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkCreateRequest" }, { "$ref": "#/components/schemas/databricks_aws_private_link_config_V1" } ] }, "snowflake_aws_private_link_config_V1": { "properties": { "config": { "title": "snowflake", "required": [ "account_url", "vpce_id" ], "type": "object", "properties": { "account_url": { "type": "string", "description": "The URL of your account.", "example": "https://myaccount.snowflakecomputing.com" }, "vpce_id": { "type": "string", "description": "The ID of your Virtual Private Cloud Endpoint.", "example": "vpce-01234567890abcdef" } }, "description": "Snowflake for AWS" } } }, "snowflake_aws_PrivateLinkCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkCreateRequest" }, { "$ref": "#/components/schemas/snowflake_aws_private_link_config_V1" } ] }, "redshift_aws_private_link_config_V1": { "properties": { "config": { "title": "redshift", "required": [ "aws_account_id", "cluster_identifier" ], "type": "object", "properties": { "aws_account_id": { "type": "string", "description": "The ID of your AWS account.", "example": "123456789012" }, "cluster_identifier": { "type": "string", "description": "The cluster identifier.", "example": "my-redshift-cluster" } }, "description": "Redshift for AWS" } } }, "redshift_aws_PrivateLinkCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkCreateRequest" }, { "$ref": "#/components/schemas/redshift_aws_private_link_config_V1" } ] }, "source_aws_private_link_config_V1": { "properties": { "config": { "title": "source", "required": [ "connection_service_name" ], "type": "object", "properties": { "connection_service_name": { "type": "string", "description": "The name of your connection service.", "example": "com.amazonaws.vpce.us-east-1.vpce-svc-01234567890abcdef" } }, "description": "Source and all other services for AWS" } } }, "source_aws_PrivateLinkCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkCreateRequest" }, { "$ref": "#/components/schemas/source_aws_private_link_config_V1" } ] }, "databricks_azure_private_link_config_V1": { "properties": { "config": { "title": "databricks", "required": [ "connection_service_id", "workspace_url" ], "type": "object", "properties": { "connection_service_id": { "type": "string", "description": "The resource ID of your Azure service (the full Azure Resource Manager path).", "example": "/subscriptions/012345ab-0000-0000-0000-0123456789ab/resourceGroups/my-rg/providers/Microsoft.Sql/servers/my-sql-server" }, "workspace_url": { "type": "string", "description": "Workspace Url", "example": "https://adb-1234567890123456.12.azuredatabricks.net" } }, "description": "Databricks for Azure" } } }, "databricks_azure_PrivateLinkCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkCreateRequest" }, { "$ref": "#/components/schemas/databricks_azure_private_link_config_V1" } ] }, "snowflake_azure_private_link_config_V1": { "properties": { "config": { "title": "snowflake", "required": [ "account_url", "pls_id" ], "type": "object", "properties": { "account_url": { "type": "string", "description": "The URL of your account.", "example": "https://myaccount.snowflakecomputing.com" }, "pls_id": { "type": "string", "description": "The ID of your Private Link service.", "example": "com.snowflakecomputing.us-east-1.privatelink" } }, "description": "Snowflake for Azure" } } }, "snowflake_azure_PrivateLinkCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkCreateRequest" }, { "$ref": "#/components/schemas/snowflake_azure_private_link_config_V1" } ] }, "onelake_azure_private_link_config_V1": { "properties": { "config": { "title": "onelake", "required": [ "connection_service_id" ], "type": "object", "properties": { "connection_service_id": { "type": "string", "description": "The resource ID of your Azure service (the full Azure Resource Manager path).", "example": "/subscriptions/012345ab-0000-0000-0000-0123456789ab/resourceGroups/my-rg/providers/Microsoft.Sql/servers/my-sql-server" } }, "description": "Onelake for Azure" } } }, "onelake_azure_PrivateLinkCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkCreateRequest" }, { "$ref": "#/components/schemas/onelake_azure_private_link_config_V1" } ] }, "postgres_warehouse_azure_private_link_config_V1": { "properties": { "config": { "title": "azure_postgres_warehouse", "required": [ "connection_service_id" ], "type": "object", "properties": { "connection_service_id": { "type": "string", "description": "The resource ID of your Azure service (the full Azure Resource Manager path).", "example": "/subscriptions/012345ab-0000-0000-0000-0123456789ab/resourceGroups/my-rg/providers/Microsoft.Sql/servers/my-sql-server" } }, "description": "Postgres Warehouse for Azure" } } }, "postgres_warehouse_azure_PrivateLinkCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkCreateRequest" }, { "$ref": "#/components/schemas/postgres_warehouse_azure_private_link_config_V1" } ] }, "sql_data_warehouse_azure_private_link_config_V1": { "properties": { "config": { "title": "azure_sql_data_warehouse", "required": [ "connection_service_id" ], "type": "object", "properties": { "connection_service_id": { "type": "string", "description": "The resource ID of your Azure service (the full Azure Resource Manager path).", "example": "/subscriptions/012345ab-0000-0000-0000-0123456789ab/resourceGroups/my-rg/providers/Microsoft.Sql/servers/my-sql-server" } }, "description": "Azure SQL Data Warehouse for Azure" } } }, "sql_data_warehouse_azure_PrivateLinkCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkCreateRequest" }, { "$ref": "#/components/schemas/sql_data_warehouse_azure_private_link_config_V1" } ] }, "source_azure_private_link_config_V1": { "properties": { "config": { "title": "source", "required": [ "connection_service_id", "sub_resource_name" ], "type": "object", "properties": { "connection_service_id": { "type": "string", "description": "The resource ID of your Azure service (the full Azure Resource Manager path).", "example": "/subscriptions/012345ab-0000-0000-0000-0123456789ab/resourceGroups/my-rg/providers/Microsoft.Sql/servers/my-sql-server" }, "sub_resource_name": { "type": "string", "description": "The Azure subresource name for the Private Link endpoint. Allowed values depend on your Azure resource type, for example `sqlServer`, `postgresqlServer`, `blob`, `managedInstance`, `namespace`, `sql`, `MongoDB`.", "example": "sqlServer" }, "private_dns_records": { "type": "string", "description": "Optional. One or more relative DNS record names for the private link, separated by semicolons. Do not include the DNS zone suffix — Fivetran appends it automatically based on sub_resource_name. If omitted, Fivetran derives the record name from the last segment of connection_service_id.", "example": "my-sql-server" } }, "description": "Source and all other services for Azure" } } }, "source_azure_PrivateLinkCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkCreateRequest" }, { "$ref": "#/components/schemas/source_azure_private_link_config_V1" } ] }, "snowflake_gcp_private_link_config_V1": { "properties": { "config": { "title": "snowflake", "required": [ "account_url", "pls_id" ], "type": "object", "properties": { "account_url": { "type": "string", "description": "The URL of your account.", "example": "https://myaccount.snowflakecomputing.com" }, "pls_id": { "type": "string", "description": "The ID of your Private Link service.", "example": "com.snowflakecomputing.us-east-1.privatelink" } }, "description": "Snowflake for GCP" } } }, "snowflake_gcp_PrivateLinkCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkCreateRequest" }, { "$ref": "#/components/schemas/snowflake_gcp_private_link_config_V1" } ] }, "source_gcp_private_link_config_V1": { "properties": { "config": { "title": "source", "required": [ "private_connection_service_id" ], "type": "object", "properties": { "private_connection_service_id": { "type": "string", "description": "The ID of your connection service.", "example": "projects/my-project/regions/us-central1/serviceAttachments/my-service" } }, "description": "Source and all other services for GCP" } } }, "source_gcp_PrivateLinkCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkCreateRequest" }, { "$ref": "#/components/schemas/source_gcp_private_link_config_V1" } ] }, "databricks_gcp_private_link_config_V1": { "properties": { "config": { "title": "databricks", "required": [ "connection_service_id", "workspace_url" ], "type": "object", "properties": { "connection_service_id": { "type": "string", "description": "The resource ID of your Azure service (the full Azure Resource Manager path).", "example": "/subscriptions/012345ab-0000-0000-0000-0123456789ab/resourceGroups/my-rg/providers/Microsoft.Sql/servers/my-sql-server" }, "workspace_url": { "type": "string", "description": "Workspace Url", "example": "https://adb-1234567890123456.12.azuredatabricks.net" } }, "description": "Databricks for GCP" } } }, "databricks_gcp_PrivateLinkCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkCreateRequest" }, { "$ref": "#/components/schemas/databricks_gcp_private_link_config_V1" } ] }, "databricks_aws_PrivateLinkUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkUpdateRequest" }, { "$ref": "#/components/schemas/databricks_aws_private_link_config_V1" } ] }, "snowflake_aws_PrivateLinkUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkUpdateRequest" }, { "$ref": "#/components/schemas/snowflake_aws_private_link_config_V1" } ] }, "redshift_aws_PrivateLinkUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkUpdateRequest" }, { "$ref": "#/components/schemas/redshift_aws_private_link_config_V1" } ] }, "source_aws_PrivateLinkUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkUpdateRequest" }, { "$ref": "#/components/schemas/source_aws_private_link_config_V1" } ] }, "databricks_azure_PrivateLinkUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkUpdateRequest" }, { "$ref": "#/components/schemas/databricks_azure_private_link_config_V1" } ] }, "snowflake_azure_PrivateLinkUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkUpdateRequest" }, { "$ref": "#/components/schemas/snowflake_azure_private_link_config_V1" } ] }, "onelake_azure_PrivateLinkUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkUpdateRequest" }, { "$ref": "#/components/schemas/onelake_azure_private_link_config_V1" } ] }, "postgres_warehouse_azure_PrivateLinkUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkUpdateRequest" }, { "$ref": "#/components/schemas/postgres_warehouse_azure_private_link_config_V1" } ] }, "sql_data_warehouse_azure_PrivateLinkUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkUpdateRequest" }, { "$ref": "#/components/schemas/sql_data_warehouse_azure_private_link_config_V1" } ] }, "source_azure_PrivateLinkUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkUpdateRequest" }, { "$ref": "#/components/schemas/source_azure_private_link_config_V1" } ] }, "snowflake_gcp_PrivateLinkUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkUpdateRequest" }, { "$ref": "#/components/schemas/snowflake_gcp_private_link_config_V1" } ] }, "source_gcp_PrivateLinkUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkUpdateRequest" }, { "$ref": "#/components/schemas/source_gcp_private_link_config_V1" } ] }, "databricks_gcp_PrivateLinkUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkUpdateRequest" }, { "$ref": "#/components/schemas/databricks_gcp_private_link_config_V1" } ] }, "databricks_aws_PrivateLinkResponse": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkResponse" }, { "$ref": "#/components/schemas/databricks_aws_private_link_config_V1" } ] }, "snowflake_aws_PrivateLinkResponse": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkResponse" }, { "$ref": "#/components/schemas/snowflake_aws_private_link_config_V1" } ] }, "redshift_aws_PrivateLinkResponse": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkResponse" }, { "$ref": "#/components/schemas/redshift_aws_private_link_config_V1" } ] }, "source_aws_PrivateLinkResponse": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkResponse" }, { "$ref": "#/components/schemas/source_aws_private_link_config_V1" } ] }, "databricks_azure_PrivateLinkResponse": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkResponse" }, { "$ref": "#/components/schemas/databricks_azure_private_link_config_V1" } ] }, "snowflake_azure_PrivateLinkResponse": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkResponse" }, { "$ref": "#/components/schemas/snowflake_azure_private_link_config_V1" } ] }, "onelake_azure_PrivateLinkResponse": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkResponse" }, { "$ref": "#/components/schemas/onelake_azure_private_link_config_V1" } ] }, "postgres_warehouse_azure_PrivateLinkResponse": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkResponse" }, { "$ref": "#/components/schemas/postgres_warehouse_azure_private_link_config_V1" } ] }, "sql_data_warehouse_azure_PrivateLinkResponse": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkResponse" }, { "$ref": "#/components/schemas/sql_data_warehouse_azure_private_link_config_V1" } ] }, "source_azure_PrivateLinkResponse": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkResponse" }, { "$ref": "#/components/schemas/source_azure_private_link_config_V1" } ] }, "snowflake_gcp_PrivateLinkResponse": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkResponse" }, { "$ref": "#/components/schemas/snowflake_gcp_private_link_config_V1" } ] }, "source_gcp_PrivateLinkResponse": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkResponse" }, { "$ref": "#/components/schemas/source_gcp_private_link_config_V1" } ] }, "databricks_gcp_PrivateLinkResponse": { "allOf": [ { "$ref": "#/components/schemas/PrivateLinkResponse" }, { "$ref": "#/components/schemas/databricks_gcp_private_link_config_V1" } ] } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } } }